Mixite is a hexagonal grid library. The motivation behind it is to have an optimized, simple and usable library for drawing hexagonal grids without being tied to any GUI framework.
This means that you can use Mixite on Android, your backend or your desktop app.
There is a REST-based web example which you can tinker with here. (not recommended, this is under rewrite)
You can also check out the mixite.example.swt project here.
Mixite currently supports a maximum grid size of 1000 * 1000 (1.000.000 cells) with the default implementation but you can provide your own storage implementation to alleviate this limitation.
Disclaimer for Java users: There is no need to worry, Mixite works in exactly the same way as Hexameter worked before. Java interop is seamless, you only have to change the imports / project dependency.
As always with Maven Central artifacts: previous versions of Hexameter also work, they are not affected.
Need info? Ask us on Discord | or Create an issue | Support us on Patreon
This library uses Amit's guide to hexagonal grids. The coordinate system used by this library is the Cubic coordinate system. Please check here for further details.
Hexagonal grids come in flat topped and pointy topped shapes. The grid can have several layouts:
- Hexagonal: the width and height of a this layout has to be equal and both have to be an odd number.
- Triangular: the width and height of a this layout has to be equal.
- Rectangular: no special rules
- Trapezoid: no special rules
- Custom: your own implementation of
GridLayoutStrategy
All layouts have width and height values of at least 1. You can consult HexagonalGridLayout if you need further details.
This library is not tied to any GUI implementation. All operations provided by the API work using the most abstract concept possible.
Let's start by adding Mixite as a dependency.
<repositories>
<repository>
<id>jitpack.io</id>
<url>https://jitpack.io</url> <!-- Mixite uses Jitpack repository -->
</repository>
</repositories>
...
<dependency>
<groupId>com.github.Hexworks.mixite</groupId>
<artifactId>mixite.core-jvm</artifactId>
<version>2018.2.0-RELEASE</version>
</dependency>
allprojects {
repositories {
maven { url 'https://jitpack.io' } // Mixite uses Jitpack repository
}
}
...
dependencies {
implementation 'com.github.Hexworks.mixite:mixite.core-jvm:2018.2.0-RELEASE'
}
Note that if you are using Javascript you need
mixite.core-web:'org.hexworks.mixite:mixite.core-web:2018.2.0-RELEASE'
You can also use the latest preview versions, more info here.
You can use the HexagonalGridBuilder to create a HexagonalGrid:
HexagonalGridBuilder<DefaultSatelliteData> builder = new HexagonalGridBuilder<>()
.setGridHeight(9)
.setGridWidth(9)
.setGridLayout(HexagonalGridLayout.RECTANGULAR)
.setOrientation(HexagonOrientation.FLAT_TOP)
.setRadius(30.0);
HexagonalGrid<DefaultSatelliteData> grid = builder.build();
You can also use it to create a HexagonalGridCalculator for you which supports advanced operations on HexagonalGrids:
HexagonalGridCalculator<DefaultSatelliteData> calc = builder.buildCalculatorFor(grid);
calc.calculateDistanceBetween(sourceHex, targetHex)
Method Grid.getHexagons returns an iterable collection of hexagons. Each Point represents a coordinate in 2D space that can
be transformed for rendering.
for (Hexagon<DefaultSatelliteData> hexagon : grid.getHexagons()) {
for(Point p : hexagon.getPoints()) {
// Do you stuff with point.coordinateX, point.coordinateY
}
}
There are basically only one operation for manipulating your data on the grid:
The Hexagon#setSatelliteData(T data) operation with which you can add your own arbitrary
data to a Hexagon object. This means that once created a HexagonalGrid is immutable apart from the
satellite data you add.
There is also a HexagonalGrid#clearSatelliteData() method for clearing all satellite data from your grid.
The implementation of the HexagonalGrid is lazy. This means that it only stores data which is absolutely necessary
to keep in memory (the coordinates and your satellite data). Everything else is generated on the fly. The only limiting
factor of a grid at the moment is the coordinates (which consume memory) and the satellite data.
You can find a simple GUI example in the mixite.example.swt project. Run it by doing the following steps.
- Clone the project:
git clone [email protected]:Hexworks/mixite.git - cd to the newly created
mixitefolder:cd mixite/ - build the project:
./gradlew clean build(orgradlew clean buildon Windows) - run the created uberjar:
java -jar mixite.example.swt/build/libs/mixite.example.swt.jar
- Querying the characteristics of the
HexagonGrid - Fetching all the
Hexagonobjects from the grid - Getting a subset of Hexagons (using cube or offset coordinate range) from the grid
- Checking whether a Hexagon is on a grid or not
- Getting a
Hexagonby its grid coordinate (cube) - Getting a
Hexagonby its pixel coordinate - Getting the neighbors of a hexagon (also by index)
- Calculating the distance between two
Hexagons - Calculating the movement range from a
Hexagonto an other - Rotating a
Hexagon - Calculating a ring from a
Hexagon - Draw a line from a
Hexagonto an other - Checking visibility of a
Hexagonfrom an other - Adding custom data to a Hexagon
- Clearing all custom data from the HexagonalGrid
Check these interfaces for more details:
- You can add satellite data (any arbitrary data you have) to a
Hexagon. By implementing theSatelliteDatainterface you gain operations like visibility checking - Mixite comes with a sensible default implementation of
SatelliteDataso if you don't want to add extra data you can useDefaultSatelliteData. - You can use your own implementation of
HexagonDataStoragefor storing yourHexagons - Mixite comes with a sensible
DefaultHexagonDataStorageimplementation which stores all data in memory - You don't have to fetch all
Hexagonobjects by using thegetHexagonsmethod. You can queryHexagons by a range using offset or cube coordinates
- Path finding with obstacles (blocking movement)
- Movement range with obstacles and movement cost calculation
- Android example
Mixite is made available under the Apache2 License.
Mixite is created and maintained by Adam Arold
I'm open to suggestions, feel free to comment or to send me a message. Pull requests are also welcome!