# Hexlign

A regular Hexagon aligned to the X and Y axes.

## Value members

### Concrete methods

### Inherited methods

The centre of the bounding rectangle. consider also using cenDefault.

The centre of the bounding rectangle. consider also using cenDefault.

- Inherited from
- BoundedElem

Currently throws, not sure if that is the correct behaviour. Creates a bounding rectangle for a collection of 2d points

Currently throws, not sure if that is the correct behaviour. Creates a bounding rectangle for a collection of 2d points

- Definition Classes
- Inherited from
- Polygon

The width of the BoundingRect of this object.

The width of the BoundingRect of this object.

- Inherited from
- BoundedElem

The centre of this geometric / graphical element. The centre will not change if the object type is capable of being rotated and is rotated. The cenDefault on other bounded elements may move relative to points on the object when the object is rotated.

The centre of this geometric / graphical element. The centre will not change if the object type is capable of being rotated and is rotated. The cenDefault on other bounded elements may move relative to points on the object when the object is rotated.

- Inherited from
- WithCentre

The default centre of this object is the centre. The centre will not change if the object type is capable of being rotated and is rotated.

The default centre of this object is the centre. The centre will not change if the object type is capable of being rotated and is rotated.

- Definition Classes
- Inherited from
- CentredElem

The centre point of this Polygon. The default centre for Polygons is the centre of the bounding rectangle.

The centre point of this Polygon. The default centre for Polygons is the centre of the bounding rectangle.

- Inherited from
- Polygon

The diameter of the inner circle of this regular hexagon. The shorter diameter from the centre of a side to the centre of the opposite side.

The diameter of the inner circle of this regular hexagon. The shorter diameter from the centre of a side to the centre of the opposite side.

- Inherited from
- HexReg

The diameter of the outer circle of this regular hexagon. The longer diameter length from a vertex to the opposite vertex. This lenght is twice the length of the hexagon side.

The diameter of the outer circle of this regular hexagon. The longer diameter length from a vertex to the opposite vertex. This lenght is twice the length of the hexagon side.

- Inherited from
- HexReg

Creates a PolygonCompound graphic that is active with a simple 1 colour fill and has a draw graphic for the Polygon. The default values for the draw area line width of 2 and a colour of Black.

Creates a PolygonCompound graphic that is active with a simple 1 colour fill and has a draw graphic for the Polygon. The default values for the draw area line width of 2 and a colour of Black.

- Inherited from
- Polygon

- Inherited from
- Polygon

- Inherited from
- Polygon

- Inherited from
- Polygon

- Inherited from
- Polygon

- Inherited from
- Polygon

Insert vertices before the specified insertion vertex.

Insert vertices before the specified insertion vertex.

- Inherited from
- Polygon

Map this collection of data elements to PolygonLike class of type BB.

Map this collection of data elements to PolygonLike class of type BB.

- Inherited from
- PolygonLike

- Inherited from
- Polygon

Determines if the parameter point lies inside this Polygon.

Determines if the parameter point lies inside this Polygon.

- Inherited from
- Polygon

The radius of the inner circle of this regular hexagon. The shorter radius from the centre of the hexagon to the centre of a side.

The radius of the inner circle of this regular hexagon. The shorter radius from the centre of the hexagon to the centre of a side.

- Inherited from
- HexReg

The radius of the outer circle of this regular hexagon. The longer radius length from the centre of the Hexagon to a vertex. Also the length of the hexagon side.

The radius of the outer circle of this regular hexagon. The longer radius length from the centre of the Hexagon to a vertex. Also the length of the hexagon side.

- Inherited from
- HexReg

Reflect 2D geometric transformation across a line, line segment or ray on a HexReg, returns a HexReg. The Return type will be narrowed in sub traits / classes.

Uniform scaling against both X and Y axes transformation on a HexReg returning a HexReg. Use the xyScale method for differential scaling. The return type of this method will be narrowed further in descendant traits / classes.

