Vec • tldraw Docs

Table of contents

pressure
x
y
z
Properties
Methods
- Abs
- Add
- AddScalar
- AddXY
- Angle
- Average
- Cast
- Clamp
- Clockwise
- Cpr
- Cross
- Dist
- Dist2
- DistanceToLineSegment
- DistanceToLineThroughPoint
- DistMin
- Div
- DivV
- Dpr
- Equals
- EqualsXY
- From
- FromAngle
- FromArray
- IsNaN
- Len
- Len2
- Lrp
- Max
- Med
- Min
- Mul
- MulV
- NearestPointOnLineSegment
- NearestPointOnLineThroughPoint
- Neg
- Nudge
- Per
- PointsBetween
- Pry
- Rescale
- Rot
- RotWith
- ScaleWithOrigin
- Slope
- Snap
- SnapToGrid
- Sub
- SubScalar
- SubXY
- Tan
- ToAngle
- ToArray
- ToCss
- ToFixed
- ToInt
- ToJson
- ToString
- Uni
- abs
- add
- addScalar
- addXY
- angle
- clamp
- clone
- cpr
- cross
- dist
- distanceToLineSegment
- div
- divV
- dpr
- equals
- equalsXY
- len
- len2
- lrp
- mul
- mulV
- neg
- norm
- nudge
- per
- pry
- rot
- rotWith
- set
- setTo
- slope
- snapToGrid
- sub
- subScalar
- subXY
- tan
- toAngle
- toArray
- toFixed
- toJson
- toString
- uni

class Vec {}

Constructor

Constructs a new instance of the Vec class

Parameters

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

Properties

pressure

readonly

get pressure(): number

x

x: number

y

y: number

z

z: number

Methods

Abs()

static

static Abs(A: VecLike): Vec

Parameters

Name	Description
`A`	`VecLike`

Returns

Vec

Add()

static

static Add(A: VecLike, B: VecLike): Vec

Parameters

Name	Description
`A`	`VecLike`
`B`	`VecLike`

Returns

Vec

AddScalar()

static

static AddScalar(A: VecLike, n: number): Vec

Parameters

Name	Description
`A`	`VecLike`
`n`	`number`

Returns

Vec

AddXY()

static

static AddXY(A: VecLike, x: number, y: number): Vec

Parameters

Name	Description
`A`	`VecLike`
`x`	`number`
`y`	`number`

Returns

Vec

Angle()

static

static Angle(A: VecLike, B: VecLike): number

Parameters

Name	Description
`A`	`VecLike`
`B`	`VecLike`

Returns

number

Average()

static

static Average(arr: VecLike[]): Vec

Parameters

Name	Description
`arr`	`VecLike[]`

Returns

Vec

Cast()

static

static Cast(A: VecLike): Vec

Parameters

Name	Description
`A`	`VecLike`

Returns

Vec

Clamp()

static

static Clamp(A: Vec, min: number, max?: number): Vec

Parameters

Name	Description
`A`	`Vec`
`min`	`number`
`max`	`number`

Returns

Vec

Clockwise()

static

static Clockwise(A: VecLike, B: VecLike, C: VecLike): boolean

Parameters

Name	Description
`A`	`VecLike`
`B`	`VecLike`
`C`	`VecLike`

Returns

boolean

Cpr()

static

Cross product of two vectors which is used to calculate the area of a parallelogram.

static Cpr(A: VecLike, B: VecLike): number

Parameters

Name	Description
`A`	`VecLike`
`B`	`VecLike`

Returns

number

Cross()

static

static Cross(A: VecLike, V: VecLike): Vec

Parameters

Name	Description
`A`	`VecLike`
`V`	`VecLike`

Returns

Vec

Dist()

static

static Dist(A: VecLike, B: VecLike): number

Parameters

Name	Description
`A`	`VecLike`
`B`	`VecLike`

Returns

number

Dist2()

static

static Dist2(A: VecLike, B: VecLike): number

Parameters

Name	Description
`A`	`VecLike`
`B`	`VecLike`

Returns

number

DistanceToLineSegment()

static

static DistanceToLineSegment(
  A: VecLike,
  B: VecLike,
  P: VecLike,
  clamp?: boolean
): number

