Table of contents

Extends Polyline2d.

class Polygon2d extends Polyline2d {}

Constructor

Constructs a new instance of the Polygon2d class

Parameters

NameDescription

config

Omit<Geometry2dOptions, 'isClosed'> & {
  points: Vec[]
}

Properties


area

readonly
get area(): number

bounds

readonly
get bounds(): Box

center

readonly
get center(): Vec

debugColor

optional
debugColor?: string

ignore

optional
ignore?: boolean

isClosed

isClosed: boolean

isFilled

isFilled: boolean

isLabel

isLabel: boolean

length

readonly
get length(): number

points

points: Vec[]

segments

readonly
get segments(): Edge2d[]

vertices

readonly
get vertices(): Vec[]

Methods

distanceToLineSegment()

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

Parameters

NameDescription

A

B

Returns

number

distanceToPoint()

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

Parameters

NameDescription

point

hitInside

boolean

Returns

number

getArea()

getArea(): number

getBounds()

getBounds(): Box

getLength()

getLength(): number

getSvgPathData()

getSvgPathData(): string

getVertices()

getVertices(): Vec[]

hitTestLineSegment()

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

Parameters

NameDescription

A

B

distance

number

Returns

boolean

hitTestPoint()

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

Parameters

NameDescription

point

margin

number

hitInside

boolean

Returns

boolean

isPointInBounds()

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

Parameters

NameDescription

point

margin

number

Returns

boolean

nearestPoint()

nearestPoint(A: Vec): Vec

Parameters

NameDescription

A

Returns


nearestPointOnLineSegment()

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

Parameters

NameDescription

A

B

Returns


toSimpleSvgPath()

toSimpleSvgPath(): string

Prev
Point2d
Next
Polyline2d