Class Affine3

Represents a 3x4 affine. Can be used to represent 3 dimensional rotation, scale,skew and translation.

a	d	g	j
b	e	h	k
c	f	i	l

Hierarchy (View Summary)

Affine3
- GlobalTransform3D

Index

Constructors

constructor

Properties

a b c d e f g h i x y z Identity Zero

Constructors

constructor

new Affine3(
    e11?: number,
    e12?: number,
    e13?: number,
    e14?: number,
    e21?: number,
    e22?: number,
    e23?: number,
    e24?: number,
    e31?: number,
    e32?: number,
    e33?: number,
    e34?: number,
): Affine3
Parameters
- e11: number = 1
- e12: number = 0
- e13: number = 0
- e14: number = 0
- e21: number = 0
- e22: number = 1
- e23: number = 0
- e24: number = 0
- e31: number = 0
- e32: number = 0
- e33: number = 1
- e34: number = 0
Returns Affine3
- Defined in src/math/core/affines/affine3.js:77

Properties

a

a: number

b

b: number

c

c: number

d

d: number

e

e: number

f

f: number

g

g: number

h

h: number

i

i: number

x

x: number

y

y: number

z

z: number

`Static` `Readonly`Identity

Identity: Affine3 = ...

`Static` `Readonly`Zero

Zero: Affine3 = ...

Methods

[iterator]

"[iterator]"(): Generator<number, void, unknown>
Allows iteration of components.

Returns Generator<number, void, unknown>
Yields
- Defined in src/math/core/affines/affine3.js:800

clone

clone(): Affine3
Creates a new affine,fills its values with this ones and returns the former.

Returns Affine3
- Defined in src/math/core/affines/affine3.js:131

compose

compose(translation: Vector3, orientation: Quaternion, scale: Vector3): Affine3
Parameters
- translation: Vector3
- orientation: Quaternion
- scale: Vector3
Returns Affine3
- Defined in src/math/core/affines/affine3.js:142

copy

copy(affine: Affine3): Affine3
Copies a affine into this affine.
Parameters
- affine: Affine3
Returns Affine3
- Defined in src/math/core/affines/affine3.js:120

decompose

decompose(): [Vector3, Quaternion, Vector3]
Returns [Vector3, Quaternion, Vector3]
- Defined in src/math/core/affines/affine3.js:151

divide

divide(affine: Affine3): Affine3
Multiplies with another affine, A * B = C, where A is this affine.
Parameters
- affine: Affine3
Returns Affine3
- Defined in src/math/core/affines/affine3.js:244

equals

equals(affine: Affine3): boolean
Deeply checks if a affine is equal to another.
Parameters
- affine: Affine3
Returns boolean
- Defined in src/math/core/affines/affine3.js:256

invert

invert(): Affine3
Inverts the affine.

Returns Affine3
- Defined in src/math/core/affines/affine3.js:218

lookAt

lookAt(target: Vector3, up: Vector3): Affine3
Parameters
- target: Vector3
- up: Vector3
Returns Affine3
- Defined in src/math/core/affines/affine3.js:196

multiply

multiply(affine: Affine3): Affine3
Multiplies with another affine, A * B = C, where A is this affine.
Parameters
- affine: Affine3
Returns Affine3
- Defined in src/math/core/affines/affine3.js:231

rotate

rotate(angle: Quaternion): Affine3
Rotates the affine by the given angle.
Parameters
- angle: Quaternion
Returns Affine3
- Defined in src/math/core/affines/affine3.js:173

scale

scale(scale: Vector3): Affine3
Scales a affine by a given amount.
Parameters
- scale: Vector3
Returns Affine3
- Defined in src/math/core/affines/affine3.js:185

set

set(
    e11: number,
    e12: number,
    e13: number,
    e14: number,
    e21: number,
    e22: number,
    e23: number,
    e24: number,
    e31: number,
    e32: number,
    e33: number,
    e34: number,
): Affine3
Parameters
- e11: number
- e12: number
- e13: number
- e14: number
- e21: number
- e22: number
- e23: number
- e24: number
- e31: number
- e32: number
- e33: number
- e34: number
Returns Affine3
- Defined in src/math/core/affines/affine3.js:108

transform

transform(vector: Vector3): Vector3
Transforms the given vector.
Parameters
- vector: Vector3
Returns Vector3
- Defined in src/math/core/affines/affine3.js:209

translate

translate(translation: Vector3): Affine3
Translates a affine by a given amount.
Parameters
- translation: Vector3
Returns Affine3
- Defined in src/math/core/affines/affine3.js:161

`Static`compose

compose(
    position: Vector3,
    orientation: Quaternion,
    scale: Vector3,
    out?: Affine3,
): Affine3
Parameters
- position: Vector3
- orientation: Quaternion
- scale: Vector3
- out: Affine3 = ...
Returns Affine3
- Defined in src/math/core/affines/affine3.js:361

`Static`copy

copy(affine: Affine3, out?: Affine3): Affine3
Parameters
- affine: Affine3
- Optionalout: Affine3 = ...
Returns Affine3
- Defined in src/math/core/affines/affine3.js:296

`Static`decompose