Parameters

Name	Description
`A`	`VecLike`
`B`	`VecLike`
`P`	`VecLike`
`clamp`	`boolean`

Returns

number

DistanceToLineThroughPoint()

static

static DistanceToLineThroughPoint(A: VecLike, u: VecLike, P: VecLike): number

Parameters

Name	Description
`A`	`VecLike`
`u`	`VecLike`
`P`	`VecLike`

Returns

number

DistMin()

static

static DistMin(A: VecLike, B: VecLike, n: number): boolean

Parameters

Name	Description
`A`	`VecLike`
`B`	`VecLike`
`n`	`number`

Returns

boolean

Div()

static

static Div(A: VecLike, t: number): Vec

Parameters

Name	Description
`A`	`VecLike`
`t`	`number`

Returns

Vec

DivV()

static

static DivV(A: VecLike, B: VecLike): Vec

Parameters

Name	Description
`A`	`VecLike`
`B`	`VecLike`

Returns

Vec

Dpr()

static

Dot product of two vectors which is used to calculate the angle between them.

static Dpr(A: VecLike, B: VecLike): number

Parameters

Name	Description
`A`	`VecLike`
`B`	`VecLike`

Returns

number

Equals()

static

static Equals(A: VecLike, B: VecLike): boolean

Parameters

Name	Description
`A`	`VecLike`
`B`	`VecLike`

Returns

boolean

EqualsXY()

static

static EqualsXY(A: VecLike, x: number, y: number): boolean

Parameters

Name	Description
`A`	`VecLike`
`x`	`number`
`y`	`number`

Returns

boolean

From()

static

static From({ x, y, z }: VecModel): Vec

Parameters

Name	Description
`{ x, y, z }`	`VecModel`

Returns

Vec

FromAngle()

static

static FromAngle(r: number, length?: number): Vec

Parameters

Name	Description
`r`	`number`
`length`	`number`

Returns

Vec

FromArray()

static

static FromArray(v: number[]): Vec

Parameters

Name	Description
`v`	`number[]`

Returns

Vec

IsNaN()

static

static IsNaN(A: VecLike): boolean

Parameters

Name	Description
`A`	`VecLike`

Returns

boolean

Len()

static

static Len(A: VecLike): number

Parameters

Name	Description
`A`	`VecLike`

Returns

number

Len2()

static

static Len2(A: VecLike): number

Parameters

Name	Description
`A`	`VecLike`

Returns

number

Lrp()

static

Linearly interpolate between two points.

static Lrp(A: VecLike, B: VecLike, t: number): Vec

Parameters

Name	Description
`A`	`VecLike` The first point.
`B`	`VecLike` The second point.
`t`	`number` The interpolation value between 0 and 1.

Returns

Vec

The interpolated point.

Max()

static

static Max(A: VecLike, B: VecLike): Vec

Parameters

Name	Description
`A`	`VecLike`
`B`	`VecLike`

Returns

Vec

Med()

static

static Med(A: VecLike, B: VecLike): Vec

Parameters

Name	Description
`A`	`VecLike`
`B`	`VecLike`

Returns

Vec

Min()

static

static Min(A: VecLike, B: VecLike): Vec

Parameters

Name	Description
`A`	`VecLike`
`B`	`VecLike`

Returns

Vec

Mul()

static

static Mul(A: VecLike, t: number): Vec

Parameters

Name	Description
`A`	`VecLike`
`t`	`number`

Returns

Vec

MulV()

static

static MulV(A: VecLike, B: VecLike): Vec

Parameters

Name	Description
`A`	`VecLike`
`B`	`VecLike`

Returns

Vec

NearestPointOnLineSegment()

static

static NearestPointOnLineSegment(
  A: VecLike,
  B: VecLike,
  P: VecLike,
  clamp?: boolean
): Vec

Parameters

Name	Description
`A`	`VecLike`
`B`	`VecLike`
`P`	`VecLike`
`clamp`	`boolean`

Returns

Vec

NearestPointOnLineThroughPoint()

static

Get the nearest point on a line with a known unit vector that passes through point A

Vec.nearestPointOnLineThroughPoint(A, u, Point)

