Class Matrix4x4

Stores a 4x4 transformation matrix and provides operations for it.

[ 0, 1, 2, 3 ] ← row vector x
[ 4, 5, 6, 7 ] ← row vector y
[ 8, 9,10,11 ] ← row vector z
[12,13,14,15 ] ← translation
           ↑  homogeneous column

Authors

Jascha Karagöl, HFU, 2019 | Jirka Dell'Oro-Friedl, HFU, 2019 | Jonas Plotzky, HFU, 2023

Hierarchy (view full)

Mutable
- Matrix4x4

Implements

Constructors

constructor

new Matrix4x4(): Matrix4x4
Returns Matrix4x4
Overrides Mutable.constructor
- Defined in Source/Core/Math/Matrix4x4.ts:28

Accessors

clone

get clone(): Matrix4x4
Creates and returns a clone of this matrix.

Returns Matrix4x4
- Defined in Source/Core/Math/Matrix4x4.ts:535

forward

get forward(): Vector3
Returns the normalized cardinal z-axis.

Returns Vector3
- Defined in Source/Core/Math/Matrix4x4.ts:526

quaternion

get quaternion(): Quaternion
- get: return a unit quaternion representing the rotation of this matrix. Caution! Use immediately and readonly, since the quaternion is going to be reused internally. Create a clone to keep longer and manipulate.
- set: effect the matrix
Returns Quaternion
- Defined in Source/Core/Math/Matrix4x4.ts:493
set quaternion(_quaternion): void
Parameters
- _quaternion: Quaternion
Returns void
- Defined in Source/Core/Math/Matrix4x4.ts:501

right

get right(): Vector3
Returns the normalized cardinal x-axis.

Returns Vector3
- Defined in Source/Core/Math/Matrix4x4.ts:508

rotation

get rotation(): Vector3
- get: return a vector representation of the rotation Vector3.
  Caution! Use immediately and readonly, since the vector is going to be reused internally. Create a clone to keep longer and manipulate.
- set: effect the matrix
Returns Vector3
- Defined in Source/Core/Math/Matrix4x4.ts:420
set rotation(_rotation): void
Parameters
- _rotation: Quaternion | Vector3
Returns void
- Defined in Source/Core/Math/Matrix4x4.ts:464

scaling

get scaling(): Vector3
- get: return a vector representation of the scaling Vector3.
  Caution! Use immediately and readonly, since the vector is going to be reused internally. Create a clone to keep longer and manipulate.
- set: effect the matrix
Returns Vector3
- Defined in Source/Core/Math/Matrix4x4.ts:473
set scaling(_scaling): void
Parameters
- _scaling: Vector3
Returns void
- Defined in Source/Core/Math/Matrix4x4.ts:484

translation

get translation(): Vector3
- get: return a vector representation of the translation Vector3.
  Caution! Use immediately and readonly, since the vector is going to be reused internally. Create a clone to keep longer and manipulate.
- set: effect the matrix ignoring its rotation and scaling
Returns Vector3
- Defined in Source/Core/Math/Matrix4x4.ts:404
set translation(_translation): void
Parameters
- _translation: Vector3
Returns void
- Defined in Source/Core/Math/Matrix4x4.ts:411

type

get type(): string
Retrieves the type of this mutable subclass as the name of the runtime class

Returns string
The type of the mutable
Inherited from Mutable.type
- Defined in Source/Core/Serialization/Mutable.ts:142

up

get up(): Vector3
Returns the normalized cardinal y-axis.

Returns Vector3
- Defined in Source/Core/Math/Matrix4x4.ts:517

Methods

addEventListener

addEventListener(_type, _handler, _options?): void
See EventTarget.addEventListener for reference. Works with EventListenerUnified and EventUnified
Parameters
- _type: string
- _handler: EventListenerUnified
- Optional _options: boolean | AddEventListenerOptions
Returns void
Inherited from Mutable.addEventListener
- Defined in Source/Core/Event/Event.ts:91

copy

