Class GlobalTransform2D

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

Matrix layout: | a | c | x | | b | d | y |

Hierarchy (View Summary)

Affine2
- GlobalTransform2D

Index

Constructors

constructor

new GlobalTransform2D(
    e11?: number,
    e12?: number,
    e13?: number,
    e21?: number,
    e22?: number,
    e23?: number,
): GlobalTransform2D
Parameters
- Optionale11: number
- Optionale12: number
- Optionale13: number
- Optionale21: number
- Optionale22: number
- Optionale23: number
Returns GlobalTransform2D
Inherited from Affine2.constructor
- Defined in node_modules/hisabati/dist/index.d.ts:1509

Properties

a

a: number

b

b: number

c

c: number

d

d: number

x

x: number

y

y: number

`Static` `Readonly`Identity

Identity: Affine2

The identity affine.

`Static` `Readonly`Zero

Zero: Affine2

The zero affine.

Methods

[iterator]

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

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

clone

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

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

compose

compose(translation: Vector2, orientation: Rotary, scale: Vector2): this
Composes this affine from translation, orientation and scale.
Parameters
- translation: Vector2
- orientation: Rotary
- scale: Vector2
Returns this
Inherited from Affine2.compose
- Defined in node_modules/hisabati/dist/index.d.ts:1529

copy

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

decompose

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

Returns [Vector2, Rotary, Vector2]
Inherited from Affine2.decompose
- Defined in node_modules/hisabati/dist/index.d.ts:1533

divide

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

equals

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

invert

invert(): Affine2
Inverts this affine in place.

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

lookAt

lookAt(target: Vector2): Affine2
Orients this affine to face a target position.
Parameters
- target: Vector2
Returns Affine2
Inherited from Affine2.lookAt
- Defined in node_modules/hisabati/dist/index.d.ts:1549

multiply

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

rotate

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

scale

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

serialize

serialize(): Affine2Like
Serializes this affine.

Returns Affine2Like
Inherited from Affine2.serialize
- Defined in node_modules/hisabati/dist/index.d.ts:1525

set

set(
    e11: number,
    e12: number,
    e13: number,
    e21: number,
    e22: number,
    e23: number,
): this
Sets this affine from raw matrix components.
Parameters
- e11: number
- e12: number
- e13: number
- e21: number
- e22: number
- e23: number
Returns this
Inherited from Affine2.set
- Defined in node_modules/hisabati/dist/index.d.ts:1513

transform

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

transformWithoutTranslation

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

translate

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

`Static`clone

clone(target: GlobalTransform2D): Affine2
Parameters
- target: GlobalTransform2D
Returns Affine2
- Defined in packages/transform/src/components/2d/globaltransform.js:16

`Static`compose

compose(
    translation: Vector2,
    orientation: Rotary,
    scale: Vector2,
    affine?: Affine2,
): Affine2
Composes an affine from translation, rotation and scale.
Parameters
- translation: Vector2
- orientation: Rotary
- scale: Vector2
- Optionalaffine: Affine2
Returns Affine2
Inherited from Affine2.compose
- Defined in node_modules/hisabati/dist/index.d.ts:1605

`Static`copy

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

`Static`decompose

decompose(
    affine: Affine2,
    position?: Vector2,
    orientation?: Rotary,
    scale?: Vector2,
): [Vector2, Rotary, Vector2]
Decomposes an affine into translation, rotation and scale.
Parameters
- affine: Affine2
- Optionalposition: Vector2
- Optionalorientation: Rotary
- Optionalscale: Vector2
Returns [Vector2, Rotary, Vector2]
Inherited from Affine2.decompose
- Defined in node_modules/hisabati/dist/index.d.ts:1609

`Static`deserialize

deserialize(value: Affine2Like, out?: GlobalTransform2D): Affine2
Parameters
- value: Affine2Like
- Optionalout: GlobalTransform2D = ...
Returns Affine2
Overrides Affine2.deserialize
- Defined in packages/transform/src/components/2d/globaltransform.js:31

`Static`divide

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

`Static`equal

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

`Static`identity

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

`Static`invert

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

`Static`lookAt

lookAt(eye: Vector2, target: Vector2, out?: Affine2): Affine2
Creates a look-at transform from eye to target.
Parameters
- eye: Vector2
- target: Vector2
- Optionalout: Affine2
Returns Affine2
Inherited from Affine2.lookAt
- Defined in node_modules/hisabati/dist/index.d.ts:1637

`Static`multiply

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

`Static`rotate

rotate(affine: Affine2, rotary: Rotary, out?: Affine2): Affine2
Rotates an affine by a rotary angle.
Parameters
- affine: Affine2
- rotary: Rotary
- Optionalout: Affine2
Returns Affine2
Inherited from Affine2.rotate
- Defined in node_modules/hisabati/dist/index.d.ts:1629

`Static`scale

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

`Static`serialize

serialize(value: GlobalTransform2D): Affine2Like
Parameters
- value: GlobalTransform2D
Returns Affine2Like
Overrides Affine2.serialize
- Defined in packages/transform/src/components/2d/globaltransform.js:23

`Static`set

set(
    e11: number,
    e12: number,
    e13: number,
    e21: number,
    e22: number,
    e23: number,
    out?: Affine2,
): Affine2
Creates or overwrites an affine with raw matrix components.
Parameters
- e11: number
- e12: number
- e13: number
- e21: number
- e22: number
- e23: number
- Optionalout: Affine2
Returns Affine2
Inherited from Affine2.set
- Defined in node_modules/hisabati/dist/index.d.ts:1577

`Static`transform

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

`Static`transformWithoutTranslation

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

`Static`translate

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

`Static`validateSerial

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

`Static`zero

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

Class GlobalTransform2D

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns GlobalTransform2D

Properties

a

b

c

d

x

y

Static ReadonlyIdentity

Static ReadonlyZero

Methods

[iterator]

Returns IterableIterator<number>

clone

Returns Affine2

compose

Parameters

Returns this

copy

Parameters

Returns this

decompose

Returns [Vector2, Rotary, Vector2]

divide

Parameters

Returns Affine2

equals

Parameters

Returns boolean

invert

Returns Affine2

lookAt

Parameters

Returns Affine2

multiply

Parameters

Returns Affine2

rotate

Parameters

Returns Affine2

scale

Parameters

Returns Affine2

serialize

Returns Affine2Like

set

Parameters

Returns this

transform

Parameters

Returns Vector2

transformWithoutTranslation

Parameters

Returns Vector2

translate

Parameters

Returns Affine2

Staticclone

Parameters

Returns Affine2

Staticcompose

Parameters

Returns Affine2

Staticcopy

Parameters

Returns Affine2

Staticdecompose

Parameters

Returns [Vector2, Rotary, Vector2]

Staticdeserialize

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`transform

`Static`transformWithoutTranslation

`Static`translate

`Static`validateSerial

`Static`zero