VehicleEclipseBodies

class ansys.stk.core.stkobjects.VehicleEclipseBodies

Satellite Eclipse Bodies, for defining the eclipse central body list used for lighting computations.

Overview

Methods

is_central_body_assigned	Check whether a central body is already assigned.
assign_central_body	Assign a central body.
remove_central_body	Remove a central body.
remove_all	Remove all the central bodies.

Properties

use_customized_list	Property used to specify whether or not to use the customized list of central bodies.
available_central_bodies	Return an array of available Central Bodies.
assigned_central_bodies	Return an array of all assigned central bodies.

Import detail

from ansys.stk.core.stkobjects import VehicleEclipseBodies

Property detail

property VehicleEclipseBodies.use_customized_list: bool

Property used to specify whether or not to use the customized list of central bodies.

property VehicleEclipseBodies.available_central_bodies: list

Return an array of available Central Bodies.

property VehicleEclipseBodies.assigned_central_bodies: list

Return an array of all assigned central bodies.

Method detail

VehicleEclipseBodies.is_central_body_assigned(self, central_body: str) → bool

Check whether a central body is already assigned.

Parameters:

central_body : str

Returns:

bool

VehicleEclipseBodies.assign_central_body(self, central_body: str) → None

Assign a central body.

Parameters:

central_body : str

Returns:

None

VehicleEclipseBodies.remove_central_body(self, central_body: str) → None

Remove a central body.

Parameters:

central_body : str

Returns:

None

VehicleEclipseBodies.remove_all(self) → None

Remove all the central bodies.

Returns:

None