Class SquareGrid

The square grid class.

Hierarchy (View Summary)

BaseGrid
- SquareGrid

Constructors

constructor

new SquareGrid(config: SquareGridConfiguration): SquareGrid
The square grid constructor.
Parameters
- config: SquareGridConfiguration
  The grid configuration
Returns SquareGrid
Overrides BaseGrid.constructor

Properties

`Readonly`alpha

alpha: number

The opacity of the grid.

`Readonly`color

color: Color

The color of the grid.

`Readonly`diagonals

diagonals: GridDiagonalRule

The rule for diagonal measurement (see CONST.GRID_DIAGONALS).

`Readonly`distance

distance: number

The distance of a grid space in units.

`Readonly`size

size: number

The size of a grid space in pixels.

`Readonly`sizeX

sizeX: number

The width of a grid space in pixels.

`Readonly`sizeY

sizeY: number

The height of a grid space in pixels.

`Readonly`style

style: string

The style of the grid.

`Readonly`thickness

thickness: number

The thickness of the grid.

`Readonly`type

type: 1 = GRID_TYPES.SQUARE

`Readonly`units

units: string

The distance units used in this grid.

Accessors

isGridless

get isGridless(): boolean
Is this a gridless grid?

Returns boolean
Inherited from BaseGrid.isGridless

isHexagonal

get isHexagonal(): boolean
Is this a hexagonal grid?

Returns boolean
Inherited from BaseGrid.isHexagonal

isSquare

get isSquare(): boolean
Is this a square grid?

Returns boolean
Inherited from BaseGrid.isSquare

Methods

_measurePath

_measurePath(
    waypoints: any,
    __namedParameters: { cost: any },
    result: any,
): void
Parameters
- waypoints: any
- __namedParameters: { cost: any }
- result: any
Returns void
Overrides BaseGrid._measurePath

calculateDimensions

calculateDimensions(
    sceneWidth: any,
    sceneHeight: any,
    padding: any,
): {
    columns: number;
    height: any;
    rows: number;
    width: any;
    x: number;
    y: number;
}
Parameters
- sceneWidth: any
- sceneHeight: any
- padding: any
Returns { columns: number; height: any; rows: number; width: any; x: number; y: number }
Overrides BaseGrid.calculateDimensions

getAdjacentOffsets

getAdjacentOffsets(
coords: any,
): { i: any; j: any }[] | { i: any; j: any; k: any }[]
Parameters
- coords: any
Returns { i: any; j: any }[] | { i: any; j: any; k: any }[]
Overrides BaseGrid.getAdjacentOffsets

getCenterPoint

getCenterPoint(
    coords: any,
):
    | { elevation?: undefined; x: number; y: number }
    | { elevation: number; x: number; y: number }
Parameters
- coords: any
Returns
| { elevation?: undefined; x: number; y: number }
| { elevation: number; x: number; y: number }
Overrides BaseGrid.getCenterPoint

getCircle

getCircle(center: any, radius: any): Point[]
Parameters
- center: any
- radius: any
Returns Point[]
Overrides BaseGrid.getCircle

getCone

getCone(
    origin: Point,
    radius: number,
    direction: number,
    angle: number,
): Point[]
Get the cone polygon given the radius in grid units and the angle in degrees for this grid. The points of the polygon are returned ordered in positive orientation. In gridless grids an approximation of the true cone with a deviation of less than 0.25 pixels is returned. If the angle less than 360 and the cone not empty, the first point of the polygon is the origin.
Parameters
- origin: Point
  The origin point of the cone
- radius: number
  The radius in grid units
- direction: number
  The direction in degrees
- angle: number
  The angle in degrees
Returns Point[]
The points of the cone polygon

Inherited from BaseGrid.getCone

getDirectPath

getDirectPath(waypoints: any): GridOffset2D[]
Parameters
- waypoints: any
Returns GridOffset2D[]
Overrides BaseGrid.getDirectPath

getEllipse

getEllipse(center: any, radiusX: any, radiusY: any, rotation: any): Point[]
Get the ellipse polygon given the radius in grid units for this grid. The points of the polygon are returned ordered in positive orientation. In gridless grids an approximation of the true ellipse with a deviation of less than 0.25 pixels is returned.
Parameters
- center: any
  The center point of the ellipse.
- radiusX: any
  The x-radius in grid units.
- radiusY: any
  The y-radius in grid units.
- rotation: any
  The rotation in degrees.
Returns Point[]
The points of the ellipse polygon.

Overrides BaseGrid.getEllipse

getLine

