Class PoissonDisc

constructor

• new PoissonDisc(
      size: IDimension,
      radius: number,
      retries: number,
      dimensions: number,
      firstPoint?: ICoordinates,
  ): PoissonDisc

  Create a new disc sampler

  Parameters

  • size: IDimension

    Size of the display in pixels

  • radius: number

    The minimum distance between points

  • retries: number

    Number of tries to make a new point before giving up

  • dimensions: number

    n-dimensional grid

  • OptionalfirstPoint: ICoordinates

    The first point position (optional)

  Returns PoissonDisc

active

cellSize

cols

dimensions

firstPoint

grid

points

radius

retries

rows

size

addPoint

• addPoint(inputPoint: ICoordinates): void

  Add a new point to the points, grid and active arrays. Points array holds the point data and grid / active hold indices to the points array.

  Parameters

  • inputPoint: ICoordinates

    The pixel position of the point

  Returns void

getRandom

• getRandom(min: number, max: number): number

  Get a random integer between min and max

  Parameters

  • min: number

    The minimum value

  • max: number

    The maximum value

  Returns number

  Random number from min to max

initialiseGrid

• initialiseGrid(): void

  Initialise the empty background grid array

  Returns void

reset

• reset(): void

  Reset the algorithm and data

  Returns void

run

• run(): Promise<void>

  Run the algorithm till the end

  Returns Promise<void>

steps

• steps(steps: number): Promise<void>

  Take a single or n steps through the algorithm

  Parameters

  • steps: number

    Number of steps to take

  Returns Promise<void>