Copyright	(c) Amy de Buitléir 2012-2017
License	BSD-style
Maintainer	amy@nualeargais.ie
Stability	experimental
Portability	portable
Safe Haskell	Safe
Language	Haskell2010

Math.Geometry.Grid.Hexagonal

Contents

Unbounded grid with hexagonal tiles
Hexagonal grid with hexagonal tiles
Parallelogram-shaped grid with hexagonal tiles

Description

A regular arrangement of hexagonal tiles. The userguide, with illustrations, is available at https://github.com/mhwombat/grid/wiki. Also see Math.Geometry.Grid for examples of how to use this class.

Synopsis

data UnboundedHexGrid = UnboundedHexGrid
data HexHexGrid
hexHexGrid :: Int -> HexHexGrid
data ParaHexGrid
paraHexGrid :: Int -> Int -> ParaHexGrid

Unbounded grid with hexagonal tiles

data UnboundedHexGrid Source #

An unbounded grid with hexagonal tiles The grid and its indexing scheme are illustrated in the user guide, available at https://github.com/mhwombat/grid/wiki.

Constructors

UnboundedHexGrid

Instances

Eq UnboundedHexGrid Source #
Instance details Defined in Math.Geometry.Grid.HexagonalInternal Methods (==) :: UnboundedHexGrid -> UnboundedHexGrid -> Bool # (/=) :: UnboundedHexGrid -> UnboundedHexGrid -> Bool #
Show UnboundedHexGrid Source #
Instance details Defined in Math.Geometry.Grid.HexagonalInternal Methods showsPrec :: Int -> UnboundedHexGrid -> ShowS # show :: UnboundedHexGrid -> String # showList :: [UnboundedHexGrid] -> ShowS #
Generic UnboundedHexGrid Source #
Instance details Defined in Math.Geometry.Grid.HexagonalInternal Associated Types type Rep UnboundedHexGrid :: Type -> Type # Methods from :: UnboundedHexGrid -> Rep UnboundedHexGrid x # to :: Rep UnboundedHexGrid x -> UnboundedHexGrid #
Grid UnboundedHexGrid Source #
Instance details Defined in Math.Geometry.Grid.HexagonalInternal Associated Types type Index UnboundedHexGrid :: Type Source # type Direction UnboundedHexGrid :: Type Source # Methods indices :: UnboundedHexGrid -> [Index UnboundedHexGrid] Source # distance :: UnboundedHexGrid -> Index UnboundedHexGrid -> Index UnboundedHexGrid -> Int Source # minDistance :: UnboundedHexGrid -> [Index UnboundedHexGrid] -> Index UnboundedHexGrid -> Int Source # neighbours :: UnboundedHexGrid -> Index UnboundedHexGrid -> [Index UnboundedHexGrid] Source # neighboursOfSet :: UnboundedHexGrid -> [Index UnboundedHexGrid] -> [Index UnboundedHexGrid] Source # neighbour :: UnboundedHexGrid -> Index UnboundedHexGrid -> Direction UnboundedHexGrid -> Maybe (Index UnboundedHexGrid) Source # numNeighbours :: UnboundedHexGrid -> Index UnboundedHexGrid -> Int Source # contains :: UnboundedHexGrid -> Index UnboundedHexGrid -> Bool Source # tileCount :: UnboundedHexGrid -> Int Source # null :: UnboundedHexGrid -> Bool Source # nonNull :: UnboundedHexGrid -> Bool Source # edges :: UnboundedHexGrid -> [(Index UnboundedHexGrid, Index UnboundedHexGrid)] Source # viewpoint :: UnboundedHexGrid -> Index UnboundedHexGrid -> [(Index UnboundedHexGrid, Int)] Source # isAdjacent :: UnboundedHexGrid -> Index UnboundedHexGrid -> Index UnboundedHexGrid -> Bool Source # adjacentTilesToward :: UnboundedHexGrid -> Index UnboundedHexGrid -> Index UnboundedHexGrid -> [Index UnboundedHexGrid] Source # minimalPaths :: UnboundedHexGrid -> Index UnboundedHexGrid -> Index UnboundedHexGrid -> [[Index UnboundedHexGrid]] Source # directionTo :: UnboundedHexGrid -> Index UnboundedHexGrid -> Index UnboundedHexGrid -> [Direction UnboundedHexGrid] Source # defaultMinDistance :: UnboundedHexGrid -> [Index UnboundedHexGrid] -> Index UnboundedHexGrid -> Int Source # defaultNeighbours :: UnboundedHexGrid -> Index UnboundedHexGrid -> [Index UnboundedHexGrid] Source # defaultNeighboursOfSet :: UnboundedHexGrid -> [Index UnboundedHexGrid] -> [Index UnboundedHexGrid] Source # defaultNeighbour :: UnboundedHexGrid -> Index UnboundedHexGrid -> Direction UnboundedHexGrid -> Maybe (Index UnboundedHexGrid) Source # defaultTileCount :: UnboundedHexGrid -> Int Source # defaultEdges :: UnboundedHexGrid -> [(Index UnboundedHexGrid, Index UnboundedHexGrid)] Source # defaultIsAdjacent :: UnboundedHexGrid -> Index UnboundedHexGrid -> Index UnboundedHexGrid -> Bool Source # defaultAdjacentTilesToward :: UnboundedHexGrid -> Index UnboundedHexGrid -> Index UnboundedHexGrid -> [Index UnboundedHexGrid] Source # defaultMinimalPaths :: UnboundedHexGrid -> Index UnboundedHexGrid -> Index UnboundedHexGrid -> [[Index UnboundedHexGrid]] Source #
type Rep UnboundedHexGrid Source #
Instance details Defined in Math.Geometry.Grid.HexagonalInternal type Rep UnboundedHexGrid = D1 (MetaData "UnboundedHexGrid" "Math.Geometry.Grid.HexagonalInternal" "grid-7.8.12-1ADrZUlWO0vHdPyzqP6MYM" False) (C1 (MetaCons "UnboundedHexGrid" PrefixI False) (U1 :: Type -> Type))
type Index UnboundedHexGrid Source #
Instance details Defined in Math.Geometry.Grid.HexagonalInternal type Index UnboundedHexGrid = (Int, Int)
type Direction UnboundedHexGrid Source #
Instance details Defined in Math.Geometry.Grid.HexagonalInternal type Direction UnboundedHexGrid = HexDirection

