Click or drag to resize

DirectionGripUserInterfaceObject Class

A point plus direction arrows that represents a grip constrained to a line
Inheritance Hierarchy
SystemObject
  Rhino.UIUserInterfaceObjectBase
    Rhino.UIGripUserInterfaceObject
      Rhino.UIDirectionGripUserInterfaceObject

Namespace:  Rhino.UI
Assembly:  RhinoCommon (in RhinoCommon.dll)
Syntax
public class DirectionGripUserInterfaceObject : GripUserInterfaceObject

The DirectionGripUserInterfaceObject type exposes the following members.

Constructors
  NameDescription
Public methodDirectionGripUserInterfaceObject
Create a direction grip located at location and constrained to a direction
Top
Properties
  NameDescription
Public propertyArrowRadius
Size of direction end shape
Public propertyArrowShape
Shape used for end of direction line
Public propertyBoundToActiveView (Inherited from UserInterfaceObjectBase.)
Public propertyDirectionLineLength
Length of direction line in pixel units
Public propertyGripColor (Inherited from GripUserInterfaceObject.)
Public propertyGripDirection
Constrained direction of grip
Public propertyGripFillColor (Inherited from GripUserInterfaceObject.)
Public propertyGripLocation (Inherited from GripUserInterfaceObject.)
Public propertyGripPointVisible
Is the grip point itself drawn
Public propertyGripRadius (Inherited from GripUserInterfaceObject.)
Public propertyGripShape (Inherited from GripUserInterfaceObject.)
Public propertyGripShapeRotationRadians (Inherited from GripUserInterfaceObject.)
Public propertyGripStrokeWidth (Inherited from GripUserInterfaceObject.)
Public propertyObjectSnapCursorsEnabled (Inherited from GripUserInterfaceObject.)
Public propertyObjectSnapPermitted (Inherited from GripUserInterfaceObject.)
Public propertyOneWay
Is the grip a single direction grip
Public propertyOnObjectCursorsEnabled (Inherited from GripUserInterfaceObject.)
Public propertyVisible
Is the user interface object visible? Objects that are not visible will not be drawn and will not receive mouse events
(Inherited from UserInterfaceObjectBase.)
Top
Methods
  NameDescription
Public methodArrowsVisibleInViewport
Are the arrows visible for a given viewport. Projections that cause the arrows to be end on are projections where arrows are not drawn.
Public methodClearSnapPoints (Inherited from GripUserInterfaceObject.)
Public methodConstrain(Arc) (Inherited from GripUserInterfaceObject.)
Public methodConstrain(Circle) (Inherited from GripUserInterfaceObject.)
Public methodConstrain(Curve) (Inherited from GripUserInterfaceObject.)
Public methodConstrain(Line) (Inherited from GripUserInterfaceObject.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodIsMouseOver
Called to test if the mouse is actively over this object
(Inherited from UserInterfaceObjectBase.)
Public methodIsRegistered
Is this user interface object active
(Inherited from UserInterfaceObjectBase.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnDrag (Inherited from GripUserInterfaceObject.)
Protected methodOnDraw
All user interface objects are drawn and can customize their look with the OnDraw function
(Inherited from UserInterfaceObjectBase.)
Protected methodOnMouseClick
Called during a mouse click event on this object
(Inherited from UserInterfaceObjectBase.)
Protected methodOnMouseDoubleClick
Called during a mouse double click event on this object
(Inherited from UserInterfaceObjectBase.)
Protected methodOnMouseDown
Called when the mouse goes down on this object
(Inherited from UserInterfaceObjectBase.)
Protected methodOnMouseEnter
Called when the mouse goes over this object
(Inherited from UserInterfaceObjectBase.)
Protected methodOnMouseLeave
Called when the mouse leaves this object
(Inherited from UserInterfaceObjectBase.)
Protected methodOnMouseMove
Called when the mouse is moved
(Inherited from UserInterfaceObjectBase.)
Protected methodOnMouseUp
Called when the mouse is released on this object
(Inherited from UserInterfaceObjectBase.)
Public methodRegisterForAllDocuments
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 from UserInterfaceObjectBase.)
Public methodSetSnapPoints (Inherited from GripUserInterfaceObject.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUnregister
Unregister this object
(Inherited from UserInterfaceObjectBase.)
Top
See Also