Constructors

UserInterfaceObjectBase

#
protected UserInterfaceObjectBase()

Properties

BoundToActiveView

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

HasKeyboardFocus

#Since v9.0
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.
public bool HasKeyboardFocus { get; }

Tooltip

#Since v9.0
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.
public string Tooltip { get; set; }

Visible

#Since v9.0
Is the user interface object visible? Objects that are not visible will not be drawn and will not receive mouse events
public bool Visible { get; set; }

Methods

ClearKeyboardFocus

#Since v9.0
Take keyboard focus away from whichever user interface object has it, so that typing goes to the command line again.
public static void ClearKeyboardFocus(
doc
Document to redraw. This can be null.
)

IsMouseOver

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

IsRegistered

#Since v9.0
Is this user interface object active
public bool IsRegistered()

OnDraw

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

OnMouseClick

#
Called during a mouse click event on this object
protected virtual void OnMouseClick()

OnMouseDoubleClick

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

OnMouseDown

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

OnMouseEnter

#
Called when the mouse goes over this object
protected virtual void OnMouseEnter()

OnMouseLeave

#
Called when the mouse leaves this object
protected virtual void OnMouseLeave()

OnMouseMove

#
Called when the mouse is moved
protected virtual void OnMouseMove()

OnMouseUp

#
Called when the mouse is released on this object
protected virtual void OnMouseUp()

OnRunCommand

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

RegisterForAllDocuments

#Since v9.0
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
public bool RegisterForAllDocuments()

RunCommand

#Since v9.0
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.
public void RunCommand(
mouse
Current mouse state. This is handed back to OnRunCommand
)

Unregister

#Since v9.0
Unregister this object
public void Unregister()