copy(_original): Matrix4x4
Copies the state of the given matrix into this matrix.
Parameters
- _original: Matrix4x4
Returns Matrix4x4
- Defined in Source/Core/Math/Matrix4x4.ts:917

deserialize

deserialize(_serialization): Promise<Serializable>
Recreates this instance of Serializable with the information from the given Serialization.
Parameters
- _serialization: Serialization
Returns Promise<Serializable>
Implementation of Serializable.deserialize
- Defined in Source/Core/Math/Matrix4x4.ts:1023

dispatchEvent

dispatchEvent(_event): boolean
See EventTarget.dispatchEvent for reference. Works with with EventUnified
Parameters
- _event: EventUnified
Returns boolean
Inherited from Mutable.dispatchEvent
- Defined in Source/Core/Event/Event.ts:105

get

get(): Float32Array
Returns an array of the elements of this matrix.

Returns Float32Array
- Defined in Source/Core/Math/Matrix4x4.ts:944

getMetaAttributeTypes

getMetaAttributeTypes(): MetaAttributeTypes
Retrieves the specified attribute types from the metadata of this instance's class.

Returns MetaAttributeTypes
Inherited from Mutable.getMetaAttributeTypes
- Defined in Source/Core/Serialization/Mutable.ts:231

getMetadata

getMetadata(): Metadata
Retrieves the metadata of this instance's class.

Returns Metadata
Inherited from Mutable.getMetadata
- Defined in Source/Core/Serialization/Mutable.ts:238

getMutator

getMutator(): Mutator
Collect applicable attributes of the instance and copies of their values in a Mutator-object. By default, a mutator cannot be extended, since extensions are not available in the object the mutator belongs to. A mutator may be reduced by the descendants of Mutable to contain only the properties needed.

Returns Mutator
Overrides Mutable.getMutator
- Defined in Source/Core/Math/Matrix4x4.ts:1033

getMutatorAttributeTypes

getMutatorAttributeTypes(_mutator): MutatorAttributeTypes
Returns an associative array with the same attributes as the given mutator, but with the corresponding types as string-values. Does not recurse into objects! This will return the decorated meta-type instead of the runtime-type of the object, if available.
Parameters
- _mutator: Mutator
Returns MutatorAttributeTypes
Overrides Mutable.getMutatorAttributeTypes
- Defined in Source/Core/Math/Matrix4x4.ts:1092

getMutatorForAnimation

getMutatorForAnimation(_extendable?): MutatorForAnimation
Collect the attributes of the instance and their values applicable for animation. Basic functionality is identical to getMutator, returned mutator should then be reduced by the subclassed instance
Parameters
- _extendable: boolean = false
Returns MutatorForAnimation
Inherited from Mutable.getMutatorForAnimation
- Defined in Source/Core/Serialization/Mutable.ts:185

getMutatorForUserInterface

getMutatorForUserInterface(_extendable?): MutatorForUserInterface
Collect the attributes of the instance and their values applicable for the user interface. Basic functionality is identical to getMutator, returned mutator should then be reduced by the subclassed instance
Parameters
- _extendable: boolean = false
Returns MutatorForUserInterface
Inherited from Mutable.getMutatorForUserInterface
- Defined in Source/Core/Serialization/Mutable.ts:193

getTranslationTo

getTranslationTo(_mtxTarget): Vector3
Returns the tranlation from this matrix to the target matrix
Parameters
- _mtxTarget: Matrix4x4
Returns Vector3
- Defined in Source/Core/Math/Matrix4x4.ts:1008

getX

getX(): Vector3
Return cardinal x-axis

Returns Vector3
- Defined in Source/Core/Math/Matrix4x4.ts:952

getY

getY(): Vector3
Return cardinal y-axis

Returns Vector3
- Defined in Source/Core/Math/Matrix4x4.ts:960

getZ

getZ(): Vector3
Return cardinal z-axis

Returns Vector3
- Defined in Source/Core/Math/Matrix4x4.ts:968

invert