Uniform scaling against both X and Y axes transformation on a HexReg returning a HexReg. Use the xyScale method for differential scaling. The return type of this method will be narrowed further in descendant traits / classes.

- Definition Classes
- Inherited from
- HexReg

XY scaling 2D geometric transformation on a Polygon returns a Polygon. This allows different scaling factors across X and Y dimensions. The return type will be narrowed in some, but not all descendant Polygon types.

Polygon side 1 from the last vertex to Vertex 1.

Polygon side 1 from the last vertex to Vertex 1.

- Inherited from
- Polygon3Plus

The centre or half way point of side 1 of this polygon. Side 1 starts at the vLast vertex and ends at the v1 vertex. This can be thought of as vertex 0.5.

The centre or half way point of side 1 of this polygon. Side 1 starts at the vLast vertex and ends at the v1 vertex. This can be thought of as vertex 0.5.

- Inherited from
- Polygon3Plus

The X component of the centre or half way point of side 1 of this polygon. Side 1 starts at the vLast vertex and ends at the v1 vertex. This can be thought of as vertex 0.5.

The X component of the centre or half way point of side 1 of this polygon. Side 1 starts at the vLast vertex and ends at the v1 vertex. This can be thought of as vertex 0.5.

- Inherited from
- Polygon3Plus

The Y component of the centre or half way point of side 1 of this polygon. Side 1 starts at the vLast vertex and ends at the v1 vertex. This can be thought of as vertex 0.5.

The Y component of the centre or half way point of side 1 of this polygon. Side 1 starts at the vLast vertex and ends at the v1 vertex. This can be thought of as vertex 0.5.

- Inherited from
- Polygon3Plus

Polygon side 2 from vertex 1 to vertex 2.

Polygon side 2 from vertex 1 to vertex 2.

- Inherited from
- Polygon3Plus

The centre or half way point of side 2 of this polygon. Side 2 starts at the v1 vertex and ends at the v2 vertex. This can be thought of as vertex 1.5

The centre or half way point of side 2 of this polygon. Side 2 starts at the v1 vertex and ends at the v2 vertex. This can be thought of as vertex 1.5

- Inherited from
- Polygon3Plus

The X component of the centre or half way point of side 2 of this polygon. Side 2 starts at the v1 vertex and ends at the v1 vertex. This can be thought of as vertex 1.5.

The X component of the centre or half way point of side 2 of this polygon. Side 2 starts at the v1 vertex and ends at the v1 vertex. This can be thought of as vertex 1.5.

- Inherited from
- Polygon3Plus

The Y component of the centre or half way point of side 3 of this polygon. Side 2 starts at the v1 vertex and ends at the v2 vertex. This can be thought of as vertex 1.5.

The Y component of the centre or half way point of side 3 of this polygon. Side 2 starts at the v1 vertex and ends at the v2 vertex. This can be thought of as vertex 1.5.

- Inherited from
- Polygon3Plus

The centre or half way point of side 3 of this polygon. Side 3 starts at the v2 vertex and ends at the v3 vertex. This can be thought of as vertex 2.5.

The centre or half way point of side 3 of this polygon. Side 3 starts at the v2 vertex and ends at the v3 vertex. This can be thought of as vertex 2.5.

- Inherited from
- Polygon3Plus

The X component of the centre or half way point of side 3 of this polygon. Side 3 starts at the v2 vertex and ends at the v3 vertex. This can be thought of as vertex 2.5.

The X component of the centre or half way point of side 3 of this polygon. Side 3 starts at the v2 vertex and ends at the v3 vertex. This can be thought of as vertex 2.5.

- Inherited from
- Polygon3Plus

The Y component of the centre or half way point of side 3 of this polygon. Side 3 starts at the v2 vertex and ends at the v3 vertex. This can be thought of as vertex 2.5.

