Class HexGrid

A regular 2d grid of hexagons. The co-ordinate system used is "Cube-cordinates described here: https://www.redblobgames.com/grids/hexagons/ However, it'll usually be fairly forgiving if you just use x,y and don't fill the z value. See HexOrientation for more details. Covers both the infinite grid, and bounded versions. Related classes:

Inheritance
System.Object
HexGrid
Implements
Namespace: Sylves
Assembly: Sylves.dll
Syntax
public class HexGrid : Object, IGrid

Constructors

HexGrid(Vector2, HexOrientation, HexBound)

Creates a hex grid where each hex has width and height given by cellSize.x and cellSize.y

Declaration
public HexGrid(Vector2 cellSize, HexOrientation orientation, HexBound bound = null)
Parameters
Type Name Description
Vector2 cellSize
HexOrientation orientation
HexBound bound

HexGrid(Single, HexOrientation, HexBound)

Creates a hex grid where the side length is cellSize/2. I.e. the incircle diameter is cellSize * sqrt(3) / 2 and circumcircle diameter is cellSize

Declaration
public HexGrid(float cellSize, HexOrientation orientation, HexBound bound = null)
Parameters
Type Name Description
System.Single cellSize
HexOrientation orientation
HexBound bound

Properties

CoordinateDimension

Declaration
public int CoordinateDimension { get; }
Property Value
Type Description
System.Int32

IndexCount

Declaration
public int IndexCount { get; }
Property Value
Type Description
System.Int32

Is2d

Declaration
public bool Is2d { get; }
Property Value
Type Description
System.Boolean

Is3d

Declaration
public bool Is3d { get; }
Property Value
Type Description
System.Boolean

IsFinite

Declaration
public bool IsFinite { get; }
Property Value
Type Description
System.Boolean

IsOrientable

Declaration
public bool IsOrientable { get; }
Property Value
Type Description
System.Boolean

IsPlanar

Declaration
public bool IsPlanar { get; }
Property Value
Type Description
System.Boolean

IsRepeating

Declaration
public bool IsRepeating { get; }
Property Value
Type Description
System.Boolean

IsSingleCellType

Declaration
public bool IsSingleCellType { get; }
Property Value
Type Description
System.Boolean

Orientation

Declaration
public HexOrientation Orientation { get; }
Property Value
Type Description
HexOrientation

Unbounded

Declaration
public IGrid Unbounded { get; }
Property Value
Type Description
IGrid

Unwrapped

Declaration
public IGrid Unwrapped { get; }
Property Value
Type Description
IGrid

Methods

BoundBy(IBound)

Declaration
public IGrid BoundBy(IBound bound)
Parameters
Type Name Description
IBound bound
Returns
Type Description
IGrid

FindBasicPath(Cell, Cell)

Declaration
public IEnumerable<(Cell, CellDir)> FindBasicPath(Cell startCell, Cell destCell)
Parameters
Type Name Description
Cell startCell
Cell destCell
Returns
Type Description
System.Collections.Generic.IEnumerable<System.ValueTuple<Cell, CellDir>>

FindCell(Matrix4x4, out Cell, out CellRotation)

Declaration
public bool FindCell(Matrix4x4 matrix, out Cell cell, out CellRotation rotation)
Parameters
Type Name Description
Matrix4x4 matrix
Cell cell
CellRotation rotation
Returns
Type Description
System.Boolean

FindCell(Vector3, out Cell)

Declaration
public bool FindCell(Vector3 position, out Cell cell)
Parameters
Type Name Description
Vector3 position
Cell cell
Returns
Type Description
System.Boolean

FindGridSymmetry(ISet<Cell>, ISet<Cell>, Cell, CellRotation)

Declaration
public GridSymmetry FindGridSymmetry(ISet<Cell> src, ISet<Cell> dest, Cell srcCell, CellRotation cellRotation)
Parameters
Type Name Description
System.Collections.Generic.ISet<Cell> src
System.Collections.Generic.ISet<Cell> dest
Cell srcCell
CellRotation cellRotation
Returns
Type Description
GridSymmetry

GetBound()

Declaration
public IBound GetBound()
Returns
Type Description
IBound

