ViewMouseTool Property

Sets or returns the current mouse tool.

Syntax

FlpCAD.ViewMouseTool [ = type]

The ViewMouseTool property has these parts:

Part	Description
FlpCAD	An object expression that evaluates the Flipper CAD Control object.
type	A numeric expression of the current drawing shape type or selection type.

Settings

*type*	Description
-4	Zoom Realtime Tool - for determining the percentage of zoom
-3	Net Zoom - for zooming the view within a rectangle.
-2	Pan - for panning the view.
-1	Net Select - for selecting one or more shapes within a rectangle.
0	Select - selects each shape on the screen for moving and resizing (default).
1	Rectangle
2	Round Rectangle
3	Line
4	Two Point Ellipse
5	Polyline
6	Polygon
7	Freehand
8	Spline
9	Closed Spline
10	Three Point Arc
11	Text
12	Picture
13	Arc
14	Pie Slice
15	Chord
16	Reserved for future use.
17	Point
18	Group
19	Circle
20	Ellipse

Remarks

This property sets the type of tool to be used by the mouse. This is for adding shapes with the mouse, or performing other operations such as panning, zooming, and net selection.

You may wish to set this property using a shape type constant rather than an integer value.

When set to zoom realtime tool, moving the mouse up zooms in and moving the mouse down zooms out. The amount of the zoom depends on the ZoomRealtimePercentage property.

When drawing shapes, they are added to the current layer set by LayerNumber. DrawBegin is fired when the shape is first added, and DrawEnd when completed.

Tip: The control can be customized to snap to a grid point or another shape handle while drawing the shape (see View Routines).

When type is set to select, shapes can be selected, moved, or resized, depending on what LayerAction is set to.

When type is set to net select, any shape that intersects the selection rectangle is added to the selection buffer.

For more on selection, see the Shape Selection Overview.

To add shapes programmatically, see ShapeAdd.

After a shape has completed drawing, the shape type will change depending on what ViewPersistMouseTool is set to. By default, it resets to the select tool (0) upon completion of drawing a shape or a net select.

Group shapes are most commonly added programmatically. If added with the mouse, a new group shape is created, though it will not have shapes initially and will not be visible on the control. See the Grouping Shapes Overview for more information.