VectorGeometryToolAxesCommonTasks

class ansys.stk.core.analysis_workbench.VectorGeometryToolAxesCommonTasks

Provide methods to create non-persistent VGT axes components. Non-persistent components do not have names, do not get saved/loaded and are not shown in the VGT browser.

Overview

Methods

create_fixed	Create non-persistent fixed axes based on specified axes.
create_topocentric_axes_euler_angles	Create non-persistent axes fixed in axes on the surface of a central body with the location specified by the origin point. The euler angles define the axes’s orientation.
create_topocentric_axes_quaternion	Create non-persistent axes fixed in axes on the surface of a central body with the location specified by the origin point. The quaternion defines the axes’s orientation.
sample	Compute and returns tabulated orientations and angular velocities of axes with respect to reference axes using specified sampling parameters.

Import detail

from ansys.stk.core.analysis_workbench import VectorGeometryToolAxesCommonTasks

Method detail

VectorGeometryToolAxesCommonTasks.create_fixed(self, reference_axes: IVectorGeometryToolAxes) → VectorGeometryToolAxesFixed

Create non-persistent fixed axes based on specified axes.

Parameters:

reference_axes : IVectorGeometryToolAxes

Returns:

VectorGeometryToolAxesFixed

VectorGeometryToolAxesCommonTasks.create_topocentric_axes_euler_angles(self, origin_point: IVectorGeometryToolPoint, sequence: EulerOrientationSequenceType, a: Any, b: Any, c: Any) → VectorGeometryToolAxesFixed

Create non-persistent axes fixed in axes on the surface of a central body with the location specified by the origin point. The euler angles define the axes’s orientation.

Parameters:

origin_point : IVectorGeometryToolPoint

sequence : EulerOrientationSequenceType

a : Any

b : Any

c : Any

Returns:

VectorGeometryToolAxesFixed

VectorGeometryToolAxesCommonTasks.create_topocentric_axes_quaternion(self, origin_point: IVectorGeometryToolPoint, qx: float, qy: float, qz: float, qs: float) → VectorGeometryToolAxesFixed

Create non-persistent axes fixed in axes on the surface of a central body with the location specified by the origin point. The quaternion defines the axes’s orientation.

Parameters:

origin_point : IVectorGeometryToolPoint

qx : float

qy : float

qz : float

qs : float

Returns:

VectorGeometryToolAxesFixed

VectorGeometryToolAxesCommonTasks.sample(self, axes: IVectorGeometryToolAxes, reference_axes: IVectorGeometryToolAxes, intervals: list, min_step: float, max_step: float, target_rate: Any) → TimeToolAxesSamplingResult

Compute and returns tabulated orientations and angular velocities of axes with respect to reference axes using specified sampling parameters.

Parameters:

axes : IVectorGeometryToolAxes

reference_axes : IVectorGeometryToolAxes

intervals : list

min_step : float

max_step : float

target_rate : Any

Returns:

TimeToolAxesSamplingResult