GetBound(IEnumerable<Cell>)

Declaration
public IBound GetBound(IEnumerable<Cell> cells)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<Cell> cells
Returns
Type Description
IBound

GetCellByIndex(Int32)

Declaration
public Cell GetCellByIndex(int index)
Parameters
Type Name Description
System.Int32 index
Returns
Type Description
Cell

GetCellCenter(Cell)

Returns the center of the cell in local space

Declaration
public Vector3 GetCellCenter(Cell cell)
Parameters
Type Name Description
Cell cell
Returns
Type Description
Vector3

GetCellCorner(Cell, CellCorner)

Declaration
public Vector3 GetCellCorner(Cell cell, CellCorner corner)
Parameters
Type Name Description
Cell cell
CellCorner corner
Returns
Type Description
Vector3

GetCellCorners(Cell)

Declaration
public IEnumerable<CellCorner> GetCellCorners(Cell cell)
Parameters
Type Name Description
Cell cell
Returns
Type Description
System.Collections.Generic.IEnumerable<CellCorner>

GetCellDirs(Cell)

Declaration
public IEnumerable<CellDir> GetCellDirs(Cell cell)
Parameters
Type Name Description
Cell cell
Returns
Type Description
System.Collections.Generic.IEnumerable<CellDir>

GetCells()

Declaration
public IEnumerable<Cell> GetCells()
Returns
Type Description
System.Collections.Generic.IEnumerable<Cell>

GetCellsInBounds(IBound)

Declaration
public IEnumerable<Cell> GetCellsInBounds(IBound bound)
Parameters
Type Name Description
IBound bound
Returns
Type Description
System.Collections.Generic.IEnumerable<Cell>

GetCellsIntersectsApprox(Vector3, Vector3)

Declaration
public IEnumerable<Cell> GetCellsIntersectsApprox(Vector3 min, Vector3 max)
Parameters
Type Name Description
Vector3 min
Vector3 max
Returns
Type Description
System.Collections.Generic.IEnumerable<Cell>

GetCellType(Cell)

Declaration
public ICellType GetCellType(Cell cell)
Parameters
Type Name Description
Cell cell
Returns
Type Description
ICellType

GetCellTypes()

Returns the full list of cell types that can be returned by GetCellType(Cell)

Declaration
public IEnumerable<ICellType> GetCellTypes()
Returns
Type Description
System.Collections.Generic.IEnumerable<ICellType>

GetChildTriangleGrid()

Declaration
public TriangleGrid GetChildTriangleGrid()
Returns
Type Description
TriangleGrid

GetChildTriangles(Cell)

Declaration
public Cell[] GetChildTriangles(Cell cell)
Parameters
Type Name Description
Cell cell
Returns
Type Description
Cell[]

GetDeformation(Cell)

Declaration
public Deformation GetDeformation(Cell cell)
Parameters
Type Name Description
Cell cell
Returns
Type Description
Deformation

GetDual()

Declaration
public virtual IDualMapping GetDual()
Returns
Type Description
IDualMapping

GetIndex(Cell)

Declaration
public int GetIndex(Cell cell)
Parameters
Type Name Description
Cell cell
Returns
Type Description
System.Int32

GetMeshData(Cell, out MeshData, out Matrix4x4)

Declaration
public void GetMeshData(Cell cell, out MeshData meshData, out Matrix4x4 transform)
Parameters
Type Name Description
Cell cell
MeshData meshData
Matrix4x4 transform

GetPolygon(Cell, out Vector3[], out Matrix4x4)

Declaration
public void GetPolygon(Cell cell, out Vector3[] vertices, out Matrix4x4 transform)
Parameters
Type Name Description
Cell cell
Vector3[] vertices
Matrix4x4 transform

GetTriangleMesh(Cell)

Declaration
public IEnumerable<(Vector3, Vector3, Vector3, CellDir)> GetTriangleMesh(Cell cell)
Parameters
Type Name Description
Cell cell
Returns
Type Description
System.Collections.Generic.IEnumerable<System.ValueTuple<Vector3, Vector3, Vector3, CellDir>>

GetTriangleParent(Cell)

