Class Affine2

A class that is used to transform positions through rotation, scaling and translation.

a	c	e
b	d	f

Hierarchy (View Summary)

Affine2
- GlobalTransform2D

Index

Constructors

Properties

a b c d x y Identity Zero

Constructors

constructor

new Affine2(
    e11?: number,
    e12?: number,
    e13?: number,
    e21?: number,
    e22?: number,
    e23?: number,
): Affine2
Parameters
- e11: number = 1
- e12: number = 0
- e13: number = 0
- e21: number = 0
- e22: number = 1
- e23: number = 0
Returns Affine2
- Defined in packages/math/src/core/affines/affine2.js:51

Properties

a

a: number

b

b: number

c

c: number

d

d: number

x

x: number

y

y: number

`Static` `Readonly`Identity

Identity: Affine2 = ...

`Static` `Readonly`Zero

Zero: Affine2 = ...

Methods

[iterator]

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

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

clone

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

Returns Affine2
- Defined in packages/math/src/core/affines/affine2.js:86

compose

compose(translation: Vector2, orientation: Rotary, scale: Vector2): Affine2
Parameters
- translation: Vector2
- orientation: Rotary
- scale: Vector2
Returns Affine2
- Defined in packages/math/src/core/affines/affine2.js:97

copy

copy(affine: Affine2): Affine2
Copies a affine into this affine.
Parameters
- affine: Affine2
Returns Affine2
- Defined in packages/math/src/core/affines/affine2.js:75

decompose

decompose(): [Vector2, Rotary, Vector2]
Returns [Vector2, Rotary, Vector2]
- Defined in packages/math/src/core/affines/affine2.js:106

divide

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

equals

equals(affine: Affine2): boolean
Deeply checks if a affine is equal to another.
Parameters
- affine: Affine2
Returns boolean
- Defined in packages/math/src/core/affines/affine2.js:210

invert

invert(): Affine2
Inverts the affine.

Returns Affine2
- Defined in packages/math/src/core/affines/affine2.js:172

lookAt

lookAt(target: Vector2): Affine2
Parameters
- target: Vector2
Returns Affine2
- Defined in packages/math/src/core/affines/affine2.js:150

multiply

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

rotate

rotate(angle: Rotary): Affine2
Rotates the affine by the given angle.
Parameters
- angle: Rotary
Returns Affine2
- Defined in packages/math/src/core/affines/affine2.js:128

scale

scale(scale: Vector2): Affine2
Scales a affine by a given amount.
Parameters
- scale: Vector2
Returns Affine2
- Defined in packages/math/src/core/affines/affine2.js:140

set

set(
    e11: number,
    e12: number,
    e13: number,
    e21: number,
    e22: number,
    e23: number,
): Affine2
Parameters
- e11: number
- e12: number
- e13: number
- e21: number
- e22: number
- e23: number
Returns Affine2
- Defined in packages/math/src/core/affines/affine2.js:63

transform

transform(vector: Vector2): Vector2
Transforms the given vector.
Parameters
- vector: Vector2
Returns Vector2
- Defined in packages/math/src/core/affines/affine2.js:163

translate

translate(translation: Vector2): Affine2
Translates a affine by a given amount.
Parameters
- translation: Vector2
Returns Affine2
- Defined in packages/math/src/core/affines/affine2.js:116

`Static`compose

compose(
    translation: Vector2,
    orientation: Rotary,
    scale: Vector2,
    affine?: Affine2,
): Affine2
Parameters
- translation: Vector2
- orientation: Rotary
- scale: Vector2
- affine: Affine2 = ...
Returns Affine2
- Defined in packages/math/src/core/affines/affine2.js:315

`Static`copy

copy(affine: Affine2, out?: Affine2): Affine2
Parameters
- affine: Affine2
- Optionalout: Affine2 = ...
Returns Affine2
- Defined in packages/math/src/core/affines/affine2.js:238

`Static`decompose

