Graphics3DReferenceVectorGeometryToolComponentCollection

class ansys.stk.core.stkobjects.Graphics3DReferenceVectorGeometryToolComponentCollection

Collection of reference vectors, axes, points, planes and angles (3D Graphics, Vector Geometry Tool).

Overview

Methods

item	Return an element of the collection at the specified position.
add	Add a VGT component to the collection. The path must refer to a valid VGT component. The method throws an exception if the path is invalid or if the element already exist.
remove	Remove an element at the specified position from the collection.
remove_all	Remove all elements from the collection.
remove_by_name	Remove an element from the collection using the element’s path. The method does not throw an exception if the element with the specified name is not in the collection.
get_component_by_name	Return an element with the specified name and type. The method throws an exception if the element with the specified name does not exist.

Properties

count	Return a number of elements in the collection.
_new_enum	Enumerates through the vector collection.
available_vector_geometry_tool_components	Get a list of available VGT elements that can be added to the collection.

Import detail

from ansys.stk.core.stkobjects import Graphics3DReferenceVectorGeometryToolComponentCollection

Property detail

property Graphics3DReferenceVectorGeometryToolComponentCollection.count: int

Return a number of elements in the collection.

property Graphics3DReferenceVectorGeometryToolComponentCollection._new_enum: EnumeratorProxy

Enumerates through the vector collection.

property Graphics3DReferenceVectorGeometryToolComponentCollection.available_vector_geometry_tool_components: list

Get a list of available VGT elements that can be added to the collection.

Method detail

Graphics3DReferenceVectorGeometryToolComponentCollection.item(self, index: int) → IGraphics3DReferenceAnalysisWorkbenchComponent

Return an element of the collection at the specified position.

Parameters:

index : int

Returns:

IGraphics3DReferenceAnalysisWorkbenchComponent

Graphics3DReferenceVectorGeometryToolComponentCollection.add(self, type: GeometricElementType, name: str) → IGraphics3DReferenceAnalysisWorkbenchComponent

Add a VGT component to the collection. The path must refer to a valid VGT component. The method throws an exception if the path is invalid or if the element already exist.

Parameters:

type : GeometricElementType

name : str

Returns:

IGraphics3DReferenceAnalysisWorkbenchComponent

Graphics3DReferenceVectorGeometryToolComponentCollection.remove(self, index: int) → None

Remove an element at the specified position from the collection.

Parameters:

index : int

Returns:

None

Graphics3DReferenceVectorGeometryToolComponentCollection.remove_all(self) → None

Remove all elements from the collection.

Returns:

None

Graphics3DReferenceVectorGeometryToolComponentCollection.remove_by_name(self, type: GeometricElementType, name: str) → None

Remove an element from the collection using the element’s path. The method does not throw an exception if the element with the specified name is not in the collection.

Parameters:

type : GeometricElementType

name : str

Returns:

None

Graphics3DReferenceVectorGeometryToolComponentCollection.get_component_by_name(self, type: GeometricElementType, name: str) → IGraphics3DReferenceAnalysisWorkbenchComponent

Return an element with the specified name and type. The method throws an exception if the element with the specified name does not exist.

Parameters:

type : GeometricElementType

name : str

Returns:

IGraphics3DReferenceAnalysisWorkbenchComponent