The Y component of the centre or half way point of side 3 of this polygon. Side 3 starts at the v2 vertex and ends at the v3 vertex. This can be thought of as vertex 2.5.

- Inherited from
- Polygon3Plus

The centre or half way point of side 4 of this polygon. Side 4 starts at the v3 vertex and ends at the v4 vertex. This can be thought of as vertex 3.5.

The centre or half way point of side 4 of this polygon. Side 4 starts at the v3 vertex and ends at the v4 vertex. This can be thought of as vertex 3.5.

- Inherited from
- Polygon4Plus

The X component of the centre or half way point of side 4 of this polygon. Side 4 starts at the v3 vertex and ends at the v4 vertex. This can be thought of as vertex 3.5.

The X component of the centre or half way point of side 4 of this polygon. Side 4 starts at the v3 vertex and ends at the v4 vertex. This can be thought of as vertex 3.5.

- Inherited from
- Polygon4Plus

The Y component of the centre or half way point of side 4 of this polygon. Side 4 starts at the v3 vertex and ends at the v4 vertex. This can be thought of as vertex 3.5.

The Y component of the centre or half way point of side 4 of this polygon. Side 4 starts at the v3 vertex and ends at the v4 vertex. This can be thought of as vertex 3.5.

- Inherited from
- Polygon4Plus

The centre or half way point of side 5 of this polygon. Side 5 starts at the v4 vertex and ends at the v5 vertex. This can be thought of as vertex 4.5.

The centre or half way point of side 5 of this polygon. Side 5 starts at the v4 vertex and ends at the v5 vertex. This can be thought of as vertex 4.5.

- Inherited from
- Polygon5Plus

The X component of the centre or half way point of side 5 of this polygon. Side 5 starts at the v4 vertex and ends at the v5 vertex. This can be thought of as vertex 4.5.

The X component of the centre or half way point of side 5 of this polygon. Side 5 starts at the v4 vertex and ends at the v5 vertex. This can be thought of as vertex 4.5.

- Inherited from
- Polygon5Plus

The Y component of the centre or half way point of side 5 of this polygon. Side 5 starts at the v4 vertex and ends at the v5 vertex. This can be thought of as vertex 4.5.

The Y component of the centre or half way point of side 5 of this polygon. Side 5 starts at the v4 vertex and ends at the v5 vertex. This can be thought of as vertex 4.5.

- Inherited from
- Polygon5Plus

The centre or half way point of side 6 of this polygon. Side 6 starts at the v5 vertex and ends at the v6 vertex. This can be thought of as vertex 5.5.

The centre or half way point of side 6 of this polygon. Side 6 starts at the v5 vertex and ends at the v6 vertex. This can be thought of as vertex 5.5.

- Inherited from
- Polygon6Plus

The X component of the centre or half way point of side 6 of this polygon. Side 6 starts at the v5 vertex and ends at the v6 vertex. This can be thought of as vertex 5.5.

The X component of the centre or half way point of side 6 of this polygon. Side 6 starts at the v5 vertex and ends at the v6 vertex. This can be thought of as vertex 5.5.

- Inherited from
- Polygon6Plus

The Y component of the centre or half way point of side 6 of this polygon. Side 5 starts at the v5 vertex and ends at the v6 vertex. This can be thought of as vertex 5.5.

The Y component of the centre or half way point of side 6 of this polygon. Side 5 starts at the v5 vertex and ends at the v6 vertex. This can be thought of as vertex 5.5.

- Inherited from
- Polygon6Plus

Shear 2D geometric transformation along the X Axis on a Polygon, returns a Polygon. The return type will be narrowed in some but not all sub classes and traits.

Shear 2D geometric transformation along the Y Axis on a Polygon, returns a Polygon. The return type will be narrowed in sub classes and traits.

Translate geometric transformation on a Polygon returns a Polygon. The return type of this method will be narrowed further in most descendant traits / classes. The exceptions being those classes where the centring of the geometry at the origin is part of the type.

