tldraw SDK

Table of contents

a
area
b
bounds
c
center
config
d
debugColor
h
ignore
isClosed
isFilled
isLabel
length
vertices
w
Properties
Methods

Extends Geometry2d.

class Stadium2d extends Geometry2d {}

Constructor

Constructs a new instance of the Stadium2d class

Parameters

Name	Description
`config`	`Omit<Geometry2dOptions, 'isClosed'> & { height: number width: number }`

Properties

a

a: Arc2d

area

readonly

from Geometry2d

get area(): number

b

b: Edge2d

bounds

readonly

from Geometry2d

get bounds(): Box

c

c: Arc2d

center

readonly

from Geometry2d

get center(): Vec

config

config: Omit<Geometry2dOptions, 'isClosed'> & {
  height: number
  width: number
}

d

d: Edge2d

debugColor

optional

from Geometry2d

debugColor?: string

h

h: number

ignore

optional

from Geometry2d

ignore?: boolean

isClosed

from Geometry2d

isClosed: boolean

isFilled

from Geometry2d

isFilled: boolean

isLabel

from Geometry2d

isLabel: boolean

length

readonly

from Geometry2d

get length(): number

vertices

readonly

from Geometry2d

get vertices(): Vec[]

w

w: number

Methods

distanceToLineSegment()

from Geometry2d

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

Parameters

Name	Description
`A`	`Vec`
`B`	`Vec`

Returns

number

distanceToPoint()

from Geometry2d

distanceToPoint(point: Vec, hitInside?: boolean): number

Parameters

Name	Description
`point`	`Vec`
`hitInside`	`boolean`

Returns

number

getArea()

from Geometry2d

getArea(): number

getBounds()

getBounds(): Box

getLength()

getLength(): number

getSvgPathData()

getSvgPathData(): string

getVertices()

getVertices(): Vec[]

hitTestLineSegment()

hitTestLineSegment(A: Vec, B: Vec): boolean

Parameters

Name	Description
`A`	`Vec`
`B`	`Vec`

Returns

boolean

hitTestPoint()

from Geometry2d

hitTestPoint(point: Vec, margin?: number, hitInside?: boolean): boolean

Parameters

Name	Description
`point`	`Vec`
`margin`	`number`
`hitInside`	`boolean`

Returns

boolean

isPointInBounds()

from Geometry2d

isPointInBounds(point: Vec, margin?: number): boolean

Parameters

Name	Description
`point`	`Vec`
`margin`	`number`

Returns

boolean

nearestPoint()

nearestPoint(A: Vec): Vec

Parameters

Name	Description
`A`	`Vec`

Returns

Vec

nearestPointOnLineSegment()

from Geometry2d

nearestPointOnLineSegment(A: Vec, B: Vec): Vec

Parameters

Name	Description
`A`	`Vec`
`B`	`Vec`

Returns

Vec

toSimpleSvgPath()

from Geometry2d

toSimpleSvgPath(): string