Edge2d • tldraw Docs

Table of contents

area
bounds
center
d
debugColor
end
ignore
isClosed
isFilled
isInternal
isLabel
length
start
u
ul
vertices
Properties
Methods

Extends Geometry2d.

class Edge2d extends Geometry2d {}

Constructor

Constructs a new instance of the Edge2d class

Parameters

Name	Description
`config`	`{ end: Vec start: Vec }`

Properties

area

readonly

from Geometry2d

get area(): number

bounds

readonly

from Geometry2d

get bounds(): Box

center

readonly

from Geometry2d

get center(): Vec

d

d: Vec

debugColor

optional

from Geometry2d

debugColor?: string

end

end: Vec

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

start

start: Vec

u

u: Vec

ul

ul: number

vertices

readonly

from Geometry2d

get vertices(): Vec[]

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()

from Geometry2d

getBounds(): Box

getLength()

getLength(): number

getSvgPathData()

getSvgPathData(first?: boolean): string

Parameters

Name	Description
`first`	`boolean`

Returns

string

getVertices()

getVertices(): Vec[]

hitTestLineSegment()

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

midPoint()

midPoint(): Vec

nearestPoint()

nearestPoint(point: Vec): Vec

Parameters

Name	Description
`point`	`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,
  opts?: TransformedGeometry2dOptions
): Geometry2d

Parameters

Name	Description
`transform`	`MatModel`
`opts`	`TransformedGeometry2dOptions`

Returns

Geometry2d