Description
Returns the angle measured between the CelestialObject identified by coID1 and the CelestialObject identified by coID2 with the calling Spacecraft as the vertex.
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.
Method Signature
Arguments
coID1
|
|
Description:
|
Numerical identifier of a celestial body to use to form the desired angle. Body ID's 1-11 are assigned to the default Solar System objects, as shown below. Custom CelestialObjects will have body ID's starting at 12 and assigned in the order they are created.
|
Valid Range:
|
coID1 ≥ 0
|
Valid Values:
|
Celestial Object
|
Value
|
Mercury
|
Mercury.BodyID or 1
|
Venus
|
Venus.BodyID or 2
|
Earth
|
Earth.BodyID or 3
|
Mars
|
Mars.BodyID or 4
|
Jupiter
|
Jupiter.BodyID or 5
|
Saturn
|
Saturn.BodyID or 6
|
Uranus
|
Uranus.BodyID or 7
|
Neptune
|
Neptune.BodyID or 8
|
Pluto
|
Pluto.BodyID or 9
|
Moon
|
Moon.BodyID or 10
|
Sun
|
Sun.BodyID or 11
|
<Custom CelestialBody>
|
<Custom CelestialBody>.BodyID, starting at 12 and assigned in the order the custom CelestialObjects are created.
|
|
coID2
|
|
Description:
|
Numerical identifier of a second celestial body to use to form the desired angle. Body ID's 1-11 are assigned to the default Solar System objects, as shown below. Custom CelestialObjects will have body ID's starting at 12 and assigned in the order they are created.
|
Valid Range:
|
coID2 ≥ 0
|
Valid Values:
|
Celestial Object
|
Value
|
Mercury
|
Mercury.BodyID or 1
|
Venus
|
Venus.BodyID or 2
|
Earth
|
Earth.BodyID or 3
|
Mars
|
Mars.BodyID or 4
|
Jupiter
|
Jupiter.BodyID or 5
|
Saturn
|
Saturn.BodyID or 6
|
Uranus
|
Uranus.BodyID or 7
|
Neptune
|
Neptune.BodyID or 8
|
Pluto
|
Pluto.BodyID or 9
|
Moon
|
Moon.BodyID or 10
|
Sun
|
Sun.BodyID or 11
|
<Custom CelestialBody>
|
<Custom CelestialBody>.BodyID, starting at 12 and assigned in the order the custom CelestialObjects are created.
|
|
Return Value
Returns the angle measured between any two celestial objects, Stars, or Vehicles, with the calling Vehicle as the vertex.
Syntax
myVariable1 = mySpacecraft1.RelativeAngle(myVariable2, myVariable3);
|
See also
Spacecraft Object
Spacecraft.RelativeAngle
Spacecraft Propagation Guide
Coverage and Contact Analysis Guide
|