CustomDisplay

Public Class

Provides some basic (indeed, very basic) mechanisms for drawing custom geometry in viewports.

Inheritance Hierarchy

System.Object
Rhino.Display.CustomDisplay

Namespace: Rhino.Display

Assembly: RhinoCommon (in RhinoCommon.dll)

Syntax

public class CustomDisplay : IDisposable

The CustomDisplay type exposes the following members.

Constructors

Name

Description

---

Public Method

CustomDisplay

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.

---

Properties

Name

Description

---

Public Property

ClippingBox

Gets the clipping box of this CustomDisplay.

---

Public Property

Enabled

Gets or sets the Enabled state of this CustomDisplay instance. If you wish to terminate this CustomDisplay, place a call to Dispose() instead.

---

Public Property

IsDisposed

Gets a value indicating whether this CustomDisplay instance has been disposed. Once a CustomDisplay has been disposed, you can no longer use it.

---

Methods

Name

Description

---

Public Method

AddArc(Arc)

Adds a new, black arc to the display list.

---

Public Method

AddArc(Arc, Color)

Adds a new, colored arc to the display list.

---

Public Method

AddArc(Arc, Color, Int32)

Adds a new, colored arc to the display list.

---

Public Method

AddCircle(Circle)

Adds a new, black circle to the display list.

---

Public Method

AddCircle(Circle, Color)

Adds a new, colored arc to the display list.

---

Public Method

AddCircle(Circle, Color, Int32)

Adds a new, colored circle to the display list.

---

Public Method

AddCurve(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.

---

Public Method

AddCurve(Curve, 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.

---

Public Method

AddCurve(Curve, Color, Int32)

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 Method

AddLine(Line)

Adds a new, black line to the display list.

---

Public Method

AddLine(Line, Color)

Adds a new, colored line to the display list.

---

Public Method

AddLine(Line, Color, Int32)

Adds a new, colored line to the display list.

---

Public Method

AddPoint(Point3d)

Adds a new, black point to the display list.

---

Public Method

AddPoint(Point3d, Color)

Adds a new colored point to the display list.

---

Public Method

AddPoint(Point3d, Color, PointStyle, Int32)

Adds a new stylized point to the display list.

---

Public Method

AddPoints(IEnumerable.Point3d.)

Adds a collection of black points to the display list.

---

Public Method

AddPoints(IEnumerable.Point3d., Color)

Adds a collection of colored points to the display list.

---

Public Method

AddPoints(IEnumerable.Point3d., Color, PointStyle, Int32)

Adds a collection of stylized points to the display list.

---

Public Method

AddPolygon

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 Method

AddText(Text3d, Color)

Adds a new 3D text object to the display list.

---

Public Method

AddText(String, Plane, Double)

Adds a new, black 3D text object to the display list.

---

Public Method

AddText(String, Plane, Double, Color)

Adds a new, colored 3D text object to the display list.

---

Public Method

AddVector(Point3d, Vector3d)

Adds a new, black vector to the display list.

---

Public Method

AddVector(Point3d, Vector3d, Color)

Adds a new, colored vector to the display list.

---

Public Method

AddVector(Point3d, Vector3d, Color, Boolean)

Adds a new, colored vector to the display list.

---

Public Method

Clear

Clear the drawing lists.

---

Public Method

Dispose

Dispose this CustomDisplay instance. You must call this function in order to properly shut down the CustomDisplay.

---

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

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.)

---

Public Method

ToString

Returns a string that represents the current object.

(Inherited from Object.)

---