@deck.gl/aggregation-layers 8.8.0-alpha.6 → 8.8.0-beta.3

package/src/{grid-aggregation-layer.js → grid-aggregation-layer.ts}

@@ -18,18 +18,32 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 // THE SOFTWARE.
 
-import AggregationLayer from './aggregation-layer';
+import AggregationLayer, {AggregationLayerProps} from './aggregation-layer';
 import GPUGridAggregator from './utils/gpu-grid-aggregation/gpu-grid-aggregator';
 import {Buffer} from '@luma.gl/core';
-import {log} from '@deck.gl/core';
+import {LayerContext, log, UpdateParameters} from '@deck.gl/core';
 import GL from '@luma.gl/constants';
 import BinSorter from './utils/bin-sorter';
 import {pointToDensityGridDataCPU} from './cpu-grid-layer/grid-aggregator';
 
-export default class GridAggregationLayer extends AggregationLayer {
-  initializeState({dimensions}) {
+export type GridAggregationLayerProps<DataT = any> = AggregationLayerProps<DataT>;
+
+export default abstract class GridAggregationLayer<
+  ExtraPropsT = {}
+> extends AggregationLayer<ExtraPropsT> {
+  static layerName = 'GridAggregationLayer';
+
+  state!: AggregationLayer['state'] & {
+    aggregationDataDirty?: any;
+    aggregationWeightsDirty?: any;
+    gpuAggregation?: any;
+    getValue?: () => any;
+    sortedBins?: BinSorter;
+  };
+
+  initializeAggregationLayer({dimensions}) {
     const {gl} = this.context;
-    super.initializeState(dimensions);
+    super.initializeAggregationLayer(dimensions);
     this.setState({
       // CPU aggregation results
       layerData: {},
@@ -38,7 +52,7 @@ export default class GridAggregationLayer extends AggregationLayer {
     });
   }
 
-  updateState(opts) {
+  updateState(opts: UpdateParameters<this>) {
     // get current attributes
     super.updateState(opts);
 
@@ -68,16 +82,16 @@ export default class GridAggregationLayer extends AggregationLayer {
     this.setState({aggregationDirty});
   }
 
-  finalizeState() {
+  finalizeState(context: LayerContext) {
     const {count} = this.state.weights;
     if (count && count.aggregationBuffer) {
       count.aggregationBuffer.delete();
     }
     this.state.gpuGridAggregator?.delete();
-    super.finalizeState();
+    super.finalizeState(context);
   }
 
-  updateShaders(shaders) {
+  updateShaders(shaders: any): void {
     if (this.state.gpuAggregation) {
       this.state.gpuGridAggregator.updateShaders(shaders);
     }
@@ -179,10 +193,10 @@ export default class GridAggregationLayer extends AggregationLayer {
     this.setState({sortedBins});
   }
 
-  _uploadAggregationResults() {
+  _uploadAggregationResults(): void {
     const {numCol, numRow} = this.state;
     const {data} = this.state.layerData;
-    const {aggregatedBins, minValue, maxValue, totalCount} = this.state.sortedBins;
+    const {aggregatedBins, minValue, maxValue, totalCount} = this.state.sortedBins!;
 
     const ELEMENTCOUNT = 4;
     const aggregationSize = numCol * numRow * ELEMENTCOUNT;
@@ -200,5 +214,3 @@ export default class GridAggregationLayer extends AggregationLayer {
     this.updateResults({aggregationData, maxMinData, maxData, minData});
   }
 }
-
-GridAggregationLayer.layerName = 'GridAggregationLayer';

package/src/grid-layer/{grid-layer.js → grid-layer.ts}

@@ -1,28 +1,62 @@
-import {CompositeLayer} from '@deck.gl/core';
+import {
+  CompositeLayer,
+  CompositeLayerProps,
+  Layer,
+  UpdateParameters,
+  DefaultProps
+} from '@deck.gl/core';
 import GPUGridAggregator from '../utils/gpu-grid-aggregation/gpu-grid-aggregator';
-import GPUGridLayer from '../gpu-grid-layer/gpu-grid-layer';
-import CPUGridLayer from '../cpu-grid-layer/cpu-grid-layer';
+import GPUGridLayer, {_GPUGridLayerProps} from '../gpu-grid-layer/gpu-grid-layer';
+import CPUGridLayer, {_CPUGridLayerProps} from '../cpu-grid-layer/cpu-grid-layer';
 
-const defaultProps = {
+const defaultProps: DefaultProps<GridLayerProps> = {
   ...GPUGridLayer.defaultProps,
   ...CPUGridLayer.defaultProps,
   gpuAggregation: false
 };
 
-export default class GridLayer extends CompositeLayer {
+/** All properties supported by GridLayer. */
+export type GridLayerProps<DataT = any> = _GridLayerProps<DataT> & CompositeLayerProps<DataT>;
+
+/** Properties added by GridLayer. */
+type _GridLayerProps<DataT> = _CPUGridLayerProps<DataT> &
+  _GPUGridLayerProps<DataT> & {
+    /**
+     * Whether the aggregation should be performed in high-precision 64-bit mode.
+     * @default false
+     */
+    fp64?: boolean;
+
+    /**
+     * When set to true, aggregation is performed on GPU, provided other conditions are met.
+     * @default false
+     */
+    gpuAggregation?: boolean;
+  };
+
+export default class GridLayer<DataT = any, ExtraPropsT = {}> extends CompositeLayer<
+  ExtraPropsT & Required<_GridLayerProps<DataT>>
+> {
+  static layerName = 'GridLayer';
+  static defaultProps = defaultProps;
+
+  state!: CompositeLayer['state'] & {
+    useGPUAggregation: boolean;
+  };
+
   initializeState() {
     this.state = {
       useGPUAggregation: true
     };
   }
 
-  updateState({oldProps, props, changeFlags}) {
-    const newState = {};
-    newState.useGPUAggregation = this.canUseGPUAggregation(props);
-    this.setState(newState);
+  updateState({props}: UpdateParameters<this>) {
+    this.setState({
+      useGPUAggregation: this.canUseGPUAggregation(props)
+    });
   }
 
-  renderLayers() {
+  renderLayers(): Layer {
     const {data, updateTriggers} = this.props;
     const id = this.state.useGPUAggregation ? 'GPU' : 'CPU';
     const LayerType = this.state.useGPUAggregation
@@ -42,7 +76,7 @@ export default class GridLayer extends CompositeLayer {
 
   // Private methods
 
-  canUseGPUAggregation(props) {
+  canUseGPUAggregation(props: GridLayer['props']) {
     const {
       gpuAggregation,
       lowerPercentile,
@@ -73,6 +107,3 @@ export default class GridLayer extends CompositeLayer {
     return true;
   }
 }
-
-GridLayer.layerName = 'GridLayer';
-GridLayer.defaultProps = defaultProps;

package/src/heatmap-layer/{heatmap-layer-utils.js → heatmap-layer-utils.ts}

@@ -1,7 +1,7 @@
 import GL from '@luma.gl/constants';
 import {isWebGL2} from '@luma.gl/core';
 
-export function getBounds(points) {
+export function getBounds(points: number[][]): number[] {
   // Now build bounding box in world space (aligned to world coordiante system)
   const x = points.map(p => p[0]);
   const y = points.map(p => p[1]);
@@ -15,7 +15,7 @@ export function getBounds(points) {
 }
 
 // true if currentBounds contains targetBounds, false otherwise
-export function boundsContain(currentBounds, targetBounds) {
+export function boundsContain(currentBounds: number[], targetBounds: number[]): boolean {
   if (
     targetBounds[0] >= currentBounds[0] &&
     targetBounds[2] <= currentBounds[2] &&
@@ -30,7 +30,7 @@ export function boundsContain(currentBounds, targetBounds) {
 const scratchArray = new Float32Array(12);
 
 // For given rectangle bounds generates two triangles vertices that coverit completely
-export function packVertices(points, dimensions = 2) {
+export function packVertices(points: number[][], dimensions: number = 2): Float32Array {
   let index = 0;
   for (const point of points) {
     for (let i = 0; i < dimensions; i++) {
@@ -41,7 +41,7 @@ export function packVertices(points, dimensions = 2) {
 }
 
 // Expands boundingBox:[xMin, yMin, xMax, yMax] to match aspect ratio of given width and height
-export function scaleToAspectRatio(boundingBox, width, height) {
+export function scaleToAspectRatio(boundingBox: number[], width: number, height: number): number[] {
   const [xMin, yMin, xMax, yMax] = boundingBox;
 
   const currentWidth = xMax - xMin;
@@ -73,7 +73,7 @@ export function scaleToAspectRatio(boundingBox, width, height) {
 }
 
 // Get texture coordiante of point inside a bounding box
-export function getTextureCoordinates(point, bounds) {
+export function getTextureCoordinates(point: number[], bounds: number[]) {
   const [xMin, yMin, xMax, yMax] = bounds;
   return [(point[0] - xMin) / (xMax - xMin), (point[1] - yMin) / (yMax - yMin)];
 }

package/src/heatmap-layer/{heatmap-layer.js → heatmap-layer.ts}

@@ -29,14 +29,28 @@ import {
   getTextureParams
 } from './heatmap-layer-utils';
 import {Buffer, Texture2D, Transform, getParameters, FEATURES, hasFeatures} from '@luma.gl/core';
-import {AttributeManager, COORDINATE_SYSTEM, log} from '@deck.gl/core';
+import {
+  Accessor,
+  AccessorFunction,
+  AttributeManager,
+  ChangeFlags,
+  Color,
+  COORDINATE_SYSTEM,
+  Layer,
+  LayerContext,
+  LayersList,
+  log,
+  Position,
+  UpdateParameters,
+  DefaultProps
+} from '@deck.gl/core';
 import TriangleLayer from './triangle-layer';
-import AggregationLayer from '../aggregation-layer';
+import AggregationLayer, {AggregationLayerProps} from '../aggregation-layer';
 import {defaultColorRange, colorRangeToFlatArray} from '../utils/color-utils';
-import weights_vs from './weights-vs.glsl';
-import weights_fs from './weights-fs.glsl';
-import vs_max from './max-vs.glsl';
-import fs_max from './max-fs.glsl';
+import weightsVs from './weights-vs.glsl';
+import weightsFs from './weights-fs.glsl';
+import vsMax from './max-vs.glsl';
+import fsMax from './max-fs.glsl';
 
 const RESOLUTION = 2; // (number of common space pixels) / (number texels)
 const TEXTURE_OPTIONS = {
@@ -55,7 +69,7 @@ const AGGREGATION_MODE = {
   MEAN: 1
 };
 
-const defaultProps = {
+const defaultProps: DefaultProps<HeatmapLayerProps> = {
   getPosition: {type: 'accessor', value: x => x.position},
   getWeight: {type: 'accessor', value: 1},
   intensity: {type: 'number', min: 0, value: 1},
@@ -85,7 +99,104 @@ const DIMENSIONS = {
   }
 };
 
-export default class HeatmapLayer extends AggregationLayer {
+export type HeatmapLayerProps<DataT = any> = _HeatmapLayerProps<DataT> &
+  AggregationLayerProps<DataT>;
+
+type _HeatmapLayerProps<DataT> = {
+  /**
+   * Radius of the circle in pixels, to which the weight of an object is distributed.
+   *
+   * @default 30
+   */
+  radiusPixels?: number;
+
+  /**
+   * Specified as an array of colors [color1, color2, ...].
+   *
+   * @default `6-class YlOrRd` - [colorbrewer](http://colorbrewer2.org/#type=sequential&scheme=YlOrRd&n=6)
+   */
+  colorRange?: Color[];
+
+  /**
+   * Value that is multiplied with the total weight at a pixel to obtain the final weight.
+   *
+   * @default 1
+   */
+  intensity?: number;
+
+  /**
+   * Ratio of the fading weight to the max weight, between `0` and `1`.
+   *
+   * For example, `0.1` affects all pixels with weight under 10% of the max.
+   *
+   * Ignored when `colorDomain` is specified.
+   * @default 0.05
+   */
+  threshold?: number;
+
+  /**
+   * Controls how weight values are mapped to the `colorRange`, as an array of two numbers [`minValue`, `maxValue`].
+   *
+   * @default null
+   */
+  colorDomain?: [number, number] | null;
+
+  /**
+   * Defines the type of aggregation operation
+   *
+   * V valid values are 'SUM', 'MEAN'.
+   *
+   * @default 'SUM'
+   */
+  aggregation?: 'SUM' | 'MEAN';
+
+  /**
+   * Specifies the size of weight texture.
+   * @default 2048
+   */
+  weightsTextureSize?: number;
+
+  /**
+   * Interval in milliseconds during which changes to the viewport don't trigger aggregation.
+   *
+   * @default 500
+   */
+  debounceTimeout?: number;
+
+  /**
+   * Method called to retrieve the position of each object.
+   *
+   * @default d => d.position
+   */
+  getPosition?: AccessorFunction<DataT, Position>;
+
+  /**
+   * The weight of each object.
+   *
+   * @default 1
+   */
+  getWeight?: Accessor<DataT, number>;
+};
+
+export default class HeatmapLayer<DataT = any, ExtraPropsT = {}> extends AggregationLayer<
+  ExtraPropsT & Required<_HeatmapLayerProps<DataT>>
+> {
+  static layerName = 'HeatmapLayer';
+  static defaultProps = defaultProps;
+
+  state!: AggregationLayer['state'] & {
+    supported: boolean;
+    colorDomain?: number[];
+    isWeightMapDirty?: boolean;
+    weightsTexture?: Texture2D;
+    zoom?: number;
+    worldBounds?: number[];
+    normalizedCommonBounds?: number[];
+    updateTimer?: any;
+    triPositionBuffer?: Buffer;
+    triTexCoordBuffer?: Buffer;
+  };
+
   initializeState() {
     const {gl} = this.context;
     if (!hasFeatures(gl, REQUIRED_FEATURES)) {
@@ -93,20 +204,20 @@ export default class HeatmapLayer extends AggregationLayer {
       log.error(`HeatmapLayer: ${this.id} is not supported on this browser`)();
       return;
     }
-    super.initializeState(DIMENSIONS);
+    super.initializeAggregationLayer(DIMENSIONS);
     this.setState({supported: true, colorDomain: DEFAULT_COLOR_DOMAIN});
     this._setupTextureParams();
     this._setupAttributes();
     this._setupResources();
   }
 
-  shouldUpdateState({changeFlags}) {
+  shouldUpdateState({changeFlags}: UpdateParameters<this>) {
     // Need to be updated when viewport changes
     return changeFlags.somethingChanged;
   }
 
   /* eslint-disable max-statements,complexity */
-  updateState(opts) {
+  updateState(opts: UpdateParameters<this>) {
     if (!this.state.supported) {
       return;
     }
@@ -114,7 +225,7 @@ export default class HeatmapLayer extends AggregationLayer {
     this._updateHeatmapState(opts);
   }
 
-  _updateHeatmapState(opts) {
+  _updateHeatmapState(opts: UpdateParameters<this>) {
     const {props, oldProps} = opts;
     const changeFlags = this._getChangeFlags(opts);
 
@@ -144,7 +255,7 @@ export default class HeatmapLayer extends AggregationLayer {
     this.setState({zoom: opts.context.viewport.zoom});
   }
 
-  renderLayers() {
+  renderLayers(): LayersList | Layer {
     if (!this.state.supported) {
       return [];
     }
@@ -187,8 +298,8 @@ export default class HeatmapLayer extends AggregationLayer {
     );
   }
 
-  finalizeState() {
-    super.finalizeState();
+  finalizeState(context: LayerContext) {
+    super.finalizeState(context);
     const {
       weightsTransform,
       weightsTexture,
@@ -221,8 +332,11 @@ export default class HeatmapLayer extends AggregationLayer {
     });
   }
 
-  _getChangeFlags(opts) {
-    const changeFlags = {};
+  _getChangeFlags(opts: UpdateParameters<this>) {
+    const changeFlags: Partial<ChangeFlags> & {
+      boundsChanged?: boolean;
+      viewportZoomChanged?: boolean;
+    } = {};
     const {dimensions} = this.state;
     changeFlags.dataChanged =
       this.isAttributeChanged() || // if any attribute is changed
@@ -257,7 +371,7 @@ export default class HeatmapLayer extends AggregationLayer {
   }
 
   _setupAttributes() {
-    const attributeManager = this.getAttributeManager();
+    const attributeManager = this.getAttributeManager()!;
     attributeManager.add({
       positions: {size: 3, type: GL.DOUBLE, accessor: 'getPosition'},
       weights: {size: 1, accessor: 'getWeight'}
@@ -285,12 +399,12 @@ export default class HeatmapLayer extends AggregationLayer {
     return super.getShaders(
       type === 'max-weights-transform'
         ? {
-            vs: vs_max,
-            _fs: fs_max
+            vs: vsMax,
+            _fs: fsMax
           }
         : {
-            vs: weights_vs,
-            _fs: weights_fs
+            vs: weightsVs,
+            _fs: weightsFs
           }
     );
   }
@@ -366,7 +480,7 @@ export default class HeatmapLayer extends AggregationLayer {
   }
 
   // Computes world bounds area that needs to be processed for generate heatmap
-  _updateBounds(forceUpdate = false) {
+  _updateBounds(forceUpdate: any = false): boolean {
     const {viewport} = this.context;
 
     // Unproject all 4 corners of the current screen coordinates into world coordinates (lng/lat)
@@ -381,7 +495,7 @@ export default class HeatmapLayer extends AggregationLayer {
     // #1: get world bounds for current viewport extends
     const visibleWorldBounds = getBounds(viewportCorners); // TODO: Change to visible bounds
 
-    const newState = {visibleWorldBounds, viewportCorners};
+    const newState: Partial<HeatmapLayer['state']> = {visibleWorldBounds, viewportCorners};
     let boundsChanged = false;
 
     if (
@@ -426,7 +540,7 @@ export default class HeatmapLayer extends AggregationLayer {
     triPositionBuffer.subData(packVertices(viewportCorners, 3));
 
     const textureBounds = viewportCorners.map(p =>
-      getTextureCoordinates(viewport.projectPosition(p), normalizedCommonBounds)
+      getTextureCoordinates(viewport.projectPosition(p), normalizedCommonBounds!)
     );
     triTexCoordBuffer.subData(packVertices(textureBounds, 2));
   }
@@ -434,7 +548,7 @@ export default class HeatmapLayer extends AggregationLayer {
   _updateColorTexture(opts) {
     const {colorRange} = opts.props;
     let {colorTexture} = this.state;
-    const colors = colorRangeToFlatArray(colorRange, false, Uint8Array);
+    const colors = colorRangeToFlatArray(colorRange, false, Uint8Array as any);
 
     if (colorTexture) {
       colorTexture.setImageData({
@@ -527,7 +641,7 @@ export default class HeatmapLayer extends AggregationLayer {
   // input: worldBounds: [minLong, minLat, maxLong, maxLat]
   // input: opts.useLayerCoordinateSystem : layers coordiante system is used
   // optput: commonBounds: [minX, minY, maxX, maxY] scaled to fit the current texture
-  _worldToCommonBounds(worldBounds, opts = {}) {
+  _worldToCommonBounds(worldBounds, opts: {useLayerCoordinateSystem?: boolean} = {}) {
     const {useLayerCoordinateSystem = false} = opts;
     const [minLong, minLat, maxLong, maxLat] = worldBounds;
     const {viewport} = this.context;
@@ -578,6 +692,3 @@ export default class HeatmapLayer extends AggregationLayer {
     return bottomLeftWorld.slice(0, 2).concat(topRightWorld.slice(0, 2));
   }
 }
-
-HeatmapLayer.layerName = 'HeatmapLayer';
-HeatmapLayer.defaultProps = defaultProps;

package/src/heatmap-layer/{triangle-layer.js → triangle-layer.ts}

@@ -19,19 +19,31 @@
 // THE SOFTWARE.
 
 import GL from '@luma.gl/constants';
-import {Model, Geometry} from '@luma.gl/core';
-import {Layer, project32} from '@deck.gl/core';
+import {Model, Geometry, Texture2D} from '@luma.gl/core';
+import {Layer, LayerContext, project32} from '@deck.gl/core';
 import vs from './triangle-layer-vertex.glsl';
 import fs from './triangle-layer-fragment.glsl';
 
-export default class TriangleLayer extends Layer {
+type _TriangleLayerProps = {
+  colorDomain: number[];
+  aggregationMode: string;
+  threshold: number;
+  intensity: number;
+  vertexCount: number;
+  colorTexture: Texture2D;
+  maxTexture: Texture2D;
+  texture: Texture2D;
+};
+
+export default class TriangleLayer extends Layer<_TriangleLayerProps> {
+  static layerName = 'TriangleLayer';
+
   getShaders() {
     return {vs, fs, modules: [project32]};
   }
 
-  initializeState() {
-    const {gl} = this.context;
-    const attributeManager = this.getAttributeManager();
+  initializeState({gl}: LayerContext): void {
+    const attributeManager = this.getAttributeManager()!;
     attributeManager.add({
       positions: {size: 3, noAlloc: true},
       texCoords: {size: 2, noAlloc: true}
@@ -41,7 +53,7 @@ export default class TriangleLayer extends Layer {
     });
   }
 
-  _getModel(gl) {
+  _getModel(gl: WebGLRenderingContext): Model {
     const {vertexCount} = this.props;
 
     return new Model(gl, {
@@ -54,7 +66,7 @@ export default class TriangleLayer extends Layer {
     });
   }
 
-  draw({uniforms}) {
+  draw({uniforms}): void {
     const {model} = this.state;
 
     const {texture, maxTexture, colorTexture, intensity, threshold, aggregationMode, colorDomain} =
@@ -74,5 +86,3 @@ export default class TriangleLayer extends Layer {
       .draw();
   }
 }
-
-TriangleLayer.layerName = 'TriangleLayer';