Matrix3D | core

Hierarchy

Matrix3D

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Matrix3D(rawData?: Float32Array): Matrix3D

- Defined in geom/Matrix3D.ts:217
Creates a Matrix3D object.

Parameters
- Default value rawData: Float32Array = null
Returns Matrix3D

Properties

_rawData

_rawData: Float32Array

A Vector of 16 Numbers, where every four elements is a column of a 4x4 matrix.

An exception is thrown if the _rawData property is set to a matrix that is not invertible. The Matrix3D object must be invertible. If a non-invertible matrix is needed, create a subexport class of the Matrix3D object.

Static CALCULATION_MATRIX

CALCULATION_MATRIX: Matrix3D

A reference to a Matrix3D to be used as a temporary data container, preventing object creation.

Accessors

determinant

get (): number

- Defined in geom/Matrix3D.ts:198
[read-only] A number that determines whether a matrix is invertible.

Returns number

position

get (): Vector3D

- Defined in geom/Matrix3D.ts:207
A Vector3D object that holds the position, the 3D coordinate (x,y,z) of a display object within the transformation's frame of reference.

Returns Vector3D

Methods

append

append(lhs: Matrix3D): void

- Defined in geom/Matrix3D.ts:235
Appends the matrix by multiplying another Matrix3D object by the current Matrix3D object.

Parameters
- lhs: Matrix3D
Returns void

appendRotation

appendRotation(degrees: number, axis: Vector3D): void

- Defined in geom/Matrix3D.ts:298
Appends an incremental rotation to a Matrix3D object.

Parameters
- degrees: number
- axis: Vector3D
Returns void

appendScale

appendScale(xScale: number, yScale: number, zScale: number): void

- Defined in geom/Matrix3D.ts:339
Appends an incremental scale change along the x, y, and z axes to a Matrix3D object.

Parameters
- xScale: number
- yScale: number
- zScale: number
Returns void

appendSkew

appendSkew(xSkew: number, ySkew: number, zSkew: number): void

- Defined in geom/Matrix3D.ts:306
Appends an incremental skew change along the x, y, and z axes to a Matrix3D object.

Parameters
- xSkew: number
- ySkew: number
- zSkew: number
Returns void

appendTranslation

appendTranslation(x: number, y: number, z: number): void

- Defined in geom/Matrix3D.ts:372
Appends an incremental translation, a repositioning along the x, y, and z axes, to a Matrix3D object.

Parameters
- x: number
- y: number
- z: number
Returns void

clone

clone(): Matrix3D

- Defined in geom/Matrix3D.ts:384
Returns a new Matrix3D object that is an exact copy of the current Matrix3D object.

Returns Matrix3D

copyColumnFrom

copyColumnFrom(column: number, vector3D: Vector3D): void

- Defined in geom/Matrix3D.ts:396
Copies a Vector3D object into specific column of the calling Matrix3D object.

Parameters
- column: number
- vector3D: Vector3D
Returns void

copyColumnTo

copyColumnTo(column: number, vector3D: Vector3D, negate?: boolean): void

- Defined in geom/Matrix3D.ts:413
Copies specific column of the calling Matrix3D object into the Vector3D object.

Parameters
- column: number
- vector3D: Vector3D
- Default value negate: boolean = false
Returns void

copyFrom

copyFrom(source: Matrix3D, transpose?: boolean): void

- Defined in geom/Matrix3D.ts:438
Copies all of the matrix data from the source Matrix3D object into the calling Matrix3D object.

Parameters
- source: Matrix3D
- Default value transpose: boolean = false
Returns void

copyRawDataFrom

copyRawDataFrom(sourceData: Float32Array, offset?: number, transpose?: boolean): void

- Defined in geom/Matrix3D.ts:486
Parameters
- sourceData: Float32Array
- Default value offset: number = 0
- Default value transpose: boolean = false
Returns void

copyRawDataTo

copyRawDataTo(targetData: Float32Array, offset?: number, transpose?: boolean): void

- Defined in geom/Matrix3D.ts:526
Parameters
- targetData: Float32Array
- Default value offset: number = 0
- Default value transpose: boolean = false
Returns void

copyRowFrom

copyRowFrom(row: number, vector3D: Vector3D): void

- Defined in geom/Matrix3D.ts:567
Copies a Vector3D object into specific row of the calling Matrix3D object.

Parameters
- row: number
- vector3D: Vector3D
Returns void

copyRowTo

copyRowTo(row: number, vector3D: Vector3D, negate?: boolean): void

- Defined in geom/Matrix3D.ts:583
Copies specific row of the calling Matrix3D object into the Vector3D object.

Parameters
- row: number
- vector3D: Vector3D
- Default value negate: boolean = false
Returns void

copyTo

copyTo(target: Matrix3D, transpose?: boolean): void

- Defined in geom/Matrix3D.ts:481
Copies this Matrix3D object into a destination Matrix3D object.

Parameters
- target: Matrix3D
- Default value transpose: boolean = false
Returns void

decompose

decompose(orientationStyle?: string): Vector3D[]

- Defined in geom/Matrix3D.ts:606
Returns the transformation matrix's translation, rotation, and scale settings as a Vector of three Vector3D objects.

Parameters
- Default value orientationStyle: string = "eulerAngles"
Returns Vector3D[]

deltaTransformVector

deltaTransformVector(v: Vector3D, t?: Vector3D): Vector3D

- Defined in geom/Matrix3D.ts:724
Uses the transformation matrix without its translation elements to transform a Vector3D object from one space coordinate to another.

Parameters
- v: Vector3D
- Default value t: Vector3D = null
Returns Vector3D

deltaTransformVectors

deltaTransformVectors(vin: Array<number>, vout: Array<number>): void

