Class Hex

A hexagon is a 6-sided polygon

Hierarchy

Polygon<6>
- Hex

Index

Constructors

Accessors

angle calculatedVertices edges normals offset position vertices

Methods

getAABB getAABBAsQuad getCentroid rotate setAngle setOffset setVertices translate

Constructors

constructor

new Hex(position?: Vector2, ...vertices: Vector2[] & { length: 6 }): Hex
Create a new polygon
Parameters
- position: Vector2 = ...
  The location of the polygon
- ...vertices: Vector2[] & { length: 6 }
  The vertices of the polygon
Returns Hex
Inherited from Polygon.constructor

Accessors

angle

get angle(): number
The angle of this polygon

Returns number
Inherited from Polygon.angle

calculatedVertices

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

Returns Vector2[]
Inherited from Polygon.calculatedVertices

edges

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

Returns Vector2[]
Inherited from Polygon.edges

normals

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

Returns Vector2[]
Inherited from Polygon.normals

offset

get offset(): Vector2
The offset of this polygon

Returns Vector2
Inherited from Polygon.offset

position

get position(): Vector2
The location of this polygon

Returns Vector2
Inherited from Polygon.position

vertices

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

Returns Vector2[]
Inherited from Polygon.vertices

Methods

getAABB

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

Returns Box
The containing box

Inherited from Polygon.getAABB

getAABBAsQuad

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

Returns Quad
The containing quad

Inherited from Polygon.getAABBAsQuad

getCentroid

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

Returns Vector2
The centroid's location

Inherited from Polygon.getCentroid

rotate

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

Inherited from Polygon.rotate

setAngle

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

Inherited from Polygon.setAngle

setOffset

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

Inherited from Polygon.setOffset

setVertices

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

Inherited from Polygon.setVertices

translate

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