Class Euler

Serializable THREE.js Euler

Hierarchy-Diagram

Legend

class

Hierarchy

Euler
- Euler

Index

Constructors

constructor

new Euler(x?, y?, z?, order?, unit?): 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 number
Pitch in degrees
- Defined in src/utils/math/Euler.ts:95

roll

get roll(): number
Get roll in degrees

Returns number
Roll in degrees
- Defined in src/utils/math/Euler.ts:103

yaw

get yaw(): number
Get yaw in degrees

Returns number
Yaw in degrees
- Defined in src/utils/math/Euler.ts:111

Methods

[iterator]

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

_onChange

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

clone

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

copy

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

equals

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

fromArray

fromArray(xyzo): 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): Euler
Parameters
- newOrder: EulerOrder
Returns Euler
Inherited from THREE.Euler.reorder
- Defined in src/three/math/Euler.d.ts:39

set

set(x, y, z, order?): 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, order?, update?): 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, order?, update?): 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, order?): 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?, offset?): (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 Matrix4
Rotation matrix
- Defined in src/utils/math/Euler.ts:87

toVector

toVector(unit?): Vector3
Convert the Euler angles to a vector
Parameters
- Optional unit: AngleUnit = AngleUnit.RADIAN
  Angle unit to use in vector
Returns Vector3
Vector output of Euler angles
- Defined in src/utils/math/Euler.ts:65

toVector3

toVector3(unit?): Vector3
Convert the Euler angles to a vector
Parameters
- Optional unit: AngleUnit
  Angle unit to use in vector
Returns Vector3
Vector output of Euler angles

Deprecated
use Euler.toVector
- Defined in src/utils/math/Euler.ts:79

`Static` fromQuaternion

fromQuaternion(quat, order?): Euler
Convert quaternion to euler
Parameters
- quat: Quaternion
  Quaternion
- Optional order: EulerOrder = 'XYZ'
  Euler order
Returns Euler
Euler instance
- Defined in src/utils/math/Euler.ts:42

`Static` fromRotationMatrix

fromRotationMatrix(matrix, order?): Euler
Convert rotation matrix to euler
Parameters
- matrix: Matrix4
  Rotation matrix
- Optional order: EulerOrder = 'XYZ'
  Euler order
Returns Euler
Euler instance
- Defined in src/utils/math/Euler.ts:54

Class Euler

Hierarchy-Diagram

Legend

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional x: number

Optional y: number

Optional z: number

Optional order: EulerOrder

Optional unit: AngleUnit

Returns Euler

Properties

_onChangeCallback

Type declaration

Returns void

Readonly isEuler

order

Default

x

y

z

Static DEFAULT_ORDER

Accessors

pitch

Returns number

roll

Returns number

yaw

Returns number

Methods

[iterator]

Returns Generator<string | number, void, unknown>

_onChange

Parameters

callback: (() => void)

Returns void

Returns this

clone

Returns this

copy

Parameters

euler: Euler

Returns this

equals

Parameters

euler: Euler

Returns boolean

fromArray

Parameters

xyzo: [number, number, number, EulerOrder?, ...any[]]

Returns Euler

reorder

Parameters

newOrder: EulerOrder

Returns Euler

set

Parameters

x: number

y: number

z: number

Optional order: EulerOrder

Returns Euler

setFromQuaternion

Parameters

q: Quaternion

Optional order: EulerOrder

Optional update: boolean

Returns Euler

setFromRotationMatrix

Parameters

m: Matrix4

Optional order: EulerOrder

Optional update: boolean

`Optional` x: number

`Optional` y: number

`Optional` z: number

`Optional` order: EulerOrder

`Optional` unit: AngleUnit

`Readonly` isEuler

`Static` DEFAULT_ORDER

`Optional` order: EulerOrder

`Optional` order: EulerOrder

`Optional` update: boolean

`Optional` order: EulerOrder

`Optional` update: boolean

`Optional` order: EulerOrder

`Optional` array: (string | number)[]

`Optional` offset: number

`Optional` unit: AngleUnit = AngleUnit.RADIAN

`Optional` unit: AngleUnit

`Static` fromQuaternion

`Optional` order: EulerOrder = 'XYZ'

`Static` fromRotationMatrix

`Optional` order: EulerOrder = 'XYZ'