Description
Returns the angle between the reference-to-target vector and the x-y plane of the reference object in the coordinate frame of the input sensor.
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
GroundVehicle.Elevation(
|
Variable celestialBodyIdentifier,
|
|
Sensor sensor)
|
Arguments
celestialBodyIdentifier
|
|
Description:
|
The numerical identifier of the target celestial body to be used in the elevation calculation. 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:
|
celestialBodyIdentifier ≥ 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.
|
|
sensor
|
|
Description:
|
The Sensor that provides the coordinate frame for the elevation calculation.
|
Return Value
Returns the elevation angle of the argument as seen from the reference object.
Syntax
myVariable1 = myGroundVehicle1.Elevation(myVariable2, mySensor1);
|
See also
GroundVehicle Object
GroundVehicle.Elevation
|