invert(): Matrix4x4
Invert this matrix

Returns Matrix4x4
- Defined in Source/Core/Math/Matrix4x4.ts:576

lookAt

lookAt(_target, _up?, _restrict?): Matrix4x4
Adjusts the rotation of this matrix to point the z-axis directly at the given target and tilts it to accord with the given up-Vector3, respectively calculating yaw and pitch. If no up-Vector3 is given, the previous up-Vector3 is used. The pitch may be restricted to the up-vector to only calculate yaw.
Parameters
- _target: Vector3
- Optional _up: Vector3
- _restrict: boolean = false
Returns Matrix4x4
- Defined in Source/Core/Math/Matrix4x4.ts:756

lookIn

lookIn(_direction, _up?): Matrix4x4
Adjusts the rotation of this matrix to align the z-axis with the given direction and tilts it to accord with the given up-Vector3. Up should be perpendicular to the given direction. If no up-vector is provided, (0, 1, 0) is used.
Parameters
- _direction: Vector3
- _up: Vector3 = ...
Returns Matrix4x4
- Defined in Source/Core/Math/Matrix4x4.ts:770

multiply

multiply(_matrix, _fromLeft?): Matrix4x4
Multiply this matrix by the given matrix.
Parameters
- _matrix: Matrix4x4
- _fromLeft: boolean = false
Returns Matrix4x4
- Defined in Source/Core/Math/Matrix4x4.ts:866

mutate

mutate(_mutator): Promise<void>
Updates the attribute values of the instance according to the state of the mutator. The mutation may be restricted to a subset of the mutator and the event dispatching suppressed. Uses mutateBase, but can be overwritten in subclasses
Parameters
- _mutator: Mutator
Returns Promise<void>
Overrides Mutable.mutate
- Defined in Source/Core/Math/Matrix4x4.ts:1048

recycle

recycle(): void
Resets the matrix to the identity-matrix and clears cache. Used by the recycler to reset.

Returns void
Implementation of Recycable.recycle
- Defined in Source/Core/Math/Matrix4x4.ts:543

removeEventListener

removeEventListener(_type, _handler, _options?): void
See EventTarget.removeEventListener for reference. Works with EventListenerUnified and EventUnified
Parameters
- _type: string
- _handler: EventListenerUnified
- Optional _options: boolean | AddEventListenerOptions
Returns void
Inherited from Mutable.removeEventListener
- Defined in Source/Core/Event/Event.ts:98

reset

reset(): void
Resets the matrix to the identity-matrix and clears cache.

Returns void
- Defined in Source/Core/Math/Matrix4x4.ts:555

rotate

rotate(_by, _fromLeft?): Matrix4x4
Rotates this matrix by given Vector3 in the order Z, Y, X. Right hand rotation is used, thumb points in axis direction, fingers curling indicate rotation The rotation is appended to already applied transforms, thus multiplied from the right. Set _fromLeft to true to switch and put it in front.
Parameters
- _by: Vector3
- _fromLeft: boolean = false
Returns Matrix4x4
- Defined in Source/Core/Math/Matrix4x4.ts:714

rotateX

rotateX(_angleInDegrees, _fromLeft?): Matrix4x4
Adds a rotation around the x-axis to this matrix.
Parameters
- _angleInDegrees: number
- _fromLeft: boolean = false
Returns Matrix4x4
- Defined in Source/Core/Math/Matrix4x4.ts:724

rotateY

rotateY(_angleInDegrees, _fromLeft?): Matrix4x4
Adds a rotation around the y-axis to this matrix.
Parameters
- _angleInDegrees: number
- _fromLeft: boolean = false
Returns Matrix4x4
- Defined in Source/Core/Math/Matrix4x4.ts:734

rotateZ

rotateZ(_angleInDegrees, _fromLeft?): Matrix4x4
Adds a rotation around the z-axis to this matrix.
Parameters
- _angleInDegrees: number
- _fromLeft: boolean = false
Returns Matrix4x4
- Defined in Source/Core/Math/Matrix4x4.ts:744