- Defined in geom/Matrix3D.ts:741
Parameters
- vin: Array<number>
- vout: Array<number>
Returns void

identity

identity(): void

- Defined in geom/Matrix3D.ts:774
Converts the current matrix to an identity or unit matrix.

Returns void

invalidatePosition

invalidatePosition(): void

- Defined in geom/Matrix3D.ts:1250
Returns void

invert

invert(): boolean

- Defined in geom/Matrix3D.ts:799
Inverts the current matrix.

Returns boolean

isIdentity

isIdentity(): boolean

- Defined in geom/Matrix3D.ts:846
Returns boolean

prepend

prepend(rhs: Matrix3D): void

- Defined in geom/Matrix3D.ts:872
Prepends a matrix by multiplying the current Matrix3D object by another Matrix3D object.

Parameters
- rhs: Matrix3D
Returns void

prependRotation

prependRotation(degrees: number, axis: Vector3D): void

- Defined in geom/Matrix3D.ts:934
Prepends an incremental rotation to a Matrix3D object.

Parameters
- degrees: number
- axis: Vector3D
Returns void

prependScale

prependScale(xScale: number, yScale: number, zScale: number): void

- Defined in geom/Matrix3D.ts:942
Prepends an incremental scale change along the x, y, and z axes to a Matrix3D object.

Parameters
- xScale: number
- yScale: number
- zScale: number
Returns void

prependTranslation

prependTranslation(x: number, y: number, z: number): void

- Defined in geom/Matrix3D.ts:975
Prepends an incremental translation, a repositioning along the x, y, and z axes, to a Matrix3D object.

Parameters
- x: number
- y: number
- z: number
Returns void

recompose

recompose(components: Vector3D[]): boolean

- Defined in geom/Matrix3D.ts:1006
Sets the transformation matrix's translation, rotation, and scale settings.

Parameters
- components: Vector3D[]
Returns boolean

reflect

reflect(plane: Plane3D): void

- Defined in geom/Matrix3D.ts:1110
Parameters
- plane: Plane3D
Returns void

toFixed

toFixed(decimalPlace: number): string

- Defined in geom/Matrix3D.ts:1255
Parameters
- decimalPlace: number
Returns string

toString

toString(): string

- Defined in geom/Matrix3D.ts:1261
Returns string

transformBox

transformBox(box: Box, target?: Box): Box

- Defined in geom/Matrix3D.ts:1139
Parameters
- box: Box
- Default value target: Box = null
Returns Box

transformVector

transformVector(vector: Vector3D, target?: Vector3D): Vector3D

- Defined in geom/Matrix3D.ts:1185
Parameters
- vector: Vector3D
- Default value target: Vector3D = null
Returns Vector3D

transformVectors

transformVectors(vin: number[], vout: number[]): void

- Defined in geom/Matrix3D.ts:1209
Uses the transformation matrix to transform a Vector of Numbers from one coordinate space to another.

Parameters
- vin: number[]
- vout: number[]
Returns void

transpose

transpose(): void

- Defined in geom/Matrix3D.ts:1228
Converts the current Matrix3D object to a matrix where the rows and columns are swapped.

Returns void

Static compare

compare(m1: Matrix3D, m2: Matrix3D): boolean

- Defined in geom/Matrix3D.ts:170
Returns a boolean value representing whether there is any difference between the two given 3d matrices.

Parameters
- m1: Matrix3D
- m2: Matrix3D
Returns boolean

Static getAxisRotationMatrix

getAxisRotationMatrix(x: number, y: number, z: number, degrees: number, target?: Matrix3D): Matrix3D

- Defined in geom/Matrix3D.ts:18
Parameters
- x: number
- y: number
- z: number
- degrees: number
- Default value target: Matrix3D = null
Returns Matrix3D

Static getPointAtMatrix

getPointAtMatrix(pos: Vector3D, dir: Vector3D, up: Vector3D, target?: Matrix3D): Matrix3D

- Defined in geom/Matrix3D.ts:61
Parameters
- pos: Vector3D
- dir: Vector3D
- up: Vector3D
- Default value target: Matrix3D = null
Returns Matrix3D

Static getQuaternionMatrix

getQuaternionMatrix(quarternion: Quaternion, target?: Matrix3D): Matrix3D

- Defined in geom/Matrix3D.ts:120
Fills the 3d matrix with values representing the transformation made by the given quaternion.

Parameters
- quarternion: Quaternion
  
  The quarterion object to convert.
- Default value target: Matrix3D = null
Returns Matrix3D

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Default value rawData: Float32Array = null

Returns Matrix3D

Properties

_rawData

Static CALCULATION_MATRIX

Accessors

determinant

Returns number

position

Returns Vector3D

Methods

append

Parameters

lhs: Matrix3D

Returns void

appendRotation

Parameters

degrees: number

axis: Vector3D

Returns void

appendScale

Parameters

xScale: number

yScale: number

zScale: number

Returns void

appendSkew

Parameters

xSkew: number

ySkew: number

zSkew: number

Returns void

appendTranslation

Parameters

x: number

y: number

z: number

Returns void

clone

Returns Matrix3D

copyColumnFrom

Parameters

column: number

vector3D: Vector3D

Returns void

copyColumnTo

Parameters

column: number

vector3D: Vector3D

Default value negate: boolean = false

Returns void

copyFrom

Parameters

source: Matrix3D

Default value transpose: boolean = false

Returns void

copyRawDataFrom

Parameters

sourceData: Float32Array

Default value offset: number = 0

Default value transpose: boolean = false

Returns void

copyRawDataTo

Parameters

targetData: Float32Array

Default value offset: number = 0

Default value transpose: boolean = false

Returns void

copyRowFrom

Parameters

row: number