decompose(affine: Affine3): [Vector3, Quaternion, Vector3]
Parameters
- affine: Affine3
Returns [Vector3, Quaternion, Vector3]
- Defined in src/math/core/affines/affine3.js:403

`Static`divide

divide(affine1: Affine3, affine2: Affine3, out?: Affine3): Affine3
Parameters
- affine1: Affine3
- affine2: Affine3
- Optionalout: Affine3 = ...
Returns Affine3
- Defined in src/math/core/affines/affine3.js:511

`Static`equal

equal(affine1: Affine3, Affine3: Affine3): boolean
Parameters
- affine1: Affine3
- Affine3: Affine3
Returns boolean
- Defined in src/math/core/affines/affine3.js:778

`Static`identity

identity(out?: Affine3): Affine3
Parameters
- out: Affine3 = ...
Returns Affine3
- Defined in src/math/core/affines/affine3.js:317

`Static`invert

invert(affine: Affine3, out?: Affine3): Affine3
Parameters
- affine: Affine3
- Optionalout: Affine3 = ...
Returns Affine3
- Defined in src/math/core/affines/affine3.js:523

`Static`lookAt

lookAt(eye: Vector3, target: Vector3, up: Vector3, out?: Affine3): Affine3
Parameters
- eye: Vector3
- target: Vector3
- up: Vector3
- out: Affine3 = ...
Returns Affine3
- Defined in src/math/core/affines/affine3.js:663

`Static`multiply

multiply(affine1: Affine3, affine2: Affine3, out?: Affine3): Affine3
Parameters
- affine1: Affine3
- affine2: Affine3
- out: Affine3 = ...
Returns Affine3
- Defined in src/math/core/affines/affine3.js:458

`Static`rotate

rotate(affine: Affine3, rotation: Quaternion, out?: Affine3): Affine3
Parameters
- affine: Affine3
- rotation: Quaternion
- Optionalout: Affine3 = ...
Returns Affine3
- Defined in src/math/core/affines/affine3.js:579

`Static`scale

scale(affine: Affine3, scale: Vector3, out?: Affine3): Affine3
Parameters
- affine: Affine3
- scale: Vector3
- Optionalout: Affine3 = ...
Returns Affine3
- Defined in src/math/core/affines/affine3.js:643

`Static`set

set(
    e11: number,
    e12: number,
    e13: number,
    e14: number,
    e21: number,
    e22: number,
    e23: number,
    e24: number,
    e31: number,
    e32: number,
    e33: number,
    e34: number,
    out?: Affine3,
): Affine3
Parameters
- e11: number
- e12: number
- e13: number
- e14: number
- e21: number
- e22: number
- e23: number
- e24: number
- e31: number
- e32: number
- e33: number
- e34: number
- out: Affine3 = ...
Returns Affine3
- Defined in src/math/core/affines/affine3.js:275

`Static`toMatrix4

toMatrix4(affine: Affine3, out?: Matrix4): Matrix4
Parameters
- affine: Affine3
- out: Matrix4 = ...
Returns Matrix4
- Defined in src/math/core/affines/affine3.js:751

`Static`transform

transform(affine: Affine3, vector: Vector3, out?: Vector3): Vector3
Parameters
- affine: Affine3
- vector: Vector3
- out: Vector3 = ...
Returns Vector3
- Defined in src/math/core/affines/affine3.js:735

`Static`translate

translate(affine: Affine3, translation: Vector3, out?: Affine3): Affine3
Parameters
- affine: Affine3
- translation: Vector3
- Optionalout: Affine3 = ...
Returns Affine3
- Defined in src/math/core/affines/affine3.js:557

`Static`zero

zero(out?: Affine3): Affine3
Parameters
- out: Affine3 = ...
Returns Affine3
- Defined in src/math/core/affines/affine3.js:338

Class Affine3

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Affine3

Properties

a

b

c

d

e

f

g

h

i

x

y

z

Static ReadonlyIdentity

Static ReadonlyZero

Methods

[iterator]

Returns Generator<number, void, unknown>

Yields

clone

Returns Affine3

compose

Parameters

Returns Affine3

copy

Parameters

Returns Affine3

decompose

Returns [Vector3, Quaternion, Vector3]

divide

Parameters

Returns Affine3

equals

Parameters

Returns boolean

invert

Returns Affine3

lookAt

Parameters

Returns Affine3

multiply

Parameters

Returns Affine3

rotate

Parameters

Returns Affine3

scale

Parameters

Returns Affine3

set

Parameters

Returns Affine3

transform

Parameters

Returns Vector3

translate

Parameters

Returns Affine3

Staticcompose

Parameters

Returns Affine3

Staticcopy

Parameters

Returns Affine3

Staticdecompose

Parameters

Returns [Vector3, Quaternion, Vector3]

Staticdivide

Parameters

Returns Affine3

`Static` `Readonly`Identity

`Static` `Readonly`Zero

`Static`compose

`Static`copy

`Static`decompose

`Static`divide

`Static`equal

`Static`identity

`Static`invert

`Static`lookAt

`Static`multiply

`Static`rotate

`Static`scale

`Static`set

`Static`toMatrix4

`Static`transform

`Static`translate

`Static`zero