Class Matrix4x4

Index

Constructors

Properties

ww wx wy wz xw xx xy xz yw yx yy yz zw zx zy zz

Methods

apply3 apply4 clear clone multiply setFromObject setIdentity setRotation setScaling setTranslation toJSON makeRotationMatrix makeScalingMatrix makeTransformationMatrix makeTranslationMatrix

Constructors

constructor

new Matrix4x4(matrix?): Matrix4x4
Generic class for representing 4x4 matrices.
Parameters
- Optional matrix: Matrix4x4
  An object with the initial values for the Matrix4x4. Can be either an Object or Matrix4x4.
Returns Matrix4x4
- Defined in plotboilerplate/src/ts/utils/datastructures/Matrix4x4.ts:167

Properties

`Private` ww

ww: number

ww component of the matrix.

`Private` wx

wx: number

wx component of the matrix.

`Private` wy

wy: number

wy component of the matrix.

`Private` wz

wz: number

wz component of the matrix.

`Private` xw

xw: number

xw component of the matrix.

`Private` xx

xx: number

xx component of the matrix.

`Private` xy

xy: number

xy component of the matrix.

`Private` xz

xz: number

xz component of the matrix.

`Private` yw

yw: number

yw component of the matrix.

`Private` yx

yx: number

yx component of the matrix.

`Private` yy

yy: number

yy component of the matrix.

`Private` yz

yz: number

yz component of the matrix.

`Private` zw

zw: number

zw component of the matrix.

`Private` zx

zx: number

zx component of the matrix.

`Private` zy

zy: number

zy component of the matrix.

`Private` zz

zz: number

zz component of the matrix.

Methods

apply3

apply3(vec3): Vec3
Parameters
- vec3: Vec3
Returns Vec3
- Defined in plotboilerplate/src/ts/utils/datastructures/Matrix4x4.ts:209

apply4

apply4(vec4): Vec4
Parameters
- vec4: Vec4
Returns Vec4
- Defined in plotboilerplate/src/ts/utils/datastructures/Matrix4x4.ts:200

clear

clear(): void
Set all matrix components to 0.

Returns void
- Defined in plotboilerplate/src/ts/utils/datastructures/Matrix4x4.ts:220

clone

clone(): Matrix4x4
Returns a deep copy of this matrix.

Returns Matrix4x4
A deep copy of this matrix.
- Defined in plotboilerplate/src/ts/utils/datastructures/Matrix4x4.ts:413

multiply

multiply(matrix): Matrix4x4
Sets this matrix to the dot product between this matrix and the matrix specified by rhs.
Parameters
- matrix: Matrix4x4
  The matrix on the right hand side of the dot product.
Returns Matrix4x4
- Defined in plotboilerplate/src/ts/utils/datastructures/Matrix4x4.ts:307

setFromObject

setFromObject(mat): void
Set matrix components from object
Parameters
- mat: IMatrix4x4 | Matrix4x4
  Object with each component of the matrix, all components must be present.
Returns void
- Defined in plotboilerplate/src/ts/utils/datastructures/Matrix4x4.ts:180

setIdentity

setIdentity(): Matrix4x4
Set matrix to the identity matrix.

Returns Matrix4x4
- Defined in plotboilerplate/src/ts/utils/datastructures/Matrix4x4.ts:228

setRotation

setRotation(axis, angle): Matrix4x4
Sets this matrix to a rotation matrix.
Parameters
- axis: Vec3
  The vector to rotate around.
- angle: number
  The angle to rotate in radians.
Returns Matrix4x4
- Defined in plotboilerplate/src/ts/utils/datastructures/Matrix4x4.ts:240

setScaling

setScaling(x, y, z): Matrix4x4
Sets this matrix to a rotation matrix.
Parameters
- x: number
  Scaling factor in the x axis.
- y: number
  Scaling factor in the y axis.
- z: number
  Scaling factor in the z axis.
Returns Matrix4x4
- Defined in plotboilerplate/src/ts/utils/datastructures/Matrix4x4.ts:272

setTranslation

setTranslation(x, y, z): Matrix4x4
Sets the translation elements of this matrix while leaving the rest of the matrix untouched.
Parameters
- x: number
  Translation amount in the x axis.
