Class: HeadingPitchRange

HeadingPitchRange

new HeadingPitchRange(headingopt, pitchopt, rangeopt)

Defines a heading angle, pitch angle, and range in a local frame. Heading is the rotation from the local north direction where a positive angle is increasing eastward. Pitch is the rotation from the local xy-plane. Positive pitch angles are above the plane. Negative pitch angles are below the plane. Range is the distance from the center of the frame.
Parameters:
Name Type Attributes Default Description
heading Number <optional>
0.0 The heading angle in radians.
pitch Number <optional>
0.0 The pitch angle in radians.
range Number <optional>
0.0 The distance from the center in meters.
Source:

Members

heading :Number

Heading is the rotation from the local north direction where a positive angle is increasing eastward.
Type:
  • Number
Source:

pitch :Number

Pitch is the rotation from the local xy-plane. Positive pitch angles are above the plane. Negative pitch angles are below the plane.
Type:
  • Number
Source:

range :Number

Range is the distance from the center of the local frame.
Type:
  • Number
Source:

Methods

(static) clone(hpr, resultopt) → {HeadingPitchRange}

Duplicates a HeadingPitchRange instance.
Parameters:
Name Type Attributes Description
hpr HeadingPitchRange The HeadingPitchRange to duplicate.
result HeadingPitchRange <optional>
The object onto which to store the result.
Source:
Returns:
The modified result parameter or a new HeadingPitchRange instance if one was not provided. (Returns undefined if hpr is undefined)
Type
HeadingPitchRange