@deck.gl/aggregation-layers 8.10.0-alpha.7 → 9.0.0-alpha.3

package/src/screen-grid-layer/screen-grid-layer.ts

@@ -31,17 +31,17 @@ import {
   UpdateParameters,
   DefaultProps
 } from '@deck.gl/core';
-import GL from '@luma.gl/constants';
-import type {Texture2D} from '@luma.gl/core';
+import type {Buffer, Texture} from '@luma.gl/core';
+import {GL} from '@luma.gl/constants';
 import GPUGridAggregator from '../utils/gpu-grid-aggregation/gpu-grid-aggregator';
 import {AGGREGATION_OPERATION, getValueFunc} from '../utils/aggregation-operation-utils';
 import ScreenGridCellLayer from './screen-grid-cell-layer';
 import GridAggregationLayer, {GridAggregationLayerProps} from '../grid-aggregation-layer';
-import {getFloatTexture} from '../utils/resource-utils.js';
+import {getFloatTexture} from '../utils/resource-utils';
 
 const defaultProps: DefaultProps<ScreenGridLayerProps> = {
-  ...ScreenGridCellLayer.defaultProps,
-  getPosition: {type: 'accessor', value: d => d.position},
+  ...(ScreenGridCellLayer.defaultProps as DefaultProps<ScreenGridLayerProps<unknown>>),
+  getPosition: {type: 'accessor', value: (d: any) => d.position},
   getWeight: {type: 'accessor', value: 1},
 
   gpuAggregation: true,
@@ -60,7 +60,7 @@ const DIMENSIONS = {
 };
 
 /** All properties supported by ScreenGridLayer. */
-export type ScreenGridLayerProps<DataT = any> = _ScreenGridLayerProps<DataT> &
+export type ScreenGridLayerProps<DataT = unknown> = _ScreenGridLayerProps<DataT> &
   GridAggregationLayerProps<DataT>;
 
 /** Properties added by ScreenGridLayer. */
@@ -151,12 +151,13 @@ export default class ScreenGridLayer<
     gpuGridAggregator?: any;
     gpuAggregation?: any;
     weights?: any;
-    maxTexture?: Texture2D;
+    maxTexture?: Texture;
+    aggregationBuffer?: Buffer;
+    maxBuffer?: Buffer;
   };
 
   initializeState() {
-    const {gl} = this.context;
-    if (!ScreenGridCellLayer.isSupported(gl)) {
+    if (!ScreenGridCellLayer.isSupported(this.context.device)) {
       // max aggregated value is sampled from a float texture
       this.setState({supported: false});
       log.error(`ScreenGridLayer: ${this.id} is not supported on this browser`)();
@@ -172,7 +173,7 @@ export default class ScreenGridLayer<
         size: 1,
         operation: AGGREGATION_OPERATION.SUM,
         needMax: true,
-        maxTexture: getFloatTexture(gl, {id: `${this.id}-max-texture`})
+        maxTexture: getFloatTexture(this.context.device, {id: `${this.id}-max-texture`})
       }
     };
     this.setState({
@@ -276,7 +277,7 @@ export default class ScreenGridLayer<
     const {viewportChanged} = opts.changeFlags;
     let gpuAggregation = opts.props.gpuAggregation;
     if (this.state.gpuAggregation !== opts.props.gpuAggregation) {
-      if (gpuAggregation && !GPUGridAggregator.isSupported(this.context.gl)) {
+      if (gpuAggregation && !GPUGridAggregator.isSupported(this.context.device)) {
         log.warn('GPU Grid Aggregation not supported, falling back to CPU')();
         gpuAggregation = false;
       }

package/src/utils/{aggregation-operation-utils.js → aggregation-operation-utils.ts}

@@ -91,7 +91,13 @@ export function getValueFunc(aggregation, accessor, context) {
   }
 }
 
-function wrapAccessor(accessor, context = {}) {
+type AccessorContext = {
+  data?;
+  index?: number;
+  indices?: number[];
+};
+
+function wrapAccessor(accessor, context: AccessorContext = {}) {
   if (Number.isFinite(accessor)) {
     return accessor;
   }
@@ -101,7 +107,7 @@ function wrapAccessor(accessor, context = {}) {
   };
 }
 
-export function wrapGetValueFunc(getValue, context = {}) {
+export function wrapGetValueFunc(getValue, context: AccessorContext = {}) {
   return pts => {
     context.indices = pts.map(pt => pt.index);
     return getValue(

package/src/utils/bin-sorter.ts

@@ -59,7 +59,7 @@ export default class BinSorter {
   sortedBins!: AggregatedBin[];
   binMap: Record<number, AggregatedBin>;
 
-  constructor(bins = [], props: Partial<typeof defaultProps> = defaultProps) {
+  constructor(bins: unknown[] = [], props: Partial<typeof defaultProps> = defaultProps) {
     this.aggregatedBins = this.getAggregatedBins(bins, props);
     this._updateMinMaxValues();
     this.binMap = this.getBinMap();

package/src/utils/{cpu-aggregator.js → cpu-aggregator.ts}

@@ -21,7 +21,8 @@ import BinSorter from './bin-sorter';
 import {getScaleFunctionByScaleType} from './scale-utils';
 import {getValueFunc, wrapGetValueFunc} from './aggregation-operation-utils';
 
-function nop() {}
+// @eslint-disable-next-line @typescript-eslint/no-empty-function
+function noop() {}
 
 const dimensionSteps = ['getBins', 'getDomain', 'getScaleFunc'];
 const defaultDimensions = [
@@ -122,27 +123,37 @@ const defaultDimensions = [
 ];
 const defaultGetCellSize = props => props.cellSize;
 export default class CPUAggregator {
-  constructor(opts) {
-    this.state = {
-      layerData: {},
-      dimensions: {
-        // color: {
-        //   getValue: null,
-        //   domain: null,
-        //   sortedBins: null,
-        //   scaleFunc: nop
-        // },
-        // elevation: {
-        //   getValue: null,
-        //   domain: null,
-        //   sortedBins: null,
-        //   scaleFunc: nop
-        // }
-      }
+  state: {
+    layerData: {
+      data?: any[];
     };
-    this.changeFlags = {};
-    this.dimensionUpdaters = {};
+    dimensions: Record<string, any>;
+  } = {
+    layerData: {
+      data: undefined
+    },
+    dimensions: {
+      // color: {
+      //   getValue: null,
+      //   domain: null,
+      //   sortedBins: null,
+      //   scaleFunc: noop
+      // },
+      // elevation: {
+      //   getValue: null,
+      //   domain: null,
+      //   sortedBins: null,
+      //   scaleFunc: noop
+      // }
+    }
+  };
+  changeFlags: Record<string, any> = {};
+  dimensionUpdaters: Record<string, any> = {};
+
+  _getCellSize;
+  _getAggregator;
 
+  constructor(opts) {
     this._getCellSize = opts.getCellSize || defaultGetCellSize;
     this._getAggregator = opts.getAggregator;
     this._addDimension(opts.dimensions || defaultDimensions);
@@ -187,7 +198,7 @@ export default class CPUAggregator {
     });
   }
 
-  normalizeResult(result = {}) {
+  normalizeResult(result: {hexagons?; layerData?} = {}) {
     // support previous hexagonAggregator API
     if (result.hexagons) {
       return {data: result.hexagons, ...result};
@@ -259,7 +270,7 @@ export default class CPUAggregator {
         getValue: null,
         domain: null,
         sortedBins: null,
-        scaleFunc: nop
+        scaleFunc: noop
       };
     });
   }
@@ -269,9 +280,9 @@ export default class CPUAggregator {
       key,
       accessor,
       pickingInfo,
-      getBins: {updater: this.getDimensionSortedBins, ...getBins},
-      getDomain: {updater: this.getDimensionValueDomain, ...getDomain},
-      getScaleFunc: {updater: this.getDimensionScale, ...getScaleFunc},
+      getBins: {updater: this.getDimensionSortedBins.bind(this), ...getBins},
+      getDomain: {updater: this.getDimensionValueDomain.bind(this), ...getDomain},
+      getScaleFunc: {updater: this.getDimensionScale.bind(this), ...getScaleFunc},
       attributeAccessor: this.getSubLayerDimensionAttribute(key, nullValue)
     };
   }
@@ -294,7 +305,7 @@ export default class CPUAggregator {
     //     prop: 'elevationAggregation'
     //   }
     // }
-    return Object.values(dimensionStep.triggers).some(item => {
+    return Object.values(dimensionStep.triggers).some((item: any) => {
       if (item.updateTrigger) {
         // check based on updateTriggers change first
         // if data has changed, always update value
@@ -310,9 +321,9 @@ export default class CPUAggregator {
     });
   }
 
-  getDimensionChanges(oldProps, props, changeFlags) {
+  getDimensionChanges(oldProps: any, props: any, changeFlags: any): Function[] | null {
     // const {dimensionUpdaters} = this.state;
-    const updaters = [];
+    const updaters: Function[] = [];
 
     // get dimension to be updated
     for (const key in this.dimensionUpdaters) {
@@ -351,7 +362,7 @@ export default class CPUAggregator {
 
       dimensionSteps.forEach(step => {
         Object.values(this.dimensionUpdaters[key][step].triggers).forEach(
-          ({prop, updateTrigger}) => {
+          ({prop, updateTrigger}: any) => {
             if (updateTrigger) {
               // if prop is based on updateTrigger e.g. getColorValue, getColorWeight
               // and updateTriggers is passed in from layer prop
@@ -460,6 +471,7 @@ export default class CPUAggregator {
     if (isPicked) {
       // const {sortedColorBins, sortedElevationBins} = this.state;
 
+      // @ts-expect-error
       const cell = this.state.layerData.data[info.index];
 
       const binInfo = {};
@@ -484,7 +496,7 @@ export default class CPUAggregator {
 
   getAccessor(dimensionKey) {
     if (!this.dimensionUpdaters.hasOwnProperty(dimensionKey)) {
-      return nop;
+      return noop;
     }
     return this.dimensionUpdaters[dimensionKey].attributeAccessor;
   }

package/src/utils/gpu-grid-aggregation/{gpu-grid-aggregator-constants.js → gpu-grid-aggregator-constants.ts}

@@ -1,4 +1,4 @@
-import GL from '@luma.gl/constants';
+import {GL} from '@luma.gl/constants';
 import {AGGREGATION_OPERATION} from '../aggregation-operation-utils';
 
 export const DEFAULT_RUN_PARAMS = {
@@ -36,9 +36,9 @@ export const MAX_MIN_TEXTURE_OPTS = {
   type: GL.FLOAT,
   border: 0,
   mipmaps: false,
-  parameters: {
-    [GL.TEXTURE_MAG_FILTER]: GL.NEAREST,
-    [GL.TEXTURE_MIN_FILTER]: GL.NEAREST
+  sampler: {
+    minFilter: 'nearest',
+    magFilter: 'nearest'
   },
   dataFormat: GL.RGBA,
   width: 1,

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

@@ -4,7 +4,7 @@
 
 # Usage (Aggregation in World space)
 ```
-const aggregator = new GPUGridAggregator(gl);
+const aggregator = new GPUGridAggregator(device);
 
 const results = aggregator.run({
   attributes, // position and weight attributes
@@ -29,7 +29,7 @@ const results = aggregator.run({
 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(gl);
+const aggregator = new GPUGridAggregator(device);
 
 const results = aggregator.run({
   attributes, // position and weight attributes
@@ -57,7 +57,7 @@ const results = aggregator.run({
 
 ‘ScreenGridAggregator’ constructor takes following arguments and constructs an object.
 
-* gl (WebGLContext) : used for querying WebGL features and creating required webgl resources.
+* 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.