getLine(
    origin: Point,
    length: number,
    width: number,
    direction: number,
): Point[]
Get the line polygon given the length and width in grid units for this grid. The points of the polygon are returned ordered in positive orientation.
Parameters
- origin: Point
  The origin point of the line.
- length: number
  The length in grid units.
- width: number
  The width in grid units.
- direction: number
  The direction in degrees.
Returns Point[]
The points of the line polygon.

Inherited from BaseGrid.getLine

getOffset

getOffset(
coords: any,
): { i: any; j: any; k: any } | { i: any; j: any; k?: undefined }
Parameters
- coords: any
Returns { i: any; j: any; k: any } | { i: any; j: any; k?: undefined }
Overrides BaseGrid.getOffset

getOffsetRange

getOffsetRange(
__namedParameters: { height: any; width: any; x: any; y: any },
): number[]
Parameters
- __namedParameters: { height: any; width: any; x: any; y: any }
Returns number[]
Overrides BaseGrid.getOffsetRange

getRectangle

getRectangle(
    origin: Point,
    width: number,
    height: number,
    anchor: Point,
    rotation: number,
): Point[]
Get the rectangle polygon given the width and height in grid units for this grid. The points of the polygon are returned ordered in positive orientation.
Parameters
- origin: Point
  The origin point of the rectangle.
- width: number
  The width in grid units.
- height: number
  The height in grid units.
- anchor: Point
  The anchor.
- rotation: number
  The rotation in degrees.
Returns Point[]
The points of the rectangle polygon.

Inherited from BaseGrid.getRectangle

getRing

getRing(center: any, radius: any, innerWidth: any, outerWidth: any): Point[][]
Get the ring polygon given the radius and width in grid units for this grid. The points of the polygons are returned ordered in positive orientation. In gridless grids an approximation of the true ring with a deviation of less than 0.25 pixels is returned.
Parameters
- center: any
  The center point of the ring.
- radius: any
  The radius in grid units.
- innerWidth: any
  The inner width in grid units.
- outerWidth: any
  The outer width in grid units.
Returns Point[][]
The inner and outer circles of the ring polygon.

Overrides BaseGrid.getRing

getShape

getShape(): { x: number; y: number }[]
Returns { x: number; y: number }[]
Overrides BaseGrid.getShape

getShiftedOffset

getShiftedOffset(
coords: any,
direction: any,
): { i: any; j: any; k: any } | { i: any; j: any; k?: undefined }
Parameters
- coords: any
- direction: any
Returns { i: any; j: any; k: any } | { i: any; j: any; k?: undefined }
Overrides BaseGrid.getShiftedOffset

getShiftedPoint

getShiftedPoint(
    point: any,
    direction: any,
):
    | { elevation?: undefined; x: number; y: number }
    | { elevation: number; x: number; y: number }
Parameters
- point: any
- direction: any
Returns
| { elevation?: undefined; x: number; y: number }
| { elevation: number; x: number; y: number }
Overrides BaseGrid.getShiftedPoint

getSnappedPoint

getSnappedPoint(
    point: any,
    __namedParameters: { mode: any; resolution?: number },
):
    | { elevation: any; x: any; y: any }
    | { elevation?: undefined; x: any; y: any }
    | undefined
Parameters
- point: any
- __namedParameters: { mode: any; resolution?: number }
Returns
    | { elevation: any; x: any; y: any }
    | { elevation?: undefined; x: any; y: any }
    | undefined
Overrides BaseGrid.getSnappedPoint

getTopLeftPoint

getTopLeftPoint(
    coords: any,
):
    | { elevation?: undefined; x: number; y: number }
    | { elevation: number; x: number; y: number }
Parameters
- coords: any
Returns
| { elevation?: undefined; x: number; y: number }
| { elevation: number; x: number; y: number }
Overrides BaseGrid.getTopLeftPoint

getTranslatedPoint

getTranslatedPoint(
    point: any,
    direction: any,
    distance: any,
):
    | { elevation: any; x: any; y: any }
    | { elevation?: undefined; x: any; y: any }
Parameters
- point: any
- direction: any
- distance: any
Returns { elevation: any; x: any; y: any } | { elevation?: undefined; x: any; y: any }
Overrides BaseGrid.getTranslatedPoint

getVertices

getVertices(coords: any): { x: number; y: number }[]
Parameters
- coords: any
Returns { x: number; y: number }[]
Overrides BaseGrid.getVertices

measurePath

measurePath<
    SegmentData extends
        {
            cost: never;
            elevation: never;
            i: never;
            j: never;
            k: never;
            q: never;
            r: never;
            s: never;
            x: never;
            y: never;
        } = {},
