RhinoCommon documentation has a new look. The old site can still be found here.

/

/

DisplayConduit

DisplayConduit class

Derived Classes:

Namespace: Rhino.Display
DisplayConduit: references

Constructors (1)

DisplayConduit()

Properties (3)

Enabled

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

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 (13)

CalculateBoundingBox(CalculateBoundingBoxEventArgs e)

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.

CalculateBoundingBoxZoomExtents(CalculateBoundingBoxEventArgs e)

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.

DrawForeground(DrawEventArgs e)

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.

DrawOverlay(DrawEventArgs e)

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.

GetSelectionFilter(out bool on, out bool checkSubObjects)

The selection filter will make per-object conduit functions only be called for selected objects (when the filter is turned on)

ObjectCulling(CullObjectEventArgs e)

The default implementation does nothing.

OnEnable(bool enable)

Called when the enabled state changes for this class instance

PostDrawObjects(DrawEventArgs e)

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.

PreDrawObject(DrawObjectEventArgs e)

Called before every object in the scene is drawn.

PreDrawObjects(DrawEventArgs e)

Called before objects are been drawn. Depth writing and testing are on.
The default implementation does nothing.

SetObjectIdFilter(IEnumerable<Guid> ids)

Set object Ids that this conduit's per-object functions will only be called for

SetObjectIdFilter(Guid id)

Set an object Id that this conduit's per-object functions will only be called for

SetSelectionFilter(bool on, bool checkSubObjects)

The selection filter will make per-object conduit functions only be called for selected objects (when the filter is turned on)

Nothing found