GripUserInterfaceObject

UserInterfaceObjectBaseReferences
A point style user interface widget that can be dragged in world space

Constructors

GripUserInterfaceObject

#
protected GripUserInterfaceObject()

GripUserInterfaceObject

#Since v9.0
public GripUserInterfaceObject(Point3d location)
location (Point3d)

Properties

BoundToActiveView

public bool BoundToActiveView { get; set; }
inherited fromUserInterfaceObjectBase

GripColor

#Since v9.0
public Color GripColor { get; set; }

GripFillColor

#Since v9.0
public Color GripFillColor { get; set; }

GripLocation

#Since v9.0
public Point3d GripLocation { get; set; }

GripRadius

#Since v9.0
public float GripRadius { get; set; }

GripShape

#Since v9.0
public GripUserInterfaceObjectShape GripShape { get; set; }

GripShapeRotationRadians

#Since v9.0
public float GripShapeRotationRadians { get; set; }

GripStrokeWidth

#Since v9.0
public float GripStrokeWidth { get; set; }

HasKeyboardFocus

public bool HasKeyboardFocus { get; }
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.
inherited fromUserInterfaceObjectBase

ObjectSnapCursorsEnabled

#Since v9.0
public bool ObjectSnapCursorsEnabled { get; set; }

ObjectSnapPermitted

#Since v9.0
public bool ObjectSnapPermitted { get; set; }

OnObjectCursorsEnabled

#Since v9.0
public bool OnObjectCursorsEnabled { get; set; }

Tooltip

public string Tooltip { get; set; }
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.
inherited fromUserInterfaceObjectBase

Visible

public bool Visible { get; set; }
Is the user interface object visible? Objects that are not visible will not be drawn and will not receive mouse events
inherited fromUserInterfaceObjectBase

Methods

ClearSnapPoints

#Since v9.0
public void ClearSnapPoints()

Constrain

#Since v9.0
public void Constrain(Arc arc)
arc (Arc)

Constrain

#Since v9.0
public void Constrain(Circle circle)
circle (Circle)

Constrain

#Since v9.0
public void Constrain(Curve curve)
curve (Curve)

Constrain

#Since v9.0
public void Constrain(Line line)
line (Line)

IsMouseOver

protected virtual bool IsMouseOver(MouseState mouse)
Called to test if the mouse is actively over this object
inherited fromUserInterfaceObjectBase
mouse (MouseState)
Return true if the mouse is over this object

IsRegistered

public bool IsRegistered()
Is this user interface object active
inherited fromUserInterfaceObjectBase

OnDrag

#
protected virtual void OnDrag(Point3d newLocation, MouseState mouse)
newLocation (Point3d)
mouse (MouseState)

OnDraw

protected virtual void OnDraw(DrawEventArgs args)
All user interface objects are drawn and can customize their look with the OnDraw function
inherited fromUserInterfaceObjectBase
args (DrawEventArgs)

OnMouseClick

protected virtual void OnMouseClick(MouseState mouse)
Called during a mouse click event on this object
inherited fromUserInterfaceObjectBase
mouse (MouseState)

OnMouseDoubleClick

protected virtual void OnMouseDoubleClick(MouseState mouse)
Called during a mouse double click event on this object
inherited fromUserInterfaceObjectBase
mouse (MouseState)

OnMouseDown

protected virtual void OnMouseDown(MouseState mouse)
Called when the mouse goes down on this object
inherited fromUserInterfaceObjectBase
mouse (MouseState)Current mouse state when this event occurs

OnMouseEnter

protected virtual void OnMouseEnter(MouseState mouse)
Called when the mouse goes over this object
inherited fromUserInterfaceObjectBase
mouse (MouseState)

OnMouseLeave

protected virtual void OnMouseLeave(MouseState mouse)
Called when the mouse leaves this object
inherited fromUserInterfaceObjectBase
mouse (MouseState)

OnMouseMove

protected virtual void OnMouseMove(MouseState mouse)
Called when the mouse is moved
inherited fromUserInterfaceObjectBase
mouse (MouseState)

OnMouseUp

protected virtual void OnMouseUp(MouseState mouse)
Called when the mouse is released on this object
inherited fromUserInterfaceObjectBase
mouse (MouseState)

OnRunCommand

protected virtual Result OnRunCommand(RhinoDoc doc, RunMode mode, MouseState mouse)
Called after the above RunCommand function is called. This will be executing while inside of a Rhino command.
inherited fromUserInterfaceObjectBase
doc (RhinoDoc)Document that the command is running in
mode (RunMode)Interactive or scripted mode
mouse (MouseState)Mouse state that was passed to RunCommand
Result of the command. The default implementation returns Success

RegisterForAllDocuments

public bool 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
inherited fromUserInterfaceObjectBase

RunCommand

public void RunCommand(MouseState mouse)
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.
inherited fromUserInterfaceObjectBase
mouse (MouseState)Current mouse state. This is handed back to OnRunCommand

SetSnapPoints

#Since v9.0
public void SetSnapPoints(IEnumerable<Point3d> points)
points (IEnumerable<Point3d>)

Unregister

public void Unregister()
Unregister this object
inherited fromUserInterfaceObjectBase