scale

scale(_by): Matrix4x4
Adds a scaling by the given Vector3 to this matrix.
Parameters
- _by: Vector3
Returns Matrix4x4
- Defined in Source/Core/Math/Matrix4x4.ts:820

scaleX

scaleX(_by): Matrix4x4
Adds a scaling along the x-axis to this matrix.
Parameters
- _by: number
Returns Matrix4x4
- Defined in Source/Core/Math/Matrix4x4.ts:831

scaleY

scaleY(_by): Matrix4x4
Adds a scaling along the y-axis to this matrix.
Parameters
- _by: number
Returns Matrix4x4
- Defined in Source/Core/Math/Matrix4x4.ts:842

scaleZ

scaleZ(_by): Matrix4x4
Adds a scaling along the z-axis to this matrix.
Parameters
- _by: number
Returns Matrix4x4
- Defined in Source/Core/Math/Matrix4x4.ts:853

serialize

serialize(): Serialization
Returns a Serialization of this object.

Returns Serialization
Implementation of Serializable.serialize
- Defined in Source/Core/Math/Matrix4x4.ts:1014

set

set(_array): Matrix4x4
Sets the elements of this matrix to the given array.
Parameters
- _array: ArrayLike<number>
Returns Matrix4x4
- Defined in Source/Core/Math/Matrix4x4.ts:908

swapXY

swapXY(): void
Swaps the two cardinal axis and reverses the third, effectively rotating the transform 180 degrees around one and 90 degrees around a second axis

Returns void
- Defined in Source/Core/Math/Matrix4x4.ts:977

swapXZ

swapXZ(): void
Swaps the two cardinal axis and reverses the third, effectively rotating the transform 180 degrees around one and 90 degrees around a second axis

Returns void
- Defined in Source/Core/Math/Matrix4x4.ts:987

swapYZ

swapYZ(): void
Swaps the two cardinal axis and reverses the third, effectively rotating the transform 180 degrees around one and 90 degrees around a second axis

Returns void
- Defined in Source/Core/Math/Matrix4x4.ts:997

toString

toString(): string
Returns a formatted string representation of this matrix

Returns string
- Defined in Source/Core/Math/Matrix4x4.ts:937

translate

translate(_by, _local?): Matrix4x4
Adds a translation by the given Vector3 to this matrix. If _local is true, the translation occurs according to the current rotation and scaling of this matrix, otherwise, it occurs according to the parent.
Parameters
- _by: Vector3
- _local: boolean = true
Returns Matrix4x4
- Defined in Source/Core/Math/Matrix4x4.ts:658

translateX

translateX(_x, _local?): Matrix4x4
Adds a translation along the x-axis to this matrix.
Parameters
- _x: number
- _local: boolean = true
Returns Matrix4x4
- Defined in Source/Core/Math/Matrix4x4.ts:681

translateY

translateY(_y, _local?): Matrix4x4
Adds a translation along the y-axis to this matrix.
Parameters
- _y: number
- _local: boolean = true
Returns Matrix4x4
- Defined in Source/Core/Math/Matrix4x4.ts:691

translateZ

translateZ(_z, _local?): Matrix4x4
Adds a translation along the z-axis to this matrix.
Parameters
- _z: number
- _local: boolean = true
Returns Matrix4x4
- Defined in Source/Core/Math/Matrix4x4.ts:701

transpose

transpose(): Matrix4x4
Transpose this matrix

Returns Matrix4x4
- Defined in Source/Core/Math/Matrix4x4.ts:562

updateMutator

updateMutator(_mutator): void
Updates the values of the given mutator according to the current state of the instance
Parameters
- _mutator: Mutator
Returns void
Inherited from Mutable.updateMutator
- Defined in Source/Core/Serialization/Mutable.ts:246

`Static` COMPOSITION

