Class GlobalTransform3D

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

Matrix layout: | a | d | g | x | | b | e | h | y | | c | f | i | z |

Hierarchy (View Summary)

Affine3
- GlobalTransform3D

Index

Constructors

constructor

new GlobalTransform3D(
    e11?: number,
    e12?: number,
    e13?: number,
    e14?: number,
    e21?: number,
    e22?: number,
    e23?: number,
    e24?: number,
    e31?: number,
    e32?: number,
    e33?: number,
    e34?: number,
): GlobalTransform3D
Parameters
- Optionale11: number
- Optionale12: number
- Optionale13: number
- Optionale14: number
- Optionale21: number
- Optionale22: number
- Optionale23: number
- Optionale24: number
- Optionale31: number
- Optionale32: number
- Optionale33: number
- Optionale34: number
Returns GlobalTransform3D
Inherited from Affine3.constructor
- Defined in node_modules/hisabati/dist/index.d.ts:1687

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

The identity affine.

`Static` `Readonly`Zero

Zero: Affine3

The zero affine.

Methods

[iterator]

"[iterator]"(): IterableIterator<number>
Iterates over the affine components in row-major order.

Returns IterableIterator<number>
Inherited from Affine3.[iterator]
- Defined in node_modules/hisabati/dist/index.d.ts:1835

clone

clone(): Affine3
Creates a new affine with the same components.

Returns Affine3
Inherited from Affine3.clone
- Defined in node_modules/hisabati/dist/index.d.ts:1699

compose

compose(translation: Vector3, orientation: Quaternion, scale: Vector3): this
Composes this affine from translation, orientation and scale.
Parameters
- translation: Vector3
- orientation: Quaternion
- scale: Vector3
Returns this
Inherited from Affine3.compose
- Defined in node_modules/hisabati/dist/index.d.ts:1707

copy

copy(affine: Affine3): this
Copies another affine into this one.
Parameters
- affine: Affine3
Returns this
Inherited from Affine3.copy
- Defined in node_modules/hisabati/dist/index.d.ts:1695

decompose

decompose(): [Vector3, Quaternion, Vector3]
Decomposes this affine into translation, orientation and scale.

Returns [Vector3, Quaternion, Vector3]
Inherited from Affine3.decompose
- Defined in node_modules/hisabati/dist/index.d.ts:1711

divide

divide(affine: Affine3): Affine3
Divides this affine by another (this = this * inverse(affine)).
Parameters
- affine: Affine3
Returns Affine3
Inherited from Affine3.divide
- Defined in node_modules/hisabati/dist/index.d.ts:1747

equals

equals(affine: Affine3): boolean
Checks component-wise equality.
Parameters
- affine: Affine3
Returns boolean
Inherited from Affine3.equals
- Defined in node_modules/hisabati/dist/index.d.ts:1751

invert

invert(): Affine3
Inverts this affine in place.

Returns Affine3
Inherited from Affine3.invert
- Defined in node_modules/hisabati/dist/index.d.ts:1739

lookAt

lookAt(target: Vector3, up: Vector3): Affine3
Orients this affine to face a target position.
Parameters
- target: Vector3
- up: Vector3
Returns Affine3
Inherited from Affine3.lookAt
- Defined in node_modules/hisabati/dist/index.d.ts:1727

multiply

multiply(affine: Affine3): Affine3
Multiplies this affine by another (this = this * affine).
Parameters
- affine: Affine3
Returns Affine3
Inherited from Affine3.multiply
- Defined in node_modules/hisabati/dist/index.d.ts:1743

rotate

rotate(angle: Quaternion): Affine3
Applies a rotation to this affine.
Parameters
- angle: Quaternion
Returns Affine3
Inherited from Affine3.rotate
- Defined in node_modules/hisabati/dist/index.d.ts:1719

scale

scale(scale: Vector3): Affine3
Applies a scale to this affine.
Parameters
- scale: Vector3
Returns Affine3
Inherited from Affine3.scale
- Defined in node_modules/hisabati/dist/index.d.ts:1723

serialize

serialize(): Affine3Like
Serializes this affine.

Returns Affine3Like
Inherited from Affine3.serialize
- Defined in node_modules/hisabati/dist/index.d.ts:1703

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,
): this
Sets this affine from raw matrix components.
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 this
Inherited from Affine3.set
- Defined in node_modules/hisabati/dist/index.d.ts:1691

transform

