DisplayConduit
Inheritance Hierarchy
System.Object
Rhino.Display.DisplayConduit
Namespace: Rhino.Display
Assembly: RhinoCommon (in RhinoCommon.dll)
Syntax
public abstract class DisplayConduitThe DisplayConduit type exposes the following members.
Constructors
Name
Description
Protected Method
DisplayConduit
Initializes a new instance of the DisplayConduit class
Properties
Name
Description
Public Property
Enabled
Public Property
GeometryFilter
The geometry filter will ensure that your conduit’s per-object functions will only be called for objects that are of certain geometry type
Public Property
SpaceFilter
If you want this conduit to only work in a specific space (model or page), then set this filter to that specific space. The default is None meaning no filter is applied
Methods
Name
Description
Protected Method
Code Example
CalculateBoundingBox
Library developers should override this function to increase the bounding box of scene so it includes the geometry that you plan to draw in the “Draw” virtual functions.
The default implementation does nothing.
Protected Method
CalculateBoundingBoxZoomExtents
If you want to participate in the Zoom Extents command with your display conduit, then you will need to override ZoomExtentsBoundingBox. Typically you could just call your CalculateBoundingBox override, but you may also want to spend a little more time here and compute a tighter bounding box for your conduit geometry if that is needed.
The default implementation does nothing.
Protected Method
DrawForeground
Called after all non-highlighted objects have been drawn and PostDrawObjects has been called. Depth writing and testing are turned OFF. If you want to draw with depth writing/testing, see PostDrawObjects.
The default implementation does nothing.
Protected Method
DrawOverlay
If Rhino is in a feedback mode, the draw overlay call allows for temporary geometry to be drawn on top of everything in the scene. This is similar to the dynamic draw routine that occurs with custom get point.
The default implementation does nothing.
Public Method
Equals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected Method
Finalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public Method
GetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public Method
GetSelectionFilter
The selection filter will make per-object conduit functions only be called for selected objects (when the filter is turned on)
Public Method
GetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected Method
MemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected Method
ObjectCulling
The default implementation does nothing.
Protected Method
OnEnable
Called when the enabled state changes for this class instance
Protected Method
PostDrawObjects
Called after all non-highlighted objects have been drawn. Depth writing and testing are still turned on. If you want to draw without depth writing/testing, see DrawForeground.
The default implementation does nothing.
Protected Method
PreDrawObject
Called before every object in the scene is drawn.
Protected Method
Code Example
PreDrawObjects
Called before objects are been drawn. Depth writing and testing are on.
The default implementation does nothing.
Public Method
SetObjectIdFilter(Guid)
Set an object Id that this conduit’s per-object functions will only be called for
Public Method
SetObjectIdFilter(IEnumerable.Guid.)
Set object Ids that this conduit’s per-object functions will only be called for
Public Method
SetSelectionFilter
The selection filter will make per-object conduit functions only be called for selected objects (when the filter is turned on)
Public Method
ToString
Returns a string that represents the current object.
(Inherited from Object.)