@deck.gl/aggregation-layers 9.0.40 → 9.1.0-beta.3

package/src/utils/gpu-grid-aggregation/aggregate-to-grid-vs.glsl.ts

@@ -1,79 +0,0 @@
-// Copyright (c) 2015 - 2018 Uber Technologies, Inc.
-//
-// Permission is hereby granted, free of charge, to any person obtaining a copy
-// of this software and associated documentation files (the "Software"), to deal
-// in the Software without restriction, including without limitation the rights
-// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-// copies of the Software, and to permit persons to whom the Software is
-// furnished to do so, subject to the following conditions:
-//
-// The above copyright notice and this permission notice shall be included in
-// all copies or substantial portions of the Software.
-//
-// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-// THE SOFTWARE.
-
-export default `\
-#version 300 es
-#define SHADER_NAME gpu-aggregation-to-grid-vs
-
-in vec3 positions;
-in vec3 positions64Low;
-in vec3 weights;
-uniform vec2 cellSize;
-uniform vec2 gridSize;
-uniform bool projectPoints;
-uniform vec2 translation;
-uniform vec3 scaling;
-
-out vec3 vWeights;
-
-vec2 project_to_pixel(vec4 pos) {
-  vec4 result;
-  pos.xy = pos.xy/pos.w;
-  result = pos + vec4(translation, 0., 0.);
-  result.xy = scaling.z > 0. ? result.xy * scaling.xy : result.xy;
-  return result.xy;
-}
-
-void main(void) {
-
-  vWeights = weights;
-
-  vec4 windowPos = vec4(positions, 1.);
-  if (projectPoints) {
-    windowPos = project_position_to_clipspace(positions, positions64Low, vec3(0));
-  }
-
-  vec2 pos = project_to_pixel(windowPos);
-
-  vec2 pixelXY64[2];
-  pixelXY64[0] = vec2(pos.x, 0.);
-  pixelXY64[1] = vec2(pos.y, 0.);
-
-  // Transform (0,0):windowSize -> (0, 0): gridSize
-  vec2 gridXY64[2];
-  gridXY64[0] = div_fp64(pixelXY64[0], vec2(cellSize.x, 0));
-  gridXY64[1] = div_fp64(pixelXY64[1], vec2(cellSize.y, 0));
-  float x = floor(gridXY64[0].x);
-  float y = floor(gridXY64[1].x);
-  pos = vec2(x, y);
-
-  // Transform (0,0):gridSize -> (-1, -1):(1,1)
-  pos = (pos * (2., 2.) / (gridSize)) - (1., 1.);
-
-  // Move to pixel center, pixel-size in screen sapce (2/gridSize) * 0.5 => 1/gridSize
-  vec2 offset = 1.0 / gridSize;
-  pos = pos + offset;
-
-  gl_Position = vec4(pos, 0.0, 1.0);
-
-  // Enforce default value for ANGLE issue (https://bugs.chromium.org/p/angleproject/issues/detail?id=3941)
-  gl_PointSize = 1.0;
-}
-`;

package/src/utils/gpu-grid-aggregation/gpu-grid-aggregator-constants.ts

@@ -1,46 +0,0 @@
-import {GL} from '@luma.gl/constants';
-import {AGGREGATION_OPERATION} from '../aggregation-operation-utils';
-
-export const DEFAULT_RUN_PARAMS = {
-  projectPoints: false,
-  viewport: null,
-  createBufferObjects: true,
-  moduleSettings: {}
-};
-
-export const MAX_32_BIT_FLOAT = 3.402823466e38;
-export const MIN_BLEND_EQUATION = [GL.MIN, GL.FUNC_ADD];
-export const MAX_BLEND_EQUATION = [GL.MAX, GL.FUNC_ADD];
-export const MAX_MIN_BLEND_EQUATION = [GL.MAX, GL.MIN];
-export const EQUATION_MAP = {
-  [AGGREGATION_OPERATION.SUM]: GL.FUNC_ADD,
-  [AGGREGATION_OPERATION.MEAN]: GL.FUNC_ADD,
-  [AGGREGATION_OPERATION.MIN]: MIN_BLEND_EQUATION,
-  [AGGREGATION_OPERATION.MAX]: MAX_BLEND_EQUATION
-};
-
-export const ELEMENTCOUNT = 4;
-export const DEFAULT_WEIGHT_PARAMS = {
-  size: 1,
-  operation: AGGREGATION_OPERATION.SUM,
-  needMin: false,
-  needMax: false,
-  combineMaxMin: false
-};
-
-export const PIXEL_SIZE = 4; // RGBA32F
-export const WEIGHT_SIZE = 3;
-
-export const MAX_MIN_TEXTURE_OPTS = {
-  format: GL.RGBA32F,
-  type: GL.FLOAT,
-  border: 0,
-  mipmaps: false,
-  sampler: {
-    minFilter: 'nearest',
-    magFilter: 'nearest'
-  },
-  dataFormat: GL.RGBA,
-  width: 1,
-  height: 1
-};

