IVectorGeometryToolAxes

class ansys.stk.core.analysis_workbench.IVectorGeometryToolAxes

The interface defines methods and properties common to all axes.

Overview

Methods

find_in_axes	Find an orientation in the specified axes.
find_in_axes_with_rate	Find an angular velocity and orientation in the specified axes.
transform	Transform the input vector from this axes into the output axes.
transform_with_rate	Transform the input vector and vector’s rate from this axes into the output axes.

Properties

labels	Return an object that allows modifying the axes labels.
type	Return a type of the axes object.
x_axis	Return the X axis of the component.
y_axis	Return the Y axis of the component.
z_axis	Return the Z axis of the component.

Import detail

from ansys.stk.core.analysis_workbench import IVectorGeometryToolAxes

Property detail

property IVectorGeometryToolAxes.labels: VectorGeometryToolAxesLabels

Return an object that allows modifying the axes labels.

property IVectorGeometryToolAxes.type: AxesType

Return a type of the axes object.

property IVectorGeometryToolAxes.x_axis: IVectorGeometryToolVector

Return the X axis of the component.

property IVectorGeometryToolAxes.y_axis: IVectorGeometryToolVector

Return the Y axis of the component.

property IVectorGeometryToolAxes.z_axis: IVectorGeometryToolVector

Return the Z axis of the component.

Method detail

IVectorGeometryToolAxes.find_in_axes(self, epoch: Any, axes: IVectorGeometryToolAxes) → AnalysisWorkbenchAxesFindInAxesResult

Find an orientation in the specified axes.

Parameters:

epoch : Any

axes : IVectorGeometryToolAxes

Returns:

AnalysisWorkbenchAxesFindInAxesResult

IVectorGeometryToolAxes.find_in_axes_with_rate(self, epoch: Any, axes: IVectorGeometryToolAxes) → AnalysisWorkbenchAxesFindInAxesWithRateResult

Find an angular velocity and orientation in the specified axes.

Parameters:

epoch : Any

axes : IVectorGeometryToolAxes

Returns:

AnalysisWorkbenchAxesFindInAxesWithRateResult

IVectorGeometryToolAxes.transform(self, epoch: Any, output_axes: IVectorGeometryToolAxes, vector_in_my_axes: ICartesian3Vector) → AnalysisWorkbenchAxesTransformResult

Transform the input vector from this axes into the output axes.

Parameters:

epoch : Any

output_axes : IVectorGeometryToolAxes

vector_in_my_axes : ICartesian3Vector

Returns:

AnalysisWorkbenchAxesTransformResult

IVectorGeometryToolAxes.transform_with_rate(self, epoch: Any, output_axes: IVectorGeometryToolAxes, vector_in_my_axes: ICartesian3Vector, rate_in_my_axes: ICartesian3Vector) → AnalysisWorkbenchAxesTransformWithRateResult

Transform the input vector and vector’s rate from this axes into the output axes.

Parameters:

epoch : Any

output_axes : IVectorGeometryToolAxes

vector_in_my_axes : ICartesian3Vector

rate_in_my_axes : ICartesian3Vector

Returns:

AnalysisWorkbenchAxesTransformWithRateResult