Interface TransformationMatrix

Matrix for affine 2D transformations.

Layout:

        // The values represent:

| a c e | // - (a,b) the x base vector | b d f | // - (c,d) the y base vector | 0 0 1 | // - (e,f) the origin // of the resulting coordinate system.

The third row is always [0 0 1], thus we don't store the values.

interface TransformationMatrix {
    a: number;
    b: number;
    c: number;
    d: number;
    e: number;
    f: number;
    "[iterator]"(): IterableIterator<
        ["b" | "a" | "c" | "d" | "e" | "f", number],
    >;
    applyToPoint(__namedParameters: [number, number]): [number, number];
    applyToVector(__namedParameters: [number, number]): [number, number];
    asImmutable(): this;
    asMutable(): this;
    clear(): this;
    delete<K extends "b" | "a" | "c" | "d" | "e" | "f">(key: K): this;
    deleteIn(keyPath: Iterable<any>): this;
    equals(other: any): boolean;
    get<K extends "b" | "a" | "c" | "d" | "e" | "f">(
        key: K,
        notSetValue?: any,
    ): { a: number; b: number; c: number; d: number; e: number; f: number }[K];
    get<T>(key: string, notSetValue: T): T;
    getIn(keyPath: Iterable<any>): any;
    has(key: string): key is "b" | "a" | "c" | "d" | "e" | "f";
    hashCode(): number;
    hasIn(keyPath: Iterable<any>): boolean;
    inverse(): TransformationMatrix;
    merge(
        ...collections: (
            | Iterable<[string, any]>
            | Partial<
                { a: number; b: number; c: number; d: number; e: number; f: number },
            >
        )[],
    ): this;
    mergeDeep(
        ...collections: (
            | Iterable<[string, any]>
            | Partial<
                { a: number; b: number; c: number; d: number; e: number; f: number },
            >
        )[],
    ): this;
    mergeDeepIn(keyPath: Iterable<any>, ...collections: any[]): this;
    mergeDeepWith(
        merger: (oldVal: any, newVal: any, key: any) => any,
        ...collections: (
            | Iterable<[string, any]>
            | Partial<
                { a: number; b: number; c: number; d: number; e: number; f: number },
            >
        )[],
    ): this;
    mergeIn(keyPath: Iterable<any>, ...collections: any[]): this;
    mergeWith(
        merger: (
            oldVal: any,
            newVal: any,
            key: "b" | "a" | "c" | "d" | "e" | "f",
        ) => any,
        ...collections: (
            | Iterable<[string, any]>
            | Partial<
                { a: number; b: number; c: number; d: number; e: number; f: number },
            >
        )[],
    ): this;
    remove<K extends "b" | "a" | "c" | "d" | "e" | "f">(key: K): this;
    removeIn(keyPath: Iterable<any>): this;
    rotate(degCW: number): TransformationMatrix;
    rotateRad(a: number): TransformationMatrix;
    scale(sx: number, sy?: number): TransformationMatrix;
    set<K extends "b" | "a" | "c" | "d" | "e" | "f">(
        key: K,
        value: {
            a: number;
            b: number;
            c: number;
            d: number;
            e: number;
            f: number;
        }[K],
    ): this;
    setIn(keyPath: Iterable<any>, value: any): this;
    toCssValue(): string;
    toJS(): { a: any; b: any; c: any; d: any; e: any; f: any };
    toJSON(): {
        a: number;
        b: number;
        c: number;
        d: number;
        e: number;
        f: number;
    };
    toObject(): {
        a: number;
        b: number;
        c: number;
        d: number;
        e: number;
        f: number;
    };
    toSeq(): Keyed<"b" | "a" | "c" | "d" | "e" | "f", number>;
    transform(
        a2: number,
        b2: number,
        c2: number,
        d2: number,
        e2: number,
        f2: number,
    ): TransformationMatrix;
    translate(
        __namedParameters: { x: number; y: number },
    ): TransformationMatrix;
    translateX(tx: number): TransformationMatrix;
    translateY(ty: number): TransformationMatrix;
    update<K extends "b" | "a" | "c" | "d" | "e" | "f">(
        key: K,
        updater: (
            value: {
                a: number;
                b: number;
                c: number;
                d: number;
                e: number;
                f: number;
            }[K],
        ) => { a: number; b: number; c: number; d: number; e: number; f: number }[K],
    ): this;
    updateIn(keyPath: Iterable<any>, updater: (value: any) => any): this;
    wasAltered(): boolean;
    withMutations(mutator: (mutable: this) => any): this;
}

