VolumetricGraphics3DSpatialCalculationLevelCollection

class ansys.stk.core.stkobjects.VolumetricGraphics3DSpatialCalculationLevelCollection

Class defining collections of defining Spatial Calculation Boundary/Fill Levels for volumetric grid.

Overview

Methods

add	Add a new level to the collection. When adding a level with duplicate ‘Value’, it will update ‘Color’ and ‘Translucency’ values of the existing level.
item	Given an index, returns an element in the collection.
remove_all	Remove all elements from the collection.
remove_at	Remove an element from the collection using specified index.

Properties

_new_enum	Return an enumerator that can iterate through the collection.
count	Return the number of elements in a collection.

Import detail

from ansys.stk.core.stkobjects import VolumetricGraphics3DSpatialCalculationLevelCollection

Property detail

property VolumetricGraphics3DSpatialCalculationLevelCollection._new_enum: EnumeratorProxy

Return an enumerator that can iterate through the collection.

property VolumetricGraphics3DSpatialCalculationLevelCollection.count: int

Return the number of elements in a collection.

Method detail

VolumetricGraphics3DSpatialCalculationLevelCollection.add(self, value: float, color: agcolor.Color, translucency: float) → VolumetricGraphics3DSpatialCalculationLevel

Add a new level to the collection. When adding a level with duplicate ‘Value’, it will update ‘Color’ and ‘Translucency’ values of the existing level.

Parameters:

value : float

color : Color

translucency : float

Returns:

VolumetricGraphics3DSpatialCalculationLevel

VolumetricGraphics3DSpatialCalculationLevelCollection.item(self, level: int) → VolumetricGraphics3DSpatialCalculationLevel

Given an index, returns an element in the collection.

Parameters:

level : int

Returns:

VolumetricGraphics3DSpatialCalculationLevel

VolumetricGraphics3DSpatialCalculationLevelCollection.remove_all(self) → None

Remove all elements from the collection.

Returns:

None

VolumetricGraphics3DSpatialCalculationLevelCollection.remove_at(self, level: int) → None

Remove an element from the collection using specified index.

Parameters:

level : int

Returns:

None