Class Euler

Describe a rotation using Euler angles.

The contents of the #graphene_euler_t structure are private and should never be accessed directly.

record

Hierarchy

Euler

Index

Constructors

constructor

Properties

name

Methods

Constructors

constructor

new Euler(): Graphene.Euler

Returns Graphene.Euler

Properties

Static name

name: string

Methods

equal

equal(b: Graphene.Euler): boolean

- Defined in Graphene-1.0.d.ts:573
Checks if two #graphene_euler_t are equal.

Parameters
- b: Graphene.Euler
  
  a #graphene_euler_t
Returns boolean

free

free(): void

- Defined in Graphene-1.0.d.ts:577
Frees the resources allocated by graphene_euler_alloc().

Returns void

getAlpha

getAlpha(): number

- Defined in Graphene-1.0.d.ts:584
Retrieves the first component of the Euler angle vector, depending on the order of rotation.

See also: graphene_euler_get_x()

Returns number

getBeta

getBeta(): number

- Defined in Graphene-1.0.d.ts:591
Retrieves the second component of the Euler angle vector, depending on the order of rotation.

See also: graphene_euler_get_y()

Returns number

getGamma

getGamma(): number

- Defined in Graphene-1.0.d.ts:598
Retrieves the third component of the Euler angle vector, depending on the order of rotation.

See also: graphene_euler_get_z()

Returns number

getOrder

getOrder(): EulerOrder

- Defined in Graphene-1.0.d.ts:608
Retrieves the order used to apply the rotations described in the #graphene_euler_t structure, when converting to and from other structures, like #graphene_quaternion_t and #graphene_matrix_t.

This function does not return the %GRAPHENE_EULER_ORDER_DEFAULT enumeration value; it will return the effective order of rotation instead.

Returns EulerOrder

getX

getX(): number

- Defined in Graphene-1.0.d.ts:612
Retrieves the rotation angle on the X axis, in degrees.

Returns number

getY

getY(): number

- Defined in Graphene-1.0.d.ts:616
Retrieves the rotation angle on the Y axis, in degrees.

Returns number

getZ

getZ(): number

- Defined in Graphene-1.0.d.ts:620
Retrieves the rotation angle on the Z axis, in degrees.

Returns number

init

init(x: number, y: number, z: number): Graphene.Euler

- Defined in Graphene-1.0.d.ts:629
Initializes a #graphene_euler_t using the given angles.

The order of the rotations is %GRAPHENE_EULER_ORDER_DEFAULT.

Parameters
- x: number
  
  rotation angle on the X axis, in degrees
- y: number
  
  rotation angle on the Y axis, in degrees
- z: number
  
  rotation angle on the Z axis, in degrees
Returns Graphene.Euler

initFromEuler

initFromEuler(src: Graphene.Euler): Graphene.Euler

- Defined in Graphene-1.0.d.ts:638
Initializes a #graphene_euler_t using the angles and order of another #graphene_euler_t.

If the #graphene_euler_t src is %NULL, this function is equivalent to calling graphene_euler_init() with all angles set to 0.

Parameters
- src: Graphene.Euler
  
  a #graphene_euler_t
Returns Graphene.Euler

initFromMatrix

initFromMatrix(m: Graphene.Matrix, order: EulerOrder): Graphene.Euler

- Defined in Graphene-1.0.d.ts:647
Initializes a #graphene_euler_t using the given rotation matrix.

If the #graphene_matrix_t m is %NULL, the #graphene_euler_t will be initialized with all angles set to 0.

Parameters
- m: Graphene.Matrix
  
  a rotation matrix
- order: EulerOrder
  
  the order used to apply the rotations
Returns Graphene.Euler

initFromQuaternion

initFromQuaternion(q: Graphene.Quaternion, order: EulerOrder): Graphene.Euler

- Defined in Graphene-1.0.d.ts:656
Initializes a #graphene_euler_t using the given normalized quaternion.

If the #graphene_quaternion_t q is %NULL, the #graphene_euler_t will be initialized with all angles set to 0.

Parameters
- q: Graphene.Quaternion
  
  a normalized #graphene_quaternion_t
- order: EulerOrder
  
  the order used to apply the rotations
Returns Graphene.Euler

initFromRadians

initFromRadians(x: number, y: number, z: number, order: EulerOrder): Graphene.Euler

- Defined in Graphene-1.0.d.ts:665
Initializes a #graphene_euler_t using the given angles and order of rotation.

