Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OrientationEuler3D

Instantiations of this class define an orientation in 3D space. A user's orientation in 3D space affects the way the mixed spatial audio is heard by the user. Additionally, orientation affects the way a user's audio input propagates through a space: speakers facing directly towards a listener will sound louder than speakers facing away from a listener. By default, the axis configuration is set up to be right-handed.

Hierarchy

  • OrientationEuler3D

Index

Constructors

constructor

  • new OrientationEuler3D(__namedParameters?: { pitchDegrees?: number; rollDegrees?: number; yawDegrees?: number }): OrientationEuler3D
  • Construct a new OrientationEuler3D object. All parameters are optional. Unset parameters will be set to 0. Remember, all units for member variables are degrees.

    Parameters

    • __namedParameters: { pitchDegrees?: number; rollDegrees?: number; yawDegrees?: number } = ...
      • Optional pitchDegrees?: number
      • Optional rollDegrees?: number
      • Optional yawDegrees?: number

    Returns OrientationEuler3D

Properties

pitchDegrees

pitchDegrees: number

Consider an aircraft: "Pitch" is defined as "nose up/down about the axis running from wing to wing". Negative pitch means that the aircraft moves its nose closer to the ground. Positive pitch means that the aircraft moves its nose away from the ground. Units here are degrees.

rollDegrees

rollDegrees: number

Consider an aircraft: "Roll" is defined as "rotation about the axis running from nose to tail". Positive roll means that the aircraft's right wing will move closer to the ground. Negative roll means that the aircraft's left wing will move closer to the ground. Units here are degrees.

yawDegrees

yawDegrees: number

Consider an aircraft: "Yaw" is defined as "nose left/right about the axis running up and down". Negative yaw means that the aircraft will rotate clockwise when viewing the aircraft from above. Positive yaw means that the aircraft will rotate counter-clockwise when viewing the aircraft from above. Units here are degrees.