VectorPrimitive#

class ansys.stk.core.graphics.VectorPrimitive#

Bases: IPrimitive

Render a vector in the 3D scene. A vector is defined by a source (given by a reference frame) and a direction (given by a vector). Length is auto-calculated or can be set separately.

Overview#

Properties

`lighting`	Get or set whether the primitive is lit.
`label`	Get or set the user-defined label.
`display_label`	Get or set whether the vector’s label is displayed.
`display_magnitude`	Get or set whether the vector’s magnitude is displayed.
`display_ra_dec`	Get or set whether the vector’s RA-Dec is displayed.
`display_trace`	Get or set whether the persistence trace (points) is displayed.
`display_sweep`	Get or set whether the persistence sweep (triangles) is displayed.
`display_lines`	Get or set whether persistence lines are displayed.
`persistence_width`	Get or set persistence point/line width.
`fade_persistence`	Get or set whether the persistence path should fade over time.
`persistence_duration`	Get or set the maximum duration of the persistence path.
`length`	Get or set the vector’s source-to-arrow-tip length.
`width`	Get or set the vector’s width in pixels. As the camera distances changes from this primitive, the geometry will autoscale to maintain this thickness.
`true_scale`	Get or set whether vector’s ‘true scale’ length (based on how the primitive was created) should be used.

Import detail#

from ansys.stk.core.graphics import VectorPrimitive

Property detail#

property VectorPrimitive.lighting: bool#: Get or set whether the primitive is lit.

property VectorPrimitive.label: str#: Get or set the user-defined label.

property VectorPrimitive.display_label: bool#: Get or set whether the vector’s label is displayed.

property VectorPrimitive.display_magnitude: bool#: Get or set whether the vector’s magnitude is displayed.

property VectorPrimitive.display_ra_dec: bool#: Get or set whether the vector’s RA-Dec is displayed.

property VectorPrimitive.display_trace: bool#: Get or set whether the persistence trace (points) is displayed.

property VectorPrimitive.display_sweep: bool#: Get or set whether the persistence sweep (triangles) is displayed.

property VectorPrimitive.display_lines: bool#: Get or set whether persistence lines are displayed.

property VectorPrimitive.persistence_width: float#: Get or set persistence point/line width.

property VectorPrimitive.fade_persistence: bool#: Get or set whether the persistence path should fade over time.

property VectorPrimitive.persistence_duration: float#: Get or set the maximum duration of the persistence path.

property VectorPrimitive.length: float#: Get or set the vector’s source-to-arrow-tip length.

property VectorPrimitive.width: float#: Get or set the vector’s width in pixels. As the camera distances changes from this primitive, the geometry will autoscale to maintain this thickness.

property VectorPrimitive.true_scale: bool#: Get or set whether vector’s ‘true scale’ length (based on how the primitive was created) should be used.