Declaration
public Cell GetTriangleParent(Cell triangleCell)
Parameters
Type Name Description
Cell triangleCell
Returns
Type Description
Cell

GetTRS(Cell)

Returns the appropriate transform for the cell. The translation will always be to GetCellCenter. Not inclusive of cell rotation, that should be applied first.

Declaration
public TRS GetTRS(Cell cell)
Parameters
Type Name Description
Cell cell
Returns
Type Description
TRS

IntersectBounds(IBound, IBound)

Declaration
public IBound IntersectBounds(IBound bound, IBound other)
Parameters
Type Name Description
IBound bound
IBound other
Returns
Type Description
IBound

IsCellInBound(Cell, IBound)

Declaration
public bool IsCellInBound(Cell cell, IBound bound)
Parameters
Type Name Description
Cell cell
IBound bound
Returns
Type Description
System.Boolean

IsCellInGrid(Cell)

Declaration
public bool IsCellInGrid(Cell cell)
Parameters
Type Name Description
Cell cell
Returns
Type Description
System.Boolean

ParallelTransport(IGrid, Cell, Cell, Cell, CellRotation, out Cell, out CellRotation)

Declaration
public bool ParallelTransport(IGrid aGrid, Cell aSrcCell, Cell aDestCell, Cell srcCell, CellRotation startRotation, out Cell destCell, out CellRotation destRotation)
Parameters
Type Name Description
IGrid aGrid
Cell aSrcCell
Cell aDestCell
Cell srcCell
CellRotation startRotation
Cell destCell
CellRotation destRotation
Returns
Type Description
System.Boolean

Raycast(Vector3, Vector3, Single)

Declaration
public IEnumerable<RaycastInfo> Raycast(Vector3 origin, Vector3 direction, float maxDistance = InfinityF)
Parameters
Type Name Description
Vector3 origin
Vector3 direction
System.Single maxDistance
Returns
Type Description
System.Collections.Generic.IEnumerable<RaycastInfo>

TryApplySymmetry(GridSymmetry, Cell, out Cell, out CellRotation)

Declaration
public bool TryApplySymmetry(GridSymmetry s, Cell src, out Cell dest, out CellRotation r)
Parameters
Type Name Description
GridSymmetry s
Cell src
Cell dest
CellRotation r
Returns
Type Description
System.Boolean

TryApplySymmetry(GridSymmetry, IBound, out IBound)

Declaration
public bool TryApplySymmetry(GridSymmetry s, IBound srcBound, out IBound destBound)
Parameters
Type Name Description
GridSymmetry s
IBound srcBound
IBound destBound
Returns
Type Description
System.Boolean

TryMove(Cell, CellDir, out Cell, out CellDir, out Connection)

Declaration
public bool TryMove(Cell cell, CellDir dir, out Cell dest, out CellDir inverseDir, out Connection connection)
Parameters
Type Name Description
Cell cell
CellDir dir
Cell dest
CellDir inverseDir
Connection connection
Returns
Type Description
System.Boolean

TryMoveByOffset(Cell, Vector3Int, Vector3Int, CellRotation, out Cell, out CellRotation)

Declaration
public bool TryMoveByOffset(Cell startCell, Vector3Int startOffset, Vector3Int destOffset, CellRotation startRotation, out Cell destCell, out CellRotation destRotation)
Parameters
Type Name Description
Cell startCell
Vector3Int startOffset
Vector3Int destOffset
CellRotation startRotation
Cell destCell
CellRotation destRotation
Returns
Type Description
System.Boolean

UnionBounds(IBound, IBound)

Declaration
public IBound UnionBounds(IBound bound, IBound other)
Parameters
Type Name Description
IBound bound
IBound other
Returns
Type Description
IBound

WithIncircleDiameter(Single, HexOrientation, HexBound)

Creates a hex grid where each hex has the given incircle diameter. The incircle diameter is the distance between the centers of two adjacent hexes.

Declaration
public static HexGrid WithIncircleDiameter(float diameter, HexOrientation orientation, HexBound bound = null)
Parameters
Type Name Description
System.Single diameter
HexOrientation orientation
HexBound bound
Returns
Type Description
HexGrid

Implements