CustomDisplay

public class CustomDisplay : IDisposable
Provides some basic (indeed, very basic) mechanisms for drawing custom geometry in viewports.

Constructors

CustomDisplay

#Since v5.0
public CustomDisplay(bool enable)
Constructs a new CustomDisplay instance. You must call Dispose() when you are done with this instance, otherwise the display methods will never be switched off.
Parameters:
enable (bool)If true, the display will be enabled immediately.

Properties

ClippingBox

#Since v5.0
public BoundingBox ClippingBox { get; }
Gets the clipping box of this CustomDisplay.

Enabled

#Since v5.0
public bool Enabled { get; set; }
Gets or sets the Enabled state of this CustomDisplay instance. If you wish to terminate this CustomDisplay, place a call to Dispose() instead.

IsDisposed

#Since v5.0
public bool IsDisposed { get; }
Gets a value indicating whether this CustomDisplay instance has been disposed. Once a CustomDisplay has been disposed, you can no longer use it.

Methods

AddArc

#Since v5.0
public void AddArc(Arc arc, Color color, int thickness)
Adds a new, colored arc to the display list.
Parameters:
arc (Arc)Arc to add.
color (Color)Color of arc.
thickness (int)Thickness of arc.

AddArc

#Since v5.0
public void AddArc(Arc arc, Color color)
Adds a new, colored arc to the display list.
Parameters:
arc (Arc)Arc to add.
color (Color)Color of arc.

AddArc

#Since v5.0
public void AddArc(Arc arc)
Adds a new, black arc to the display list.
Parameters:
arc (Arc)Arc to add.

AddCircle

#Since v5.0
public void AddCircle(Circle circle, Color color, int thickness)
Adds a new, colored circle to the display list.
Parameters:
circle (Circle)Circle to add.
color (Color)Color of circle.
thickness (int)Thickness of circle.

AddCircle

#Since v5.0
public void AddCircle(Circle circle, Color color)
Adds a new, colored arc to the display list.
Parameters:
circle (Circle)Circle to add.
color (Color)Color of circle.

AddCircle

#Since v5.0
public void AddCircle(Circle circle)
Adds a new, black circle to the display list.
Parameters:
circle (Circle)Circle to add.

AddCurve

#Since v5.0
public void AddCurve(Curve curve, Color color, int thickness)
Adds a new, colored curve to the display list. The curve will be duplicated so changes to the original will not affect the display.
Parameters:
curve (Curve)Curve to add.
color (Color)Color of curve.
thickness (int)Thickness of curve.

AddCurve

#Since v5.0
public void AddCurve(Curve curve, Color color)
Adds a new, colored curve to the display list. The curve will be duplicated so changes to the original will not affect the display.
Parameters:
curve (Curve)Curve to add.
color (Color)Color of curve.

AddCurve

#Since v5.0
public void AddCurve(Curve curve)
Adds a new, black curve to the display list. The curve will be duplicated so changes to the original will not affect the display.
Parameters:
curve (Curve)Curve to add.

AddLine

#Since v5.0
public void AddLine(Line line, Color color, int thickness)
Adds a new, colored line to the display list.
Parameters:
line (Line)Line to add.
color (Color)Color of line.
thickness (int)Thickness of line.

AddLine

#Since v5.0
public void AddLine(Line line, Color color)
Adds a new, colored line to the display list.
Parameters:
line (Line)Line to add.
color (Color)Color of line.

AddLine

#Since v5.0
public void AddLine(Line line)
Adds a new, black line to the display list.
Parameters:
line (Line)Line to add.

AddPoint

#Since v5.0
public void AddPoint(Point3d point, Color color, PointStyle style, int radius)
Adds a new stylized point to the display list.
Parameters:
point (Point3d)Point to add.
color (Color)Color of point.
style (PointStyle)Display style of point.
radius (int)Radius of point widget.

AddPoint

#Since v5.0
public void AddPoint(Point3d point, Color color)
Adds a new colored point to the display list.
Parameters:
point (Point3d)Point to add.
color (Color)Color of point.

AddPoint

#Since v5.0
public void AddPoint(Point3d point)
Adds a new, black point to the display list.
Parameters:
point (Point3d)Point to add.

AddPoints

#Since v5.0
public void AddPoints(IEnumerable<Point3d> points, Color color, PointStyle style, int radius)
Adds a collection of stylized points to the display list.
Parameters:
points (IEnumerable<Point3d>)Points to add.
color (Color)Color of points.
style (PointStyle)Display style of points.
radius (int)Radius of point widgets.

AddPoints

#Since v5.0
public void AddPoints(IEnumerable<Point3d> points, Color color)
Adds a collection of colored points to the display list.
Parameters:
points (IEnumerable<Point3d>)Points to add.
color (Color)Color of points.

AddPoints

#Since v5.0
public void AddPoints(IEnumerable<Point3d> points)
Adds a collection of black points to the display list.
Parameters:
points (IEnumerable<Point3d>)Points to add.

AddPolygon

#Since v5.0
public void AddPolygon(IEnumerable<Point3d> polygon, Color fillColor, Color edgeColor, bool drawFill, bool drawEdge)
Adds a polygon to the drawing list. Polygons are not like Hatches, when you supply a concave polygon, the shading probably won't work.
Parameters:
polygon (IEnumerable<Point3d>)Points that define the corners of the polygon.
fillColor (Color)Fill color of polygon.
edgeColor (Color)Edge color of polygon.
drawFill (bool)If true, the polygon contents will be drawn.
drawEdge (bool)If true, the polygon edge will be drawn.

AddText

#Since v5.0
public void AddText(string text, Plane plane, double size, Color color)
Adds a new, colored 3D text object to the display list.
Parameters:
text (string)Text to add.
plane (Plane)Plane for text orientation.
size (double)Height (in units) of font.
color (Color)Color of text.

AddText

#Since v5.0
public void AddText(string text, Plane plane, double size)
Adds a new, black 3D text object to the display list.
Parameters:
text (string)Text to add.
plane (Plane)Plane for text orientation.
size (double)Height (in units) of font.

AddText

#Since v5.0
public void AddText(Text3d text, Color color)
Adds a new 3D text object to the display list.
Parameters:
text (Text3d)Text object to add.
color (Color)Color of text object.

AddVector

#Since v5.0
public void AddVector(Point3d anchor, Vector3d span, Color color, bool drawAnchor)
Adds a new, colored vector to the display list.
Parameters:
anchor (Point3d)Anchor point of vector.
span (Vector3d)Direction and magnitude of vector.
color (Color)Color of vector.
drawAnchor (bool)Include a point at the vector anchor.

AddVector

#Since v5.0
public void AddVector(Point3d anchor, Vector3d span, Color color)
Adds a new, colored vector to the display list.
Parameters:
anchor (Point3d)Anchor point of vector.
span (Vector3d)Direction and magnitude of vector.
color (Color)Color of vector.

AddVector

#Since v5.0
public void AddVector(Point3d anchor, Vector3d span)
Adds a new, black vector to the display list.
Parameters:
anchor (Point3d)Anchor point of vector.
span (Vector3d)Direction and magnitude of vector.

Clear

#Since v5.0
public void Clear()
Clear the drawing lists.

Dispose

#Since v5.0
public void Dispose()
Dispose this CustomDisplay instance. You must call this function in order to properly shut down the CustomDisplay.