Parameters
- x: number
  
  rotation angle on the X axis, in radians
- y: number
  
  rotation angle on the Y axis, in radians
- z: number
  
  rotation angle on the Z axis, in radians
- order: EulerOrder
  
  order of rotations
Returns Graphene.Euler

initFromVec3

initFromVec3(v: Graphene.Vec3, order: EulerOrder): Graphene.Euler

- Defined in Graphene-1.0.d.ts:675
Initializes a #graphene_euler_t using the angles contained in a #graphene_vec3_t.

If the #graphene_vec3_t v is %NULL, the #graphene_euler_t will be initialized with all angles set to 0.

Parameters
- v: Graphene.Vec3
  
  a #graphene_vec3_t containing the rotation angles in degrees
- order: EulerOrder
  
  the order used to apply the rotations
Returns Graphene.Euler

initWithOrder

initWithOrder(x: number, y: number, z: number, order: EulerOrder): Graphene.Euler

- Defined in Graphene-1.0.d.ts:683
Initializes a #graphene_euler_t with the given angles and order.

Parameters
- x: number
  
  rotation angle on the X axis, in degrees
- y: number
  
  rotation angle on the Y axis, in degrees
- z: number
  
  rotation angle on the Z axis, in degrees
- order: EulerOrder
  
  the order used to apply the rotations
Returns Graphene.Euler

reorder

reorder(order: EulerOrder): Graphene.Euler

- Defined in Graphene-1.0.d.ts:692
Reorders a #graphene_euler_t using order.

This function is equivalent to creating a #graphene_quaternion_t from the given #graphene_euler_t, and then converting the quaternion into another #graphene_euler_t.

Parameters
- order: EulerOrder
  
  the new order
Returns Graphene.Euler

toMatrix

toMatrix(): Graphene.Matrix

- Defined in Graphene-1.0.d.ts:711
Converts a #graphene_euler_t into a transformation matrix expressing the extrinsic composition of rotations described by the Euler angles.
The rotations are applied over the reference frame axes in the order associated with the #graphene_euler_t; for instance, if the order used to initialize e is %GRAPHENE_EULER_ORDER_XYZ:
- the first rotation moves the body around the X axis with an angle φ
- the second rotation moves the body around the Y axis with an angle of ϑ
- the third rotation moves the body around the Z axis with an angle of ψ
The rotation sign convention is right-handed, to preserve compatibility between Euler-based, quaternion-based, and angle-axis-based rotations.
Returns Graphene.Matrix

toQuaternion

toQuaternion(): Graphene.Quaternion

- Defined in Graphene-1.0.d.ts:715
Converts a #graphene_euler_t into a #graphene_quaternion_t.

Returns Graphene.Quaternion

toVec3

toVec3(): Graphene.Vec3

- Defined in Graphene-1.0.d.ts:720
Retrieves the angles of a #graphene_euler_t and initializes a #graphene_vec3_t with them.

Returns Graphene.Vec3

Static alloc

alloc(): Graphene.Euler

- Defined in Graphene-1.0.d.ts:744
Allocates a new #graphene_euler_t.

The contents of the returned structure are undefined.

Returns Graphene.Euler

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Graphene.Euler

Properties

Static name

Methods

equal

Parameters

b: Graphene.Euler

Returns boolean

free

Returns void

getAlpha

Returns number

getBeta

Returns number

getGamma

Returns number

getOrder

Returns EulerOrder

getX

Returns number

getY

Returns number

getZ

Returns number

init

Parameters

x: number

y: number

z: number

Returns Graphene.Euler

initFromEuler

Parameters

src: Graphene.Euler

Returns Graphene.Euler

initFromMatrix

Parameters

m: Graphene.Matrix

order: EulerOrder

Returns Graphene.Euler

initFromQuaternion

Parameters

q: Graphene.Quaternion

order: EulerOrder

Returns Graphene.Euler

initFromRadians

Parameters

x: number

y: number

z: number

order: EulerOrder

Returns Graphene.Euler

initFromVec3

Parameters

v: Graphene.Vec3

order: EulerOrder

Returns Graphene.Euler

initWithOrder

Parameters

x: number

y: number

z: number

order: EulerOrder

Returns Graphene.Euler

reorder

Parameters

order: EulerOrder

Returns Graphene.Euler

toMatrix

Returns Graphene.Matrix

toQuaternion

Returns Graphene.Quaternion

toVec3

Returns Graphene.Vec3