@novorender/api / PitchRollYawOrientation

Class: PitchRollYawOrientation

Defined in: @novorender/src/web_app/controller/orientation.ts:14

A 3D rotation expressed as pitch, roll and yaw angles.

See

https://en.wikipedia.org/wiki/Aircraft_principal_axes

Accessors

pitch

Get Signature

get pitch(): number;

Defined in: @novorender/src/web_app/controller/orientation.ts:32

Pitch angle, in degrees.

Returns

number

Set Signature

set pitch(value): void;

Defined in: @novorender/src/web_app/controller/orientation.ts:35

Parameters

Parameter	Type
value	number

Returns

void

---

roll

Get Signature

get roll(): number;

Defined in: @novorender/src/web_app/controller/orientation.ts:44

Roll angle, in degrees.

Returns

number

Set Signature

set roll(value): void;

Defined in: @novorender/src/web_app/controller/orientation.ts:47

Parameters

Parameter	Type
value	number

Returns

void

---

rotation

Get Signature

get rotation(): ReadonlyQuat;

Defined in: @novorender/src/web_app/controller/orientation.ts:77

Rotation expressed as a quaternion.

Remarks

The rotation will return a new object if after pitch, roll or yaw angles have changed since last time this accessor was called. Othewise, it returns the previous, cached, object. This enables strict equality to determine when the rotation remains unchanged.

See

https://glmatrix.net/docs/module-quat.html

Returns

ReadonlyQuat

---

yaw

Get Signature

get yaw(): number;

Defined in: @novorender/src/web_app/controller/orientation.ts:57

Yaw angle, in degrees.

Returns

number

Set Signature

set yaw(value): void;

Defined in: @novorender/src/web_app/controller/orientation.ts:60

Parameters

Parameter	Type
value	number

Returns

void

Constructors

Constructor

new PitchRollYawOrientation(
   pitch, 
   yaw, 
   roll): PitchRollYawOrientation;

Defined in: @novorender/src/web_app/controller/orientation.ts:25

Parameters

Parameter	Type	Default value	Description
pitch	number	0	Pitch angle, in degrees.
yaw	number	0	Yaw angle, in degrees.
roll	number	0	Roll angle, in degrees.

Returns

PitchRollYawOrientation

Methods

decomposeRotation()

decomposeRotation(rot): void;

Defined in: @novorender/src/web_app/controller/orientation.ts:87

Set pitch, roll and yaw angles from rotation quaternion.

Parameters

Parameter	Type	Description
rot	ReadonlyQuat	The rotation quaternion to decompose into angles.

Returns

void