Rectangle2d • tldraw Docs

Table of contents

_segments
area
bounds
center
debugColor
h
ignore
isClosed
isFilled
isInternal
isLabel
length
points
segments
vertices
w
x
y
Properties
Methods
- distanceToLineSegment
- distanceToPoint
- getArea
- getBounds
- getLength
- getSvgPathData
- getVertices
- hitTestLineSegment
- hitTestPoint
- intersectCircle
- intersectLineSegment
- intersectPolygon
- intersectPolyline
- isExcludedByFilter
- isPointInBounds
- nearestPoint
- nearestPointOnLineSegment
- toSimpleSvgPath
- transform

Extends Polygon2d.

class Rectangle2d extends Polygon2d {}

Constructor

Constructs a new instance of the Rectangle2d class

Parameters

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

Properties

area

readonly

from Geometry2d

get area(): number

bounds

readonly

from Geometry2d

get bounds(): Box

center

readonly

from Geometry2d

get center(): Vec

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

isInternal

from Geometry2d

isInternal: boolean

isLabel

from Geometry2d

isLabel: boolean

length

readonly

from Geometry2d

get length(): number

points

from Polyline2d

points: Vec[]

segments

readonly

from Polyline2d

get segments(): Edge2d[]

vertices

readonly

from Geometry2d

get vertices(): Vec[]

w

w: number

x

x: number

y

y: number

Methods

distanceToLineSegment()

from Geometry2d

distanceToLineSegment(A: Vec, B: Vec, filters?: Geometry2dFilters): number

Parameters

Name	Description
`A`	`Vec`
`B`	`Vec`
`filters`	`Geometry2dFilters`

Returns

number

distanceToPoint()

from Geometry2d

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

Parameters

Name	Description
`point`	`Vec`
`hitInside`	`boolean`
`filters`	`Geometry2dFilters`

Returns

number

getArea()

from Geometry2d

getArea(): number

getBounds()

getBounds(): Box

getLength()

from Polyline2d

getLength(): number

getSvgPathData()

getSvgPathData(): string

getVertices()

from Polyline2d

getVertices(): Vec[]

hitTestLineSegment()

from Polyline2d

hitTestLineSegment(A: Vec, B: Vec, distance?: number): boolean

Parameters

Name	Description
`A`	`Vec`
`B`	`Vec`
`distance`	`number`

Returns

boolean

hitTestPoint()

from Geometry2d

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

Parameters

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

Returns

boolean

intersectCircle()

from Geometry2d

intersectCircle(
  center: VecLike,
  radius: number,
  filters?: Geometry2dFilters
): VecLike[]

Parameters

Name	Description
`center`	`VecLike`
`radius`	`number`
`filters`	`Geometry2dFilters`

Returns

VecLike[]

intersectLineSegment()

from Geometry2d

intersectLineSegment(
  A: VecLike,
  B: VecLike,
  filters?: Geometry2dFilters
): VecLike[]

Parameters

Name	Description
`A`	`VecLike`
`B`	`VecLike`
`filters`	`Geometry2dFilters`

Returns

VecLike[]

intersectPolygon()

from Geometry2d

intersectPolygon(polygon: VecLike[], filters?: Geometry2dFilters): VecLike[]

Parameters

Name	Description
`polygon`	`VecLike[]`
`filters`	`Geometry2dFilters`

Returns

VecLike[]

intersectPolyline()

from Geometry2d

intersectPolyline(polyline: VecLike[], filters?: Geometry2dFilters): VecLike[]

Parameters

Name	Description
`polyline`	`VecLike[]`
`filters`	`Geometry2dFilters`

Returns

VecLike[]

isExcludedByFilter()

from Geometry2d

isExcludedByFilter(filters?: Geometry2dFilters): boolean

Parameters

Name	Description
`filters`	`Geometry2dFilters`

Returns

boolean

isPointInBounds()

from Geometry2d

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

Parameters

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

Returns

boolean

nearestPoint()

from Polyline2d

nearestPoint(A: Vec): Vec

Parameters

Name	Description
`A`	`Vec`

Returns

Vec

nearestPointOnLineSegment()

from Geometry2d

Deprecated: Iterate the vertices instead.

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

Parameters

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

Returns

Vec

toSimpleSvgPath()

from Geometry2d

toSimpleSvgPath(): string

transform()

from Geometry2d

transform(transform: MatModel): Geometry2d

Parameters

Name	Description
`transform`	`MatModel`

Returns

Geometry2d