transform(vector: Vector3): Vector3
Transforms a vector by this affine in place.
Parameters
- vector: Vector3
Returns Vector3
Inherited from Affine3.transform
- Defined in node_modules/hisabati/dist/index.d.ts:1731

transformWithoutTranslation

transformWithoutTranslation(vector: Vector3): Vector3
Transforms a vector by scale and rotation with no translation.
Parameters
- vector: Vector3
Returns Vector3
Inherited from Affine3.transformWithoutTranslation
- Defined in node_modules/hisabati/dist/index.d.ts:1735

translate

translate(translation: Vector3): Affine3
Applies a translation to this affine.
Parameters
- translation: Vector3
Returns Affine3
Inherited from Affine3.translate
- Defined in node_modules/hisabati/dist/index.d.ts:1715

`Static`clone

clone(target: GlobalTransform3D): Affine3
Parameters
- target: GlobalTransform3D
Returns Affine3
- Defined in packages/transform/src/components/3d/globaltransform.js:16

`Static`compose

compose(
    position: Vector3,
    orientation: Quaternion,
    scale: Vector3,
    out?: Affine3,
): Affine3
Composes an affine from translation, orientation and scale.
Parameters
- position: Vector3
- orientation: Quaternion
- scale: Vector3
- Optionalout: Affine3
Returns Affine3
Inherited from Affine3.compose
- Defined in node_modules/hisabati/dist/index.d.ts:1783

`Static`copy

copy(source: GlobalTransform3D, target?: GlobalTransform3D): Affine3
Parameters
- source: GlobalTransform3D
- target: GlobalTransform3D = ...
Returns Affine3
Overrides Affine3.copy
- Defined in packages/transform/src/components/3d/globaltransform.js:9

`Static`decompose

decompose(affine: Affine3): [Vector3, Quaternion, Vector3]
Decomposes an affine into translation, orientation and scale.
Parameters
- affine: Affine3
Returns [Vector3, Quaternion, Vector3]
Inherited from Affine3.decompose
- Defined in node_modules/hisabati/dist/index.d.ts:1787

`Static`deserialize

deserialize(value: Affine3Like, out?: GlobalTransform3D): Affine3
Parameters
- value: Affine3Like
- Optionalout: GlobalTransform3D = ...
Returns Affine3
Overrides Affine3.deserialize
- Defined in packages/transform/src/components/3d/globaltransform.js:31

`Static`divide

divide(affine1: Affine3, affine2: Affine3, out?: Affine3): Affine3
Divides two affines (out = affine1 * inverse(affine2)).
Parameters
- affine1: Affine3
- affine2: Affine3
- Optionalout: Affine3
Returns Affine3
Inherited from Affine3.divide
- Defined in node_modules/hisabati/dist/index.d.ts:1795

`Static`equal

equal(affine1: Affine3, Affine3: Affine3): boolean
Checks component-wise equality for two affines.
Parameters
- affine1: Affine3
- Affine3: Affine3
Returns boolean
Inherited from Affine3.equal
- Defined in node_modules/hisabati/dist/index.d.ts:1831

`Static`identity

identity(out?: Affine3): Affine3
Writes the identity transform.
Parameters
- Optionalout: Affine3
Returns Affine3
Inherited from Affine3.identity
- Defined in node_modules/hisabati/dist/index.d.ts:1775

`Static`invert

invert(affine: Affine3, out?: Affine3): Affine3
Inverts an affine.
Parameters
- affine: Affine3
- Optionalout: Affine3
Returns Affine3
Inherited from Affine3.invert
- Defined in node_modules/hisabati/dist/index.d.ts:1799

`Static`lookAt

lookAt(eye: Vector3, target: Vector3, up: Vector3, out?: Affine3): Affine3
Creates a look-at transform from eye to target with an up direction.
Parameters
- eye: Vector3
- target: Vector3
- up: Vector3
- Optionalout: Affine3
Returns Affine3
Inherited from Affine3.lookAt
- Defined in node_modules/hisabati/dist/index.d.ts:1815

`Static`multiply

multiply(affine1: Affine3, affine2: Affine3, out?: Affine3): Affine3
Multiplies two affines (out = affine1 * affine2).
Parameters
- affine1: Affine3
- affine2: Affine3
- Optionalout: Affine3
Returns Affine3
Inherited from Affine3.multiply
- Defined in node_modules/hisabati/dist/index.d.ts:1791

