VectorGeometryToolPlaneGroup#

class ansys.stk.core.analysis_workbench.VectorGeometryToolPlaneGroup#: Represents a VGT Plane component.

Overview#

Methods

`remove`	Remove a specified Plane.
`contains`	Search for a an element with a given name. Returns false if the specified element does not exist.
`item`	Return an Plane by name or at a specified position.
`get_item_by_index`	Retrieve a plane from the collection by index.
`get_item_by_name`	Retrieve a plane from the collection by name.

Properties

`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 planes.
`_new_enum`	Return a COM enumerator.

from ansys.stk.core.analysis_workbench import VectorGeometryToolPlaneGroup

property VectorGeometryToolPlaneGroup.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 VectorGeometryToolPlaneGroup.count: int#: Return a number of elements in the group.

property VectorGeometryToolPlaneGroup.factory: VectorGeometryToolPlaneFactory#: Return a Factory object used to create custom planes.

property VectorGeometryToolPlaneGroup._new_enum: EnumeratorProxy#: Return a COM enumerator.

VectorGeometryToolPlaneGroup.remove(self, plane_name: str) → None#

Remove a specified Plane.

VectorGeometryToolPlaneGroup.contains(self, name: str) → bool#

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

VectorGeometryToolPlaneGroup.item(self, index_or_name: Any) → IVectorGeometryToolPlane#

Return an Plane by name or at a specified position.

VectorGeometryToolPlaneGroup.get_item_by_index(self, index: int) → IVectorGeometryToolPlane#

Retrieve a plane from the collection by index.

VectorGeometryToolPlaneGroup.get_item_by_name(self, name: str) → IVectorGeometryToolPlane#

Retrieve a plane from the collection by name.