Graphene-1.0 ▶ Graphene ▶ EulerSince 1.2

constructor

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

  Parameters

  • Optionalproperties: Partial<{}>

  Returns Euler

Static$gtype

equal

• equal(b: Euler): boolean

  Checks if two Graphene.Euler are equal.

  Parameters

  • b: Euler

    a Graphene.Euler

  Returns boolean

  true if the two Graphene.Euler are equal

free

• free(): void

  Frees the resources allocated by graphene_euler_alloc().

  Returns void

get_alpha

• get_alpha(): number

  Retrieves the first component of the Euler angle vector, depending on the order of rotation.

  See also: graphene_euler_get_x()

  Returns number

  the first component of the Euler angle vector, in radians

get_beta

• get_beta(): number

  Retrieves the second component of the Euler angle vector, depending on the order of rotation.

  See also: graphene_euler_get_y()

  Returns number

  the second component of the Euler angle vector, in radians

get_gamma

• get_gamma(): number

  Retrieves the third component of the Euler angle vector, depending on the order of rotation.

  See also: graphene_euler_get_z()

  Returns number

  the third component of the Euler angle vector, in radians

get_order

• get_order(): EulerOrder

  Retrieves the order used to apply the rotations described in the Graphene.Euler structure, when converting to and from other structures, like Graphene.Quaternion and Graphene.Matrix.

  This function does not return the Graphene.EulerOrder.DEFAULT enumeration value; it will return the effective order of rotation instead.

  Returns EulerOrder

  the order used to apply the rotations

get_x

• get_x(): number

  Retrieves the rotation angle on the X axis, in degrees.

  Returns number

  the rotation angle

get_y

• get_y(): number

  Retrieves the rotation angle on the Y axis, in degrees.

  Returns number

  the rotation angle

get_z

• get_z(): number

  Retrieves the rotation angle on the Z axis, in degrees.

  Returns number

  the rotation angle

init

• init(x: number, y: number, z: number): Euler

  Initializes a Graphene.Euler using the given angles.

  The order of the rotations is Graphene.EulerOrder.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 Euler

  the initialized Graphene.Euler

init_from_euler

• init_from_euler(src?: Euler): Euler

  Initializes a Graphene.Euler using the angles and order of another Graphene.Euler.

  If the Graphene.Euler src is null, this function is equivalent to calling graphene_euler_init() with all angles set to 0.

  Parameters

  • Optionalsrc: Euler

    a Graphene.Euler

  Returns Euler

  the initialized Graphene.Euler

init_from_matrix

• init_from_matrix(m: Graphene.Matrix, order: EulerOrder): Euler

  Initializes a Graphene.Euler using the given rotation matrix.

  If the Graphene.Matrix m is null, the Graphene.Euler 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 Euler

  the initialized Graphene.Euler

init_from_quaternion

• init_from_quaternion(q: Quaternion, order: EulerOrder): Euler

  Initializes a Graphene.Euler using the given normalized quaternion.

  If the Graphene.Quaternion q is null, the Graphene.Euler will be initialized with all angles set to 0.

  Parameters

  • q: Quaternion

    a normalized Graphene.Quaternion

  • order: EulerOrder

    the order used to apply the rotations

  Returns Euler

  the initialized Graphene.Euler

init_from_radians

• init_from_radians(x: number, y: number, z: number, order: EulerOrder): Euler

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

  the initialized Graphene.Euler

init_from_vec3

• init_from_vec3(v: Vec3, order: EulerOrder): Euler

  Initializes a Graphene.Euler using the angles contained in a Graphene.Vec3.

  If the Graphene.Vec3 v is null, the Graphene.Euler will be initialized with all angles set to 0.

  Parameters

  • v: Vec3

    a Graphene.Vec3 containing the rotation angles in degrees

  • order: EulerOrder

    the order used to apply the rotations

  Returns Euler

  the initialized Graphene.Euler

init_with_order

• init_with_order(x: number, y: number, z: number, order: EulerOrder): Euler

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

  the initialized Graphene.Euler

reorder

• reorder(order: EulerOrder): Euler

  Reorders a Graphene.Euler using order.

  This function is equivalent to creating a Graphene.Quaternion from the given Graphene.Euler, and then converting the quaternion into another Graphene.Euler.

  Parameters

  • order: EulerOrder

    the new order

  Returns Euler

to_matrix

• to_matrix(): Graphene.Matrix

  Converts a Graphene.Euler 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; for instance, if the order used to initialize e is Graphene.EulerOrder.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

to_quaternion

• to_quaternion(): Quaternion

  Converts a Graphene.Euler into a Graphene.Quaternion.

  Returns Quaternion

to_vec3

• to_vec3(): Vec3

  Retrieves the angles of a Graphene.Euler and initializes a Graphene.Vec3 with them.

  Returns Vec3

Staticalloc

• alloc(): Euler

  Returns Euler