Hexagon | @caolo-game/cao-math

Hierarchy

Hexagon

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Hexagon(): Hexagon

- Defined in cao_math.d.ts:175
Returns Hexagon

Properties

center

center: Vec2f

center point in Vec2 coordinate system

returns

radius

radius: number

returns

Methods

contains

contains(point: Vec2f): boolean

- Defined in cao_math.d.ts:188
Parameters
- point: Vec2f
Returns boolean

free

free(): void

- Defined in cao_math.d.ts:175
Returns void

list_points

list_points(): any[]

- Defined in cao_math.d.ts:195
Generates a list of point in the Axial coordinate system that build up this hexagon grid.

Returns any[]

list of tuples of [q, r] integer coordinates.

with_center

with_center(center: Vec2f): Hexagon

- Defined in cao_math.d.ts:200
Parameters
- center: Vec2f
Returns Hexagon

with_offset

with_offset(offset: Vec2f): Hexagon

- Defined in cao_math.d.ts:205
Parameters
- offset: Vec2f
Returns Hexagon

with_radius

with_radius(radius: number): Hexagon

- Defined in cao_math.d.ts:210
Parameters
- radius: number
Returns Hexagon

Static from_radius

from_radius(radius: number): Hexagon

- Defined in cao_math.d.ts:183
Parameters
- radius: number
Returns Hexagon

Generated using TypeDoc