VectorGeometryToolAngleGroup#

class ansys.stk.core.analysis_workbench.VectorGeometryToolAngleGroup#

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

Overview#

remove

Remove a specified Angle.

contains

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

item

Return an angle by name or at a specified position.

get_item_by_index

Retrieve an angle from the collection by index.

get_item_by_name

Retrieve an angle 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 group.

factory

Return a Factory object used to create custom angles.

_new_enum

Return a COM enumerator.

Import detail#

from ansys.stk.core.analysis_workbench import VectorGeometryToolAngleGroup

Property detail#

property VectorGeometryToolAngleGroup.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 VectorGeometryToolAngleGroup.count: int#

Return a number of elements in the group.

property VectorGeometryToolAngleGroup.factory: VectorGeometryToolAngleFactory#

Return a Factory object used to create custom angles.

property VectorGeometryToolAngleGroup._new_enum: EnumeratorProxy#

Return a COM enumerator.

Method detail#

VectorGeometryToolAngleGroup.remove(self, angle_name: str) None#

Remove a specified Angle.

Parameters:

angle_name : str

Returns:

None

VectorGeometryToolAngleGroup.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

VectorGeometryToolAngleGroup.item(self, index_or_name: Any) IVectorGeometryToolAngle#

Return an angle by name or at a specified position.

Parameters:

index_or_name : Any

Returns:

IVectorGeometryToolAngle

VectorGeometryToolAngleGroup.get_item_by_index(self, index: int) IVectorGeometryToolAngle#

Retrieve an angle from the collection by index.

Parameters:

index : int

Returns:

IVectorGeometryToolAngle

VectorGeometryToolAngleGroup.get_item_by_name(self, name: str) IVectorGeometryToolAngle#

Retrieve an angle from the collection by name.

Parameters:

name : str

Returns:

IVectorGeometryToolAngle