VolumetricGraphics3DCrossSectionPlaneCollection#

class ansys.stk.core.stkobjects.VolumetricGraphics3DCrossSectionPlaneCollection#

Class defining collection of cross-section planes for volumetric grid.

Overview#

item

Given an index, returns an element in the collection.

remove_at

Remove an element from the collection using specified index.

remove_all

Remove all elements from the collection.

add

Add a new plane to the collection.

count

Return the number of elements in a collection.

_new_enum

Return an enumerator that can iterate through the collection.

Import detail#

from ansys.stk.core.stkobjects import VolumetricGraphics3DCrossSectionPlaneCollection

Property detail#

property VolumetricGraphics3DCrossSectionPlaneCollection.count: int#

Return the number of elements in a collection.

property VolumetricGraphics3DCrossSectionPlaneCollection._new_enum: EnumeratorProxy#

Return an enumerator that can iterate through the collection.

Method detail#

VolumetricGraphics3DCrossSectionPlaneCollection.item(self, index: int) VolumetricGraphics3DCrossSectionPlane#

Given an index, returns an element in the collection.

Parameters:

index : int

Returns:

VolumetricGraphics3DCrossSectionPlane

VolumetricGraphics3DCrossSectionPlaneCollection.remove_at(self, index: int) None#

Remove an element from the collection using specified index.

Parameters:

index : int

Returns:

None

VolumetricGraphics3DCrossSectionPlaneCollection.remove_all(self) None#

Remove all elements from the collection.

Returns:

None

VolumetricGraphics3DCrossSectionPlaneCollection.add(self, plane: str) VolumetricGraphics3DCrossSectionPlane#

Add a new plane to the collection.

Parameters:

plane : str

Returns:

VolumetricGraphics3DCrossSectionPlane