Spacecraft.SubSatellitePointInShadow Method

Top

Description

Returns an integer value indicating whether the sub-satellite point on the Spacecraft's Central Body is in shadow. A value of 1 is returned when the sub-satellite point is in shadow, and a 0 is returned if it is not.

Timing Precision Mode

This page describes functionality in nanosecond timing precision mode.

Click here to see the documentation for this object in millisecond timing precision mode.

Overload List

Signatures	Return Value	Description
Spacecraft.SubSatellitePointInShadow()	Variable	Returns true if the calling Spacecraft's sub-satellite point on its CentralBody is in shadow at the Spacecraft's Epoch. Only the Spacecraft's CentralBody will be considered in shadow calculations.
Spacecraft.SubSatellitePointInShadow(CelestialObject occultingCelestialObject)	Variable	Returns true if the calling Spacecraft's sub-satellite point on its CentralBody is in shadow of any of the specified CelestialObject objects at the Spacecraft's Epoch.
Spacecraft.SubSatellitePointInShadow(Variable occultingBodyID)	Variable	Returns true if the calling Spacecraft's sub-satellite point on its CentralBody is in shadow of any of the CelestialObject objects specified by their BodyID at the Spacecraft's Epoch.

See also

Spacecraft Object

Spacecraft Propagation Guide

Coverage and Contact Analysis Guide