ReferenceTransformationMatrix

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

Hierarchy

ReadonlyInheritableImmutableRecordTransformationMatrix

0

Methods

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]

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

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
degCWnumber
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
anumber
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
sxnumber
synumber
Optional
Returns
TransformationMatrix

toCssValue

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

Returns
string

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
a2number
b2number
c2number
d2number
e2number
f2number
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
txnumber
Returns
TransformationMatrix

translateY

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

Immutable Record API

asImmutable

Deprecated

asImmutable(): this
Deprecated
Returns
this
Deprecated
Not part of the collection API the Nutrient Web SDK supports. Build the value once, or use withMutations().
See Also
Map#asImmutable

asMutable

Deprecated

asMutable(): this
Deprecated
Returns
this
Deprecated
Not part of the collection API the Nutrient Web SDK supports. Use withMutations().
See Also
Map#asMutable

clear

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

Returns
this

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
Kextends "b" | "a" | "c" | "d" | "e" | "f"
Parameters
keyK
Returns
this

deleteIn

deleteIn(keyPath: Iterable<unknown>): this
Returns a new instance of this Record type with the value at the given key path removed.

Also available as removeIn.

Parameters
keyPathIterable<unknown>
Returns
this

equals

equals(other: unknown): boolean
Parameters
otherunknown
Returns
boolean

get

get<K extends "b" | "a" | "c" | "d" | "e" | "f">(key: K): { … }[K]get<K extends "b" | "a" | "c" | "d" | "e" | "f">(
key: K,
): { 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
Kextends "b" | "a" | "c" | "d" | "e" | "f"
Parameters
keyK
Returns
{ … }[K]{ a: number; b: number; c: number; d: number; e: number; f: number }[K]

getIn

getIn(keyPath: Iterable<unknown>, notSetValue?: unknown): unknown
Parameters
keyPathIterable<unknown>
notSetValueunknown
Optional
Returns
unknown

has

has(key: unknown): boolean
Parameters
keyunknown
Returns
boolean

merge

merge(...collections: Partial<{ … }>[]): thismerge(
    ...collections: Partial<
        { a: number; b: number; c: number; d: number; e: number; f: number },
    >[],
): this
Parameters
...collections
Partial<{ … }>[]Partial<{ a: number; b: number; c: number; d: number; e: number; f: number }>[]
Returns
this

mergeDeep

mergeDeep(
    ...collections: (Iterable<[string, unknown], any, any> | Partial<{ … }>)[],
): thismergeDeep(
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            { a: number; b: number; c: number; d: number; e: number; f: number },
        >
    )[],
): this
Parameters
...collections
(Iterable<[string, unknown], any, any> | Partial<{ … }>)[](
    | Iterable<[string, unknown], any, any>
    | Partial<
        { a: number; b: number; c: number; d: number; e: number; f: number },
    >
)[]
Returns
this

mergeDeepIn

mergeDeepIn(
    keyPath: Iterable<unknown>,
    ...collections: (Iterable<[string, unknown], any, any> | Partial<{ … }>)[],
): thismergeDeepIn(
    keyPath: Iterable<unknown>,
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            { a: number; b: number; c: number; d: number; e: number; f: number },
        >
    )[],
): this
Parameters
keyPathIterable<unknown>
...collections
(Iterable<[string, unknown], any, any> | Partial<{ … }>)[](
    | Iterable<[string, unknown], any, any>
    | Partial<
        { a: number; b: number; c: number; d: number; e: number; f: number },
    >
)[]
Returns
this

mergeDeepWith

mergeDeepWith(
    merger: (previous?: unknown, next?: unknown, key?: string) => unknown,
    ...collections: (Iterable<[string, unknown], any, any> | Partial<{ … }>)[],
): thismergeDeepWith(
    merger: (previous?: unknown, next?: unknown, key?: string) => unknown,
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            { a: number; b: number; c: number; d: number; e: number; f: number },
        >
    )[],
): this
Parameters
merger(previous?: unknown, next?: unknown, key?: string) => unknown
...collections
(Iterable<[string, unknown], any, any> | Partial<{ … }>)[](
    | Iterable<[string, unknown], any, any>
    | Partial<
        { a: number; b: number; c: number; d: number; e: number; f: number },
    >
)[]
Returns
this

mergeIn

Deprecated