decompose(
    affine: Affine2,
    position?: Vector2,
    orientation?: Rotary,
    scale?: Vector2,
): [Vector2, Rotary, Vector2]
Parameters
- affine: Affine2
- position: Vector2 = ...
- orientation: Rotary = ...
- scale: Vector2 = ...
Returns [Vector2, Rotary, Vector2]
- Defined in packages/math/src/core/affines/affine2.js:335

`Static`deserialize

deserialize(value: Affine2Serial, out?: Affine2): Affine2
Parameters
- value: Affine2Serial
- Optionalout: Affine2 = ...
Returns Affine2
- Defined in packages/math/src/core/affines/affine2.js:261

`Static`divide

divide(affine1: Affine2, affine2: Affine2, out?: Affine2): Affine2
Parameters
- affine1: Affine2
- affine2: Affine2
- Optionalout: Affine2 = ...
Returns Affine2
- Defined in packages/math/src/core/affines/affine2.js:380

`Static`equal

equal(affine1: Affine2, affine2: Affine2): boolean
Parameters
- affine1: Affine2
- affine2: Affine2
Returns boolean
- Defined in packages/math/src/core/affines/affine2.js:504

`Static`identity

identity(out?: Affine2): Affine2
Parameters
- out: Affine2 = ...
Returns Affine2
- Defined in packages/math/src/core/affines/affine2.js:292

`Static`invert

invert(affine: Affine2, out?: Affine2): Affine2
Parameters
- affine: Affine2
- Optionalout: Affine2 = ...
Returns Affine2
- Defined in packages/math/src/core/affines/affine2.js:392

`Static`lookAt

lookAt(eye: Vector2, target: Vector2, out?: Affine2): Affine2
Parameters
- eye: Vector2
- target: Vector2
- out: Affine2 = ...
Returns Affine2
- Defined in packages/math/src/core/affines/affine2.js:465

`Static`multiply

multiply(affine1: Affine2, affine2: Affine2, out?: Affine2): Affine2
Parameters
- affine1: Affine2
- affine2: Affine2
- Optionalout: Affine2 = ...
Returns Affine2
- Defined in packages/math/src/core/affines/affine2.js:361

`Static`rotate

rotate(affine: Affine2, rotary: Rotary, out?: Affine2): Affine2
Parameters
- affine: Affine2
- rotary: Rotary
- out: Affine2 = ...
Returns Affine2
- Defined in packages/math/src/core/affines/affine2.js:430

`Static`scale

scale(affine: Affine2, scale: Vector2, out?: Affine2): Affine2
Parameters
- affine: Affine2
- scale: Vector2
- Optionalout: Affine2 = ...
Returns Affine2
- Defined in packages/math/src/core/affines/affine2.js:449

`Static`serialize

serialize(value: Affine2): Affine2Serial
Parameters
- value: Affine2
Returns Affine2Serial
- Defined in packages/math/src/core/affines/affine2.js:253

`Static`set

set(
    e11: number,
    e12: number,
    e13: number,
    e21: number,
    e22: number,
    e23: number,
    out?: Affine2,
): Affine2
Parameters
- e11: number
- e12: number
- e13: number
- e21: number
- e22: number
- e23: number
- out: Affine2 = ...
Returns Affine2
- Defined in packages/math/src/core/affines/affine2.js:223

`Static`transform

transform(affine: Affine2, v: Vector2, out?: Vector2): Vector2
Parameters
- affine: Affine2
- v: Vector2
- Optionalout: Vector2 = ...
Returns Vector2
- Defined in packages/math/src/core/affines/affine2.js:489

`Static`translate

translate(affine: Affine2, translation: Vector2, out?: Affine2): Affine2
Parameters
- affine: Affine2
- translation: Vector2
- Optionalout: Affine2 = ...
Returns Affine2
- Defined in packages/math/src/core/affines/affine2.js:414

`Static`validateSerial

validateSerial(value: unknown): value is Affine2Serial
Parameters
- value: unknown
Returns value is Affine2Serial
- Defined in packages/math/src/core/affines/affine2.js:277

`Static`zero

zero(out?: Affine2): Affine2
Parameters
- out: Affine2 = ...
Returns Affine2
- Defined in packages/math/src/core/affines/affine2.js:302