Hierarchy

Record<
    { a: number; b: number; c: number; d: number; e: number; f: number },
    this,
> & Readonly<
    { a: number; b: number; c: number; d: number; e: number; f: number },
>
- TransformationMatrix

Properties

a

a: number

b

b: number

c

c: number

d

d: number

e

e: number

f

f: number

Methods

[iterator]

"[iterator]"(): IterableIterator<["b" | "a" | "c" | "d" | "e" | "f", number]>
Returns IterableIterator<["b" | "a" | "c" | "d" | "e" | "f", number]>
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<{ a: number // `scaleX()` b: number // `skewY()` c: number // `skewX()` d: number // `scaleY()` e: number // `translateX()` f: number // `translateY()` }>).[iterator]

applyToPoint

applyToPoint(__namedParameters: [number, number]): [number, number]
Multiplies the point with the matrix to apply the transformation. Transforming a "point" means also applying any translation from the matrix.

| x'| | a c e | | x | | y'| = | b d f | * | y | | 1 | | 0 0 1 | | 1 |
Parameters
- __namedParameters: [number, number]
Returns [number, number]

applyToVector

applyToVector(__namedParameters: [number, number]): [number, number]
Multiplies the vector with the matrix to apply the transformation. Transforming a "vector" does ignore the translation of the matrix.

| x'| | a c e | | x | | y'| = | b d f | * | y | | 0 | | 0 0 1 | | 0 |
Parameters
- __namedParameters: [number, number]
Returns [number, number]

asImmutable

asImmutable(): this
Returns this
See
Map#asImmutable

Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<{ a: number // `scaleX()` b: number // `skewY()` c: number // `skewX()` d: number // `scaleY()` e: number // `translateX()` f: number // `translateY()` }>).asImmutable

asMutable

asMutable(): this
Returns this
See
Map#asMutable

Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<{ a: number // `scaleX()` b: number // `skewY()` c: number // `skewX()` d: number // `scaleY()` e: number // `translateX()` f: number // `translateY()` }>).asMutable

clear

clear(): this
Returns a new instance of this Record type with all values set to their default values.

Returns this
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<{ a: number // `scaleX()` b: number // `skewY()` c: number // `skewX()` d: number // `scaleY()` e: number // `translateX()` f: number // `translateY()` }>).clear

delete

delete<K extends "b" | "a" | "c" | "d" | "e" | "f">(key: K): this
Returns a new instance of this Record type with the value for the specific key set to its default value.
Type Parameters
- K extends "b" | "a" | "c" | "d" | "e" | "f"
Parameters
- key: K
Returns this
Alias
remove

Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<{ a: number // `scaleX()` b: number // `skewY()` c: number // `skewX()` d: number // `scaleY()` e: number // `translateX()` f: number // `translateY()` }>).delete

deleteIn

deleteIn(keyPath: Iterable<any>): this
Parameters
- keyPath: Iterable<any>
Returns this
Alias
removeIn

Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<{ a: number // `scaleX()` b: number // `skewY()` c: number // `skewX()` d: number // `scaleY()` e: number // `translateX()` f: number // `translateY()` }>).deleteIn

equals

equals(other: any): boolean
Parameters
- other: any
Returns boolean
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<{ a: number // `scaleX()` b: number // `skewY()` c: number // `skewX()` d: number // `scaleY()` e: number // `translateX()` f: number // `translateY()` }>).equals

get

get<K extends "b" | "a" | "c" | "d" | "e" | "f">(
key: K,
notSetValue?: any,
): { a: number; b: number; c: number; d: number; e: number; f: number }[K]
Returns the value associated with the provided key, which may be the default value defined when creating the Record factory function.

If the requested key is not defined by this Record type, then notSetValue will be returned if provided. Note that this scenario would produce an error when using Flow or TypeScript.
Type Parameters
- K extends "b" | "a" | "c" | "d" | "e" | "f"
Parameters
- key: K
- OptionalnotSetValue: any
Returns { a: number; b: number; c: number; d: number; e: number; f: number }[K]
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<{ a: number // `scaleX()` b: number // `skewY()` c: number // `skewX()` d: number // `scaleY()` e: number // `translateX()` f: number // `translateY()` }>).get
get<T>(key: string, notSetValue: T): T
Type Parameters
- T
Parameters
- key: string
- notSetValue: T
Returns T
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<{ a: number // `scaleX()` b: number // `skewY()` c: number // `skewX()` d: number // `scaleY()` e: number // `translateX()` f: number // `translateY()` }>).get

getIn

getIn(keyPath: Iterable<any>): any
Parameters
- keyPath: Iterable<any>
Returns any
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<{ a: number // `scaleX()` b: number // `skewY()` c: number // `skewX()` d: number // `scaleY()` e: number // `translateX()` f: number // `translateY()` }>).getIn

has

has(key: string): key is "b" | "a" | "c" | "d" | "e" | "f"
Parameters
- key: string
Returns key is "b" | "a" | "c" | "d" | "e" | "f"
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<{ a: number // `scaleX()` b: number // `skewY()` c: number // `skewX()` d: number // `scaleY()` e: number // `translateX()` f: number // `translateY()` }>).has

hashCode

hashCode(): number
Returns number
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<{ a: number // `scaleX()` b: number // `skewY()` c: number // `skewX()` d: number // `scaleY()` e: number // `translateX()` f: number // `translateY()` }>).hashCode

hasIn

hasIn(keyPath: Iterable<any>): boolean
Parameters
- keyPath: Iterable<any>
Returns boolean
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<{ a: number // `scaleX()` b: number // `skewY()` c: number // `skewX()` d: number // `scaleY()` e: number // `translateX()` f: number // `translateY()` }>).hasIn

inverse

inverse(): TransformationMatrix
Calculates the inverse matrix. This requires the determinant to be != 0, which is always granted since the matrix can only hold affine transformations (all affine transformations are easily invertible).

We exploit the fact that the matrix is affine to speed things up.

Returns TransformationMatrix

merge

merge(
    ...collections: (
        | Iterable<[string, any]>
        | Partial<
            { a: number; b: number; c: number; d: number; e: number; f: number },
        >
    )[],
): this
Parameters
- ...collections: (
      | Iterable<[string, any]>
      | Partial<
          { a: number; b: number; c: number; d: number; e: number; f: number },
      >
  )[]
Returns this
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<{ a: number // `scaleX()` b: number // `skewY()` c: number // `skewX()` d: number // `scaleY()` e: number // `translateX()` f: number // `translateY()` }>).merge

mergeDeep

mergeDeep(
    ...collections: (
        | Iterable<[string, any]>
        | Partial<
            { a: number; b: number; c: number; d: number; e: number; f: number },
        >
    )[],
): this
Parameters
- ...collections: (
      | Iterable<[string, any]>
      | Partial<
          { a: number; b: number; c: number; d: number; e: number; f: number },
      >
  )[]
Returns this
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<{ a: number // `scaleX()` b: number // `skewY()` c: number // `skewX()` d: number // `scaleY()` e: number // `translateX()` f: number // `translateY()` }>).mergeDeep

mergeDeepIn

mergeDeepIn(keyPath: Iterable<any>, ...collections: any[]): this
Parameters
- keyPath: Iterable<any>
- ...collections: any[]
Returns this
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<{ a: number // `scaleX()` b: number // `skewY()` c: number // `skewX()` d: number // `scaleY()` e: number // `translateX()` f: number // `translateY()` }>).mergeDeepIn

mergeDeepWith

mergeDeepWith(
    merger: (oldVal: any, newVal: any, key: any) => any,
    ...collections: (
        | Iterable<[string, any]>
        | Partial<
            { a: number; b: number; c: number; d: number; e: number; f: number },
        >
    )[],
): this
Parameters
- merger: (oldVal: any, newVal: any, key: any) => any
- ...collections: (
      | Iterable<[string, any]>
      | Partial<
          { a: number; b: number; c: number; d: number; e: number; f: number },
      >
  )[]
Returns this
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<{ a: number // `scaleX()` b: number // `skewY()` c: number // `skewX()` d: number // `scaleY()` e: number // `translateX()` f: number // `translateY()` }>).mergeDeepWith

mergeIn

mergeIn(keyPath: Iterable<any>, ...collections: any[]): this
Parameters
- keyPath: Iterable<any>
- ...collections: any[]
Returns this
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<{ a: number // `scaleX()` b: number // `skewY()` c: number // `skewX()` d: number // `scaleY()` e: number // `translateX()` f: number // `translateY()` }>).mergeIn

mergeWith

mergeWith(
    merger: (
        oldVal: any,
        newVal: any,
        key: "b" | "a" | "c" | "d" | "e" | "f",
    ) => any,
    ...collections: (
        | Iterable<[string, any]>
        | Partial<
            { a: number; b: number; c: number; d: number; e: number; f: number },
        >
    )[],
): this
Parameters
- merger: (oldVal: any, newVal: any, key: "b" | "a" | "c" | "d" | "e" | "f") => any
- ...collections: (
      | Iterable<[string, any]>
      | Partial<
          { a: number; b: number; c: number; d: number; e: number; f: number },
      >
  )[]
Returns this
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<{ a: number // `scaleX()` b: number // `skewY()` c: number // `skewX()` d: number // `scaleY()` e: number // `translateX()` f: number // `translateY()` }>).mergeWith

remove

remove<K extends "b" | "a" | "c" | "d" | "e" | "f">(key: K): this
Type Parameters
- K extends "b" | "a" | "c" | "d" | "e" | "f"
Parameters
- key: K
Returns this
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<{ a: number // `scaleX()` b: number // `skewY()` c: number // `skewX()` d: number // `scaleY()` e: number // `translateX()` f: number // `translateY()` }>).remove

removeIn

removeIn(keyPath: Iterable<any>): this
Parameters
- keyPath: Iterable<any>
Returns this
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<{ a: number // `scaleX()` b: number // `skewY()` c: number // `skewX()` d: number // `scaleY()` e: number // `translateX()` f: number // `translateY()` }>).removeIn

rotate

rotate(degCW: number): TransformationMatrix
Rotates the matrix by deg degrees in the xy-plane clockwise about the origin of the Cartesian coordinate system.
Parameters
- degCW: number
Returns TransformationMatrix

rotateRad

rotateRad(a: number): TransformationMatrix
Rotates the matrix by rad radian in the xy-plane clockwise about the origin of the Cartesian coordinate system.
Parameters
- a: number
Returns TransformationMatrix

scale

scale(sx: number, sy?: number): TransformationMatrix
Applies a scaling to the matrix. If only sx is set and sy is undefined, we will scale x and y by sx.

A scale of 1 does not modify a dimension.
```
     | sx  0  0 |
```
M' = M * | 0 sy 0 | | 0 0 1 |
Parameters
- sx: number
- Optionalsy: number
Returns TransformationMatrix

set

set<K extends "b" | "a" | "c" | "d" | "e" | "f">(
key: K,
value: { a: number; b: number; c: number; d: number; e: number; f: number }[K],
): this
Type Parameters
- K extends "b" | "a" | "c" | "d" | "e" | "f"
Parameters
- key: K
- value: { a: number; b: number; c: number; d: number; e: number; f: number }[K]
Returns this
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<{ a: number // `scaleX()` b: number // `skewY()` c: number // `skewX()` d: number // `scaleY()` e: number // `translateX()` f: number // `translateY()` }>).set

setIn

setIn(keyPath: Iterable<any>, value: any): this
Parameters
- keyPath: Iterable<any>
- value: any
Returns this
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<{ a: number // `scaleX()` b: number // `skewY()` c: number // `skewX()` d: number // `scaleY()` e: number // `translateX()` f: number // `translateY()` }>).setIn

toCssValue

toCssValue(): string
Returns the matrix's values as a CSS transform string.

Returns string

toJS

toJS(): { a: any; b: any; c: any; d: any; e: any; f: any }
Deeply converts this Record to equivalent native JavaScript Object.

Note: This method may not be overridden. Objects with custom serialization to plain JS may override toJSON() instead.

Returns { a: any; b: any; c: any; d: any; e: any; f: any }
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<{ a: number // `scaleX()` b: number // `skewY()` c: number // `skewX()` d: number // `scaleY()` e: number // `translateX()` f: number // `translateY()` }>).toJS

toJSON

toJSON(): { a: number; b: number; c: number; d: number; e: number; f: number }
Shallowly converts this Record to equivalent native JavaScript Object.

Returns { a: number; b: number; c: number; d: number; e: number; f: number }
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<{ a: number // `scaleX()` b: number // `skewY()` c: number // `skewX()` d: number // `scaleY()` e: number // `translateX()` f: number // `translateY()` }>).toJSON

toObject

toObject(): { a: number; b: number; c: number; d: number; e: number; f: number }
Shallowly converts this Record to equivalent JavaScript Object.

Returns { a: number; b: number; c: number; d: number; e: number; f: number }
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<{ a: number // `scaleX()` b: number // `skewY()` c: number // `skewX()` d: number // `scaleY()` e: number // `translateX()` f: number // `translateY()` }>).toObject

toSeq

toSeq(): Keyed<"b" | "a" | "c" | "d" | "e" | "f", number>
Returns Keyed<"b" | "a" | "c" | "d" | "e" | "f", number>
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<{ a: number // `scaleX()` b: number // `skewY()` c: number // `skewX()` d: number // `scaleY()` e: number // `translateX()` f: number // `translateY()` }>).toSeq

transform

transform(
    a2: number,
    b2: number,
    c2: number,
    d2: number,
    e2: number,
    f2: number,
): TransformationMatrix
Multiplies current matrix values with a new transformation matrix.

The transformation will be applied on the left side of the multiplication, so that they are applied in the order transform() is called.

| a' c' e' | | a2 c2 e2 | | a c e | | b' d' f' | = | b2 d2 f2 | * | b d f | | 0 0 1 | | 0 0 1 | | 0 0 1 |
Parameters
- a2: number
- b2: number
- c2: number
- d2: number
- e2: number
- f2: number
Returns TransformationMatrix

translate

translate(__namedParameters: { x: number; y: number }): TransformationMatrix
Applies a translation to the matrix
```
     | 1 0 tx |
```
M' = M * | 0 1 ty | | 0 0 1 |
Parameters
- __namedParameters: { x: number; y: number }
Returns TransformationMatrix

translateX

translateX(tx: number): TransformationMatrix
Parameters
- tx: number
Returns TransformationMatrix

translateY

translateY(ty: number): TransformationMatrix
Parameters
- ty: number
Returns TransformationMatrix

update

update<K extends "b" | "a" | "c" | "d" | "e" | "f">(
    key: K,
    updater: (
        value: {
            a: number;
            b: number;
            c: number;
            d: number;
            e: number;
            f: number;
        }[K],
    ) => { a: number; b: number; c: number; d: number; e: number; f: number }[K],
): this
Type Parameters
- K extends "b" | "a" | "c" | "d" | "e" | "f"
Parameters
- key: K
- updater: (
      value: {
          a: number;
          b: number;
          c: number;
          d: number;
          e: number;
          f: number;
      }[K],
  ) => { a: number; b: number; c: number; d: number; e: number; f: number }[K]
Returns this
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<{ a: number // `scaleX()` b: number // `skewY()` c: number // `skewX()` d: number // `scaleY()` e: number // `translateX()` f: number // `translateY()` }>).update

updateIn

updateIn(keyPath: Iterable<any>, updater: (value: any) => any): this
Parameters
- keyPath: Iterable<any>
- updater: (value: any) => any
Returns this
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<{ a: number // `scaleX()` b: number // `skewY()` c: number // `skewX()` d: number // `scaleY()` e: number // `translateX()` f: number // `translateY()` }>).updateIn

wasAltered

wasAltered(): boolean
Returns boolean
See
Map#wasAltered

Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<{ a: number // `scaleX()` b: number // `skewY()` c: number // `skewX()` d: number // `scaleY()` e: number // `translateX()` f: number // `translateY()` }>).wasAltered

withMutations

withMutations(mutator: (mutable: this) => any): this
Note: Not all methods can be used on a mutable collection or within withMutations! Only set may be used mutatively.
Parameters
- mutator: (mutable: this) => any
Returns this
See
Map#withMutations

Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<{ a: number // `scaleX()` b: number // `skewY()` c: number // `skewX()` d: number // `scaleY()` e: number // `translateX()` f: number // `translateY()` }>).withMutations

Interface TransformationMatrix

Hierarchy

Index

Properties

Methods

Properties

a

b

c

d

e

f

Methods

[iterator]

Returns IterableIterator<["b" | "a" | "c" | "d" | "e" | "f", number]>

applyToPoint

Parameters

Returns [number, number]

applyToVector

Parameters

Returns [number, number]

asImmutable

Returns this

See

asMutable

Returns this

See

clear

Returns this

delete

Type Parameters

Parameters

Returns this

Alias

deleteIn

Parameters

Returns this

Alias

equals

Parameters

Returns boolean

get

Type Parameters

Parameters

Returns { a: number; b: number; c: number; d: number; e: number; f: number }[K]

Type Parameters

Parameters

Returns T

getIn

Parameters

Returns any

has

Parameters

Returns key is "b" | "a" | "c" | "d" | "e" | "f"

hashCode

Returns number

hasIn

Parameters

Returns boolean

inverse

Returns TransformationMatrix

merge

Parameters

Returns this

mergeDeep

Parameters

Returns this

mergeDeepIn

Parameters

Returns this

mergeDeepWith

Parameters

Returns this

mergeIn

Parameters

Returns this

mergeWith

Parameters

Returns this

remove