Class Quaternion

A quaternion.

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

record

Hierarchy

Quaternion

Index

Constructors

constructor

new Quaternion(): Graphene.Quaternion

Returns Graphene.Quaternion

Properties

Static name

name: string

Methods

add

add(b: Graphene.Quaternion): Graphene.Quaternion

- Defined in @types/Gjs/Graphene-1.0.d.ts:1810
Adds two #graphene_quaternion_t a and b.

Parameters
- b: Graphene.Quaternion
  
  a #graphene_quaternion_t
Returns Graphene.Quaternion

dot

dot(b: Graphene.Quaternion): number

- Defined in @types/Gjs/Graphene-1.0.d.ts:1815
Computes the dot product of two #graphene_quaternion_t.

Parameters
- b: Graphene.Quaternion
  
  a #graphene_quaternion_t
Returns number

equal

equal(b: Graphene.Quaternion): boolean

- Defined in @types/Gjs/Graphene-1.0.d.ts:1820
Checks whether the given quaternions are equal.

Parameters
- b: Graphene.Quaternion
  
  a #graphene_quaternion_t
Returns boolean

free

free(): void

- Defined in @types/Gjs/Graphene-1.0.d.ts:1824
Releases the resources allocated by graphene_quaternion_alloc().

Returns void

init

init(x: number, y: number, z: number, w: number): Graphene.Quaternion

- Defined in @types/Gjs/Graphene-1.0.d.ts:1832
Initializes a #graphene_quaternion_t using the given four values.

Parameters
- x: number
  
  the first component of the quaternion
- y: number
  
  the second component of the quaternion
- z: number
  
  the third component of the quaternion
- w: number
  
  the fourth component of the quaternion
Returns Graphene.Quaternion

init_from_angle_vec3

init_from_angle_vec3(angle: number, axis: Graphene.Vec3): Graphene.Quaternion

- Defined in @types/Gjs/Graphene-1.0.d.ts:1839
Initializes a #graphene_quaternion_t using an angle on a specific axis.

Parameters
- angle: number
  
  the rotation on a given axis, in degrees
- axis: Graphene.Vec3
  
  the axis of rotation, expressed as a vector
Returns Graphene.Quaternion

init_from_angles

init_from_angles(deg_x: number, deg_y: number, deg_z: number): Graphene.Quaternion

- Defined in @types/Gjs/Graphene-1.0.d.ts:1850
Initializes a #graphene_quaternion_t using the values of the Euler angles on each axis.

See also: graphene_quaternion_init_from_euler()

Parameters
- deg_x: number
  
  rotation angle on the X axis (yaw), in degrees
- deg_y: number
  
  rotation angle on the Y axis (pitch), in degrees
- deg_z: number
  
  rotation angle on the Z axis (roll), in degrees
Returns Graphene.Quaternion

init_from_euler

init_from_euler(e: Graphene.Euler): Graphene.Quaternion

- Defined in @types/Gjs/Graphene-1.0.d.ts:1855
Initializes a #graphene_quaternion_t using the given #graphene_euler_t.

Parameters
- e: Graphene.Euler
  
  a #graphene_euler_t
Returns Graphene.Quaternion

init_from_matrix

init_from_matrix(m: Graphene.Matrix): Graphene.Quaternion

- Defined in @types/Gjs/Graphene-1.0.d.ts:1861
Initializes a #graphene_quaternion_t using the rotation components of a transformation matrix.

Parameters
- m: Graphene.Matrix
  
  a #graphene_matrix_t
Returns Graphene.Quaternion

init_from_quaternion

init_from_quaternion(src: Graphene.Quaternion): Graphene.Quaternion

- Defined in @types/Gjs/Graphene-1.0.d.ts:1866
Initializes a #graphene_quaternion_t with the values from src.

Parameters
- src: Graphene.Quaternion
  
  a #graphene_quaternion_t
Returns Graphene.Quaternion

init_from_radians

init_from_radians(rad_x: number, rad_y: number, rad_z: number): Graphene.Quaternion

