Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HeadingPitchRoll

Hierarchy

  • HeadingPitchRoll
    • HeadingPitchRoll

Index

Constructors

Properties

Methods

Constructors

constructor

  • new HeadingPitchRoll(heading?: number, pitch?: number, roll?: number): HeadingPitchRoll

  • Parameters

    • Optional heading: number
    • Optional pitch: number
    • Optional roll: number

    Returns HeadingPitchRoll

Properties

heading

heading: number

pitch

pitch: number

roll

roll: number

Methods

clone

  • clone(result?: HeadingPitchRoll): HeadingPitchRoll

  • Duplicates this HeadingPitchRoll instance.

    Parameters

    • Optional result: HeadingPitchRoll

    Returns HeadingPitchRoll

    The modified result parameter or a new HeadingPitchRoll instance if one was not provided.

equals

  • equals(right?: HeadingPitchRoll): boolean

  • Compares this HeadingPitchRoll against the provided HeadingPitchRoll componentwise and returns true if they are equal, false otherwise.

    Parameters

    • Optional right: HeadingPitchRoll

    Returns boolean

    true if they are equal, false otherwise.

equalsEpsilon

  • equalsEpsilon(right?: HeadingPitchRoll, relativeEpsilon?: number, absoluteEpsilon?: number): boolean

  • Compares this HeadingPitchRoll against the provided HeadingPitchRoll componentwise and returns true if they pass an absolute or relative tolerance test, false otherwise.

    Parameters

    • Optional right: HeadingPitchRoll
    • Optional relativeEpsilon: number
    • Optional absoluteEpsilon: number

    Returns boolean

    true if they are within the provided epsilon, false otherwise.

toString

  • toString(): string

  • Creates a string representing this HeadingPitchRoll in the format '(heading, pitch, roll)' in radians.

    Returns string

    A string representing the provided HeadingPitchRoll in the format '(heading, pitch, roll)'.

Static clone

  • clone(headingPitchRoll: HeadingPitchRoll, result?: HeadingPitchRoll): HeadingPitchRoll

  • Duplicates a HeadingPitchRoll instance.

    Parameters

    • headingPitchRoll: HeadingPitchRoll

      The HeadingPitchRoll to duplicate.

    • Optional result: HeadingPitchRoll

    Returns HeadingPitchRoll

    The modified result parameter or a new HeadingPitchRoll instance if one was not provided. (Returns undefined if headingPitchRoll is undefined)

Static equals

  • equals(left?: HeadingPitchRoll, right?: HeadingPitchRoll): boolean

  • Compares the provided HeadingPitchRolls componentwise and returns true if they are equal, false otherwise.

    Parameters

    • Optional left: HeadingPitchRoll
    • Optional right: HeadingPitchRoll

    Returns boolean

    true if left and right are equal, false otherwise.

Static equalsEpsilon

  • equalsEpsilon(left?: HeadingPitchRoll, right?: HeadingPitchRoll, relativeEpsilon?: number, absoluteEpsilon?: number): boolean

  • Compares the provided HeadingPitchRolls componentwise and returns true if they pass an absolute or relative tolerance test, false otherwise.

    Parameters

    • Optional left: HeadingPitchRoll
    • Optional right: HeadingPitchRoll
    • Optional relativeEpsilon: number
    • Optional absoluteEpsilon: number

    Returns boolean

    true if left and right are within the provided epsilon, false otherwise.

Static fromDegrees

  • fromDegrees(heading: number, pitch: number, roll: number, result?: HeadingPitchRoll): HeadingPitchRoll

  • Returns a new HeadingPitchRoll instance from angles given in degrees.

    Parameters

    • heading: number

      the heading in degrees

    • pitch: number

      the pitch in degrees

    • roll: number

      the heading in degrees

    • Optional result: HeadingPitchRoll

    Returns HeadingPitchRoll

    A new HeadingPitchRoll instance

Static fromQuaternion

  • fromQuaternion(quaternion: Quaternion, result?: HeadingPitchRoll): HeadingPitchRoll

  • Computes the heading, pitch and roll from a quaternion (see http://en.wikipedia.org/wiki/Conversion_between_quaternions_and_Euler_angles )

    Parameters

    • quaternion: Quaternion

      The quaternion from which to retrieve heading, pitch, and roll, all expressed in radians.

    • Optional result: HeadingPitchRoll

    Returns HeadingPitchRoll

    The modified result parameter or a new HeadingPitchRoll instance if one was not provided.