TerrainCollection

class ansys.stk.core.stkobjects.TerrainCollection

Collection of terrain data files available in the Scenario for visualization and analysis.

Overview

Methods

item	Given an index, returns an Terrain interface.
add	Add a terrain item to the collection.
remove	Remove a given index from the collection.
remove_all	Remove all items from the collections.

Properties

count	The number of items in the collection.
_new_enum	Enumerates through the collection.

Import detail

from ansys.stk.core.stkobjects import TerrainCollection

Property detail

property TerrainCollection.count: int

The number of items in the collection.

property TerrainCollection._new_enum: EnumeratorProxy

Enumerates through the collection.

Method detail

TerrainCollection.item(self, index: int) → Terrain

Given an index, returns an Terrain interface.

Parameters:

index : int

Returns:

Terrain

TerrainCollection.add(self, location: str, terrain_file_type: TerrainFileType) → Terrain

Add a terrain item to the collection.

Parameters:

location : str

terrain_file_type : TerrainFileType

Returns:

Terrain

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

Remove a given index from the collection.

Parameters:

index : int

Returns:

None

TerrainCollection.remove_all(self) → None

Remove all items from the collections.

Returns:

None