- Defined in @types/Gjs/Graphene-1.0.d.ts:1877
Initializes a #graphene_quaternion_t using the values of the Euler angles on each axis.

See also: graphene_quaternion_init_from_euler()

Parameters
- rad_x: number
  
  rotation angle on the X axis (yaw), in radians
- rad_y: number
  
  rotation angle on the Y axis (pitch), in radians
- rad_z: number
  
  rotation angle on the Z axis (roll), in radians
Returns Graphene.Quaternion

init_from_vec4

init_from_vec4(src: Vec4): Graphene.Quaternion

- Defined in @types/Gjs/Graphene-1.0.d.ts:1882
Initializes a #graphene_quaternion_t with the values from src.

Parameters
- src: Vec4
  
  a #graphene_vec4_t
Returns Graphene.Quaternion

init_identity

init_identity(): Graphene.Quaternion

- Defined in @types/Gjs/Graphene-1.0.d.ts:1887
Initializes a #graphene_quaternion_t using the identity transformation.

Returns Graphene.Quaternion

invert

invert(): Graphene.Quaternion

- Defined in @types/Gjs/Graphene-1.0.d.ts:1892
Inverts a #graphene_quaternion_t, and returns the conjugate quaternion of q.

Returns Graphene.Quaternion

multiply

multiply(b: Graphene.Quaternion): Graphene.Quaternion

- Defined in @types/Gjs/Graphene-1.0.d.ts:1897
Multiplies two #graphene_quaternion_t a and b.

Parameters
- b: Graphene.Quaternion
  
  a #graphene_quaternion_t
Returns Graphene.Quaternion

normalize

normalize(): Graphene.Quaternion

- Defined in @types/Gjs/Graphene-1.0.d.ts:1901
Normalizes a #graphene_quaternion_t.

Returns Graphene.Quaternion

scale

scale(factor: number): Graphene.Quaternion

- Defined in @types/Gjs/Graphene-1.0.d.ts:1907
Scales all the elements of a #graphene_quaternion_t q using the given scalar factor.

Parameters
- factor: number
  
  a scaling factor
Returns Graphene.Quaternion

slerp

slerp(b: Graphene.Quaternion, factor: number): Graphene.Quaternion

- Defined in @types/Gjs/Graphene-1.0.d.ts:1915
Interpolates between the two given quaternions using a spherical linear interpolation, or SLERP, using the given interpolation factor.

Parameters
- b: Graphene.Quaternion
  
  a #graphene_quaternion_t
- factor: number
  
  the linear interpolation factor
Returns Graphene.Quaternion

to_angle_vec3

to_angle_vec3(): [number, Graphene.Vec3]

- Defined in @types/Gjs/Graphene-1.0.d.ts:1919
Converts a quaternion into an angle, axis pair.

Returns [number, Graphene.Vec3]

to_angles

to_angles(): [number, number, number]

- Defined in @types/Gjs/Graphene-1.0.d.ts:1925
Converts a #graphene_quaternion_t to its corresponding rotations on the Euler angles on each axis.

Returns [number, number, number]

to_matrix

to_matrix(): Graphene.Matrix

- Defined in @types/Gjs/Graphene-1.0.d.ts:1930
Converts a quaternion into a transformation matrix expressing the rotation defined by the #graphene_quaternion_t.

Returns Graphene.Matrix

to_radians

to_radians(): [number, number, number]

- Defined in @types/Gjs/Graphene-1.0.d.ts:1936
Converts a #graphene_quaternion_t to its corresponding rotations on the Euler angles on each axis.

Returns [number, number, number]

to_vec4

to_vec4(): Vec4

- Defined in @types/Gjs/Graphene-1.0.d.ts:1941
Copies the components of a #graphene_quaternion_t into a #graphene_vec4_t.

Returns Vec4

Static alloc

alloc(): Graphene.Quaternion

- Defined in @types/Gjs/Graphene-1.0.d.ts:1965
Allocates a new #graphene_quaternion_t.

The contents of the returned value are undefined.

Returns Graphene.Quaternion