Click or drag to resize

PathPrimitive Class

Renders a line to the 3D scene. Similar to the PolylinePrimitive; however, the PathPrimitive was designed for the efficient addition/removal of points to/from the front or back of the line.
Inheritance Hierarchy

Namespace:  AGI.Foundation.Graphics
Assembly:  AGI.Foundation.Graphics (in AGI.Foundation.Graphics.dll) Version: 19.2.399.0 (19.2.399.0)
Syntax
public sealed class PathPrimitive : Primitive, 
	IEnumerable<PathPoint>

The PathPrimitive type exposes the following members.

Constructors
  NameDescription
Public methodPathPrimitive
Initializes a default path primitive. This is equivalent to constructing a path primitive with an initial capacity of 16.
Public methodPathPrimitive(Int32)
Initializes a path primitive with the specified capacity.
Top
Properties
  NameDescription
Public propertyAutomaticallyComputeBoundingSphere
Gets or sets if the primitive's BoundingSphere is automatically computed.
(Inherited from Primitive.)
Public propertyBoundingSphere
Gets or sets the bounding sphere that encompasses the primitive. The center is defined in the primitive's ReferenceFrame.
(Inherited from Primitive.)
Public propertyCapacity
Returns the capacity that was set during object construction. The capacity is the amount of memory reserved for storing the points on the path. This will be automatically updated when adding/removing points.
Public propertyCentralBodyClipped
Gets or sets whether the polyline will be clipped by the central body.
Public propertyColor
The path primitive does not support the Color property. Instead, use the Color property on PathPoint.
(Overrides PrimitiveColor.)
Public propertyCount
Returns the number of points.
Public propertyDisplay
Gets or sets if the primitive should be rendered. Both this and DisplayCondition must evaluate to true for the primitive to be rendered.
(Inherited from Primitive.)
Public propertyDisplayCondition
Gets or sets the display condition that determines if the primitive should be rendered. Both this and Display must evaluate to true for the primitive to be rendered.
(Inherited from Primitive.)
Public propertyDisplayOutline
Gets or sets whether an outline is rendered around the line.
Public propertyItem
Returns the point at the given zero-based index.
Public propertyStatic memberMaximumWidthSupported
Gets the maximum width, in pixels, supported by the video card.
Public propertyStatic memberMinimumWidthSupported
Gets the minimum width, in pixels, supported by the video card.
Public propertyOutlineWidth
Gets or sets the width, in pixels, of the outline around the line.
Public propertyPerItemPickingEnabled
Gets or sets whether individual line indices will be included in the PickResults returned from the Scene's Pick method. Each line index that is picked will be returned as a BatchPrimitiveIndex.
Public propertyPolylineType
Gets or sets how the primitive interprets the positions.
Public propertyReferenceFrame
Gets or sets the reference frame this primitive is defined and rendered in.
(Inherited from Primitive.)
Public propertyTag
Gets or sets custom data associated with this primitive.
(Inherited from Primitive.)
Public propertyTranslucency
The path primitive does not support the Translucency property. Instead, use the Translucency property on PathPoint.
(Overrides PrimitiveTranslucency.)
Public propertyUpdatePolicy
Gets or sets how the primitive will be updated based on the current animation time.
Public propertyWidth
Gets or sets the line width, in pixels.
Top
Methods
  NameDescription
Public methodAddBack
Add a PathPoint to the back of the line.
Public methodAddFront
Add a PathPoint to the front of the line.
Public methodAddRangeToBack
Add the range of PathPoints to the back of the line.
Public methodAddRangeToFront
Add the range of PathPoints to the front of the line.
Public methodBack
Access the PathPoint at the back of the line.
Public methodClear
Removes all of the points.
Public methodDispose (Inherited from Primitive.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodFront
Access the PathPoint at the front of the line.
Public methodGetEnumerator
Returns an enumerator that iterates through the collection.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodRemoveAllAfter
Remove all points after index.
Public methodRemoveAllBefore
Remove all points before index.
Public methodRemoveBack
Remove a PathPoint to the back of the line.
Public methodRemoveFront
Remove a PathPoint to the front of the line.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also