Table of Contents
Chevron DownDeveloper Guide
Chevron DownAPI Reference

Euler (Experimental)

Note this class is experimental and may change or be removed in minor math.gl versions.

class Euler extends MathArray extends Array

A class to handle Euler rotation. More information on rotation using a Euler vector can be found here. Generally speaking the three components of the Euler object represents the roll, pitch and yaw angles and the rotation is applied according to a specific rotation order.

Usage

import {_Euler as Euler} from '@math.gl/core'

Constants

  • Euler.ZYX
  • Euler.YXZ
  • Euler.XZY
  • Euler.ZXY
  • Euler.YZX
  • Euler.XYZ
  • Euler.RollPitchYaw
  • Euler.DefaultOrder (= Euler.ZYX)
  • Euler.RotationOrders = ['ZYX', 'YXZ', 'XZY', 'ZXY', 'YZX', 'XYZ'];

Members

x, y z

x, y, z angle notation (note: only corresponds to axis in XYZ orientation)

roll, pitch, yaw

roll, pitch, yaw angle notation

alpha, beta, gamma

alpha, beta, gamma angle notation

phi, theta, psi

phi, theta, psi angle notation

order

rotation order in all notations

Methods

constructor

(x = 0, y = 0, z = 0, order = Euler.DefaultOrder)

  • Number|Number[], Number, Number, Number

fromRollPitchYaw

Common ZYX rotation order

euler.fromRollPitchYaw(roll, pitch, yaw)

fromRotationMatrix

euler.fromRotationMatrix(m, order = Euler.DefaultOrder)

fromQuaternion

euler.fromQuaternion(q, order)

copy

If copied array does contain fourth element, preserves currently set order.

euler.copy(array)

set

Sets the three angles, and optionally sets the rotation order. If order is not specified, preserves currently set order.

euler.set(x = 0, y = 0, z = 0, order)

toArray

Does not copy the orientation element

euler.toArray(array = [], offset = 0)

toArray4

Copies the orientation element

euler.toArray4(array = [], offset = 0)

toVector3

euler.toVector3(optionalResult)

fromVector3

euler.fromVector3(v, order)

fromArray

euler.fromArray(array, offset = 0)

getRotationMatrix

euler.getRotationMatrix(m = new Matrix4())

Returns Matrix4 - a rotation matrix corresponding to rotations per the specified euler angles

getQuaternion

euler.getQuaternion()

Remarks

  • Attribution: inspired by THREE.js THREE.Euler class