Translate geometric transformation on a Polygon returns a Polygon. The return type of this method will be narrowed further in most descendant traits / classes. The exceptions being those classes where the centring of the geometry at the origin is part of the type.

- Inherited from
- Polygon

Translate geometric transformation on a HexReg returns a HexReg. The return type of this method will be narrowed further in most descendant traits / classes. The exceptions being those classes where the centring of the geometry at the origin is part of the type.

Translate geometric transformation on a HexReg returns a HexReg. The return type of this method will be narrowed further in most descendant traits / classes. The exceptions being those classes where the centring of the geometry at the origin is part of the type.

- Definition Classes
- Inherited from
- HexReg

The most basic Show method, paralleling the strT method on ShowT type class instances.

The most basic Show method, paralleling the strT method on ShowT type class instances.

- Inherited from
- Show

The 1st vertex, will throw on a 0 vertices polygon.

The 1st vertex, will throw on a 0 vertices polygon.

- Inherited from
- Polygon

The X component of the 1st vertex, will throw on a 0 vertices polygon.

The X component of the 1st vertex, will throw on a 0 vertices polygon.

- Inherited from
- Polygon

The Y component of the 1st vertex, will throw on a 0 vertices polygon.

The Y component of the 1st vertex, will throw on a 0 vertices polygon.

- Inherited from
- Polygon

The 2nd Vertex. The default convention is for the vertices to be numbered in a clockwise direction with the 1st vertex immediately clockwise from 12 o'clock.

The 2nd Vertex. The default convention is for the vertices to be numbered in a clockwise direction with the 1st vertex immediately clockwise from 12 o'clock.

- Inherited from
- Polygon3Plus

The X component of the 2nd Vertex. The default convention is for the vertices to be numbered in a clockwise direction with the 1st vertex immediately clockwise from 12 o'clock.

The X component of the 2nd Vertex. The default convention is for the vertices to be numbered in a clockwise direction with the 1st vertex immediately clockwise from 12 o'clock.

- Inherited from
- Polygon3Plus

The Y component of the 2nd Vertex. The default convention is for the vertices to be numbered in a clockwise direction with the 1st vertex immediately clockwise from 12 o'clock.

The Y component of the 2nd Vertex. The default convention is for the vertices to be numbered in a clockwise direction with the 1st vertex immediately clockwise from 12 o'clock.

- Inherited from
- Polygon3Plus

The 3rd Vertex. The default convention is for the vertices to be numbered in a clockwise direction with the 1st vertex immediately clockwise from 12 o'clock.

The 3rd Vertex. The default convention is for the vertices to be numbered in a clockwise direction with the 1st vertex immediately clockwise from 12 o'clock.

- Inherited from
- Polygon3Plus

The X component of the 3rd Vertex. The default convention is for the vertices to be numbered in a clockwise direction with the 1st vertex immediately clockwise from 12 o'clock.

The X component of the 3rd Vertex. The default convention is for the vertices to be numbered in a clockwise direction with the 1st vertex immediately clockwise from 12 o'clock.

- Inherited from
- Polygon3Plus

The Y component of the 3rd Vertex. The default convention is for the vertices to be numbered in a clockwise direction with the 1st vertex immediately clockwise from 12 o'clock.

The Y component of the 3rd Vertex. The default convention is for the vertices to be numbered in a clockwise direction with the 1st vertex immediately clockwise from 12 o'clock.

- Inherited from
- Polygon3Plus

The 4th Vertex. The default convention is for the vertices to be numbered in a clockwise direction with the 1st vertex immediately clockwise from 12 o'clock.

The 4th Vertex. The default convention is for the vertices to be numbered in a clockwise direction with the 1st vertex immediately clockwise from 12 o'clock.

- Inherited from
- Polygon4Plus

The X component of the 4th Vertex. The default convention is for the vertices to be numbered in a clockwise direction with the 1st vertex immediately clockwise from 12 o'clock.

