Spacecraft.OrbitApoapsis Method

The OrbitApoapsis method is a conditional property that can be used with the Step command to advance the Spacecraft to apoapsis, the point in the orbit where the Spacecraft is at its furthest distance from a Planet, Moon, or CelestialObject. FreeFlyer determines this condition by monitoring the dot product between the position and velocity vectors and identifying when this value passes from positive to negative. The celestial body to be used in the apoapsis calculation can be specified using a Variable, String, or CelestialObject. If a celestial body is not specified, the current Spacecraft Central Body will be used.

Note that as a general rule this method should only be used as a propagation stopping condition and should not be used as a means monitor whether or not a Spacecraft is at the apoapsis of its orbit at a particular epoch.

This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.

Overload List

Signatures	Return Value	Description
Spacecraft.OrbitApoapsis()	Variable	Returns the point in the orbit where the Spacecraft is at its furthest distance from its central body.
Spacecraft.OrbitApoapsis(CelestialObject celestialObject)	Variable	Returns the point in the orbit where the Spacecraft is at its furthest distance from the specified celestialObject.
Spacecraft.OrbitApoapsis(String referenceBodyName)	Variable	Returns the point in the orbit where the Spacecraft is at its furthest distance from the celestial body represented by referenceBodyName.
Spacecraft.OrbitApoapsis(Variable referenceBodyIDVariable)	Variable	Returns the point in the orbit where the Spacecraft is at its furthest distance from the celestial body represented by referenceBodyIDVariable.

Spacecraft.OrbitApoapsis Method

Description

Overload List