Graphene-1.0 ▶ Graphene ▶ QuaternionSince 1.0

constructor

• new Quaternion(properties?: Partial<{}>): Quaternion

  Parameters

  • Optionalproperties: Partial<{}>

  Returns Quaternion

Static$gtype

Since 1.10add

• add(b: Quaternion): Quaternion

  Adds two Graphene.Quaternion a and b.

  Parameters

  • b: Quaternion

    a Graphene.Quaternion

  Returns Quaternion

  Since

  1.10

Since 1.0dot

• dot(b: Quaternion): number

  Computes the dot product of two Graphene.Quaternion.

  Parameters

  • b: Quaternion

    a Graphene.Quaternion

  Returns number

  the value of the dot products

  Since

  1.0

Since 1.0equal

• equal(b: Quaternion): boolean

  Checks whether the given quaternions are equal.

  Parameters

  • b: Quaternion

    a Graphene.Quaternion

  Returns boolean

  true if the quaternions are equal

  Since

  1.0

Since 1.0free

• free(): void

  Releases the resources allocated by graphene_quaternion_alloc().

  Returns void

  Since

  1.0

Since 1.0init

• init(x: number, y: number, z: number, w: number): Quaternion

  Initializes a Graphene.Quaternion 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 Quaternion

  the initialized quaternion

  Since

  1.0

Since 1.0init_from_angle_vec3

• init_from_angle_vec3(angle: number, axis: Vec3): Quaternion

  Initializes a Graphene.Quaternion using an angle on a specific axis.

  Parameters

  • angle: number

    the rotation on a given axis, in degrees

  • axis: Vec3

    the axis of rotation, expressed as a vector

  Returns Quaternion

  the initialized quaternion

  Since

  1.0

Since 1.0init_from_angles

• init_from_angles(deg_x: number, deg_y: number, deg_z: number): Quaternion

  Initializes a Graphene.Quaternion 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 Quaternion

  the initialized quaternion

  Since

  1.0

Since 1.2init_from_euler

• init_from_euler(e: Euler): Quaternion

  Initializes a Graphene.Quaternion using the given Graphene.Euler.

  Parameters

  • e: Euler

    a Graphene.Euler

  Returns Quaternion

  the initialized Graphene.Quaternion

  Since

  1.2

Since 1.0init_from_matrix

• init_from_matrix(m: Graphene.Matrix): Quaternion

  Initializes a Graphene.Quaternion using the rotation components of a transformation matrix.

  Parameters

  • m: Graphene.Matrix

    a Graphene.Matrix

  Returns Quaternion

  the initialized quaternion

  Since

  1.0

Since 1.0init_from_quaternion

• init_from_quaternion(src: Quaternion): Quaternion

  Initializes a Graphene.Quaternion with the values from src.

  Parameters

  • src: Quaternion

    a Graphene.Quaternion

  Returns Quaternion

  the initialized quaternion

  Since

  1.0

Since 1.0init_from_radians

• init_from_radians(rad_x: number, rad_y: number, rad_z: number): Quaternion

  Initializes a Graphene.Quaternion 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 Quaternion

  the initialized quaternion

  Since

  1.0

Since 1.0init_from_vec4

• init_from_vec4(src: Vec4): Quaternion

  Initializes a Graphene.Quaternion with the values from src.

  Parameters

  • src: Vec4

    a Graphene.Vec4

  Returns Quaternion

  the initialized quaternion

  Since

  1.0

Since 1.0init_identity

• init_identity(): Quaternion

  Initializes a Graphene.Quaternion using the identity transformation.

  Returns Quaternion

  the initialized quaternion

  Since

  1.0

Since 1.0invert

• invert(): Quaternion

  Inverts a Graphene.Quaternion, and returns the conjugate quaternion of q.

  Returns Quaternion

  Since

  1.0

Since 1.10multiply

• multiply(b: Quaternion): Quaternion

  Multiplies two Graphene.Quaternion a and b.

  Parameters

  • b: Quaternion

    a Graphene.Quaternion

  Returns Quaternion

  Since

  1.10

Since 1.0normalize

• normalize(): Quaternion

  Normalizes a Graphene.Quaternion.

  Returns Quaternion

  Since

  1.0

Since 1.10scale

• scale(factor: number): Quaternion

  Scales all the elements of a Graphene.Quaternion q using the given scalar factor.

  Parameters

  • factor: number

    a scaling factor

  Returns Quaternion

  Since

  1.10

Since 1.0slerp

• slerp(b: Quaternion, factor: number): Quaternion

  Interpolates between the two given quaternions using a spherical linear interpolation, or SLERP, using the given interpolation factor.

  Parameters

  • b: Quaternion

    a Graphene.Quaternion

  • factor: number

    the linear interpolation factor

  Returns Quaternion

  Since

  1.0

Since 1.0to_angle_vec3

• to_angle_vec3(): [number, Vec3]

  Converts a quaternion into an angle, axis pair.

  Returns [number, Vec3]

  Since

  1.0

Since 1.2to_angles

• to_angles(): [number, number, number]

  Converts a Graphene.Quaternion to its corresponding rotations on the Euler angles on each axis.

  Returns [number, number, number]

  Since

  1.2

Since 1.0to_matrix

• to_matrix(): Graphene.Matrix

  Converts a quaternion into a transformation matrix expressing the rotation defined by the Graphene.Quaternion.

  Returns Graphene.Matrix

  Since

  1.0

Since 1.2to_radians

• to_radians(): [number, number, number]

  Converts a Graphene.Quaternion to its corresponding rotations on the Euler angles on each axis.

  Returns [number, number, number]

  Since

  1.2

Since 1.0to_vec4

• to_vec4(): Vec4

  Copies the components of a Graphene.Quaternion into a Graphene.Vec4.

  Returns Vec4

  Since

  1.0

Staticalloc

• alloc(): Quaternion

  Returns Quaternion