Allow CompositeLayer to filter sub layers during redraw (visgl#5820)

harisbal · May 28, 2021 · e225cd3 · e225cd3
1 parent 9c72708
commit e225cd3
Show file tree

Hide file tree

Showing 4 changed files with 70 additions and 32 deletions.
diff --git a/modules/core/src/lib/composite-layer.js b/modules/core/src/lib/composite-layer.js
@@ -76,6 +76,18 @@ export default class CompositeLayer extends Layer {
     return null;
   }
 
+  /**
+   * Filters sub layers at draw time
+   * @param {Layer} context.layer - sub layer instance
+   * @param {Viewport} context.viewport - the viewport being rendered in
+   * @param {Boolean} context.isPicking - whether it is a picking pass
+   * @param {String} context.pass - the current pass
+   * @return {Boolean} true if the sub layer should be drawn
+   */
+  filterSubLayer(context) {
+    return true;
+  }
+
   // Returns true if sub layer needs to be rendered
   shouldRenderSubLayer(id, data) {
     const {_subLayerProps: overridingProps} = this.props;

diff --git a/modules/core/src/passes/layers-pass.js b/modules/core/src/passes/layers-pass.js
@@ -53,10 +53,15 @@ export default class LayersPass extends Pass {
   _getDrawLayerParams(viewport, {layers, pass, layerFilter, effects, moduleParameters}) {
     const drawLayerParams = [];
     const indexResolver = layerIndexResolver();
+    const drawContext = {
+      viewport,
+      isPicking: pass.startsWith('picking'),
+      renderPass: pass
+    };
     for (let layerIndex = 0; layerIndex < layers.length; layerIndex++) {
       const layer = layers[layerIndex];
       // Check if we should draw layer
-      const shouldDrawLayer = this._shouldDrawLayer(layer, viewport, pass, layerFilter);
+      const shouldDrawLayer = this._shouldDrawLayer(layer, drawContext, layerFilter);
 
       // This is the "logical" index for ordering this layer in the stack
       // used to calculate polygon offsets
@@ -164,23 +169,32 @@ export default class LayersPass extends Pass {
   }
 
   /* Private */
-  _shouldDrawLayer(layer, viewport, pass, layerFilter) {
-    let shouldDrawLayer = this.shouldDrawLayer(layer) && layer.props.visible;
-
-    if (shouldDrawLayer && layerFilter) {
-      shouldDrawLayer = layerFilter({
-        layer,
-        viewport,
-        isPicking: pass.startsWith('picking'),
-        renderPass: pass
-      });
+  _shouldDrawLayer(layer, drawContext, layerFilter) {
+    const shouldDrawLayer = this.shouldDrawLayer(layer) && layer.props.visible;
+
+    if (!shouldDrawLayer) {
+      return false;
     }
-    if (shouldDrawLayer) {
-      // If a layer is drawn, update its viewportChanged flag
-      layer.activateViewport(viewport);
+
+    drawContext.layer = layer;
+
+    if (layerFilter && !layerFilter(drawContext)) {
+      return false;
     }
 
-    return shouldDrawLayer;
+    let parent = layer.parent;
+    while (parent) {
+      if (!parent.filterSubLayer(drawContext)) {
+        return false;
+      }
+      drawContext.layer = parent;
+      parent = parent.parent;
+    }
+
+    // If a layer is drawn, update its viewportChanged flag
+    layer.activateViewport(drawContext.viewport);
+
+    return true;
   }
 
   _getModuleParameters(layer, effects, pass, overrides) {

diff --git a/modules/geo-layers/src/tile-layer/tile-layer.js b/modules/geo-layers/src/tile-layer/tile-layer.js
@@ -214,10 +214,6 @@ export default class TileLayer extends CompositeLayer {
   renderLayers() {
     const {visible} = this.props;
     return this.state.tileset.tiles.map(tile => {
-      // For a tile to be visible:
-      // - parent layer must be visible
-      // - tile must be visible in the current viewport
-      const isVisible = visible && tile.isVisible;
       const highlightedObjectIndex = this.getHighlightedObjectIndex(tile);
       // cache the rendered layer in the tile
       if (!tile.isLoaded) {
@@ -227,24 +223,29 @@ export default class TileLayer extends CompositeLayer {
           ...this.props,
           id: `${this.id}-${tile.x}-${tile.y}-${tile.z}`,
           data: tile.data,
-          visible: isVisible,
+          visible,
           _offset: 0,
-          tile,
-          highlightedObjectIndex
+          tile
         });
-        tile.layers = flatten(layers, Boolean);
+        tile.layers = flatten(layers, Boolean).map(layer =>
+          layer.clone({
+            tile,
+            highlightedObjectIndex
+          })
+        );
       } else if (
         tile.layers[0] &&
-        (tile.layers[0].props.visible !== isVisible ||
-          tile.layers[0].props.highlightedObjectIndex !== highlightedObjectIndex)
+        tile.layers[0].props.highlightedObjectIndex !== highlightedObjectIndex
       ) {
-        tile.layers = tile.layers.map(layer =>
-          layer.clone({visible: isVisible, highlightedObjectIndex})
-        );
+        tile.layers = tile.layers.map(layer => layer.clone({highlightedObjectIndex}));
       }
       return tile.layers;
     });
   }
+
+  filterSubLayer({layer}) {
+    return layer.props.tile.isVisible;
+  }
 }
 
 TileLayer.layerName = 'TileLayer';

diff --git a/test/modules/geo-layers/tile-layer/tile-layer.spec.js b/test/modules/geo-layers/tile-layer/tile-layer.spec.js
@@ -98,7 +98,10 @@ test('TileLayer', async t => {
           t.is(subLayers.length, 2, 'Rendered sublayers');
           t.is(getTileDataCalled, 2, 'Fetched tile data');
           t.ok(layer.isLoaded, 'Layer is loaded');
-          t.ok(subLayers.every(l => l.props.visible), 'Sublayers at z=2 are visible');
+          t.ok(
+            subLayers.every(l => layer.filterSubLayer({layer: l})),
+            'Sublayers at z=2 are visible'
+          );
         }
       }
     },
@@ -109,7 +112,9 @@ test('TileLayer', async t => {
           t.is(subLayers.length, 4, 'Rendered new sublayers');
           t.is(getTileDataCalled, 4, 'Fetched tile data');
           t.ok(
-            subLayers.filter(l => l.props.tile.z === 3).every(l => l.props.visible),
+            subLayers
+              .filter(l => l.props.tile.z === 3)
+              .every(l => layer.filterSubLayer({layer: l})),
             'Sublayers at z=3 are visible'
           );
         }
@@ -122,7 +127,9 @@ test('TileLayer', async t => {
           t.is(subLayers.length, 4, 'Rendered cached sublayers');
           t.is(getTileDataCalled, 4, 'Used cached data');
           t.ok(
-            subLayers.filter(l => l.props.tile.z === 3).every(l => !l.props.visible),
+            subLayers
+              .filter(l => l.props.tile.z === 3)
+              .every(l => !layer.filterSubLayer({layer: l})),
             'Sublayers at z=3 are hidden'
           );
         }
@@ -186,7 +193,11 @@ test('TileLayer#MapView:repeat', async t => {
       },
       onAfterUpdate: ({layer, subLayers}) => {
         if (layer.isLoaded) {
-          t.is(subLayers.filter(l => l.props.visible).length, 4, 'Should contain 4 visible tiles');
+          t.is(
+            subLayers.filter(l => layer.filterSubLayer({layer: l})).length,
+            4,
+            'Should contain 4 visible tiles'
+          );
         }
       }
     }