static NearestPointOnLineThroughPoint(A: VecLike, u: VecLike, P: VecLike): Vec

Parameters

Name	Description
`A`	`VecLike` Any point on the line
`u`	`VecLike` The unit vector for the line.
`P`	`VecLike` A point not on the line to test.

Returns

Vec

Neg()

static

static Neg(A: VecLike): Vec

Parameters

Name	Description
`A`	`VecLike`

Returns

Vec

Nudge()

static

static Nudge(A: VecLike, B: VecLike, distance: number): Vec

Parameters

Name	Description
`A`	`VecLike`
`B`	`VecLike`
`distance`	`number`

Returns

Vec

Per()

static

Get the perpendicular vector to A.

static Per(A: VecLike): Vec

Parameters

Name	Description
`A`	`VecLike`

Returns

Vec

PointsBetween()

static

Get an array of points (with simulated pressure) between two points.

static PointsBetween(A: VecModel, B: VecModel, steps?: number): Vec[]

Parameters

Name	Description
`A`	`VecModel` The first point.
`B`	`VecModel` The second point.
`steps`	`number` The number of points to return.

Returns

Vec[]

Pry()

static

Get the projection of A onto B.

static Pry(A: VecLike, B: VecLike): number

Parameters

Name	Description
`A`	`VecLike`
`B`	`VecLike`

Returns

number

Rescale()

static

static Rescale(A: VecLike, n: number): Vec

Parameters

Name	Description
`A`	`VecLike`
`n`	`number`

Returns

Vec

Rot()

static

static Rot(A: VecLike, r?: number): Vec

Parameters

Name	Description
`A`	`VecLike`
`r`	`number`

Returns

Vec

RotWith()

static

static RotWith(A: VecLike, C: VecLike, r: number): Vec

Parameters

Name	Description
`A`	`VecLike`
`C`	`VecLike`
`r`	`number`

Returns

Vec

ScaleWithOrigin()

static

static ScaleWithOrigin(A: VecLike, scale: number, origin: VecLike): Vec

Parameters

Name	Description
`A`	`VecLike`
`scale`	`number`
`origin`	`VecLike`

Returns

Vec

Slope()

static

static Slope(A: VecLike, B: VecLike): number

Parameters

Name	Description
`A`	`VecLike`
`B`	`VecLike`

Returns

number

Snap()

static

static Snap(A: VecLike, step?: number): Vec

Parameters

Name	Description
`A`	`VecLike`
`step`	`number`

Returns

Vec

SnapToGrid()

static

static SnapToGrid(A: VecLike, gridSize?: number): Vec

Parameters

Name	Description
`A`	`VecLike`
`gridSize`	`number`

Returns

Vec

Sub()

static

static Sub(A: VecLike, B: VecLike): Vec

Parameters

Name	Description
`A`	`VecLike`
`B`	`VecLike`

Returns

Vec

SubScalar()

static

static SubScalar(A: VecLike, n: number): Vec

Parameters

Name	Description
`A`	`VecLike`
`n`	`number`

Returns

Vec

SubXY()

static

static SubXY(A: VecLike, x: number, y: number): Vec

Parameters

Name	Description
`A`	`VecLike`
`x`	`number`
`y`	`number`

Returns

Vec

Tan()

static

static Tan(A: VecLike, B: VecLike): Vec

Parameters

Name	Description
`A`	`VecLike`
`B`	`VecLike`

Returns

Vec

ToAngle()

static

static ToAngle(A: VecLike): number

Parameters

Name	Description
`A`	`VecLike`

Returns

number

ToArray()

static

static ToArray(A: VecLike): number[]

Parameters

Name	Description
`A`	`VecLike`

Returns

number[]

ToCss()

static

static ToCss(A: VecLike): string

Parameters

Name	Description
`A`	`VecLike`

Returns

string

ToFixed()

static

static ToFixed(A: VecLike): Vec

Parameters

Name	Description
`A`	`VecLike`

Returns

Vec

ToInt()

static

static ToInt(A: VecLike): Vec

Parameters

Name	Description
`A`	`VecLike`

Returns

Vec

ToJson()

static

