Class AcGeEuler

constructor

• new AcGeEuler(x?: number, y?: number, z?: number, order?: string): AcGeEuler

• Create one instance of this class

  Parameters

  • x: number = 0

    (optional) the angle of the x axis in radians. Default is 0.
  • y: number = 0

    (optional) the angle of the y axis in radians. Default is 0.
  • z: number = 0

    (optional) the angle of the z axis in radians. Default is 0.
  • order: string = AcGeEuler.DEFAULT_ORDER

    (optional) a string representing the order that the rotations are applied, defaults to 'XYZ' (must be upper case).

  Returns AcGeEuler

StaticDEFAULT_ORDER

order

• get order(): string

• The order in which to apply rotations. Default is 'XYZ', which means that the object will first be rotated around its X axis, then its Y axis and finally its Z axis. Other possibilities are: 'YZX', 'ZXY', 'XZY', 'YXZ' and 'ZYX'. These must be in upper case.

  It uses intrinsic Tait-Bryan angles. This means that rotations are performed with respect to the local coordinate system. That is, for order 'XYZ', the rotation is first around the local-X axis (which is the same as the world-X axis), then around local-Y (which may now be different from the world Y-axis), then local-Z (which may be different from the world Z-axis).

  Returns string
• set order(value: string): void

• Parameters

  • value: string

  Returns void

x

• get x(): number

• The current value of the x component.

  Returns number
• set x(value: number): void

• Parameters

  • value: number

  Returns void

y

• get y(): number

• The current value of the y component.

  Returns number
• set y(value: number): void

• Parameters

  • value: number

  Returns void

z

• get z(): number

• The current value of the z component.

  Returns number
• set z(value: number): void

• Parameters

  • value: number

  Returns void

_onChange

• _onChange(callback: () => void): AcGeEuler

• Trigger the specified callback function once this euler changes

  Parameters

  • callback: () => void

  Returns AcGeEuler

_onChangeCallback

• _onChangeCallback(): void

• Returns void

[iterator]

• "[iterator]"(): Generator<string | number, void, unknown>

• Returns Generator<string | number, void, unknown>

clone

• clone(): AcGeEuler

• Return a new Euler with the same parameters as this one.

  Returns AcGeEuler

  Return a new Euler with the same parameters as this one.

copy

• copy(euler: AcGeEuler): AcGeEuler

• Copy value of euler to this euler.

  Parameters

  • euler: AcGeEuler

    Input the eurler copied from

  Returns AcGeEuler

  Return this euler

equals

• equals(euler: AcGeEuler): boolean

• Check for strict equality of this euler and euler.

  Parameters

  • euler: AcGeEuler

    Input the euler to compare

  Returns boolean

  Return true if the specified euler and this euler represent the same rotation.

fromArray

• fromArray(array: (string | number)[]): AcGeEuler

• Set this euler from the specified array.

  Parameters

  • array: (string | number)[]

    Input an array of length 3 or 4. The optional 4th argument corresponds to the order.

    • Assign this euler's x angle to array[0].
    • Assign this euler's y angle to array[1].
    • Assign this euler's z angle to array[2].
    • Optionally assign this euler's order to array[3].

  Returns AcGeEuler

reorder

• reorder(newOrder: string): AcGeEuler

• Resets the euler angle with a new order by creating a quaternion from this euler angle and then setting this euler angle with the quaternion and the new order.

  Parameters

  • newOrder: string

    Input the new order that the rotations are applied.

  Returns AcGeEuler

  Return this euler

set

• set(x: number, y: number, z: number, order?: string): AcGeEuler

• Set the angles of this euler transform and optionally the order.

  Parameters

  • x: number

    (optional) the angle of the x axis in radians. Default is 0.
  • y: number

    (optional) the angle of the y axis in radians. Default is 0.
  • z: number

    (optional) the angle of the z axis in radians. Default is 0.
  • order: string = ...

    (optional) a string representing the order that the rotations are applied, defaults to 'XYZ' (must be upper case).

  Returns AcGeEuler

  Return this euler

setFromQuaternion

• setFromQuaternion(q: AcGeQuaternion, order: string, update?: boolean): AcGeEuler

• Set this urler from the specified quaternion.

  Parameters

  • q: AcGeQuaternion

    Input a normalized quaternion.
  • order: string

    (optional) a string representing the order that the rotations are applied. Sets the angles of this euler transform from a pure rotation matrix based on the orientation specified by order.
  • update: boolean = true

    Input one flag to indicate whether to trigger change callback function

  Returns AcGeEuler

  Return this euler

setFromRotationMatrix

• setFromRotationMatrix(
      m: AcGeMatrix3d,
      order?: string,
      update?: boolean,
  ): AcGeEuler

• Set this euler by exatracting rotation information from the specified matrix.

  Parameters

  • m: AcGeMatrix3d

    Input a Matrix4 of which the upper 3x3 of matrix is a pure rotation matrix (i.e. unscaled).
  • order: string = ...

    (optional) a string representing the order that the rotations are applied. Sets the angles of this euler transform from a pure rotation matrix based on the orientation specified by order.
  • update: boolean = true

    Input one flag to indicate whether to trigger change callback function

  Returns AcGeEuler

  Return this euler

setFromVector3

• setFromVector3(v: AcGeVector3d, order?: string): AcGeEuler

• Set the x, y and z, and optionally update the order.

  Parameters

  • v: AcGeVector3d

    Input one 3d vector
  • order: string = ...

    Input a optional string representing the order that the rotations are applied.

  Returns AcGeEuler

  Return this euler

toArray

• toArray(array?: (string | number)[], offset?: number): (string | number)[]

• Return an array of the form [x, y, z, order ].

  Parameters

  • array: (string | number)[] = []

    Input an optional array to store the euler in.
  • offset: number = 0

    Input an optional offset in the array.

  Returns (string | number)[]

  Return an array of the form [x, y, z, order].