Description | Example | Return Message | Group

EclipseBodies

Add or remove eclipsing bodies, which are used in lighting calculations

Syntax

EclipseBodies <SatObjectPath> [UseCustomList {On | Off}] {Action} <Parameters>

Description

The EclipseBodies command allows you to specify a list of eclipsing central bodies that are used in lighting calculations.

Note: This command is valid for Satellites only.

Enter UseCustomList {On | Off} to turn on or off the use of a custom eclipse body list. If Off is entered then the default list will be used. If On is entered then use the {Action} <Parameters> (described in the following table) to define the custom eclipse body list.

{Action} <Parameters> Description
Add <CBName1> [<CBName2>...] Add the specified central bodies to the custom eclipse body list for the Satellite.
Replace <CBName1> [<CBName2>...] Replace the existing custom eclipse body list with the specified central bodies.
Delete {All | <CBName1> [<CBName2>...]} Enter All to delete all central bodies from the list or enter the name(s) of the central bodies that are to be deleted.

Example

To use a custom eclipse body list and add Mars and Jupiter to the list:

EclipseBodies */Satellite/sat1 UseCustomList On Add Mars Jupiter

To add Moon and Earth to the custom eclipse body list:

EclipseBodies */Satellite/sat1 Add Moon Earth

To replace all central bodies in the custom eclipse body list with Pluto and Uranus:

EclipseBodies */Satellite/sat1 Replace Pluto Uranus

To remove Pluto from the custom eclipse body list:

EclipseBodies */Satellite/sat1 Delete Pluto

ReturnMessage

If activated, Connect returns an acknowledgement message.

Group Membership

This command belongs to the following group(s):

Vehicles

Version

7.1

STK Programming Interface 11.0.1