IVectorGeometryToolPlane

class ansys.stk.core.analysis_workbench.IVectorGeometryToolPlane

The interface defines methods and properties common to all VGT planes.

Overview

Methods

find_in_axes	Compute the plane’s axes vectors in a specified reference axes.
find_in_axes_with_rate	Compute the plane’s axes vectors and their rates in a specified reference axes.
find_in_system	Compute the position and X and Y axes in the specified coordinate system.
find_in_system_with_rate	Compute the position, X and Y axes and their rates of change in the specified coordinate system.

Properties

type	Return a type of the plane object.
labels	Allow configuring the plane’s X and Y axes labels.

Import detail

from ansys.stk.core.analysis_workbench import IVectorGeometryToolPlane

Property detail

property IVectorGeometryToolPlane.type: PlaneType

Return a type of the plane object.

property IVectorGeometryToolPlane.labels: VectorGeometryToolPlaneLabels

Allow configuring the plane’s X and Y axes labels.

Method detail

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

Compute the plane’s axes vectors in a specified reference axes.

Parameters:

epoch : Any

axes : IVectorGeometryToolAxes

Returns:

AnalysisWorkbenchPlaneFindInAxesResult

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

Compute the plane’s axes vectors and their rates in a specified reference axes.

Parameters:

epoch : Any

axes : IVectorGeometryToolAxes

Returns:

AnalysisWorkbenchPlaneFindInAxesWithRateResult

IVectorGeometryToolPlane.find_in_system(self, epoch: Any, system: IVectorGeometryToolSystem) → AnalysisWorkbenchPlaneFindInSystemResult

Compute the position and X and Y axes in the specified coordinate system.

Parameters:

epoch : Any

system : IVectorGeometryToolSystem

Returns:

AnalysisWorkbenchPlaneFindInSystemResult

IVectorGeometryToolPlane.find_in_system_with_rate(self, epoch: Any, system: IVectorGeometryToolSystem) → AnalysisWorkbenchPlaneFindInSystemWithRateResult

Compute the position, X and Y axes and their rates of change in the specified coordinate system.

Parameters:

epoch : Any

system : IVectorGeometryToolSystem

Returns:

AnalysisWorkbenchPlaneFindInSystemWithRateResult