Polygon.md

@immugio/three-math-extensions / Exports / Polygon

Class: Polygon

Table of contents

Constructors

• constructor

Properties

• contour
• holes

Accessors

• size

Methods

• boundingBox
• center
• centerOnOrigin
• clone
• ensureLastPoint
• equals
• flip
• toBoundingPolygon
• toRectangle
• fromPoints
• fromSize

Constructors

constructor

• new Polygon(contour, holes?): Polygon

Parameters

Name	Type
contour	Vec2[]
holes?	Vec2[][]

Returns

Polygon

Defined in

src/Polygon.ts:8

Properties

contour

• contour: Vec2[]

Defined in

src/Polygon.ts:8

---

holes

• Optional holes: Vec2[][]

Defined in

src/Polygon.ts:8

Accessors

size

• get size(): Vec2

Returns

Vec2

Defined in

src/Polygon.ts:24

Methods

boundingBox

▸ boundingBox(): BoundingBox

Returns

BoundingBox

Defined in

src/Polygon.ts:73

---

center

▸ center(): Vec2

Returns

Vec2

Defined in

src/Polygon.ts:48

---

centerOnOrigin

▸ centerOnOrigin(): Polygon

Returns

Polygon

Defined in

src/Polygon.ts:29

---

clone

▸ clone(): Polygon

Returns

Polygon

Defined in

src/Polygon.ts:115

---

ensureLastPoint

▸ ensureLastPoint(): Polygon

Returns

Polygon

Defined in

src/Polygon.ts:57

---

equals

▸ equals(other): boolean

Parameters

Name	Type
other	Polygon

Returns

boolean

Defined in

src/Polygon.ts:119

---

flip

▸ flip(): Polygon

Returns

Polygon

Defined in

src/Polygon.ts:96

---

toBoundingPolygon

▸ toBoundingPolygon(): Polygon

Returns

Polygon

Defined in

src/Polygon.ts:86

---

toRectangle

▸ toRectangle(): Rectangle

Returns

Rectangle

Defined in

src/Polygon.ts:110

---

fromPoints

▸ fromPoints(contour, holes?): Polygon

Parameters

Name	Type
contour	Point2[]
holes?	Point2[][]

Returns

Polygon

Defined in

src/Polygon.ts:11

---

fromSize

▸ fromSize(width, height): Polygon

Parameters

Name	Type
width	number
height	number

Returns

Polygon

Defined in

src/Polygon.ts:15