Class Polygon<Sides>

A polygon is a convex shape constructed with straight line segments

Type Parameters

Sides extends number = number

Hierarchy

Polygon

Index

Constructors

Accessors

angle calculatedVertices edges normals offset position vertices

Methods

getAABB getAABBAsQuad getCentroid rotate setAngle setOffset setVertices translate

Constructors

constructor

new Polygon<Sides extends number = number>(
position?: Vector2,
...vertices: Vector2[] & { length: Sides },
): Polygon<Sides>
Create a new polygon
Type Parameters
- Sides extends number = number
Parameters
- position: Vector2 = ...
  The location of the polygon
- ...vertices: Vector2[] & { length: Sides }
  The vertices of the polygon
Returns Polygon<Sides>

Accessors

angle

get angle(): number
The angle of this polygon

Returns number

calculatedVertices

get calculatedVertices(): Vector2[]
The calculated vertices of this polygon

Returns Vector2[]

edges

get edges(): Vector2[]
The edges of this polygon

Returns Vector2[]

normals

get normals(): Vector2[]
The normals of each edge of this polygon

Returns Vector2[]

offset

get offset(): Vector2
The offset of this polygon

Returns Vector2

position

get position(): Vector2
The location of this polygon

Returns Vector2

vertices

get vertices(): Vector2[]
The vertices of this polygon

Returns Vector2[]

Methods

getAABB

getAABB(): Box
Get the box that contains this polygon

Returns Box
The containing box

getAABBAsQuad

getAABBAsQuad(): Quad
Get the polygonal representation of the box that contains this polygon

Returns Quad
The containing quad

getCentroid

getCentroid(): Vector2
Get the location of the geometric center of the polygon

Returns Vector2
The centroid's location

rotate

rotate(radians: number): this
Rotates the polygon by a given angle
Parameters
- radians: number
  The angle to rotate
Returns this
This for chaining

setAngle

setAngle(radians: number): this
Sets the angle of the polygon
Parameters
- radians: number
  The new angle
Returns this
This for chaining

setOffset

setOffset(offset: Vector2): this
Sets the offset of the polygon
Parameters
- offset: Vector2
  The new offset
Returns this
This for chaining

setVertices

setVertices(...vertices: Vector2[]): this
Sets the vertices of the polygon
Parameters
- ...vertices: Vector2[]
  The new vertices
Returns this
This for chaining

translate

translate(vector: Vector2): this
Translates the polygon by a given vector
Parameters
- vector: Vector2
  The translation amount
Returns this