DirectionGripUserInterfaceObject
GripUserInterfaceObjectUserInterfaceObjectBaseA point plus direction arrows that represents a grip constrained to a line
Constructors
Properties
Shape used for end of direction line
BoundToActiveView
Length of direction line in pixel units
GripFillColor
GripLocation
GripRadius
GripShapeRotationRadians
GripStrokeWidth
HasKeyboardFocus
Does this object have keyboard focus? An object with keyboard focus gets first refusal on what is typed in a viewport; what it does not use carries on to the command line as usual.
ObjectSnapCursorsEnabled
ObjectSnapPermitted
OnObjectCursorsEnabled
Tooltip
Text shown in a tooltip when the mouse rests over this object. Null or an empty string means no tooltip, which is what an object starts with. One tooltip is on screen at a time; whichever object the mouse is over owns it.
Visible
Is the user interface object visible? Objects that are not visible will not be drawn and will not receive mouse events
Methods
Are the arrows visible for a given viewport. Projections that cause the arrows to be end on are projections where arrows are not drawn.
Parameters:
| viewport (RhinoViewport) |
Returns: True if the arrow are visible for a given viewport.
ClearSnapPoints
public void ClearSnapPoints()
Parameters:
| arc (Arc) |
Parameters:
| circle (Circle) |
Parameters:
| curve (Curve) |
Parameters:
| line (Line) |
IsMouseOver
Called to test if the mouse is actively over this object
Parameters:
| mouse (MouseState) |
Returns: Return true if the mouse is over this object
Parameters:
| newLocation (Point3d) | |
| mouse (MouseState) |
OnDraw
All user interface objects are drawn and can customize their look with the OnDraw function
Parameters:
| args (DrawEventArgs) |
OnMouseClick
Called during a mouse click event on this object
Parameters:
| mouse (MouseState) |
OnMouseDoubleClick
Called during a mouse double click event on this object
Parameters:
| mouse (MouseState) |
OnMouseDown
Called when the mouse goes down on this object
Parameters:
| mouse (MouseState) | Current mouse state when this event occurs |
OnMouseEnter
Called when the mouse goes over this object
Parameters:
| mouse (MouseState) |
OnMouseLeave
Called when the mouse leaves this object
Parameters:
| mouse (MouseState) |
Parameters:
| mouse (MouseState) |
OnMouseUp
Called when the mouse is released on this object
Parameters:
| mouse (MouseState) |
OnRunCommand
Called after the above RunCommand function is called. This will be executing while inside of a Rhino command.
Parameters:
| doc (RhinoDoc) | Document that the command is running in |
| mode (RunMode) | Interactive or scripted mode |
| mouse (MouseState) | Mouse state that was passed to RunCommand |
Returns: Result of the command. The default implementation returns Success
RegisterForAllDocuments
Make this object visible for all documents. Typically you will only have user interface objects work with single documents. For that case, call doc.ViewUserInterface.Add
RunCommand
Call RunCommand to have the virtual OnRunCommand function executed in the scope of a Rhino command. If you are modifying the document from one of the mouse functions on this object, this is the best approach to do so since changes made inside of a command are recorded for undo.
Parameters:
| mouse (MouseState) | Current mouse state. This is handed back to OnRunCommand |
SetSnapPoints
Parameters:
| points (IEnumerable<Point3d>) |
Unregister
public void Unregister()
Unregister this object