CustomDisplay

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

Constructors

CustomDisplay

#Since v5.0
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.
public CustomDisplay(
enable
If true, the display will be enabled immediately.
)

Properties

ClippingBox

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

Enabled

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

IsDisposed

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

Methods

AddArc

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

AddArc

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

AddArc

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

AddCircle

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

AddCircle

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

AddCircle

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

AddCurve

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

AddCurve

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

AddCurve

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

AddLine

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

AddLine

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

AddLine

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

AddPoint

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

AddPoint

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

AddPoint

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

AddPoints

#Since v5.0
Adds a collection of stylized points to the display list.
public void AddPoints(
points,
Points to add.
color,
Color of points.
style,
Display style of points.
radius
Radius of point widgets.
)

AddPoints

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

AddPoints

#Since v5.0
Adds a collection of black points to the display list.
public void AddPoints(
points
Points to add.
)

AddPolygon

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

AddText

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

AddText

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

AddText

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

AddVector

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

AddVector

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

AddVector

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

Clear

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

Dispose

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