Class BaseGrid<Coordinates2D, Coordinates3D>Abstract

The base grid class.

Type Parameters

Hierarchy (View Summary)

Constructors

Properties

alpha: number

The opacity of the grid.

color: Color

The color of the grid.

distance: number

The distance of a grid space in units.

size: number

The size of a grid space in pixels.

sizeX: number

The width of a grid space in pixels.

sizeY: number

The height of a grid space in pixels.

style: string

The style of the grid.

thickness: number

The thickness of the grid.

type: GridType

The grid type (see CONST.GRID_TYPES).

units: string

The distance units used in this grid.

Accessors

  • get isGridless(): boolean

    Is this a gridless grid?

    Returns boolean

  • get isHexagonal(): boolean

    Is this a hexagonal grid?

    Returns boolean

  • get isSquare(): boolean

    Is this a square grid?

    Returns boolean

Methods

  • Calculate the total size of the canvas with padding applied, as well as the top-left coordinates of the inner rectangle that houses the scene.

    Parameters

    • sceneWidth: number

      The width of the scene.

    • sceneHeight: number

      The height of the scene.

    • padding: number

      The percentage of padding.

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

  • Returns the center point of the grid space corresponding to the given coordinates. If given a point, the center point of the grid space that contains it is returned. The center point lies in the plane of the bottom face of the 3D grid space. In gridless grids a point with the same coordinates as the given point is returned.

    Parameters

    Returns Point

    The center point

  • Parameters

    Returns ElevatedPoint

    The center point

  • Get the circle 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 circle with a deviation of less than 0.25 pixels is returned.

    Parameters

    • center: Point

      The center point of the circle.

    • radius: number

      The radius in grid units.

    Returns Point[]

    The points of the circle polygon.

  • 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.

    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

  • Returns the sequence of grid offsets of a shortest, direct path passing through the given waypoints.

    Parameters

    • waypoints: Coordinates2D[]

      The waypoints the path must pass through

    Returns GridOffset2D[]

    The sequence of grid offsets of a shortest, direct path

  • Parameters

    • waypoints: Coordinates3D[]

      The waypoints the path must pass through

    Returns GridOffset3D[]

    The sequence of grid offsets of a shortest, direct path

  • Returns the smallest possible range containing the offsets of all grid spaces that intersect the given bounds. If the bounds are empty (nonpositive width or height), then the offset range is empty.

    Parameters

    Returns [i0: number, j0: number, i1: number, j1: number]

    The offset range

    const [i0, j0, i1, j1] = grid.getOffsetRange(bounds);
    for ( let i = i0; i < i1; i++ ) {
    for ( let j = j0; j < j1; j++ ) {
    const offset = {i, j};
    // ...
    }
    }
  • Returns the points of the grid space shape relative to the center point. The points are returned in the same order as in BaseGrid#getVertices. In gridless grids an empty array is returned.

    Returns Point[]

    The points of the polygon

  • Returns the offset of the grid space corresponding to the given coordinates shifted by one grid space in the given direction. The k-coordinate is not changed. In square and hexagonal grids with illegal diagonals the offset of the given coordinates is returned if the direction is diagonal. In gridless grids the point is by the grid size.

    Parameters

    Returns GridOffset2D

    The offset

  • Parameters

    Returns GridOffset3D

    The offset

  • Returns the point shifted by the difference between the grid space corresponding to the given coordinates and the shifted grid space in the given direction. The z-coordinate is not changed. In square and hexagonal grids with illegal diagonals the point is not shifted if the direction is diagonal. In gridless grids the point coordinates are shifted by the grid size.

    Parameters

    Returns Point

    The shifted point

  • Parameters

    Returns ElevatedPoint

    The shifted point

  • Returns the top-left point of the grid space bounds corresponding to the given coordinates. If given a point, the top-left point of the grid space bounds that contains it is returned. The top-left point lies in the plane of the bottom face of the 3D grid space. In gridless grids a point with the same coordinates as the given point is returned.

    Parameters

    Returns Point

    The top-left point

  • Parameters

    Returns ElevatedPoint

    The top-left point

  • Get the point translated in a direction by a distance. The z-coordinate is not changed.

    Parameters

    • point: Point

      The point that is to be translated

    • direction: number

      The angle of direction in degrees

    • distance: number

      The distance in grid units

    Returns Point

    The translated point

  • Parameters

    • point: ElevatedPoint

      The point that is to be translated

    • direction: number

      The angle of direction in degrees

    • distance: number

      The distance in grid units

    Returns ElevatedPoint

    The translated point

  • Returns the vertices of the grid space corresponding to the given coordinates. The vertices are returned ordered in positive orientation with the first vertex being the top-left vertex in square grids, the top vertex in row-oriented hexagonal grids, and the left vertex in column-oriented hexagonal grids. In gridless grids an empty array is returned.

    Parameters

    Returns Point[]

    The vertices

  • Returns true if the grid spaces corresponding to the given coordinates are adjacent to each other. In square and hexagonal grids with illegal diagonals the diagonally neighboring grid spaces are not adjacent. Returns always false in gridless grids.

    Parameters

    Returns boolean

  • Parameters

    Returns boolean