COMPOSITION(_translation?, _rotation?, _scaling?): Matrix4x4
Composes a new matrix according to the given translation, rotation and scaling.
Parameters
- Optional _translation: Vector3
- Optional _rotation: Quaternion | Vector3
- Optional _scaling: Vector3
Returns Matrix4x4
- Defined in Source/Core/Math/Matrix4x4.ts:45

`Static` IDENTITY

IDENTITY(): Matrix4x4
Retrieve a new identity matrix

Returns Matrix4x4
- Defined in Source/Core/Math/Matrix4x4.ts:37

`Static` INVERSE

INVERSE(_mtx): Matrix4x4
Computes and returns the inverse of a passed matrix.
Parameters
- _mtx: Matrix4x4
  The matrix to compute the inverse of.
Returns Matrix4x4
- Defined in Source/Core/Math/Matrix4x4.ts:122

`Static` LOOK_AT

LOOK_AT(_translation, _target, _up?, _restrict?): Matrix4x4
Computes and returns a matrix with the given translation, its z-axis pointing directly at the given target, and a minimal angle between its y-axis and the given up-Vector3, respetively calculating yaw and pitch. The pitch may be restricted to the up-vector to only calculate yaw.
Parameters
- _translation: Vector3
- _target: Vector3
- _up: Vector3 = ...
- _restrict: boolean = false
Returns Matrix4x4
- Defined in Source/Core/Math/Matrix4x4.ts:131

`Static` LOOK_IN

LOOK_IN(_translation, _direction, _up?): Matrix4x4
Computes and returns a matrix with the given translation, its z-axis pointing directly in the given direction, and a minimal angle between its y-axis and the given up-Vector3. Ideally up should be perpendicular to the given direction.
Parameters
- _translation: Vector3
- _direction: Vector3
- _up: Vector3 = ...
Returns Matrix4x4
- Defined in Source/Core/Math/Matrix4x4.ts:158

`Static` PRODUCT

PRODUCT(_mtxLeft, _mtxRight): Matrix4x4
Computes and returns the product of two passed matrices.
Parameters
- _mtxLeft: Matrix4x4
- _mtxRight: Matrix4x4
Returns Matrix4x4
- Defined in Source/Core/Math/Matrix4x4.ts:54

`Static` PROJECTION_CENTRAL

PROJECTION_CENTRAL(_aspect, _fieldOfViewInDegrees, _near, _far, _direction): Matrix4x4
Computes and returns a matrix that applies perspective to an object, if its transform is multiplied by it.
Parameters
- _aspect: number
  The aspect ratio between width and height of projectionspace.(Default = canvas.clientWidth / canvas.ClientHeight)
- _fieldOfViewInDegrees: number
  The field of view in Degrees. (Default = 45)
- _near: number
  The near clipspace border on the z-axis.
- _far: number
  The far clipspace border on the z-axis.
- _direction: FIELD_OF_VIEW
  The plane on which the fieldOfView-Angle is given
Returns Matrix4x4
- Defined in Source/Core/Math/Matrix4x4.ts:310

`Static` PROJECTION_ORTHOGRAPHIC

PROJECTION_ORTHOGRAPHIC(_left, _right, _bottom, _top, _near?, _far?): Matrix4x4
Computes and returns a matrix that applies orthographic projection to an object, if its transform is multiplied by it.
Parameters
- _left: number
  The positionvalue of the projectionspace's left border.
- _right: number
  The positionvalue of the projectionspace's right border.
- _bottom: number
  The positionvalue of the projectionspace's bottom border.
- _top: number
  The positionvalue of the projectionspace's top border.
- _near: number = -400
  The positionvalue of the projectionspace's near border.
- _far: number = 400
  The positionvalue of the projectionspace's far border
Returns Matrix4x4
- Defined in Source/Core/Math/Matrix4x4.ts:347

`Static` RELATIVE

RELATIVE(_mtx, _mtxBase, _mtxInverse?): Matrix4x4
Returns a representation of the given matrix relative to the given base. If known, pass the inverse of the base to avoid unneccesary calculation
Parameters
- _mtx: Matrix4x4
- _mtxBase: Matrix4x4
- Optional _mtxInverse: Matrix4x4
Returns Matrix4x4
- Defined in Source/Core/Math/Matrix4x4.ts:290

