Methods
draw()
- Source:
Draw Square Grid lines
getCenter() → {Array}
- Source:
Given a pair of coordinates (x, y), return the center of the grid square which contains that point
Returns:
An Array [x, y] of the central point of the square which contains (x, y)
- Type
- Array
getGridPositionFromPixels(x, y) → {Array}
- Source:
Given a pair of pixel coordinates, return the grid position as an Array
Parameters:
| Name | Type | Description |
|---|---|---|
x |
Number | The x-coordinate pixel position |
y |
Number | The y-coordinate pixel position |
Returns:
An array representing the position in grid units, [row,col]
- Type
- Array
getNeighbors(row, col) → {Array}
- Source:
Get the grid row and column positions which are neighbors of a certain position
Parameters:
| Name | Type | Description |
|---|---|---|
row |
Number | The grid row coordinate against which to test for neighbors |
col |
Number | The grid column coordinate against which to test for neighbors |
Returns:
An array of grid positions which are neighbors of the row and column
- Type
- Array
getPixelsFromGridPosition(row, col) → {Array}
- Source:
Given a pair of grid coordinates, return the pixel position as an Array
Parameters:
| Name | Type | Description |
|---|---|---|
row |
Number | The row coordinate grid position |
col |
Number | The column coordinate grid position |
Returns:
An array representing the position in pixels, [x,y]
- Type
- Array
getSnappedPosition(x, y, interval)
- Source:
Given a pair of coordinates (x1,y1), return the grid coordinates (x2,y2) which represent the snapped position
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
x |
Number | The exact target location x |
|
y |
Number | The exact target location y |
|
interval |
Number |
1
|
An interval of grid spaces at which to snap, default is 1. |
getTopLeft() → {Array}
- Source:
Given a pair of coordinates (x, y) - return the top-left of the grid square which contains that point
Returns:
An Array [x, y] of the top-left coordinate of the square which contains (x, y)
- Type
- Array
highlightGridPosition(layer, x, y, color, border, alpha)
- Source:
Highlight a grid position for a certain coordinates
Parameters:
| Name | Type | Description |
|---|---|---|
layer |
GridHighlight | The highlight layer to use |
x |
Number | The x-coordinate of the highlighted position |
y |
Number | The y-coordinate of the highlighted position |
color |
Number | The hex fill color of the highlight |
border |
Number | The hex border color of the highlight |
alpha |
Number | The opacity of the highlight |
measureDistance()
- Source:
Measure the distance between two pixel coordinates See BaseGrid.measureDistance for more details
shiftPosition(x, y, dx, dy)
- Source:
Shift a pixel position [x,y] by some number of grid units dx and dy
Parameters:
| Name | Type | Description |
|---|---|---|
x |
Number | The starting x-coordinate in pixels |
y |
Number | The starting y-coordinate in pixels |
dx |
Number | The number of grid positions to shift horizontally |
dy |
Number | The number of grid positions to shift vertically |