VectorPrimitive Class

Renders a vector in the 3D scene. A vector is defined by a source (given by an ISystem) and a direction (given by an IVector or IPoint). Length is auto-calculated or can be set separately.

Inheritance Hierarchy

SystemObject
AGI.Foundation.GraphicsPrimitive
AGI.Foundation.GraphicsVectorPrimitive

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

Syntax

C++

Copy

public sealed class VectorPrimitive : Primitive

Public NotInheritable Class VectorPrimitive
	Inherits Primitive

public ref class VectorPrimitive sealed : public Primitive

[<SealedAttribute>]
type VectorPrimitive =  
    class
        inherit Primitive
    end

The VectorPrimitive type exposes the following members.

Constructors

	Name	Description
	VectorPrimitive	Initializes a vector primitive with the specified ISystem sys as its source and pointing in direction dir.

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. (Overrides PrimitiveBoundingSphere.)
	Color	Gets or sets the primitive's color. (Overrides PrimitiveColor.)
	Display	Gets or sets if the primitive should be rendered. Both this and DisplayCondition must evaluate to true for the primitive to be rendered. (Overrides PrimitiveDisplay.)
	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. (Overrides PrimitiveDisplayCondition.)
	DisplayLabel	Gets or Sets whether the vector's label is displayed.
	DisplayLines	Gets or Sets whether persistence lines are displayed.
	DisplayMagnitude	Gets or Sets whether the vector's magnitude is displayed. Formatter controls unit conversions.
	DisplayRADec	Gets or Sets whether the vector's RA-Dec is displayed. Formatter controls unit conversions.
	DisplaySweep	Gets or Sets whether the persistence sweep (triangles) is displayed.
	DisplayTrace	Gets or Sets whether the persistence trace (points) is displayed.
	FadePersistence	Gets or Sets whether the persistence path should fade over time.
	Label	Gets or Sets the a user-defined label.
	Length	Gets or Sets the vector's source-to-arrow-tip length.
	Lighting	Gets or Sets whether the primitive is lit.
	PersistenceDuration	Gets or Sets the maximum length (in seconds) of the persistence path.
	PersistenceWidth	Gets or Sets persistence point/line width.
	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	Gets or sets the primitive's translucency. Translucency is between 0 and 1, where 0 is opaque and 1 is transparent. (Overrides PrimitiveTranslucency.)
	TrueScale	Gets or Sets whether vector's "true scale" length (based on how the primitive was created) should be used.
	Width	Gets or Sets the vector's width in pixels. As the camera distances changes from this primitive, the geometry will autoscale to maintain this thickness.

Top

Methods

	Name	Description
	Dispose	(Inherited from Primitive.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Reference

AGI.Foundation.Graphics Namespace