Class Index | File Index

Classes


Class HexagonNameCalculator

HexagonNameCalculator
Defined in: hexagonNameCalculator.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
HexagonNameCalculator It's purpose is to provide a hexagon name.
Method Summary
Method Attributes Method Name and Description
 
method to get display hexagon name
 
method to get hexagonPoint
 
method to get hexagon name
 
getX()
method to get x coordinate
 
getY()
method to get y coordinate
 
setHexagonPoint(hexagon)
method to set the x coordinate and the y coordinate of the hexagon
 
setMapViewPort(mapViewPort)
method to set the mapViewPort
 
setName(name)
method to set the x coordinate and the y coordinate of the hexagon
 
setXY(x, y)
method to set the x coordinate and the y coordinate of the hexagon
Class Detail
HexagonNameCalculator()
HexagonNameCalculator It's purpose is to provide a hexagon name. It can convert it's x,y coordinate into a hexagon name It can convert it's hexagon name into a x,y coordinate
Method Detail
{string} getDisplayName()
method to get display hexagon name
Returns:
{string} display hexagon name

{point} getHexagonPoint()
method to get hexagonPoint
Returns:
{point} Point

{string} getName()
method to get hexagon name
Returns:
{string} hexagon name

{integer} getX()
method to get x coordinate
Returns:
{integer} x coordinate

{integer} getY()
method to get y coordinate
Returns:
{integer} y coordinate

setHexagonPoint(hexagon)
method to set the x coordinate and the y coordinate of the hexagon
Parameters:
{point} hexagon
point

setMapViewPort(mapViewPort)
method to set the mapViewPort
Parameters:
mapViewPort
{mapViewPort} mapViewPort

setName(name)
method to set the x coordinate and the y coordinate of the hexagon
Parameters:
name
{string} name

setXY(x, y)
method to set the x coordinate and the y coordinate of the hexagon
Parameters:
x
{integer} x coordinate
y
{integer} y coordinate

Documentation generated by JsDoc Toolkit 2.4.0 on Mon Oct 22 2018 10:19:51 GMT-0700 (PDT)