VectorGeometryToolAxesGroup#

class ansys.stk.core.analysis_workbench.VectorGeometryToolAxesGroup#

Access or create VGT axes associated with an object or a central body.

Overview#

remove

Remove a specified Axes.

contains

Search for a an element with a given name. Returns false if the specified element does not exist.

item

Return an axes by name or at a specified position.

get_item_by_index

Retrieve an axes from the collection by index.

get_item_by_name

Retrieve an axes from the collection by name.

context

Return a context object. The context can be used to find out which central body or STK object this instance is associated with.

count

Return a number of elements in the collection.

factory

Return a Factory object used to create custom axes.

_new_enum

Return a COM enumerator.

common_tasks

Provide access to common tasks that allow users quickly carry out tasks such as creating known axes, etc.

Import detail#

from ansys.stk.core.analysis_workbench import VectorGeometryToolAxesGroup

Property detail#

property VectorGeometryToolAxesGroup.context: IAnalysisWorkbenchComponentContext#

Return a context object. The context can be used to find out which central body or STK object this instance is associated with.

property VectorGeometryToolAxesGroup.count: int#

Return a number of elements in the collection.

property VectorGeometryToolAxesGroup.factory: VectorGeometryToolAxesFactory#

Return a Factory object used to create custom axes.

property VectorGeometryToolAxesGroup._new_enum: EnumeratorProxy#

Return a COM enumerator.

property VectorGeometryToolAxesGroup.common_tasks: VectorGeometryToolAxesCommonTasks#

Provide access to common tasks that allow users quickly carry out tasks such as creating known axes, etc.

Method detail#

VectorGeometryToolAxesGroup.remove(self, axes_name: str) None#

Remove a specified Axes.

Parameters:

axes_name : str

Returns:

None

VectorGeometryToolAxesGroup.contains(self, name: str) bool#

Search for a an element with a given name. Returns false if the specified element does not exist.

Parameters:

name : str

Returns:

bool

VectorGeometryToolAxesGroup.item(self, index_or_name: Any) IVectorGeometryToolAxes#

Return an axes by name or at a specified position.

Parameters:

index_or_name : Any

Returns:

IVectorGeometryToolAxes

VectorGeometryToolAxesGroup.get_item_by_index(self, index: int) IVectorGeometryToolAxes#

Retrieve an axes from the collection by index.

Parameters:

index : int

Returns:

IVectorGeometryToolAxes

VectorGeometryToolAxesGroup.get_item_by_name(self, name: str) IVectorGeometryToolAxes#

Retrieve an axes from the collection by name.

Parameters:

name : str

Returns:

IVectorGeometryToolAxes