VehicleGraphics2DElevationsCollection

class ansys.stk.core.stkobjects.VehicleGraphics2DElevationsCollection

Collection for elevation contours. Used by vehicles.

Overview

Methods

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_level	Add a new element to the collection.
add_level_range	Add a range of new levels to the collection.

Properties

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 VehicleGraphics2DElevationsCollection

Property detail

property VehicleGraphics2DElevationsCollection.count: int

Return the number of elements in a collection.

property VehicleGraphics2DElevationsCollection._new_enum: EnumeratorProxy

Return an enumerator that can iterate through the collection.

Method detail

VehicleGraphics2DElevationsCollection.item(self, index: int) → VehicleGraphics2DElevationsElement

Given an index, returns an element in the collection.

Parameters:

index : int

Returns:

VehicleGraphics2DElevationsElement

VehicleGraphics2DElevationsCollection.remove_at(self, index: int) → None

Remove an element from the collection using specified index.

Parameters:

index : int

Returns:

None

VehicleGraphics2DElevationsCollection.remove_all(self) → None

Remove all elements from the collection.

Returns:

None

VehicleGraphics2DElevationsCollection.add_level(self, elevation: float) → VehicleGraphics2DElevationsElement

Add a new element to the collection.

Parameters:

elevation : float

Returns:

VehicleGraphics2DElevationsElement

VehicleGraphics2DElevationsCollection.add_level_range(self, start: Any, stop: Any, step: Any) → None

Add a range of new levels to the collection.

Parameters:

start : Any

stop : Any

step : Any

Returns:

None