`Static`rotate

rotate(affine: Affine3, rotation: Quaternion, out?: Affine3): Affine3
Rotates an affine by a quaternion.
Parameters
- affine: Affine3
- rotation: Quaternion
- Optionalout: Affine3
Returns Affine3
Inherited from Affine3.rotate
- Defined in node_modules/hisabati/dist/index.d.ts:1807

`Static`scale

scale(affine: Affine3, scale: Vector3, out?: Affine3): Affine3
Scales an affine by per-axis factors.
Parameters
- affine: Affine3
- scale: Vector3
- Optionalout: Affine3
Returns Affine3
Inherited from Affine3.scale
- Defined in node_modules/hisabati/dist/index.d.ts:1811

`Static`serialize

serialize(value: GlobalTransform3D): Affine3Like
Parameters
- value: GlobalTransform3D
Returns Affine3Like
Overrides Affine3.serialize
- Defined in packages/transform/src/components/3d/globaltransform.js:23

`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
Creates or overwrites an affine with raw matrix components.
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
- Optionalout: Affine3
Returns Affine3
Inherited from Affine3.set
- Defined in node_modules/hisabati/dist/index.d.ts:1755

`Static`toMatrix4

toMatrix4(affine: Affine3, out?: Matrix4): Matrix4
Converts this affine to a 4x4 matrix.
Parameters
- affine: Affine3
- Optionalout: Matrix4
Returns Matrix4
Inherited from Affine3.toMatrix4
- Defined in node_modules/hisabati/dist/index.d.ts:1827

`Static`transform

transform(affine: Affine3, vector: Vector3, out?: Vector3): Vector3
Transforms a vector by an affine.
Parameters
- affine: Affine3
- vector: Vector3
- Optionalout: Vector3
Returns Vector3
Inherited from Affine3.transform
- Defined in node_modules/hisabati/dist/index.d.ts:1819

`Static`transformWithoutTranslation

transformWithoutTranslation(
    affine: Affine3,
    vector: Vector3,
    out?: Vector3,
): Vector3
Transforms a vector by an affine's scale and rotation with no translation.
Parameters
- affine: Affine3
- vector: Vector3
- Optionalout: Vector3
Returns Vector3
Inherited from Affine3.transformWithoutTranslation
- Defined in node_modules/hisabati/dist/index.d.ts:1823

`Static`translate

translate(affine: Affine3, translation: Vector3, out?: Affine3): Affine3
Translates an affine.
Parameters
- affine: Affine3
- translation: Vector3
- Optionalout: Affine3
Returns Affine3
Inherited from Affine3.translate
- Defined in node_modules/hisabati/dist/index.d.ts:1803

`Static`validateSerial

validateSerial(value: unknown): value is Affine3Like
Checks whether a value is a valid affine serial.
Parameters
- value: unknown
Returns value is Affine3Like
Inherited from Affine3.validateSerial
- Defined in node_modules/hisabati/dist/index.d.ts:1771

`Static`zero

zero(out?: Affine3): Affine3
Writes the zero transform.
Parameters
- Optionalout: Affine3
Returns Affine3
Inherited from Affine3.zero
- Defined in node_modules/hisabati/dist/index.d.ts:1779

Class GlobalTransform3D

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns GlobalTransform3D

Properties

a

b

c

d

e

f

g

h

i

x

y

z

Static ReadonlyIdentity

Static ReadonlyZero

Methods

[iterator]

Returns IterableIterator<number>

clone

Returns Affine3

compose

Parameters

Returns this

copy

Parameters

Returns this

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

serialize

Returns Affine3Like

set

Parameters

Returns this

transform

Parameters

Returns Vector3

transformWithoutTranslation

Parameters

Returns Vector3

translate

Parameters

Returns Affine3

Staticclone

Parameters

Returns Affine3

Staticcompose

Parameters

Returns Affine3

Staticcopy

Parameters

`Static` `Readonly`Identity

`Static` `Readonly`Zero

`Static`clone

`Static`compose

`Static`copy

`Static`decompose

`Static`deserialize

`Static`divide

`Static`equal

`Static`identity

`Static`invert

`Static`lookAt

`Static`multiply

`Static`rotate

`Static`scale

`Static`serialize

`Static`set

`Static`toMatrix4

`Static`transform

`Static`transformWithoutTranslation

`Static`translate

`Static`validateSerial

`Static`zero