A poisson sampler that is a grid of samplers (this allows infinite worlds to use this).
\nA fast poison disc sampler.\nBased on https://www.jasondavies.com/poisson-disc/
\nA fast poison disc sampler.\nBased on https://www.jasondavies.com/poisson-disc/
\nArray\n * [.getNewPoints()](#MultiSampler+getNewPoints) ⇒ Array\n * [.getPointsForCell(x, y)](#MultiSampler+getPointsForCell) ⇒ Array\n * [.resize(h, w)](#MultiSampler+resize)\n * [.prePopulate(points)](#MultiSampler+prePopulate)\n * [.remove(x, y)](#MultiSampler+remove)\n\n\n\n### new MultiSampler(config)\nCreate a multisampler.\n\n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| config | Object | | The config for the sampler. |\n| [config.w] | Number | 64 | The width of the entire sample space. |\n| [config.h] | Number | 64 | The height of the entire sample space. |\n| [config.cw] | Number | 32 | The width of each sub sampler. |\n| [config.ch] | Number | 32 | The height of each subsampler. |\n| [config.r] | Number | 10 | The minimum radius between samples. |\n\n\n\n### multiSampler.getPoints() ⇒ Array\nGet all points from all sub-samplers.\n\n**Kind**: instance method of [MultiSampler](#MultiSampler) \n**Returns**: Array - The array of points. \n\n\n### multiSampler.getNewPoints() ⇒ Array\nGet new sample points from sampler.\n\n**Kind**: instance method of [MultiSampler](#MultiSampler) \n**Returns**: Array - An array of points. \n\n\n### multiSampler.getPointsForCell(x, y) ⇒ Array\nGet points for a single cell.\n\n**Kind**: instance method of [MultiSampler](#MultiSampler) \n**Returns**: Array - The array of points. \n\n| Param | Type | Description |\n| --- | --- | --- |\n| x | Number | The x coord in the cell. |\n| y | Number | The y coord in the cell. |\n\n\n\n### multiSampler.resize(h, w)\nResize the multisampler.\n\n**Kind**: instance method of [MultiSampler](#MultiSampler) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| h | Number | New height. |\n| w | Number | New width. |\n\n\n\n### multiSampler.prePopulate(points)\nPrepopulates all the sub-samplers with the given points,\nrejecting ones outside the subsamplers.\n\n**Kind**: instance method of [MultiSampler](#MultiSampler) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| points | Array | The points to seed subsamplers with. |\n\n\n\n### multiSampler.remove(x, y)\nRemove a sample from the grid.\nIt will be replaced with new one the next time get points is called.\n\n**Kind**: instance method of [MultiSampler](#MultiSampler) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| x | Number | The x coord. |\n| y | Number | The y coord. |\n\n\n\n## RandomSampler\nA fast poison disc sampler.\nBased on https://www.jasondavies.com/poisson-disc/\n\n**Kind**: global class \n\n* [RandomSampler](#RandomSampler)\n * [new RandomSampler(config)](#new_RandomSampler_new)\n * [.getPoints()](#RandomSampler+getPoints) ⇒ Array\n * [.getNewPoints(The)](#RandomSampler+getNewPoints) ⇒ Array\n * [.run()](#RandomSampler+run)\n * [.remove(x, y)](#RandomSampler+remove)\n * [.prePopulate(points)](#RandomSampler+prePopulate)\n\n\n\n### new RandomSampler(config)\nconstructor\n\n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| config | Object | | The config for the sampler. |\n| [config.w] | Number | 64 | The width of the sample space. |\n| [config.h] | Number | 64 | The height of the sample space. |\n| [config.x] | Number | 0 | The offset from \"world\" center (used by multisampler). |\n| [config.y] | Number | 0 | The offset from world center. |\n| [config.r] | Number | 10 | The minimum radius between points. |\n\n\n\n### randomSampler.getPoints() ⇒ Array\nGet all sample points from sampler.\n\n**Kind**: instance method of [RandomSampler](#RandomSampler) \n**Returns**: Array - An array of points. \n\n\n### randomSampler.getNewPoints(The) ⇒ Array\nGet new sample points from sampler.\n\n**Kind**: instance method of [RandomSampler](#RandomSampler) \n**Returns**: Array - An array of points. \n\n| Param | Type | Description |\n| --- | --- | --- |\n| The | Number | number of new points desired. |\n\n\n\n### randomSampler.run()\nRuns the sampler.\n\n**Kind**: instance method of [RandomSampler](#RandomSampler) \n\n\n### randomSampler.remove(x, y)\nRemove a sample from the grid.\nIt will be replaced with new one the next time get points is called.\n\n**Kind**: instance method of [RandomSampler](#RandomSampler) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| x | Number | The x coord. |\n| y | Number | The y coord. |\n\n\n\n### randomSampler.prePopulate(points)\nPre-populate the sampler with points.\n\n**Kind**: instance method of [RandomSampler](#RandomSampler) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| points | Array | The points to add to the sampler. |\n\n\n\n## PoissonDiscSampler\nA fast poison disc sampler.\nBased on https://www.jasondavies.com/poisson-disc/\n\n**Kind**: global class \n\n* [PoissonDiscSampler](#PoissonDiscSampler)\n * [new PoissonDiscSampler(config)](#new_PoissonDiscSampler_new)\n * [.getPoints()](#PoissonDiscSampler+getPoints) ⇒ Array\n * [.getNewPoints(The)](#PoissonDiscSampler+getNewPoints) ⇒ Array\n * [.run()](#PoissonDiscSampler+run)\n * [.remove(x, y)](#PoissonDiscSampler+remove)\n * [.prePopulate(points)](#PoissonDiscSampler+prePopulate)\n\n\n\n### new PoissonDiscSampler(config)\nconstructor\n\n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| config | Object | | The config for the sampler. |\n| [config.w] | Number | 64 | The width of the sample space. |\n| [config.h] | Number | 64 | The height of the sample space. |\n| [config.x] | Number | 0 | The offset from \"world\" center (used by multisampler). |\n| [config.y] | Number | 0 | The offset from world center. |\n| [config.r] | Number | 10 | The minimum radius between points. |\n\n\n\n### poissonDiscSampler.getPoints() ⇒ Array\nGet all sample points from sampler.\n\n**Kind**: instance method of [PoissonDiscSampler](#PoissonDiscSampler) \n**Returns**: Array - An array of points. \n\n\n### poissonDiscSampler.getNewPoints(The) ⇒ Array\nGet new sample points from sampler.\n\n**Kind**: instance method of [PoissonDiscSampler](#PoissonDiscSampler) \n**Returns**: Array - An array of points. \n\n| Param | Type | Description |\n| --- | --- | --- |\n| The | Number | number of new points desired. |\n\n\n\n### poissonDiscSampler.run()\nRuns the sampler.\n\n**Kind**: instance method of [PoissonDiscSampler](#PoissonDiscSampler) \n\n\n### poissonDiscSampler.remove(x, y)\nRemove a sample from the grid.\nIt will be replaced with new one the next time get points is called.\n\n**Kind**: instance method of [PoissonDiscSampler](#PoissonDiscSampler) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| x | Number | The x coord. |\n| y | Number | The y coord. |\n\n\n\n### poissonDiscSampler.prePopulate(points)\nPre-populate the sampler with points.\n\n**Kind**: instance method of [PoissonDiscSampler](#PoissonDiscSampler) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| points | Array | The points to add to the sampler. |\n\n","readmeFilename":"README.md","homepage":"https://github.com/vantreeseba/poisson-sampler#readme","repository":{"type":"git","url":"git+https://github.com/vantreeseba/poisson-sampler.git"},"bugs":{"url":"https://github.com/vantreeseba/poisson-sampler/issues"}}