IGreatArcVehicle#

class ansys.stk.core.stkobjects.IGreatArcVehicle#

A base interface for all Great Arc Vehicles.

Overview#

set_route_type

Set the propagator type.

is_route_type_supported

Get a value indicating whether the specified type can be used.

set_attitude_type

Set the type of attitude profile.

is_attitude_type_supported

Get a value indicating whether the specified type can be used.

route_type

Get the propagator type.

route_supported_types

Return an array of valid choices.

route

Get the route properties.

attitude_type

Get the type of attitude profile.

attitude_supported_types

Return an array of valid choices.

attitude

Get the attitude profile.

ground_ellipses

Get the ground ellipses properties.

access_constraints

Get the constraints imposed on the vehicle.

eclipse_bodies

Get the customized list of Eclipse Bodies, which are central bodies used in lighting computations.

use_terrain_in_lighting_computations

Opt whether to compute lighting using terrain data.

lighting_maximum_step

Do not use this property, as it is deprecated. Use LightingMaxStepTerrain or LightingMaxStepCbShape as appropriate. The maximum step size to use when computing lighting when UseTerrainInLightingComputations is true. Uses Time Dimension.

Import detail#

from ansys.stk.core.stkobjects import IGreatArcVehicle

Property detail#

property IGreatArcVehicle.route_type: PropagatorType#

Get the propagator type.

property IGreatArcVehicle.route_supported_types: list#

Return an array of valid choices.

property IGreatArcVehicle.route: IPropagator#

Get the route properties.

property IGreatArcVehicle.attitude_type: VehicleAttitude#

Get the type of attitude profile.

property IGreatArcVehicle.attitude_supported_types: list#

Return an array of valid choices.

property IGreatArcVehicle.attitude: IVehicleAttitude#

Get the attitude profile.

property IGreatArcVehicle.ground_ellipses: VehicleGroundEllipsesCollection#

Get the ground ellipses properties.

property IGreatArcVehicle.access_constraints: AccessConstraintCollection#

Get the constraints imposed on the vehicle.

property IGreatArcVehicle.eclipse_bodies: VehicleEclipseBodies#

Get the customized list of Eclipse Bodies, which are central bodies used in lighting computations.

property IGreatArcVehicle.use_terrain_in_lighting_computations: bool#

Opt whether to compute lighting using terrain data.

property IGreatArcVehicle.lighting_maximum_step: float#

Do not use this property, as it is deprecated. Use LightingMaxStepTerrain or LightingMaxStepCbShape as appropriate. The maximum step size to use when computing lighting when UseTerrainInLightingComputations is true. Uses Time Dimension.

Method detail#

IGreatArcVehicle.set_route_type(self, route: PropagatorType) None#

Set the propagator type.

Parameters:

route : PropagatorType

Returns:

None

IGreatArcVehicle.is_route_type_supported(self, route: PropagatorType) bool#

Get a value indicating whether the specified type can be used.

Parameters:

route : PropagatorType

Returns:

bool

IGreatArcVehicle.set_attitude_type(self, attitude: VehicleAttitude) None#

Set the type of attitude profile.

Parameters:

attitude : VehicleAttitude

Returns:

None

IGreatArcVehicle.is_attitude_type_supported(self, attitude: VehicleAttitude) bool#

Get a value indicating whether the specified type can be used.

Parameters:

attitude : VehicleAttitude

Returns:

bool