Class GridlessGrid

The gridless grid class.

Hierarchy (View Summary)

BaseGrid
- GridlessGrid

Constructors

constructor

new GridlessGrid(config: GridConfiguration): GridlessGrid
The base grid constructor.
Parameters
- config: GridConfiguration
  The grid configuration
Returns GridlessGrid
Inherited from BaseGrid.constructor

Properties

`Readonly`alpha

alpha: number

The opacity of the grid.

`Readonly`color

color: Color

The color of the grid.

`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: 0 = GRID_TYPES.GRIDLESS

`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): never[]
Parameters
- coords: any
Returns never[]
Overrides BaseGrid.getAdjacentOffsets

getCenterPoint

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

getCircle

getCircle(__namedParameters: { x: any; y: any }, radius: any): any[]
Parameters
- __namedParameters: { x: any; y: any }
- radius: any
Returns any[]
Overrides BaseGrid.getCircle

getCone

getCone(origin: any, radius: any, direction: any, angle: any): any[]
Parameters
- origin: any
- radius: any
- direction: any
- angle: any
Returns any[]
Overrides BaseGrid.getCone

getDirectPath

getDirectPath(
waypoints: any,
): ({ i: any; j: any; k: any } | { i: any; j: any; k?: undefined })[]
Parameters
- waypoints: any
Returns ({ i: any; j: any; k: any } | { i: any; j: any; k?: undefined })[]
Overrides BaseGrid.getDirectPath

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

getShape

getShape(): never[]
Returns never[]
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: any; x: any; y: any }
    | { elevation?: undefined; x: any; y: any }
Parameters
- point: any
- direction: any
Returns { elevation: any; x: any; y: any } | { elevation?: undefined; x: any; y: any }
Overrides BaseGrid.getShiftedPoint

getSnappedPoint

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

getTopLeftPoint

getTopLeftPoint(
    coords: any,
):
    | { elevation?: undefined; x: any; y: any }
    | { elevation: any; x: any; y: any }
Parameters
- coords: any
Returns { elevation?: undefined; x: any; y: any } | { elevation: any; x: any; y: any }
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): never[]
Parameters
- coords: any
Returns never[]
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 GridlessGrid

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns GridlessGrid

Properties

Readonlyalpha

Readonlycolor

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 never[]

getCenterPoint

Parameters

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

getCircle

Parameters

Returns any[]

getCone

Parameters

Returns any[]

getDirectPath

Parameters

Returns ({ i: any; j: any; k: any } | { i: any; j: any; k?: undefined })[]

getOffset

Parameters

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

getOffsetRange

Parameters

Returns number[]

getShape

Returns never[]

getShiftedOffset

Parameters

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

getShiftedPoint

Parameters

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

getSnappedPoint

Parameters

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

getTopLeftPoint

Parameters

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

getTranslatedPoint

Parameters

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

getVertices

Parameters

Returns never[]

measurePath

Type Parameters

Parameters

`Readonly`alpha

`Readonly`color

`Readonly`distance

`Readonly`size

`Readonly`sizeX

`Readonly`sizeY

`Readonly`style

`Readonly`thickness

`Readonly`type

`Readonly`units

`Optional`cost?: GridMeasurePathCostFunction2D<SegmentData>

`Optional`cost?: GridMeasurePathCostFunction3D<SegmentData>