HexagonAlpha2 Class Reference

Hexagon with arbitrary orientations. More...

#include <hexagon.h>

Inheritance diagram for HexagonAlpha2:

Public Member Functions
	HexagonAlpha2 ()
	Empty.
	HexagonAlpha2 (const Vector2 &, const double &, const double &=0.0)
	Create an oriented hexagon.
	HexagonAlpha2 (const Hexagon2 &, const double &=0.0)
	Create an hexagon.
void	Rotate (const double &)
	Rotates an hexagon.
Vector2	Vertex (int) const
	Return the coordinates of the k-th vertex.
Box2	GetBox () const
	Compute the (coarse) bounding box of a hexagon.
Box2	GetTightBox () const
	Compute the (tight) bounding box of a hexagon.
void	Draw (QGraphicsScene &, const QPen &=QPen(), const QBrush &=QBrush()) const
	Draws an hexagon.
Public Member Functions inherited from Hexagon2
	Hexagon2 ()
	Empty.
	Hexagon2 (const Vector2 &, const double &)
	Create an hexagon.
	Hexagon2 (const double &)
	Create an hexagon.
void	Translate (const Vector2 &)
	Translate a hexagon.
void	Scale (const double &)
	Scale a hexagon.
double	Width () const
	Width of the hexagon.
double	Height () const
	Height of the hexagon.
bool	Inside (const Vector2 &) const
	Test if a point is inside.
bool	Intersect (const Hexagon2 &) const
	Check if two hexagons intersect.
double	R (const Vector2 &) const
	Compute the squared Euclidean distance to the hexagon.
double	Signed (const Vector2 &) const
	Compute the signed Euclidean distance to the hexagon.
Vector2	Normal (const Vector2 &) const
	Computes the distance vector between a hexagon and a point.
Vector2	Center () const
	Return the center of the hexagonal cell.
double	Radius () const
	Return the radius of the hexagonal cell.
Vector2	Radial (int) const
	Return the radial vector of the k-th vertex.
Vector2	Edge (int) const
	Return the edge vector connecting vertexes k and k+1.
Vector2	Vertex (int) const
	Return the coordinates of the k-th vertex.
Box2	GetBox () const
	Compute the bounding box of a hexagon.
double	Area () const
	Area of the hexagon.
double	Perimeter () const
	Perimeter of the hexagon.
Vector2	RandomInside (Random &=Random::R239) const
	Generate a random vector inside the hexagon.
QVector< Vector2 >	Poisson (const double &, int, Random &=Random::R239) const
	Compute a Poisson disc distribution inside the hexagon.
bool	Intersect (const Circle2 &) const
	Check the intersection with a circle.
void	Draw (QGraphicsScene &, const QPen &=QPen(), const QBrush &=QBrush()) const
	Draws an hexagon.

Protected Attributes
double	a
	Angle.
Vector2	x
	Base vector.
Protected Attributes inherited from Hexagon2
Vector2	c = Vector2::Null
	Center.
double	r = 1.0
	Radius.

Friends
std::ostream &	operator<< (std::ostream &s, const HexagonAlpha2 &hex)
	Overloaded.

Additional Inherited Members
Static Protected Member Functions inherited from Hexagon2
static int	Sector (const Vector2 &)
	Compute the sector given an input direction.
Static Protected Attributes inherited from Hexagon2
static const Vector2	vertex [6]
	Array of vertices.
static const Vector2	normal [6]
	Array of normal vectors to the edges.
static const Vector2	edge [6]
	Unit edge vectors.
static const double	Alpha = sqrt(3.0) / 2.0
	Constant sin(π/6)=√3/2.

Detailed Description

Hexagon with arbitrary orientations.

The reference hexagon is the flat topped hexagon. Pointy topped hexagons can be derived by setting the rotation angle to 30 degrees.

Constructor & Destructor Documentation

HexagonAlpha2() [1/3]

HexagonAlpha2::HexagonAlpha2 ( )

inline

Empty.

Constructor.

HexagonAlpha2() [2/3]

HexagonAlpha2::HexagonAlpha2 ( const Vector2 & c, const double & r, const double & a = 0.0 )

explicit

Create an oriented hexagon.

Parameters

c	Center.
r	Radius.
a	Angle of rotation.

HexagonAlpha2() [3/3]

HexagonAlpha2::HexagonAlpha2 ( const Hexagon2 & h, const double & a = 0.0 )

explicit

Create an hexagon.

Parameters

h	Hexagon.
a	Angle of rotation.

Member Function Documentation

Draw()

void HexagonAlpha2::Draw	(	QGraphicsScene &	scene,
		const QPen &	pen = QPen(),
		const QBrush &	brush = QBrush() ) const

Draws an hexagon.

Parameters

scene	Graphics scene.
pen	The pen.
brush	The brush.

GetBox()

Box2 HexagonAlpha2::GetBox

(

)

const

Compute the (coarse) bounding box of a hexagon.

This code is the same as:

HexagonAlpha2 h(Vector2::Null,3.0);
Box2 b=Box2(h.Center(),r.Radius());

For a tighter bounding box, use GetTightBox().

See also

GetTightBox()

GetTightBox()

Box2 HexagonAlpha2::GetTightBox

(

)

const

Compute the (tight) bounding box of a hexagon.

This function involves trigonometric functions, significantly slower than GetBox().

See also

GetBox()

Rotate()

void HexagonAlpha2::Rotate

(

const double &

ra

)

Rotates an hexagon.

Parameters

ra	Rotation angle.

Vertex()

Vector2 HexagonAlpha2::Vertex

(

int

k

)

const

Return the coordinates of the k-th vertex.

Parameters

k	Index, should be in [0,5].

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream & s, const HexagonAlpha2 & hex )

friend

Overloaded.

Parameters

s	Stream.
hex	The hexagon.