org.codetome.hexameter.core.api

Class CoordinateConverter

java.lang.Object

org.codetome.hexameter.core.api.CoordinateConverter

public final class CoordinateConverter
extends Object

Utility class for converting coordinated from the offset system to the axial one (the library uses the latter).

Constructor Summary

Constructors

Constructor and Description
CoordinateConverter()

Method Summary

Modifier and Type	Method and Description
static int	convertOffsetCoordinatesToAxialX(int offsetX, int offsetY, HexagonOrientation orientation) Calculates the axial X coordinate based on an offset coordinate pair.
static int	convertOffsetCoordinatesToAxialZ(int offsetX, int offsetY, HexagonOrientation orientation) Calculates the axial Z coordinate based on an offset coordinate pair.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CoordinateConverter

public CoordinateConverter()

Method Detail

convertOffsetCoordinatesToAxialX

public static int convertOffsetCoordinatesToAxialX(int offsetX,
                                                   int offsetY,
                                                   HexagonOrientation orientation)

Calculates the axial X coordinate based on an offset coordinate pair.

Parameters:

offsetX - offset x

offsetY - offset y

orientation - orientation

Returns:

axial x

convertOffsetCoordinatesToAxialZ

public static int convertOffsetCoordinatesToAxialZ(int offsetX,
                                                   int offsetY,
                                                   HexagonOrientation orientation)

Calculates the axial Z coordinate based on an offset coordinate pair.

Parameters:

offsetX - offset x

offsetY - offset y

orientation - orientation

Returns:

axial z