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

SystemObject
AGI.Foundation.GraphicsPrimitive
AGI.Foundation.GraphicsPathPrimitive

Namespace: AGI.Foundation.Graphics
Assembly: AGI.Foundation.Graphics (in AGI.Foundation.Graphics.dll) Version: 24.1.418.0 (24.1.418.0)

Syntax

C++

Copy

public sealed class PathPrimitive : Primitive, 
	IEnumerable<PathPoint>

Public NotInheritable Class PathPrimitive
	Inherits Primitive
	Implements IEnumerable(Of PathPoint)

public ref class PathPrimitive sealed : public Primitive, 
	IEnumerable<PathPoint^>

[<SealedAttribute>]
type PathPrimitive =  
    class
        inherit Primitive
        interface IEnumerable<PathPoint>
    end

The PathPrimitive type exposes the following members.

Constructors

	Name	Description
	PathPrimitive	Initializes a default path primitive. This is equivalent to constructing a path primitive with an initial capacity of 16.
	PathPrimitive(Int32)	Initializes a path primitive with the specified capacity.

Top

Properties

	Name	Description
	AutomaticallyComputeBoundingSphere	Gets or sets if the primitive's BoundingSphere is automatically computed. (Inherited from Primitive.)
	BoundingSphere	Gets or sets the bounding sphere that encompasses the primitive. The center is defined in the primitive's ReferenceFrame. (Inherited from Primitive.)
	Capacity	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.
	CentralBodyClipped	Gets or sets whether the polyline will be clipped by the central body.
	Color	The path primitive does not support the Color property. Instead, use the Color property on PathPoint. (Overrides PrimitiveColor.)
	Count	Returns the number of points.
	Display	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.)
	DisplayCondition	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.)
	DisplayOutline	Gets or sets whether an outline is rendered around the line.
	Item	Returns the point at the given zero-based index.
	MaximumWidthSupported	Gets the maximum width, in pixels, supported by the video card.
	MinimumWidthSupported	Gets the minimum width, in pixels, supported by the video card.
	OutlineWidth	Gets or sets the width, in pixels, of the outline around the line.
	PerItemPickingEnabled	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.
	PolylineType	Gets or sets how the primitive interprets the positions.
	ReferenceFrame	Gets or sets the reference frame this primitive is defined and rendered in. (Inherited from Primitive.)
	Tag	Gets or sets custom data associated with this primitive. (Inherited from Primitive.)
	Translucency	The path primitive does not support the Translucency property. Instead, use the Translucency property on PathPoint. (Overrides PrimitiveTranslucency.)
	UpdatePolicy	Gets or sets how the primitive will be updated based on the current animation time.
	Width	Gets or sets the line width, in pixels.

Top

Methods

	Name	Description
	AddBack	Add a PathPoint to the back of the line.
	AddFront	Add a PathPoint to the front of the line.
	AddRangeToBack	Add the range of PathPoints to the back of the line.
	AddRangeToFront	Add the range of PathPoints to the front of the line.
	Back	Access the PathPoint at the back of the line.
	Clear	Removes all of the points.
	Dispose	(Inherited from Primitive.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Front	Access the PathPoint at the front of the line.
	GetEnumerator	Returns an enumerator that iterates through the collection.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	RemoveAllAfter	Remove all points after index.
	RemoveAllBefore	Remove all points before index.
	RemoveBack	Remove a PathPoint to the back of the line.
	RemoveFront	Remove a PathPoint to the front of the line.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Reference

AGI.Foundation.Graphics Namespace

Other Resources

Path Primitive topic