VehicleGraphics3DSystemsCollection

class ansys.stk.core.stkobjects.VehicleGraphics3DSystemsCollection

List of Systems.

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	Add a new element to the collection.
contains	Check whether the given frame is already in the list.
remove	Remove a system by name.

Properties

count	Return the number of elements in a collection.
_new_enum	Return an enumerator that can iterate through the collection.
supported_systems	Return a list of element types that can be added to the collection.
inertial_by_window	Get the Inertial By Window System.
fixed_by_window	Get the Fixed By Window System.

Examples

Add Fixed System Orbit System in 3D Display

# Satellite satellite: Satellite object
orbitsystems = satellite.graphics_3d.orbit_systems
orbitsystems.fixed_by_window.show_graphics = True
orbitsystems.fixed_by_window.inherit = False
orbitsystems.fixed_by_window.color = Colors.Yellow

Import detail

from ansys.stk.core.stkobjects import VehicleGraphics3DSystemsCollection

Property detail

property VehicleGraphics3DSystemsCollection.count: int

Return the number of elements in a collection.

property VehicleGraphics3DSystemsCollection._new_enum: EnumeratorProxy

Return an enumerator that can iterate through the collection.

property VehicleGraphics3DSystemsCollection.supported_systems: list

Return a list of element types that can be added to the collection.

property VehicleGraphics3DSystemsCollection.inertial_by_window: VehicleGraphics3DSystemsSpecialElement

Get the Inertial By Window System.

property VehicleGraphics3DSystemsCollection.fixed_by_window: VehicleGraphics3DSystemsSpecialElement

Get the Fixed By Window System.

Method detail

VehicleGraphics3DSystemsCollection.item(self, index: int) → VehicleGraphics3DSystemsElement

Given an index, returns an element in the collection.

Parameters:

index : int

Returns:

VehicleGraphics3DSystemsElement

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

Remove an element from the collection using specified index.

Parameters:

index : int

Returns:

None

VehicleGraphics3DSystemsCollection.remove_all(self) → None

Remove all elements from the collection.

Returns:

None

VehicleGraphics3DSystemsCollection.add(self, system_name: str) → VehicleGraphics3DSystemsElement

Add a new element to the collection.

Parameters:

system_name : str

Returns:

VehicleGraphics3DSystemsElement

VehicleGraphics3DSystemsCollection.contains(self, system_name: str) → bool

Check whether the given frame is already in the list.

Parameters:

system_name : str

Returns:

bool

VehicleGraphics3DSystemsCollection.remove(self, system_name: str) → None

Remove a system by name.

Parameters:

system_name : str

Returns:

None