Hexagonal grid with hexagonal tiles

data HexHexGrid Source #

A hexagonal grid with hexagonal tiles The grid and its indexing scheme are illustrated in the user guide, available at https://github.com/mhwombat/grid/wiki.

Instances

Eq HexHexGrid Source #
Instance details Defined in Math.Geometry.Grid.HexagonalInternal Methods (==) :: HexHexGrid -> HexHexGrid -> Bool # (/=) :: HexHexGrid -> HexHexGrid -> Bool #
Show HexHexGrid Source #
Instance details Defined in Math.Geometry.Grid.HexagonalInternal Methods showsPrec :: Int -> HexHexGrid -> ShowS # show :: HexHexGrid -> String # showList :: [HexHexGrid] -> ShowS #
Generic HexHexGrid Source #
Instance details Defined in Math.Geometry.Grid.HexagonalInternal Associated Types type Rep HexHexGrid :: Type -> Type # Methods from :: HexHexGrid -> Rep HexHexGrid x # to :: Rep HexHexGrid x -> HexHexGrid #
BoundedGrid HexHexGrid Source #
Instance details Defined in Math.Geometry.Grid.HexagonalInternal Methods tileSideCount :: HexHexGrid -> Int Source # boundary :: HexHexGrid -> [Index HexHexGrid] Source # isBoundary :: HexHexGrid -> Index HexHexGrid -> Bool Source # centre :: HexHexGrid -> [Index HexHexGrid] Source # isCentre :: HexHexGrid -> Index HexHexGrid -> Bool Source # defaultBoundary :: HexHexGrid -> [Index HexHexGrid] Source # defaultIsBoundary :: HexHexGrid -> Index HexHexGrid -> Bool Source # defaultCentre :: HexHexGrid -> [Index HexHexGrid] Source # defaultIsCentre :: HexHexGrid -> Index HexHexGrid -> Bool Source #
FiniteGrid HexHexGrid Source #
Instance details Defined in Math.Geometry.Grid.HexagonalInternal Associated Types type Size HexHexGrid :: Type Source # Methods size :: HexHexGrid -> Size HexHexGrid Source # maxPossibleDistance :: HexHexGrid -> Int Source #
Grid HexHexGrid Source #
Instance details Defined in Math.Geometry.Grid.HexagonalInternal Associated Types type Index HexHexGrid :: Type Source # type Direction HexHexGrid :: Type Source # Methods indices :: HexHexGrid -> [Index HexHexGrid] Source # distance :: HexHexGrid -> Index HexHexGrid -> Index HexHexGrid -> Int Source # minDistance :: HexHexGrid -> [Index HexHexGrid] -> Index HexHexGrid -> Int Source # neighbours :: HexHexGrid -> Index HexHexGrid -> [Index HexHexGrid] Source # neighboursOfSet :: HexHexGrid -> [Index HexHexGrid] -> [Index HexHexGrid] Source # neighbour :: HexHexGrid -> Index HexHexGrid -> Direction HexHexGrid -> Maybe (Index HexHexGrid) Source # numNeighbours :: HexHexGrid -> Index HexHexGrid -> Int Source # contains :: HexHexGrid -> Index HexHexGrid -> Bool Source # tileCount :: HexHexGrid -> Int Source # null :: HexHexGrid -> Bool Source # nonNull :: HexHexGrid -> Bool Source # edges :: HexHexGrid -> [(Index HexHexGrid, Index HexHexGrid)] Source # viewpoint :: HexHexGrid -> Index HexHexGrid -> [(Index HexHexGrid, Int)] Source # isAdjacent :: HexHexGrid -> Index HexHexGrid -> Index HexHexGrid -> Bool Source # adjacentTilesToward :: HexHexGrid -> Index HexHexGrid -> Index HexHexGrid -> [Index HexHexGrid] Source # minimalPaths :: HexHexGrid -> Index HexHexGrid -> Index HexHexGrid -> [[Index HexHexGrid]] Source # directionTo :: HexHexGrid -> Index HexHexGrid -> Index HexHexGrid -> [Direction HexHexGrid] Source # defaultMinDistance :: HexHexGrid -> [Index HexHexGrid] -> Index HexHexGrid -> Int Source # defaultNeighbours :: HexHexGrid -> Index HexHexGrid -> [Index HexHexGrid] Source # defaultNeighboursOfSet :: HexHexGrid -> [Index HexHexGrid] -> [Index HexHexGrid] Source # defaultNeighbour :: HexHexGrid -> Index HexHexGrid -> Direction HexHexGrid -> Maybe (Index HexHexGrid) Source # defaultTileCount :: HexHexGrid -> Int Source # defaultEdges :: HexHexGrid -> [(Index HexHexGrid, Index HexHexGrid)] Source # defaultIsAdjacent :: HexHexGrid -> Index HexHexGrid -> Index HexHexGrid -> Bool Source # defaultAdjacentTilesToward :: HexHexGrid -> Index HexHexGrid -> Index HexHexGrid -> [Index HexHexGrid] Source # defaultMinimalPaths :: HexHexGrid -> Index HexHexGrid -> Index HexHexGrid -> [[Index HexHexGrid]] Source #
type Rep HexHexGrid Source #
Instance details Defined in Math.Geometry.Grid.HexagonalInternal type Rep HexHexGrid = D1 (MetaData "HexHexGrid" "Math.Geometry.Grid.HexagonalInternal" "grid-7.8.12-1ADrZUlWO0vHdPyzqP6MYM" False) (C1 (MetaCons "HexHexGrid" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(Int, Int)])))
type Size HexHexGrid Source #
Instance details Defined in Math.Geometry.Grid.HexagonalInternal type Size HexHexGrid = Int
type Index HexHexGrid Source #
Instance details Defined in Math.Geometry.Grid.HexagonalInternal type Index HexHexGrid = (Int, Int)
type Direction HexHexGrid Source #
Instance details Defined in Math.Geometry.Grid.HexagonalInternal type Direction HexHexGrid = HexDirection

