A helper for computing coordinates in a hexagonal map. More...

#include <gf/Hexagon.h>

Public Member Functions
	HexagonHelper (MapCellAxis axis, MapCellIndex index)
	Constructor. More...

Vector2f	getHexagonSize (float radius) const noexcept
	Get the hexagon size. More...

RectF	computeBounds (Vector2i size, float radius) const noexcept
	Get the bounds for hexagon cells. More...

Vector2f	computeCenter (Vector2i coords, float radius) const
	Compute the center of the hexagon. More...

std::vector< Vector2f >	computeCorners (Vector2i coords, float radius) const
	Compute the six corners of the hexagon. More...

Detailed Description

A helper for computing coordinates in a hexagonal map.

Constructor & Destructor Documentation

gf::HexagonHelper::HexagonHelper	(	MapCellAxis	axis,
		MapCellIndex	index
	)

inline

Constructor.

Parameters

axis	The orientation of hexagon cells. X for pointy and Y for flat
index	The index of data storage. Odd or Even indicate on which col or row is the offset

RectF gf::HexagonHelper::computeBounds	(	Vector2i	size,
		float	radius
	)		const

noexcept

Get the bounds for hexagon cells.

Parameters

size	Number of cells
radius	Radius of hexagon

Vector2f gf::HexagonHelper::computeCenter	(	Vector2i	coords,
		float	radius
	)		const

Compute the center of the hexagon.

Parameters

coords	The size of the hexagon in the map
radius	Radius of hexagon

std::vector<Vector2f> gf::HexagonHelper::computeCorners	(	Vector2i	coords,
		float	radius
	)		const

Compute the six corners of the hexagon.

Parameters

coords	The size of the hexagon in the map
radius	Radius of hexagon

Vector2f gf::HexagonHelper::getHexagonSize ( float radius ) const

noexcept

Get the hexagon size.

Parameters

radius Radius of hexagon