The X component of the 4th Vertex. The default convention is for the vertices to be numbered in a clockwise direction with the 1st vertex immediately clockwise from 12 o'clock.

- Inherited from
- Polygon4Plus

The Y component of the 4th Vertex. The default convention is for the vertices to be numbered in a clockwise direction with the 1st vertex immediately clockwise from 12 o'clock.

The Y component of the 4th Vertex. The default convention is for the vertices to be numbered in a clockwise direction with the 1st vertex immediately clockwise from 12 o'clock.

- Inherited from
- Polygon4Plus

The 5th Vertex. The default convention is for the vertices to be numbered in a clockwise direction with the 1st vertex immediately clockwise from 12 o'clock.

The 5th Vertex. The default convention is for the vertices to be numbered in a clockwise direction with the 1st vertex immediately clockwise from 12 o'clock.

- Inherited from
- Polygon5Plus

The X component of the 5th Vertex. The default convention is for the vertices to be numbered in a clockwise direction with the 1st vertex immediately clockwise from 12 o'clock.

The X component of the 5th Vertex. The default convention is for the vertices to be numbered in a clockwise direction with the 1st vertex immediately clockwise from 12 o'clock.

- Inherited from
- Polygon5Plus

The Y component of the 5th Vertex. The default convention is for the vertices to be numbered in a clockwise direction with the 1st vertex immediately clockwise from 12 o'clock.

The Y component of the 5th Vertex. The default convention is for the vertices to be numbered in a clockwise direction with the 1st vertex immediately clockwise from 12 o'clock.

- Inherited from
- Polygon5Plus

The 6th Vertex. The default convention is for the vertices to be numbered in a clockwise direction with the 1st vertex immediately clockwise from 12 o'clock.

The 6th Vertex. The default convention is for the vertices to be numbered in a clockwise direction with the 1st vertex immediately clockwise from 12 o'clock.

- Inherited from
- Polygon6Plus

The X component of the 6th Vertex. The default convention is for the vertices to be numbered in a clockwise direction with the 1st vertex immediately clockwise from 12 o'clock.

The X component of the 6th Vertex. The default convention is for the vertices to be numbered in a clockwise direction with the 1st vertex immediately clockwise from 12 o'clock.

- Inherited from
- Polygon6Plus

This method should be overridden in final classes.

This method should be overridden in final classes.

- Inherited from
- PolygonLike

flatMap with index to an immutable Arr.

flatMap with index to an immutable Arr.

- Inherited from
- Polygon

A Hexagon has 6 vertices.

A Hexagon has 6 vertices.

- Definition Classes
- Inherited from
- HexReg

This method does nothing if the vertNum < 2. Foreach vertex applies the side effecting function to the previous vertex with each vertex. The previous vertex to the first vertex is the last vertex of the PolygonLike. Note the function signature (previous, vertex) => U follows the foreach based convention of putting the collection element 2nd or last as seen for example in fold methods'(accumulator, element) => B signature.

This method does nothing if the vertNum < 2. Foreach vertex applies the side effecting function to the previous vertex with each vertex. The previous vertex to the first vertex is the last vertex of the PolygonLike. Note the function signature (previous, vertex) => U follows the foreach based convention of putting the collection element 2nd or last as seen for example in fold methods'(accumulator, element) => B signature.

- Definition Classes
- Inherited from
- Polygon

A function that takes a 2D geometric transformation on a Pt2 as a parameter and performs the transformation on all the vertices returning a new transformed Polygon

The Y component of the 6th Vertex. The default convention is for the vertices to be numbered in a clockwise direction with the 1st vertex immediately clockwise from 12 o'clock.

The Y component of the 6th Vertex. The default convention is for the vertices to be numbered in a clockwise direction with the 1st vertex immediately clockwise from 12 o'clock.

- Inherited from
- Polygon6Plus