Class Matrix3x3

Simple class for 3x3 matrix operations

Authors

Jascha Karagöl, HFU, 2019 | Jirka Dell'Oro-Friedl, HFU, 2020

Hierarchy (view full)

Mutable
- Matrix3x3

Implements

Constructors

constructor

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

Accessors

clone

get clone(): Matrix3x3
Return a copy of this

Returns Matrix3x3
- Defined in Core/Source/Math/Matrix3x3.ts:219

rotation

get rotation(): number
- get: a copy of the calculated rotation Vector2
- set: effect the matrix
Returns number
- Defined in Core/Source/Math/Matrix3x3.ts:188
set rotation(_rotation): void
Parameters
- _rotation: number
Returns void
- Defined in Core/Source/Math/Matrix3x3.ts:193

scaling

get scaling(): Vector2
- get: return a vector representation of the scale Vector3.
  Caution! Do not manipulate result, instead create a clone!
- set: effect the matrix
Returns Vector2
- Defined in Core/Source/Math/Matrix3x3.ts:203
set scaling(_scaling): void
Parameters
- _scaling: Vector2
Returns void
- Defined in Core/Source/Math/Matrix3x3.ts:211

translation

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

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 Core/Source/Serialization/Mutable.ts:73

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 Core/Source/Event/Event.ts:91

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 Core/Source/Math/Matrix3x3.ts:387

dispatchEvent

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

get

get(): Float32Array
Return the elements of this matrix as a Float32Array

Returns Float32Array
- Defined in Core/Source/Math/Matrix3x3.ts:374

getEulerAngle

getEulerAngle(): number
Calculates and returns the euler-angles representing the current rotation of this matrix

Returns number
- Defined in Core/Source/Math/Matrix3x3.ts:331

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 Core/Source/Math/Matrix3x3.ts:397

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!
Parameters
- _mutator: Mutator
Returns MutatorAttributeTypes
Overrides Mutable.getMutatorAttributeTypes
- Defined in Core/Source/Math/Matrix3x3.ts:450

getMutatorForAnimation

getMutatorForAnimation(): 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

Returns MutatorForAnimation
Inherited from Mutable.getMutatorForAnimation
- Defined in Core/Source/Serialization/Mutable.ts:116

getMutatorForUserInterface

getMutatorForUserInterface(): 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

Returns MutatorForUserInterface
Inherited from Mutable.getMutatorForUserInterface
- Defined in Core/Source/Serialization/Mutable.ts:123

multiply

multiply(_mtxRight): void
Multiply this matrix with the given matrix
Parameters
- _mtxRight: Matrix3x3
Returns void
- Defined in Core/Source/Math/Matrix3x3.ts:318

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 Core/Source/Math/Matrix3x3.ts:412

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 Core/Source/Math/Matrix3x3.ts:228

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 Core/Source/Event/Event.ts:98

reset

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

Returns void
- Defined in Core/Source/Math/Matrix3x3.ts:240

rotate

rotate(_angleInDegrees): void
Adds a rotation around the z-Axis to this matrix
Parameters
- _angleInDegrees: number
Returns void
- Defined in Core/Source/Math/Matrix3x3.ts:307

scale

scale(_by): void
Add a scaling by the given Vector2 to this matrix
Parameters
- _by: Vector2
Returns void
- Defined in Core/Source/Math/Matrix3x3.ts:277

scaleX

scaleX(_by): void
Add a scaling along the x-Axis by the given amount to this matrix
Parameters
- _by: number
Returns void
- Defined in Core/Source/Math/Matrix3x3.ts:285

scaleY

scaleY(_by): void
Add a scaling along the y-Axis by the given amount to this matrix
Parameters
- _by: number
Returns void
- Defined in Core/Source/Math/Matrix3x3.ts:294

serialize

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

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

set

set(_mtxTo): void
Sets the elements of this matrix to the values of the given matrix
Parameters
- _mtxTo: Matrix3x3
Returns void
- Defined in Core/Source/Math/Matrix3x3.ts:358

toString

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

Returns string
- Defined in Core/Source/Math/Matrix3x3.ts:367

translate

translate(_by): void
Add a translation by the given Vector2 to this matrix
Parameters
- _by: Vector2
Returns void
- Defined in Core/Source/Math/Matrix3x3.ts:248

translateX

translateX(_x): void
Add a translation along the x-Axis by the given amount to this matrix
Parameters
- _x: number
Returns void
- Defined in Core/Source/Math/Matrix3x3.ts:258

translateY

translateY(_y): void
Add a translation along the y-Axis by the given amount to this matrix
Parameters
- _y: number
Returns void
- Defined in Core/Source/Math/Matrix3x3.ts:266

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 Core/Source/Serialization/Mutable.ts:157

`Static` IDENTITY

IDENTITY(): Matrix3x3
Retrieve a new identity matrix

Returns Matrix3x3
- Defined in Core/Source/Math/Matrix3x3.ts:43

`Static` INVERSION

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

`Static` MULTIPLICATION

MULTIPLICATION(_mtxLeft, _mtxRight): Matrix3x3
Computes and returns the product of two passed matrices.
Parameters
- _mtxLeft: Matrix3x3
  The matrix to multiply.
- _mtxRight: Matrix3x3
  The matrix to multiply by.
Returns Matrix3x3
- Defined in Core/Source/Math/Matrix3x3.ts:97

`Static` PROJECTION

PROJECTION(_width, _height): Matrix3x3
TODO: describe!
Parameters
- _width: number
- _height: number
Returns Matrix3x3
- Defined in Core/Source/Math/Matrix3x3.ts:30

`Static` ROTATION

ROTATION(_angleInDegrees): Matrix3x3
Returns a matrix that rotates coordinates on the z-axis when multiplied by.
Parameters
- _angleInDegrees: number
  The value of the rotation.
Returns Matrix3x3
- Defined in Core/Source/Math/Matrix3x3.ts:65

`Static` SCALING

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

`Static` TRANSLATION

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

`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 Core/Source/Serialization/Mutable.ts:58

Class Matrix3x3

Authors

Hierarchy (view full)

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns Matrix3x3

Accessors

clone

Returns Matrix3x3

rotation

Returns number

Parameters

Returns void

scaling

Returns Vector2

Parameters

Returns void

translation

Returns Vector2

Parameters

Returns void

type

Returns string

Methods

addEventListener

Parameters

Returns void

deserialize

Parameters

Returns Promise<Serializable>

dispatchEvent

Parameters

Returns boolean

get

Returns Float32Array

getEulerAngle

Returns number

getMutator

Returns Mutator

getMutatorAttributeTypes

Parameters

Returns MutatorAttributeTypes

getMutatorForAnimation

Returns MutatorForAnimation

getMutatorForUserInterface

Returns MutatorForUserInterface

multiply

Parameters

Returns void

mutate

Parameters

Returns Promise<void>

recycle

Returns void

removeEventListener

Parameters

Returns void

reset

Returns void

rotate

Parameters

Returns void

scale

Parameters

Returns void

scaleX

Parameters

Returns void

scaleY

Parameters

Returns void

serialize

Returns Serialization

set

Parameters

`Static` IDENTITY

`Static` INVERSION

`Static` MULTIPLICATION

`Static` PROJECTION

`Static` ROTATION

`Static` SCALING

`Static` TRANSLATION

`Static` getMutatorFromPath