>(
    waypoints: (
        GridCoordinates2D & Partial<GridMeasurePathWaypointData2D> & SegmentData
    )[],
    options?: { cost?: GridMeasurePathCostFunction2D<SegmentData> },
): GridMeasurePathResult
Measure a shortest, direct path through the given waypoints.
Type Parameters
- SegmentData extends {
      cost: never;
      elevation: never;
      i: never;
      j: never;
      k: never;
      q: never;
      r: never;
      s: never;
      x: never;
      y: never;
  } = {}
Parameters
- waypoints: (GridCoordinates2D & Partial<GridMeasurePathWaypointData2D> & SegmentData)[]
  The waypoints the path must pass through
- Optionaloptions: { cost?: GridMeasurePathCostFunction2D<SegmentData> }
  Additional measurement options
  - Optionalcost?: GridMeasurePathCostFunction2D<SegmentData>
    The function that returns the cost for a given move between grid spaces (default is the distance travelled along the direct path)
Returns GridMeasurePathResult
The measurements a shortest, direct path through the given waypoints

Inherited from BaseGrid.measurePath
measurePath(
    waypoints: (
        GridCoordinates3D & Partial<GridMeasurePathWaypointData3D> & SegmentData
    )[],
    options?: { cost?: GridMeasurePathCostFunction3D<SegmentData> },
): GridMeasurePathResult
Parameters
- waypoints: (GridCoordinates3D & Partial<GridMeasurePathWaypointData3D> & SegmentData)[]
  The waypoints the path must pass through
- Optionaloptions: { cost?: GridMeasurePathCostFunction3D<SegmentData> }
  Additional measurement options
  - Optionalcost?: GridMeasurePathCostFunction3D<SegmentData>
    The function that returns the cost for a given move between grid spaces (default is the distance travelled along the direct path)
Returns GridMeasurePathResult
The measurements a shortest, direct path through the given waypoints

Inherited from BaseGrid.measurePath

testAdjacency

testAdjacency(coords1: any, coords2: any): boolean
Parameters
- coords1: any
- coords2: any
Returns boolean
Overrides BaseGrid.testAdjacency

Class SquareGrid

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SquareGrid

Properties

Readonlyalpha

Readonlycolor

Readonlydiagonals

Readonlydistance

Readonlysize

ReadonlysizeX

ReadonlysizeY

Readonlystyle

Readonlythickness

Readonlytype

Readonlyunits

Accessors

isGridless

Returns boolean

isHexagonal

Returns boolean

isSquare

Returns boolean

Methods

_measurePath

Parameters

Returns void

calculateDimensions

Parameters

Returns { columns: number; height: any; rows: number; width: any; x: number; y: number }

getAdjacentOffsets

Parameters

Returns { i: any; j: any }[] | { i: any; j: any; k: any }[]

getCenterPoint

Parameters

Returns | { elevation?: undefined; x: number; y: number } | { elevation: number; x: number; y: number }

getCircle

Parameters

Returns Point[]

getCone

Parameters

Returns Point[]

getDirectPath

Parameters

Returns GridOffset2D[]

getEllipse

Parameters

Returns Point[]

getLine

Parameters

Returns Point[]

getOffset

Parameters

Returns { i: any; j: any; k: any } | { i: any; j: any; k?: undefined }

getOffsetRange

Parameters

Returns number[]

getRectangle

Parameters

Returns Point[]

getRing

Parameters

Returns Point[][]

getShape

Returns { x: number; y: number }[]

getShiftedOffset

Parameters

Returns { i: any; j: any; k: any } | { i: any; j: any; k?: undefined }

getShiftedPoint

Parameters

Returns | { elevation?: undefined; x: number; y: number } | { elevation: number; x: number; y: number }

getSnappedPoint

Parameters

`Readonly`alpha

`Readonly`color

`Readonly`diagonals

`Readonly`distance

`Readonly`size

`Readonly`sizeX

`Readonly`sizeY

`Readonly`style

`Readonly`thickness

`Readonly`type

`Readonly`units

Returns
| { elevation?: undefined; x: number; y: number }
| { elevation: number; x: number; y: number }

Returns
| { elevation?: undefined; x: number; y: number }
| { elevation: number; x: number; y: number }

Returns
| { elevation: any; x: any; y: any }
| { elevation?: undefined; x: any; y: any }
| undefined

Returns
| { elevation?: undefined; x: number; y: number }
| { elevation: number; x: number; y: number }

`Optional`cost?: GridMeasurePathCostFunction2D<SegmentData>

`Optional`cost?: GridMeasurePathCostFunction3D<SegmentData>