mergeIn(
    keyPath: Iterable<unknown>,
    ...collections: (Iterable<[string, unknown], any, any> | Partial<{ … }>)[],
): thismergeIn(
    keyPath: Iterable<unknown>,
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            { a: number; b: number; c: number; d: number; e: number; f: number },
        >
    )[],
): this
Deprecated
Parameters
keyPathIterable<unknown>
...collections
(Iterable<[string, unknown], any, any> | Partial<{ … }>)[](
    | Iterable<[string, unknown], any, any>
    | Partial<
        { a: number; b: number; c: number; d: number; e: number; f: number },
    >
)[]
Returns
this
Deprecated
Not part of the collection API the Nutrient Web SDK supports. Use update() followed by merge().

mergeWith

mergeWith(
    merger: (previous?: unknown, next?: unknown, key?: string) => unknown,
    ...collections: (Iterable<[string, unknown], any, any> | Partial<{ … }>)[],
): thismergeWith(
    merger: (previous?: unknown, next?: unknown, key?: string) => unknown,
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            { a: number; b: number; c: number; d: number; e: number; f: number },
        >
    )[],
): this
Parameters
merger(previous?: unknown, next?: unknown, key?: string) => unknown
...collections
(Iterable<[string, unknown], any, any> | Partial<{ … }>)[](
    | Iterable<[string, unknown], any, any>
    | Partial<
        { a: number; b: number; c: number; d: number; e: number; f: number },
    >
)[]
Returns
this

removeIn

Deprecated

removeIn(keyPath: Iterable<unknown>): this
Deprecated
Parameters
keyPathIterable<unknown>
Returns
this
Deprecated
Not part of the collection API the Nutrient Web SDK supports. Use deleteIn(), or update() followed by delete().

set

set<K extends "b" | "a" | "c" | "d" | "e" | "f">(key: K, value: { … }[K]): thisset<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
Kextends "b" | "a" | "c" | "d" | "e" | "f"
Parameters
keyK
value
{ … }[K]{ a: number; b: number; c: number; d: number; e: number; f: number }[K]
Returns
this

setIn

setIn(keyPath: Iterable<unknown>, value: unknown): this
Parameters
keyPathIterable<unknown>
valueunknown
Returns
this

toJS

toJS(): { … }toJS(): { a: number; b: number; c: number; d: number; e: number; f: number }
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: number; b: number; c: number; d: number; e: number; f: number }
a: number
scaleX()

Default Value
1
b: number
skewY()

Default Value
0
c: number
skewX()

Default Value
0
d: number
scaleY()

Default Value
1
e: number
translateX()

Default Value
0
f: number
translateY()

Default Value
0

toJSON

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 }
a: number
scaleX()

Default Value
1
b: number
skewY()

Default Value
0
c: number
skewX()

Default Value
0
d: number
scaleY()

Default Value
1
e: number
translateX()

Default Value
0
f: number
translateY()

Default Value
0

toSeq

Deprecated

toSeq(): Keyed<string, unknown>
Deprecated
Returns
Keyed<string, unknown>
Deprecated
Not part of the collection API the Nutrient Web SDK supports. Use entries().

update

update<K extends "b" | "a" | "c" | "d" | "e" | "f">(
    key: K,
    updater: (value: { … }[K]) => { … }[K],
): thisupdate<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
Kextends "b" | "a" | "c" | "d" | "e" | "f"
Parameters
keyK
updater
(value: { … }[K]) => { … }[K](
    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

updateIn

updateIn(
    keyPath: Iterable<unknown>,
    notSetValue: unknown,
    updater: (value: unknown) => unknown,
): this
Parameters
keyPathIterable<unknown>
notSetValueunknown
updater(value: unknown) => unknown
Returns
this
updateIn(keyPath: Iterable<unknown>, updater: (value: unknown) => unknown): this
Parameters
keyPathIterable<unknown>
updater(value: unknown) => unknown
Returns
this

withMutations

withMutations(mutator: (mutable: this) => unknown): 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) => unknown
Returns
this
See Also
Map#withMutations

Interface TransformationMatrix

Hierarchy

Properties

Default Value

Default Value

Default Value

Default Value

Default Value

Default Value

Methods

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Immutable Record API

Returns

Deprecated

See Also

Returns

Deprecated

See Also

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Deprecated

Parameters

Returns

Parameters

Returns

Deprecated

Type Parameters

Parameters

Returns

Parameters

Returns

Returns

a: number

Default Value

b: number

Default Value

c: number

Default Value