feat(widgets): Remove onViewportChange Update Guard for Widgets (#9303

) * remove widget manager viewport optimization
visgl · Dec 19, 2024 · 2374bc7 · 2374bc7
1 parent 05bca74
commit 2374bc7
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 10 deletions.
diff --git a/modules/core/src/lib/widget-manager.ts b/modules/core/src/lib/widget-manager.ts
@@ -242,15 +242,14 @@ export class WidgetManager {
       acc[v.id] = v;
       return acc;
     }, {});
-    const {lastViewports} = this;
 
     for (const widget of this.getWidgets()) {
       const {viewId} = widget;
       if (viewId) {
         // Attached to a specific view
         const viewport = viewportsById[viewId];
         if (viewport) {
-          if (widget.onViewportChange && !viewport.equals(lastViewports[viewId])) {
+          if (widget.onViewportChange) {
             widget.onViewportChange(viewport);
           }
           widget.onRedraw?.({viewports: [viewport], layers});
@@ -259,10 +258,7 @@ export class WidgetManager {
         // Not attached to a specific view
         if (widget.onViewportChange) {
           for (const viewport of viewports) {
-            // eslint-disable-next-line max-depth
-            if (!viewport.equals(lastViewports[viewport.id])) {
-              widget.onViewportChange(viewport);
-            }
+            widget.onViewportChange(viewport);
           }
         }
         widget.onRedraw?.({viewports, layers});

diff --git a/modules/widgets/src/compass-widget.tsx b/modules/widgets/src/compass-widget.tsx
@@ -77,8 +77,11 @@ export class CompassWidget implements Widget<CompassWidgetProps> {
   }
 
   onViewportChange(viewport: Viewport) {
-    this.viewports[viewport.id] = viewport;
-    this.update();
+    // no need to update if viewport is the same
+    if (!viewport.equals(this.viewports[viewport.id])) {
+      this.viewports[viewport.id] = viewport;
+      this.update();
+    }
   }
 
   onAdd({deck}: {deck: Deck<any>}): HTMLDivElement {

diff --git a/test/modules/core/lib/widget-manager.spec.ts b/test/modules/core/lib/widget-manager.spec.ts
@@ -162,7 +162,7 @@ test('WidgetManager#onRedraw#without viewId', t => {
     layers: []
   });
 
-  t.is(onViewportChangeCalledCount, 1, 'widget.onViewportChange not called');
+  t.is(onViewportChangeCalledCount, 2, 'widget.onViewportChange called');
   t.is(onRedrawCalledCount, 2, 'widget.onRedraw called');
 
   widgetManager.onRedraw({
@@ -188,7 +188,7 @@ test('WidgetManager#onRedraw#without viewId', t => {
     ],
     layers: []
   });
-  t.is(onViewportChangeCalledCount, 3, 'widget.onViewportChange called');
+  t.is(onViewportChangeCalledCount, 4, 'widget.onViewportChange called');
   t.is(onRedrawCalledCount, 3, 'widget.onRedraw called');
 
   widgetManager.finalize();