Graphics3DReferenceVector#

class ansys.stk.core.stkobjects.Graphics3DReferenceVector#

Bases: IGraphics3DReferenceAnalysisWorkbenchComponent, IDisplayTime

Class defining a reference vector (3D Graphics, Vector Geometry Tool).

Overview#

Properties

`available_axes`	Return a safearray of available axes.
`available_points`	Return a safearray of available points.
`axes`	The name of the axes or system used to define the coordinate frame associated with the selected vector or axis.
`connect`	Specify the method used for connecting geometric elements.
`draw_at_central_body`	Only available for geometric elements relating to objects. If selected, the geometric element is drawn at the central body or object.
`draw_at_point`	If selected, the geometric element is drawn at the selected point.
`duration`	The length of time during which the geometric element is visible. Uses Time Dimension.
`magnitude_dimension`	The Magnitude Dimension.
`magnitude_units_abbreviation`	Magnitude’s current unit.
`point`	Displays a point at the current animation time.
`right_ascension_declination_units_abbreviation`	Right Ascension Declination Unit Abrv.
`show_magnitude_value`	If selected, the magnitude value is displayed on the selected geometric element.
`show_persistence`	Successively displays geometric elements over the specified duration.
`show_right_ascension_declination_values`	Displays right-ascension and declination values with the selected vector.
`thickness`	Thickness of line.
`transparent`	If selected, earlier occurrences of a geometric element display fade over time so that it is drawn as completely filled at the most recent animation time and fades as the animation moves forward.
`true_scale`	If the Scale Relative to Model is selected, the scale of the model is multiplied by the scale of the vector. If the Scale Relative to Model is not selected, you can set the size of the geometric elements independent of the model scale.

Import detail#

from ansys.stk.core.stkobjects import Graphics3DReferenceVector

Property detail#

property Graphics3DReferenceVector.available_axes: list#: Return a safearray of available axes.

property Graphics3DReferenceVector.available_points: list#: Return a safearray of available points.

property Graphics3DReferenceVector.axes: str#: The name of the axes or system used to define the coordinate frame associated with the selected vector or axis.

property Graphics3DReferenceVector.connect: VectorAxesConnectType#: Specify the method used for connecting geometric elements.

property Graphics3DReferenceVector.draw_at_central_body: bool#: Only available for geometric elements relating to objects. If selected, the geometric element is drawn at the central body or object.

property Graphics3DReferenceVector.draw_at_point: bool#: If selected, the geometric element is drawn at the selected point.

property Graphics3DReferenceVector.duration: float#: The length of time during which the geometric element is visible. Uses Time Dimension.

property Graphics3DReferenceVector.magnitude_dimension: str#: The Magnitude Dimension.

property Graphics3DReferenceVector.magnitude_units_abbreviation: str#: Magnitude’s current unit.

property Graphics3DReferenceVector.point: str#: Displays a point at the current animation time.

property Graphics3DReferenceVector.right_ascension_declination_units_abbreviation: str#: Right Ascension Declination Unit Abrv.

property Graphics3DReferenceVector.show_magnitude_value: bool#: If selected, the magnitude value is displayed on the selected geometric element.

property Graphics3DReferenceVector.show_persistence: bool#: Successively displays geometric elements over the specified duration.

property Graphics3DReferenceVector.show_right_ascension_declination_values: bool#: Displays right-ascension and declination values with the selected vector.

property Graphics3DReferenceVector.thickness: float#: Thickness of line.

property Graphics3DReferenceVector.transparent: bool#: If selected, earlier occurrences of a geometric element display fade over time so that it is drawn as completely filled at the most recent animation time and fades as the animation moves forward.

property Graphics3DReferenceVector.true_scale: bool#: If the Scale Relative to Model is selected, the scale of the model is multiplied by the scale of the vector. If the Scale Relative to Model is not selected, you can set the size of the geometric elements independent of the model scale.