`Static` ROTATION

ROTATION(_rotation): Matrix4x4
Returns a matrix that rotates coordinates when multiplied by, using the rotation euler angles or unit quaternion given. Rotation occurs around the axis in the order Z-Y-X .
Parameters
- _rotation: Quaternion | Vector3
Returns Matrix4x4
- Defined in Source/Core/Math/Matrix4x4.ts:266

`Static` ROTATION_X

ROTATION_X(_angleInDegrees): Matrix4x4
Returns a matrix that rotates coordinates on the x-axis when multiplied by.
Parameters
- _angleInDegrees: number
Returns Matrix4x4
- Defined in Source/Core/Math/Matrix4x4.ts:214

`Static` ROTATION_Y

ROTATION_Y(_angleInDegrees): Matrix4x4
Returns a matrix that rotates coordinates on the y-axis when multiplied by.
Parameters
- _angleInDegrees: number
Returns Matrix4x4
- Defined in Source/Core/Math/Matrix4x4.ts:231

`Static` ROTATION_Z

ROTATION_Z(_angleInDegrees): Matrix4x4
Returns a matrix that rotates coordinates on the z-axis when multiplied by.
Parameters
- _angleInDegrees: number
Returns Matrix4x4
- Defined in Source/Core/Math/Matrix4x4.ts:248

`Static` SCALING

SCALING(_scalar): Matrix4x4
Returns a matrix that scales coordinates along the x-, y- and z-axis according to the given Vector3
Parameters
- _scalar: Vector3
Returns Matrix4x4
- Defined in Source/Core/Math/Matrix4x4.ts:275

`Static` TRANSLATION

TRANSLATION(_translate): Matrix4x4
Returns a matrix that translates coordinates along the x-, y- and z-axis according to the given Vector3.
Parameters
- _translate: Vector3
Returns Matrix4x4
- Defined in Source/Core/Math/Matrix4x4.ts:200

`Static` TRANSPOSE

TRANSPOSE(_mtx): Matrix4x4
Computes and returns the transpose of a passed matrix.
Parameters
- _mtx: Matrix4x4
Returns Matrix4x4
- Defined in Source/Core/Math/Matrix4x4.ts:114

`Static` getMutatorFromPath

getMutatorFromPath(_mutator, _path): Mutator
Decorator allows to attach Mutable functionality to existing classes.
Parameters
- _mutator: Mutator
- _path: string[]
Returns Mutator
Inherited from Mutable.getMutatorFromPath
- Defined in Source/Core/Serialization/Mutable.ts:127

Class Matrix4x4

Authors

Hierarchy (view full)

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns Matrix4x4

Accessors

clone

Returns Matrix4x4

forward

Returns Vector3

quaternion

Returns Quaternion

Parameters

Returns void

right

Returns Vector3

rotation

Returns Vector3

Parameters

Returns void

scaling

Returns Vector3

Parameters

Returns void

translation

Returns Vector3

Parameters

Returns void

type

Returns string

up

Returns Vector3

Methods

addEventListener

Parameters

Returns void

copy

Parameters

Returns Matrix4x4

deserialize

Parameters

Returns Promise<Serializable>

dispatchEvent

Parameters

Returns boolean

get

Returns Float32Array

getMetaAttributeTypes

Returns MetaAttributeTypes

getMetadata

Returns Metadata

getMutator

Returns Mutator

getMutatorAttributeTypes

Parameters

Returns MutatorAttributeTypes

getMutatorForAnimation

Parameters

Returns MutatorForAnimation

getMutatorForUserInterface

Parameters

Returns MutatorForUserInterface

getTranslationTo

Parameters

Returns Vector3

getX

Returns Vector3

getY

Returns Vector3

getZ

Returns Vector3

invert

Returns Matrix4x4

lookAt