Class Euler

Serializable THREE.js Euler

Hierarchy-Diagram

UML class diagram of Euler

Legend

icon for a class in the UML class diagram

class

Hierarchy

Euler
- Euler

Index

Constructors

Properties

_onChangeCallback isEuler order x y z DEFAULT_ORDER

Accessors

Methods

[iterator] _onChange clone copy equals fromArray reorder set setFromQuaternion setFromRotationMatrix setFromVector3 toArray toRotationMatrix toVector toVector3 fromQuaternion fromRotationMatrix

Constructors

constructor

new Euler(x?: number, y?: number, z?: number, order?: EulerOrder, unit?: AngleUnit): Euler
Parameters
- Optional x: number
- Optional y: number
- Optional z: number
- Optional order: EulerOrder
- Optional unit: AngleUnit
Returns Euler
Overrides THREE.Euler.constructor
- Defined in src/utils/math/Euler.ts:12

Properties

_onChangeCallback

_onChangeCallback: (() => void)

Type declaration

- (): void
- Returns void

`Readonly` isEuler

isEuler: true

order

order: EulerOrder

Default

THREE.Euler.DEFAULT_ORDER

x

x: number

y

y: number

z

z: number

`Static` DEFAULT_ORDER

DEFAULT_ORDER: "XYZ"

Accessors

pitch

get pitch(): number
Get pitch in degrees

Returns
Pitch in degrees

Returns number
- Defined in src/utils/math/Euler.ts:101

roll

get roll(): number
Get roll in degrees

Returns
Roll in degrees

Returns number
- Defined in src/utils/math/Euler.ts:110

yaw

get yaw(): number
Get yaw in degrees

Returns
Yaw in degrees

Returns number
- Defined in src/utils/math/Euler.ts:119

Methods

[iterator]

[iterator](): Generator<string | number, void, unknown>
Returns Generator<string | number, void, unknown>
Inherited from [email protected]@278
- Defined in src/three/math/Euler.d.ts:47

_onChange

_onChange(callback: (() => void)): Euler
Parameters
- callback: (() => void)
  - - (): void
    - Returns void
Returns Euler
Inherited from THREE.Euler._onChange
- Defined in src/three/math/Euler.d.ts:43

clone

clone(): Euler
Returns Euler
Overrides THREE.Euler.clone
- Defined in src/utils/math/Euler.ts:123

copy

copy(euler: Euler): Euler
Parameters
- euler: Euler
Returns Euler
Inherited from THREE.Euler.copy
- Defined in src/three/math/Euler.d.ts:35

equals

equals(euler: Euler): boolean
Parameters
- euler: Euler
Returns boolean
Inherited from THREE.Euler.equals
- Defined in src/three/math/Euler.d.ts:40

fromArray

fromArray(xyzo: [number, number, number, EulerOrder?, ...any[]]): Euler
Parameters
- xyzo: [number, number, number, EulerOrder?, ...any[]]
Returns Euler
Inherited from THREE.Euler.fromArray
- Defined in src/three/math/Euler.d.ts:41

reorder

reorder(newOrder: EulerOrder): Euler
Parameters
- newOrder: EulerOrder
Returns Euler
Inherited from THREE.Euler.reorder
- Defined in src/three/math/Euler.d.ts:39

set

set(x: number, y: number, z: number, order?: EulerOrder): Euler
Parameters
- x: number
- y: number
- z: number
- Optional order: EulerOrder
Returns Euler
Inherited from THREE.Euler.set
- Defined in src/three/math/Euler.d.ts:33

setFromQuaternion

setFromQuaternion(q: Quaternion, order?: EulerOrder, update?: boolean): Euler
Parameters
- q: Quaternion
- Optional order: EulerOrder
- Optional update: boolean
Returns Euler
Inherited from THREE.Euler.setFromQuaternion
- Defined in src/three/math/Euler.d.ts:37

setFromRotationMatrix

setFromRotationMatrix(m: Matrix4, order?: EulerOrder, update?: boolean): Euler
Parameters
- m: Matrix4
- Optional order: EulerOrder
- Optional update: boolean
Returns Euler
Inherited from THREE.Euler.setFromRotationMatrix
- Defined in src/three/math/Euler.d.ts:36

setFromVector3

setFromVector3(v: Vector3, order?: EulerOrder): Euler
Parameters
- v: Vector3
- Optional order: EulerOrder
Returns Euler
Inherited from THREE.Euler.setFromVector3
- Defined in src/three/math/Euler.d.ts:38

toArray

toArray(array?: (string | number)[], offset?: number): (string | number)[]
Parameters
- Optional array: (string | number)[]
- Optional offset: number
Returns (string | number)[]
Inherited from THREE.Euler.toArray
- Defined in src/three/math/Euler.d.ts:42

toRotationMatrix

toRotationMatrix(): Matrix4
Convert quaternion to rotation matrix

Returns
Rotation matrix

Returns Matrix4
- Defined in src/utils/math/Euler.ts:92

toVector

toVector(unit??: AngleUnit): Vector3
Convert the Euler angles to a vector

Returns
Vector output of Euler angles
Parameters
- Optional unit: AngleUnit = AngleUnit.RADIAN
  
  Angle unit to use in vector
Returns Vector3
- Defined in src/utils/math/Euler.ts:68

toVector3

toVector3(unit?: AngleUnit): Vector3
Convert the Euler angles to a vector

Deprecated
use toVector

Returns
Vector output of Euler angles
Parameters
- Optional unit: AngleUnit
  
  Angle unit to use in vector
Returns Vector3
- Defined in src/utils/math/Euler.ts:83

`Static` fromQuaternion

fromQuaternion(quat: Quaternion, order??: EulerOrder): Euler
Convert quaternion to euler

Returns
Euler instance
Parameters
- quat: Quaternion
  
  Quaternion
- Optional order: EulerOrder = 'XYZ'
  
  Euler order
Returns Euler
- Defined in src/utils/math/Euler.ts:43

`Static` fromRotationMatrix

fromRotationMatrix(matrix: Matrix4, order??: EulerOrder): Euler
Convert rotation matrix to euler

Returns
Euler instance
Parameters
- matrix: Matrix4
  
  Rotation matrix
- Optional order: EulerOrder = 'XYZ'
  
  Euler order
Returns Euler
- Defined in src/utils/math/Euler.ts:56