- y: number
  Translation amount in the y axis.
- z: number
  Translation amount in the z axis.
Returns Matrix4x4
- Defined in plotboilerplate/src/ts/utils/datastructures/Matrix4x4.ts:289

toJSON

toJSON(): string
Returns a pretty print string representation of the matrix.

Returns string
Pretty printed string of the matrix.
- Defined in plotboilerplate/src/ts/utils/datastructures/Matrix4x4.ts:421

`Static` makeRotationMatrix

makeRotationMatrix(axis, angle): Matrix4x4
Create the rotation matrix from the given axis and angle.
Parameters
- axis: Vec3
  The axis to rotate around.
- angle: number
  The angle to use for rotation (in radians).
Returns Matrix4x4
Matrix4x4
- Defined in plotboilerplate/src/ts/utils/datastructures/Matrix4x4.ts:340

`Static` makeScalingMatrix

makeScalingMatrix(scaleX, scaleY, scaleZ): Matrix4x4
Create the scaling matrix from the given x-, y- and z- scaling factors (use 1.0 for no scaling).
Parameters
- scaleX: number
  The x scaling factor.
- scaleY: number
  The y scaling factor.
- scaleZ: number
  The z scaling factor.
Returns Matrix4x4
Matrix4x4
- Defined in plotboilerplate/src/ts/utils/datastructures/Matrix4x4.ts:352

`Static` makeTransformationMatrix

makeTransformationMatrix(rotateX, rotateY, rotateZ, scaleX, scaleY, scaleZ, translateX, translateY, translateZ): Matrix4x4
Create a full transform matrix from the rotation, scaling and translation params.
Parameters
- rotateX: number
  The rotation angle around the x axis.
- rotateY: number
  The rotation angle around the y axis.
- rotateZ: number
  The rotation angle around the z axis.
- scaleX: number
  The x scaling factor.
- scaleY: number
  The y scaling factor.
- scaleZ: number
  The z scaling factor.
- translateX: number
  The x translation amount.
- translateY: number
  The y translation amount.
- translateZ: number
  The z translation amount.
Returns Matrix4x4
Matrix4x4
- Defined in plotboilerplate/src/ts/utils/datastructures/Matrix4x4.ts:382

`Static` makeTranslationMatrix

makeTranslationMatrix(translateX, translateY, translateZ): Matrix4x4
Create the translation matrix from the given x-, y- and z- translation amounts (use 0.0 for no translation).
Parameters
- translateX: number
  The x translation amount.
- translateY: number
  The y translation amount.
- translateZ: number
  The z translation amount.
Returns Matrix4x4
Matrix4x4
- Defined in plotboilerplate/src/ts/utils/datastructures/Matrix4x4.ts:364

Class Matrix4x4

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Matrix4x4

Properties

Private ww

Private wx

Private wy

Private wz

Private xw

Private xx

Private xy

Private xz

Private yw

Private yx

Private yy

Private yz

Private zw

Private zx

Private zy

Private zz

Methods

apply3

Parameters

Returns Vec3

apply4

Parameters

Returns Vec4

clear

Returns void

clone

Returns Matrix4x4

multiply

Parameters

Returns Matrix4x4

setFromObject

Parameters

Returns void

setIdentity

Returns Matrix4x4

setRotation

Parameters

Returns Matrix4x4

setScaling

Parameters

Returns Matrix4x4

setTranslation

Parameters

Returns Matrix4x4

toJSON

Returns string

Static makeRotationMatrix

Parameters

Returns Matrix4x4

Static makeScalingMatrix

Parameters

Returns Matrix4x4

Static makeTransformationMatrix

Parameters

Returns Matrix4x4

Static makeTranslationMatrix

Parameters

Returns Matrix4x4

On This Page

`Private` ww

`Private` wx

`Private` wy

`Private` wz

`Private` xw

`Private` xx

`Private` xy

`Private` xz

`Private` yw

`Private` yx

`Private` yy

`Private` yz

`Private` zw

`Private` zx

`Private` zy

`Private` zz

`Static` makeRotationMatrix

`Static` makeScalingMatrix

`Static` makeTransformationMatrix

`Static` makeTranslationMatrix