TerrainOverlayCollection#

class ansys.stk.core.graphics.TerrainOverlayCollection#: A collection of terrain overlay objects.

Overview#

Methods

`item`	Get the terrain overlay at the specified index.
`contains`	Check the presence of a terrain overlay in the collection.
`contains_uri_string`	Check the presence of a terrain overlay with the specified Uri in the collection.
`remove`	Remove a terrain overlay from the collection.
`clear`	Remove all terrain overlay objects from the collection.
`add`	Add terrainOverlay to the collection.
`add_async`	Add terrainOverlay to the collection asynchronously.
`index_of`	Get the index of the specified terrain overlay.
`index_of_uri_string`	Get the index of the terrain overlay with the specified Uri.
`add_uri_string`	Create a terrain overlay from the uri, which represents a uri, and adds it to the collection.
`add_async_uri_string`	Create a terrain overlay from the uri, which represents a uri, and adds it to the collection asynchronously.
`swap`	Swap the position of two terrain overlay objects.
`swap_by_index`	Swap the position of two terrain overlay objects at the specified indices.
`move`	Move the terrain overlay to the specified position.
`move_by_index`	Move the terrain overlay at the specified index to the specified position.
`bring_to_front`	Brings the terrain overlay to the front of the collection so it is rendered first or on the bottom.
`send_to_back`	Send the terrain overlay to the back of the collection so it is rendered last or on the top.
`subscribe`	“””Return an ITerrainOverlayCollectionEventHandler that is subscribed to handle events associated with this instance of TerrainOverlayCollection.”””

Properties

`count`	Get the number of terrain overlay objects in the collection.
`is_read_only`	Get whether or not the collection is read only.
`_new_enum`	Construct an iterator that can be used to iterate the collection.

Import detail#

from ansys.stk.core.graphics import TerrainOverlayCollection

Property detail#

property TerrainOverlayCollection.count: int#: Get the number of terrain overlay objects in the collection.

property TerrainOverlayCollection.is_read_only: bool#: Get whether or not the collection is read only.

property TerrainOverlayCollection._new_enum: EnumeratorProxy#: Construct an iterator that can be used to iterate the collection.

Method detail#

TerrainOverlayCollection.item(self, index: int) → ITerrainOverlay#

Get the terrain overlay at the specified index.

Parameters:: index : int
Returns:: ITerrainOverlay

TerrainOverlayCollection.contains(self, terrain_overlay: ITerrainOverlay) → bool#

Check the presence of a terrain overlay in the collection.

Parameters:: terrain_overlay : ITerrainOverlay
Returns:: bool

TerrainOverlayCollection.contains_uri_string(self, string_uri: str) → bool#

Check the presence of a terrain overlay with the specified Uri in the collection.

Parameters:: string_uri : str
Returns:: bool

TerrainOverlayCollection.remove(self, terrain_overlay: ITerrainOverlay) → bool#

Remove a terrain overlay from the collection.

Parameters:: terrain_overlay : ITerrainOverlay
Returns:: bool

TerrainOverlayCollection.clear(self) → None#

Remove all terrain overlay objects from the collection.

Returns:: None

TerrainOverlayCollection.add(self, terrain_overlay: ITerrainOverlay) → None#

Add terrainOverlay to the collection.

Parameters:: terrain_overlay : ITerrainOverlay
Returns:: None

TerrainOverlayCollection.add_async(self, terrain_overlay: ITerrainOverlay) → None#

Add terrainOverlay to the collection asynchronously.

Parameters:: terrain_overlay : ITerrainOverlay
Returns:: None

TerrainOverlayCollection.index_of(self, terrain_overlay: ITerrainOverlay) → int#

Get the index of the specified terrain overlay.

Parameters:: terrain_overlay : ITerrainOverlay
Returns:: int

TerrainOverlayCollection.index_of_uri_string(self, string_uri: str) → int#

Get the index of the terrain overlay with the specified Uri.

Parameters:: string_uri : str
Returns:: int

TerrainOverlayCollection.add_uri_string(self, uri: str) → ITerrainOverlay#

Create a terrain overlay from the uri, which represents a uri, and adds it to the collection.

Parameters:: uri : str
Returns:: ITerrainOverlay

TerrainOverlayCollection.add_async_uri_string(self, uri: str) → ITerrainOverlay#

Create a terrain overlay from the uri, which represents a uri, and adds it to the collection asynchronously.

Parameters:: uri : str
Returns:: ITerrainOverlay

TerrainOverlayCollection.swap(self, terrain_overlay1: ITerrainOverlay, terrain_overlay2: ITerrainOverlay) → None#

Swap the position of two terrain overlay objects.

Parameters:

terrain_overlay1 : ITerrainOverlay

terrain_overlay2 : ITerrainOverlay

Returns:

None

TerrainOverlayCollection.swap_by_index(self, index1: int, index2: int) → None#

Swap the position of two terrain overlay objects at the specified indices.

Parameters:

index1 : int

index2 : int

Returns:

None

TerrainOverlayCollection.move(self, terrain_overlay: ITerrainOverlay, new_position: int) → None#

Move the terrain overlay to the specified position.

Parameters:

terrain_overlay : ITerrainOverlay

new_position : int

Returns:

None

TerrainOverlayCollection.move_by_index(self, index: int, new_position: int) → None#

Move the terrain overlay at the specified index to the specified position.

Parameters:

index : int

new_position : int

Returns:

None

TerrainOverlayCollection.bring_to_front(self, terrain_overlay: ITerrainOverlay) → None#

Brings the terrain overlay to the front of the collection so it is rendered first or on the bottom.

Parameters:: terrain_overlay : ITerrainOverlay
Returns:: None

TerrainOverlayCollection.send_to_back(self, terrain_overlay: ITerrainOverlay) → None#

Send the terrain overlay to the back of the collection so it is rendered last or on the top.

Parameters:: terrain_overlay : ITerrainOverlay
Returns:: None