VectorGeometryToolPointGroup#

class ansys.stk.core.analysis_workbench.VectorGeometryToolPointGroup#: Access or create VGT points associated with an object or a central body.

Overview#

Methods

`remove`	Remove a specified point by name.
`contains`	Search for a an element with a given name. Returns false if the specified element does not exist.
`item`	Return a point by name or at a specified position.
`get_item_by_index`	Retrieve a point from the collection by index.
`get_item_by_name`	Retrieve a point 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 points.
`_new_enum`	Return a COM enumerator.
`common_tasks`	Provide access to common tasks that allow users quickly carry out tasks such as creating known point types, etc.

from ansys.stk.core.analysis_workbench import VectorGeometryToolPointGroup

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

property VectorGeometryToolPointGroup.factory: VectorGeometryToolPointFactory#: Return a Factory object used to create custom points.

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

property VectorGeometryToolPointGroup.common_tasks: VectorGeometryToolPointCommonTasks#: Provide access to common tasks that allow users quickly carry out tasks such as creating known point types, etc.

VectorGeometryToolPointGroup.remove(self, point_name: str) → None#

Remove a specified point by name.

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

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

VectorGeometryToolPointGroup.item(self, index_or_name: Any) → IVectorGeometryToolPoint#

Return a point by name or at a specified position.

VectorGeometryToolPointGroup.get_item_by_index(self, index: int) → IVectorGeometryToolPoint#

Retrieve a point from the collection by index.

VectorGeometryToolPointGroup.get_item_by_name(self, name: str) → IVectorGeometryToolPoint#

Retrieve a point from the collection by name.