Mat • tldraw Docs

Table of contents

a
b
c
d
e
f
Properties
Methods
- Absolute
- applyToBounds
- applyToXY
- Cast
- Compose
- Decompose
- From
- Identity
- Inverse
- Multiply
- Point
- Rotate
- Rotation
- Scale
- Smooth
- Translate
- applyToPoint
- applyToPoints
- clone
- decompose
- decomposed
- equals
- identity
- invert
- multiply
- point
- rotate
- rotation
- scale
- setTo
- toCssString
- translate

class Mat {}

Constructor

Constructs a new instance of the Mat class

Parameters

Name	Description
`a`	`number`
`b`	`number`
`c`	`number`
`d`	`number`
`e`	`number`
`f`	`number`

Properties

a

a: number

b

b: number

c

c: number

d

d: number

e

e: number

f

f: number

Methods

Absolute( )

static

static Absolute(m: MatLike): MatModel

Parameters

Name	Description
`m`	`MatLike`

Returns

MatModel

applyToBounds( )

static

static applyToBounds(m: MatLike, box: Box): Box

Parameters

Name	Description
`m`	`MatLike`
`box`	`Box`

Returns

Box

applyToXY( )

static

static applyToXY(m: MatLike, x: number, y: number): number[]

Parameters

Name	Description
`m`	`MatLike`
`x`	`number`
`y`	`number`

Returns

number[]

Cast( )

static

static Cast(m: MatLike): Mat

Parameters

Name	Description
`m`	`MatLike`

Returns

Mat

Compose( )

static

static Compose(...matrices: MatLike[]): Mat

Parameters

Name	Description
`matrices`	`MatLike[]`

Returns

Mat

Decompose( )

static

static Decompose(m: MatLike): {
  rotation: number
  scaleX: number
  scaleY: number
  x: number
  y: number
}

Parameters

Name	Description
`m`	`MatLike`

Returns

{
  rotation: number
  scaleX: number
  scaleY: number
  x: number
  y: number
}

From( )

static

static From(m: MatLike): Mat

Parameters

Name	Description
`m`	`MatLike`

Returns

Mat

Identity( )

static

static Identity(): Mat

Inverse( )

static

static Inverse(m: MatModel): MatModel

Parameters

Name	Description
`m`	`MatModel`

Returns

MatModel

Multiply( )

static

static Multiply(m1: MatModel, m2: MatModel): MatModel

Parameters

Name	Description
`m1`	`MatModel`
`m2`	`MatModel`

Returns

MatModel

Point( )

static

static Point(m: MatLike): Vec

Parameters

Name	Description
`m`	`MatLike`

Returns

Vec

Rotate( )

static

static Rotate(r: number, cx?: number, cy?: number): Mat

Parameters

Name	Description
`r`	`number`
`cx`	`number`
`cy`	`number`

Returns

Mat

Rotation( )

static

static Rotation(m: MatLike): number

Parameters

Name	Description
`m`	`MatLike`

Returns

number

Scale( )

static

static Scale(x: number, y: number): Mat

Parameters

Name	Description
`x`	`number`
`y`	`number`

Returns

Mat

Smooth( )

static

static Smooth(m: MatLike, precision?: number): MatLike

Parameters

Name	Description
`m`	`MatLike`
`precision`	`number`

Returns

MatLike

Translate( )

static

static Translate(x: number, y: number): Mat

Parameters

Name	Description
`x`	`number`
`y`	`number`

Returns

Mat

applyToPoint( )

applyToPoint(point: VecLike): Vec

Parameters

Name	Description
`point`	`VecLike`

Returns

Vec

applyToPoints( )

applyToPoints(points: VecLike[]): Vec[]

Parameters

Name	Description
`points`	`VecLike[]`

Returns

Vec[]

clone( )

clone(): Mat

decompose( )

decompose(): {
  rotation: number
  scaleX: number
  scaleY: number
  x: number
  y: number
}

decomposed( )

decomposed(): {
  rotation: number
  scaleX: number
  scaleY: number
  x: number
  y: number
}

equals( )

equals(m: Mat | MatModel): boolean

Parameters

Name	Description
`m`	`Mat \| MatModel`

Returns

boolean

identity( )

identity(): this

invert( )

invert(): this

multiply( )

multiply(m: Mat | MatModel): this

Parameters

Name	Description
`m`	`Mat \| MatModel`

Returns

this

point( )

point(): Vec

rotate( )

rotate(r: number, cx?: number, cy?: number): Mat

Parameters

Name	Description
`r`	`number`
`cx`	`number`
`cy`	`number`

Returns

Mat

rotation( )

rotation(): number

scale( )

scale(x: number, y: number): this

Parameters

Name	Description
`x`	`number`
`y`	`number`

Returns

this

setTo( )

setTo(model: MatModel): this

Parameters

Name	Description
`model`	`MatModel`

Returns

this

toCssString( )

toCssString(): string

translate( )

translate(x: number, y: number): Mat

Parameters

Name	Description
`x`	`number`
`y`	`number`

Returns

Mat