static ToJson(A: VecLike): {
  x: number
  y: number
  z: number | undefined
}

Parameters

Name	Description
`A`	`VecLike`

Returns

{
  x: number
  y: number
  z: number | undefined
}

ToString()

static

static ToString(A: VecLike): string

Parameters

Name	Description
`A`	`VecLike`

Returns

string

Uni()

static

Get the unit vector of A.

static Uni(A: VecLike): Vec

Parameters

Name	Description
`A`	`VecLike`

Returns

Vec

abs()

abs(): this

add()

add(V: VecLike): this

Parameters

Name	Description
`V`	`VecLike`

Returns

this

addScalar()

addScalar(n: number): this

Parameters

Name	Description
`n`	`number`

Returns

this

addXY()

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

Parameters

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

Returns

this

angle()

angle(B: VecLike): number

Parameters

Name	Description
`B`	`VecLike`

Returns

number

clamp()

clamp(min: number, max?: number): this

Parameters

Name	Description
`min`	`number`
`max`	`number`

Returns

this

clone()

clone(): Vec

cpr()

cpr(V: VecLike): number

Parameters

Name	Description
`V`	`VecLike`

Returns

number

cross()

cross(V: VecLike): this

Parameters

Name	Description
`V`	`VecLike`

Returns

this

dist()

dist(V: VecLike): number

Parameters

Name	Description
`V`	`VecLike`

Returns

number

distanceToLineSegment()

distanceToLineSegment(A: VecLike, B: VecLike): number

Parameters

Name	Description
`A`	`VecLike`
`B`	`VecLike`

Returns

number

div()

div(t: number): this

Parameters

Name	Description
`t`	`number`

Returns

this

divV()

divV(V: VecLike): this

Parameters

Name	Description
`V`	`VecLike`

Returns

this

dpr()

dpr(V: VecLike): number

Parameters

Name	Description
`V`	`VecLike`

Returns

number

equals()

equals(B: VecLike): boolean

Parameters

Name	Description
`B`	`VecLike`

Returns

boolean

equalsXY()

equalsXY(x: number, y: number): boolean

Parameters

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

Returns

boolean

len()

len(): number

len2()

len2(): number

lrp()

lrp(B: VecLike, t: number): Vec

Parameters

Name	Description
`B`	`VecLike`
`t`	`number`

Returns

Vec

mul()

mul(t: number): this

Parameters

Name	Description
`t`	`number`

Returns

this

mulV()

mulV(V: VecLike): this

Parameters

Name	Description
`V`	`VecLike`

Returns

this

neg()

neg(): this

norm()

norm(): this

nudge()

nudge(B: VecLike, distance: number): this

Parameters

Name	Description
`B`	`VecLike`
`distance`	`number`

Returns

this

per()

per(): this

pry()

pry(V: VecLike): number

Parameters

Name	Description
`V`	`VecLike`

Returns

number

rot()

rot(r: number): this

Parameters

Name	Description
`r`	`number`

Returns

this

rotWith()

rotWith(C: VecLike, r: number): this

Parameters

Name	Description
`C`	`VecLike`
`r`	`number`

Returns

this

set()

set(x?: number, y?: number, z?: number): this

Parameters

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

Returns

this

setTo()

setTo({ x, y, z }: VecLike): this

Parameters

Name	Description
`{ x, y, z }`	`VecLike`

Returns

this

slope()

slope(B: VecLike): number

Parameters

Name	Description
`B`	`VecLike`

Returns

number

snapToGrid()

snapToGrid(gridSize: number): this

Parameters

Name	Description
`gridSize`	`number`

Returns

this

sub()

sub(V: VecLike): this

Parameters

Name	Description
`V`	`VecLike`

Returns

this

subScalar()

subScalar(n: number): this

Parameters

Name	Description
`n`	`number`

Returns

this

subXY()

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

Parameters

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

Returns

this

tan()

tan(V: VecLike): Vec

Parameters

Name	Description
`V`	`VecLike`

Returns

Vec

toAngle()

toAngle(): number

toArray()

toArray(): number[]

toFixed()

toFixed(): Vec

toJson()

toJson(): VecModel

toString()

toString(): string

uni()

uni(): Vec