hexHexGrid :: Int -> HexHexGrid Source #

hexHexGrid s returns a grid of hexagonal shape, with sides of length s, using hexagonal tiles. If s is nonnegative, the resulting grid will have 3*s*(s-1) + 1 tiles. Otherwise, the resulting grid will be null and the list of indices will be null.

Parallelogram-shaped grid with hexagonal tiles

data ParaHexGrid Source #

A parallelogramatical grid with hexagonal tiles The grid and its indexing scheme are illustrated in the user guide, available at https://github.com/mhwombat/grid/wiki.

Instances

Eq ParaHexGrid Source #
Instance details Defined in Math.Geometry.Grid.HexagonalInternal Methods (==) :: ParaHexGrid -> ParaHexGrid -> Bool # (/=) :: ParaHexGrid -> ParaHexGrid -> Bool #
Show ParaHexGrid Source #
Instance details Defined in Math.Geometry.Grid.HexagonalInternal Methods showsPrec :: Int -> ParaHexGrid -> ShowS # show :: ParaHexGrid -> String # showList :: [ParaHexGrid] -> ShowS #
Generic ParaHexGrid Source #
Instance details Defined in Math.Geometry.Grid.HexagonalInternal Associated Types type Rep ParaHexGrid :: Type -> Type # Methods from :: ParaHexGrid -> Rep ParaHexGrid x # to :: Rep ParaHexGrid x -> ParaHexGrid #
BoundedGrid ParaHexGrid Source #
Instance details Defined in Math.Geometry.Grid.HexagonalInternal Methods tileSideCount :: ParaHexGrid -> Int Source # boundary :: ParaHexGrid -> [Index ParaHexGrid] Source # isBoundary :: ParaHexGrid -> Index ParaHexGrid -> Bool Source # centre :: ParaHexGrid -> [Index ParaHexGrid] Source # isCentre :: ParaHexGrid -> Index ParaHexGrid -> Bool Source # defaultBoundary :: ParaHexGrid -> [Index ParaHexGrid] Source # defaultIsBoundary :: ParaHexGrid -> Index ParaHexGrid -> Bool Source # defaultCentre :: ParaHexGrid -> [Index ParaHexGrid] Source # defaultIsCentre :: ParaHexGrid -> Index ParaHexGrid -> Bool Source #
FiniteGrid ParaHexGrid Source #
Instance details Defined in Math.Geometry.Grid.HexagonalInternal Associated Types type Size ParaHexGrid :: Type Source # Methods size :: ParaHexGrid -> Size ParaHexGrid Source # maxPossibleDistance :: ParaHexGrid -> Int Source #
Grid ParaHexGrid Source #
Instance details Defined in Math.Geometry.Grid.HexagonalInternal Associated Types type Index ParaHexGrid :: Type Source # type Direction ParaHexGrid :: Type Source # Methods indices :: ParaHexGrid -> [Index ParaHexGrid] Source # distance :: ParaHexGrid -> Index ParaHexGrid -> Index ParaHexGrid -> Int Source # minDistance :: ParaHexGrid -> [Index ParaHexGrid] -> Index ParaHexGrid -> Int Source # neighbours :: ParaHexGrid -> Index ParaHexGrid -> [Index ParaHexGrid] Source # neighboursOfSet :: ParaHexGrid -> [Index ParaHexGrid] -> [Index ParaHexGrid] Source # neighbour :: ParaHexGrid -> Index ParaHexGrid -> Direction ParaHexGrid -> Maybe (Index ParaHexGrid) Source # numNeighbours :: ParaHexGrid -> Index ParaHexGrid -> Int Source # contains :: ParaHexGrid -> Index ParaHexGrid -> Bool Source # tileCount :: ParaHexGrid -> Int Source # null :: ParaHexGrid -> Bool Source # nonNull :: ParaHexGrid -> Bool Source # edges :: ParaHexGrid -> [(Index ParaHexGrid, Index ParaHexGrid)] Source # viewpoint :: ParaHexGrid -> Index ParaHexGrid -> [(Index ParaHexGrid, Int)] Source # isAdjacent :: ParaHexGrid -> Index ParaHexGrid -> Index ParaHexGrid -> Bool Source # adjacentTilesToward :: ParaHexGrid -> Index ParaHexGrid -> Index ParaHexGrid -> [Index ParaHexGrid] Source # minimalPaths :: ParaHexGrid -> Index ParaHexGrid -> Index ParaHexGrid -> [[Index ParaHexGrid]] Source # directionTo :: ParaHexGrid -> Index ParaHexGrid -> Index ParaHexGrid -> [Direction ParaHexGrid] Source # defaultMinDistance :: ParaHexGrid -> [Index ParaHexGrid] -> Index ParaHexGrid -> Int Source # defaultNeighbours :: ParaHexGrid -> Index ParaHexGrid -> [Index ParaHexGrid] Source # defaultNeighboursOfSet :: ParaHexGrid -> [Index ParaHexGrid] -> [Index ParaHexGrid] Source # defaultNeighbour :: ParaHexGrid -> Index ParaHexGrid -> Direction ParaHexGrid -> Maybe (Index ParaHexGrid) Source # defaultTileCount :: ParaHexGrid -> Int Source # defaultEdges :: ParaHexGrid -> [(Index ParaHexGrid, Index ParaHexGrid)] Source # defaultIsAdjacent :: ParaHexGrid -> Index ParaHexGrid -> Index ParaHexGrid -> Bool Source # defaultAdjacentTilesToward :: ParaHexGrid -> Index ParaHexGrid -> Index ParaHexGrid -> [Index ParaHexGrid] Source # defaultMinimalPaths :: ParaHexGrid -> Index ParaHexGrid -> Index ParaHexGrid -> [[Index ParaHexGrid]] Source #
type Rep ParaHexGrid Source #
Instance details Defined in Math.Geometry.Grid.HexagonalInternal type Rep ParaHexGrid = D1 (MetaData "ParaHexGrid" "Math.Geometry.Grid.HexagonalInternal" "grid-7.8.12-1ADrZUlWO0vHdPyzqP6MYM" False) (C1 (MetaCons "ParaHexGrid" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Int, Int)) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(Int, Int)])))
type Size ParaHexGrid Source #
Instance details Defined in Math.Geometry.Grid.HexagonalInternal type Size ParaHexGrid = (Int, Int)
type Index ParaHexGrid Source #
Instance details Defined in Math.Geometry.Grid.HexagonalInternal type Index ParaHexGrid = (Int, Int)
type Direction ParaHexGrid Source #
Instance details Defined in Math.Geometry.Grid.HexagonalInternal type Direction ParaHexGrid = HexDirection

paraHexGrid :: Int -> Int -> ParaHexGrid Source #

paraHexGrid r c returns a grid in the shape of a parallelogram with r rows and c columns, using hexagonal tiles. If r and c are both nonnegative, the resulting grid will have r*c tiles. Otherwise, the resulting grid will be null and the list of indices will be null.