Class Grid2DHelper

Represent a 2D cartesian grid (axis aligned)

Hierarchy

  • Grid2DHelper

Constructors

constructor

Accessors

count dx dy nx ny origin xLength yLength

Methods

candidate flatIndex flatIndices forEach getIJ interpolate map positionAt

Constructors

constructor

  • Parameters

    • min: V2
    • max: V2
    • nx: number
    • ny: number
    • eps: number = 1e-7

    Returns Grid2DHelper

Accessors

count

  • get count(): number

  • Returns number

dx

  • get dx(): number

  • Returns number

dy

  • get dy(): number

  • Returns number

nx

  • get nx(): number

  • Returns number

ny

  • get ny(): number

  • Returns number

origin

  • get origin(): number[]

  • Returns number[]

xLength

  • get xLength(): number

  • Returns number

yLength

  • get yLength(): number

  • Returns number

Methods

candidate

  • Get the (i,j) position of the intersecting cell. The 4 corners will be

    (i,j), (i+1,j), (i+1,j+1) and (i,j+1)

          y
          ^
          |
          *---* (i+1,j+1)
          |   |
    (i,j) *---* --> x

    Parameters

    • p: [number, number]

    Returns [number, number]

flatIndex

  • Given the (i,j) indices of a cell, return its flatten index. This index varies from 0 to nx*ny and is unique for each corner cell of the grid. It is mainly used to get the attribute at a given position.

    Parameters

    • i: number
    • j: number

    Returns number

flatIndices

  • Return the flat-indices of the 4 corners of the intersecting cell with point p

    Parameters

    • p: [number, number]

    Returns [number, number, number, number]

forEach

  • Iterate aver all points of the grids and call cb = Function(x, y, i, j, flat)

    Parameters

    • cb: ((x: number, y: number, i: number, j: number, flat: number) => void)
        • (x: number, y: number, i: number, j: number, flat: number): void

        • Parameters

          • x: number
          • y: number
          • i: number
          • j: number
          • flat: number

          Returns void

    Returns void

getIJ

  • Parameters

    • p: [number, number]

    Returns {
        ij?: number[];
        ok: boolean;
    }

    • Optional ij?: number[]
    • ok: boolean

interpolate

  • Parameters

    • p: [number, number]
    • attribute: Serie<IArray>

    Returns number | number[]

map

  • Iterate aver all points of the grids and generate a new array of the transformed point by calling cb = Function(x, y, i, j, flat)

    Parameters

    • cb: ((x: number, y: number, i: number, j: number, flat: number) => number)
        • (x: number, y: number, i: number, j: number, flat: number): number

        • Parameters

          • x: number
          • y: number
          • i: number
          • j: number
          • flat: number

          Returns number

    Returns any[]

positionAt

  • Given the (i,j) indices of a cell (lower-left corner), return its (x,y) position

    Parameters

    • i: number
    • j: number

    Returns [number, number]

Settings

Member Visibility

Theme