fix scene.updateHeight

CHANGES.md

@@ -2,6 +2,10 @@
 
 ### 1.121 - 2024-09-01
 
+##### Fixes :wrench:
+
+- Fixed a performance issue where `Scene.updateHeight` would be called too many times.
+
 #### @cesium/engine
 
 ##### Additions :tada:

packages/engine/Source/Scene/Cesium3DTileset.js

@@ -2715,6 +2715,7 @@ function processUpdateHeight(tileset, tile, frameState) {
       Cartesian3.distance(position, boundingSphere.center) <=
       boundingSphere.radius
     ) {
+      callbackData.invoked = true;
       frameState.afterRender.push(() => {
         // Callback can be removed before it actually invoked at the end of the frame
         if (defined(callbackData.callback)) {

packages/engine/Source/Scene/Scene.js

@@ -3746,7 +3746,17 @@ Scene.prototype.updateHeight = function (
   Check.typeOf.func("callback", callback);
   //>>includeEnd('debug');
 
+  let callbackWrapperCalledForFrameState = -1;
+  let removed = false;
+
   const callbackWrapper = () => {
+    if (
+      removed ||
+      this.frameState.frameNumber <= callbackWrapperCalledForFrameState
+    ) {
+      return;
+    }
+    callbackWrapperCalledForFrameState = this.frameState.frameNumber;
     Cartographic.clone(cartographic, updateHeightScratchCartographic);
 
     const height = this.getHeight(cartographic, heightReference);
@@ -3822,6 +3832,7 @@ Scene.prototype.updateHeight = function (
     tilesetRemoveCallbacks = {};
     removeAddedListener();
     removeRemovedListener();
+    removed = true;
   };
 
   return removeCallback;

packages/engine/Specs/Scene/Model/ModelSpec.js

@@ -2212,6 +2212,7 @@ describe(
     describe("height reference", function () {
       beforeEach(() => {
         scene.globe = new Globe();
+        scene.frameState.frameNumber = 0; // ensure we call updateHeight callbacks
       });
 
       afterEach(() => {