package/src/utils/gpu-grid-aggregation/gpu-grid-aggregator.md

@@ -1,155 +0,0 @@
-# GPUGridAggregator Class (Advanced) (WebGL2)
-
-`GPUGridAggregator` performs grid aggregation on GPU. Aggregation can be performed either in world space or in screen space.
-
-# Usage (Aggregation in World space)
-```
-const aggregator = new GPUGridAggregator(device);
-
-const results = aggregator.run({
-  attributes, // position and weight attributes
-  weights: {
-    weight1: {
-      operation: AGGREGATION_OPERATION.MEAN,
-      needMax: true,
-    }
-  },
-  cellSize: [50, 50],
-  width: 500,
-  height: 500
-});
-
-// results.weight1.aggregationBuffer contains, one aggregated value for each grid cell, which is equal to mean weight of all sample points that fall into that grid cell.  
-// results.weight1.maxBuffer contains max mean value of all grid cells.
-
-```
-
-# Usage (Aggregation in Screen space)
-
-You can also perform aggregation in screen space by provide a viewport and set `projectPoints` to true. Aggregator will first project positions and then aggregate them in screen space.
-
-```
-const aggregator = new GPUGridAggregator(device);
-
-const results = aggregator.run({
-  attributes, // position and weight attributes
-  weights: {
-    weight1: {
-      operation: AGGREGATION_OPERATION.MEAN,
-      needMax: true,
-    }
-  },
-  cellSize: [50, 50],
-  width: 500,
-  height: 500,
-  viewport,
-  projectPoints: true
-});
-
-// results.weight1.aggregationBuffer contains, one aggregated value for each grid cell, which is equal to mean weight of all sample points that fall into that grid cell.  
-// results.weight1.maxBuffer contains max mean value of all grid cells.
-
-```
-
-## Methods
-
-### constructor
-
-‘ScreenGridAggregator’ constructor takes following arguments and constructs an object.
-
-* device (WebGLContext) : used for querying WebGL features and creating required webgl resources.
-* opts (Object) : Optionally contains and ‘id’ and ‘sahderCache’ object for caching/re-using shaders.
-
-
-### run
-
-Performs aggregation either on CPU or GPU based on the provided options and browser’s WebGL capabilities.
-
-```js
-const results = gpuGridAggregator.run({
-  positions,
-  weights,
-  cellSize: [5, 5],
-  viewport,
-  changeFlags,
-  projectPoints: true,
-  translation,
-  scaling
-});
-```
-
-Parameters:
-* positions (Array) : Array of points in world space (lng, lat).
-* weights  (Object) : Object contains one or more weights. Key represents id and corresponding object represents the weight. Each weight object contains following values:
-
-  * `values` (Array, Float32Array or Buffer) : Contains weight values for all points, there should be 3 floats for each point, un-used values can be 0.
-  * `size` (Number, default: 1, minValue: 1, maxValue: 3) : Size of a single weight instance. Determines how many distinct weights exist in the array.
-  * `operation` (Enum {SUM, MEAN, MIN or MAX}, default: SUM) : Defines aggregation operation.
-  * `needMin` (Boolean, default: false) : when true additional aggregation steps are performed to calculate minimum of all aggregation values and total count, result object will contain minBuffer.
-  * `needMax` (Boolean, default: false) : when true additional aggregation steps are performed to calculate maximum of all aggregation values and total count, result object will contain maxBuffer.
-  * `combineMaxMin` (Boolean, default: false) : Applicable only when `needMin` and `needMax` are set. When true, both min and max values are calculated in single aggregation step using `blendEquationSeparate` WebGL API. But since Alpha channel can only contain one float, it will only provide minimum value for first weight in Alpha channel and RGB channels store maximum value up to 3 weights. Also when selected total count is not available. Result object will contain maxMinBuffer.
-
-* cellSize: (Array) : Size of the cell, cellSize[0] is width and cellSize[1] is height.
-* width: (Number, Optional) : Grid width in pixels, deduced from ‘viewport’ when not provided.
-* height: (Number, Optional) : Grid height in pixels, deduced from ‘viewport’ when not provided.
-* viewport: (Object, Viewport) : Contains size of viewport and also used to perform projection.
-* changeFlags: (Object, Optional) : Object with following keyed values, that determine whether to re-create internal WebGL resources for performing aggregation compared to last run. If no value is provided, all flags are treated to be true.
-	* dataChanged (Bool) : should be set to true when data is changed.
-	* viewportChanged (Bool) : should be set to true when viewport is changed.
-	* cellSizeChagned (Bool) : should be set to true when cellSize is changed.
-* countsBuffer: (Buffer, optional) : used to update aggregation data per grid, details in Output section.
-* maxCountBuffer: (Buffer, optional) : used to update total aggregation data, details in Output section.
-* projectPoints (Bool) : when true performs aggregation in screen space.
-* translation (Array) : [xOffset, yOffset], used to translate input positions before aggregating them (for example, lng/lat can be moved to +ve range).
-* scaling (Array) : [xScale, yScale, isScalingValid] : `xScale`, `yScale` define scaling to be applied before aggregating. Scaling is applied only when `isScalingValie` is > 0.
-* createBufferObjects (Bool, options, default: true) : Only applicable when aggregation is performed on CPU. When set to false, aggregated data is not uploaded into Buffer objects. In a typical use case, Applications need data in `Buffer` objects to use them in next rendering cycle, hence by default its value is true, but if needed this step can be avoided by setting this flag to false.
-
-NOTE: When doing screen space aggregation, i.e projectPoints is true, `translation` and `scaling` should be set to transformation required for camera space (NDC) to screen (pixel) space.
-
-Returns:
-* An object, where key represents `id` of the weight and value contains following aggregated data.
-
-  * `aggregationBuffer` (Buffer) : Aggregated values per grid cell, aggregation is performed as per specified `operation`. Size of the buffer is 4, with R, G and B channel corresponds to aggregated weights. When input `size` is < 3, G or B channels contain undefined values. Alpha channel contains count of points aggregated into this cell. (R: weight#1 G: weight#2 B: weight#3 A: count)
-
-  * `aggregationTexture` (Texture) : When aggregation is performed on GPU, contains above data as form of texture, useful for applications that want to consume the texture instead of buffer. This value is `null` when aggregation is performed on CPU.
-
-  * `minBuffer` (Buffer, optional) : Contains data for one pixel with R, G, B and A channels contain min value of all aggregated grid cells. When aggregation is performed on CPU, `minBuffer` is `null` but `minData` Array is returned with same data. This value is `null` when `needMin` is false. (R: weight#1 min value G: weight#2 min value B: weight#3 min value A: total count)
-
-  * `minTexture` (Texture2D, optional) : Texture2D object (1X1 size with RGBA_FLOAT_32 format) contains same data as `minBuffer`.
-
-  * `maxBuffer` (Buffer, optional) : Contains data for one pixel with R, G, B and A channels contain max value of all aggregated grid cells. When aggregation is performed on CPU, `maxBuffer` is `null` but `maxData` Array is returned with same data. This value is `null` when `needMax` is false. (R: weight#1 max value G: weight#2 max value B: weight#3 max value A: total count)
-
-  * `maxTexture` (Texture2D, optional) : Texture2D object (1X1 size with RGBA_FLOAT_32 format) contains same data as `maxBuffer`.
-
-  * `maxMinBuffer` (Buffer, optional) : Contains data for one pixel, with RGB channels contains max value of all aggregated grid cells and A channel contains minimum value of all aggregated grid cells. When `combineMaxMin` is `false` this value will be `null`. (R: weight#1 max value G: weight#2 max value B: weight#3 max value A: weight#1 min value)
-
-  * `maxMinTexture` (Texture2D, optional) : Texture2D object (1X1 size with RGBA_FLOAT_32 format) contains same data as `maxMinBuffer`.
-
-  NOTES:
-  * `minBuffer`, `maxBuffer` and `maxMinBuffer` are usually consumed by setting them as uniform buffer object or read by the CPU.
-  * Aggregation data per cell,  is always in `Buffer` objects to provide common API irrespective of whether aggregation is performed on CPU or GPU.
-  * Min-max aggregation results is provided in form of `Texture2D` and `Buffer` objects whether aggregation is performed on CPU or GPU.
-  * When aggregation is performed on CPU, min-max  aggregation results are also provided in form of Float32Arrays.
-
-
-### getData
-
-Reads aggregation results from GPU memory (Buffer) to CPU memory (Typed Arrays).
-
-```js
-const aggregationResults = gpuGridAggregator.getData('weightId');
-```
-
-Parameters:
-  * `weightId` (String) : `id` of the weight for which aggregation data is needed.
-
-Returns:
-An object with aggregation results in CPU memory (Typed Arrays). Returned object contains following values :
-  * `aggregationData` : Aggregated data per grid cell.
-    Following additional arrays exist if they were requested when aggregation is performed.
-  * `minData` : Min aggregation results.
-  * `maxData` : Max aggregation results.
-  * `maxMinData` : Combined max min aggregation results.
-
-Note:
-When aggregation is performed on GPU, `getData` performs Buffer read and can potentially an expensive operation due to CPU and GPU sync, in such cases data is also cached to avoid reading from GPU memory for subsequent calls.