API Docs for: 0.1.1
Show:

flatworld.extensions.hexagons.utils Class

Defined in: src/components/map/extensions/hexagons/utils/hexagonMath.js:25

Utility module, for making different calculations and tests when hexagon based grid map in use

Methods

_pointInPolygon

(
  • point
  • hitCoords.x
  • hitCoords.y
  • vs
)
Boolean private static

Defined in src/components/map/extensions/hexagons/utils/hexagonMath.js:239

credits to: https://github.com/substack/point-in-polygon Tests whether the given point / coordinate is inside the given points. Assuming the points form a polygon

Parameters:

  • point Object

    The coordinates to test against

  • hitCoords.x Integer

    X coordinate

  • hitCoords.y Integer

    Y coordinate

  • vs Integer

    The points of the polygon to test [0] === x-point, [1] === y-point

Returns:

Boolean:

Is the coordinate inside the hexagon or not

calcLongDiagonal

(
  • {}
)
static

Defined in src/components/map/extensions/hexagons/utils/hexagonMath.js:80

Calculates the hexagons: innerDiameter

  • Vertical / Flat hexagons height
  • Horizontal / pointy hexagons width

Parameters:

  • {} Object

    OPTIONAL

    • radius Float

      Usually the radius of the hexagon

    • type String

      If you provide something else than radius, where the calculation is based from

calcLongDiagonal

(
  • {}
)
static

Defined in src/components/map/extensions/hexagons/utils/hexagonMath.js:100

outerDiameter

  • Vertical / Flat hexagons width
  • Horizontal / pointy hexagons height

Parameters:

  • {} Object

    OPTIONAL

    • radius Float

      Usually the radius of the hexagon

    • type String

      If you provide something else than radius, where the calculation is based from

calcSpecialDistance

(
  • {}
)
static

Defined in src/components/map/extensions/hexagons/utils/hexagonMath.js:119

Parameters:

  • {} Object

    OPTIONAL

    • radius Float

      Usually the radius of the hexagon

createHexagonGridCoordinates

(
  • gridSize
  • {}
)
static

Defined in src/components/map/extensions/hexagons/utils/hexagonMath.js:158

Create Array that holds the coordinates for the size of hexagon grid we want to create.

Parameters:

  • gridSize Object
    • rows Object

      The count of rows in the hexagon grid

    • columns Object

      The count of columns in the hexagon grid

  • {} Object

    OPTIONAL configurations in an object

    • radius Number

      The radius of hexagon. Basically the radius of the outer edges / circle of the hexagon.

    • orientation String

      Is it horizontal or vertical hexagon grid. Default: horizontal

Returns:

:

Array that holds the coordinates for the hexagon grid, like [{x: ?, y: ?}]

getClosestHexagonCenter

(
  • coordinates
)
static

Defined in src/components/map/extensions/hexagons/utils/hexagonMath.js:195

Calculates the closest hexagon center coordinates, for the given coordinates. So aligning the given coordinates to proper hexagon coordinates

Parameters:

  • coordinates Object

    The coordinate where we want to find the closest hexagon center point

getHexagonPoints

(
  • radius
  • options
)
static

Defined in src/components/map/extensions/hexagons/utils/hexagonMath.js:46

Parameters:

  • radius Float

    radius of the hexagon

  • options Object

    extra options, like generating horizontal hexagon points and how many decimals to round

hexaHitTest

(
  • points
  • hitCoords
  • offsetCoords
)
Boolean static

Defined in src/components/map/extensions/hexagons/utils/hexagonMath.js:129

Test do the given coordinates hit the hexagon, given by the points container / array

Parameters:

  • points PIXI.Point

    Array of PIXI.points

  • hitCoords Object

    The coordinates to test against

    • x Integer

      X coordinate

    • y Integer

      Y coordinate

  • offsetCoords Object

    OPTIONAL offsetCoordinates that are added to the hitCoordinates. Separate because these are outside the given array.

    • x Integer

      X coordinate

    • y Integer

      Y coordinate

Returns:

Boolean:

Is the coordinate inside the hexagon or not

setRadius

(
  • radius
)
static

Defined in src/components/map/extensions/hexagons/utils/hexagonMath.js:34

Set hexagon radius

Parameters:

  • radius Number

    The radius of the hexagon