fix(react-components): Fixes bug where ground plane scale is stored a…

…s xz instead of xy (#4743) * Fixes bug where ground plane scale is stored as xz instead of xy
cognitedata · Sep 6, 2024 · f860ce1 · f860ce1
1 parent c054f6b
commit f860ce1
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 3 deletions.
diff --git a/react-components/src/components/SceneContainer/sceneTypes.ts b/react-components/src/components/SceneContainer/sceneTypes.ts
@@ -23,6 +23,7 @@ export type SceneConfiguration = {
   cameraTargetX?: number;
   cameraTargetY?: number;
   cameraTargetZ?: number;
+  updatedAt?: string;
 };
 
 export type CadOrPointCloudModel = Transformation3d & {

diff --git a/react-components/src/hooks/scenes/types.ts b/react-components/src/hooks/scenes/types.ts
@@ -32,6 +32,7 @@ export type SceneConfigurationProperties = {
   cameraTargetX?: number;
   cameraTargetY?: number;
   cameraTargetZ?: number;
+  updatedAt?: string;
 };
 
 export type SkyboxProperties = {
@@ -137,7 +138,8 @@ export const sceneSourceWithProperties = [
       'cameraEulerRotationZ',
       'cameraTargetX',
       'cameraTargetY',
-      'cameraTargetZ'
+      'cameraTargetZ',
+      'updatedAt'
     ]
   }
 ] as const satisfies SourceSelectorV3;

diff --git a/react-components/src/hooks/scenes/useSceneConfig.ts b/react-components/src/hooks/scenes/useSceneConfig.ts
@@ -102,7 +102,8 @@ export const useSceneConfig = (
           cameraEulerRotationZ: sceneConfigurationProperties.cameraEulerRotationZ,
           cameraTargetX: sceneConfigurationProperties.cameraTargetX,
           cameraTargetY: sceneConfigurationProperties.cameraTargetY,
-          cameraTargetZ: sceneConfigurationProperties.cameraTargetZ
+          cameraTargetZ: sceneConfigurationProperties.cameraTargetZ,
+          updatedAt: sceneConfigurationProperties.updatedAt
         },
         skybox: getSkybox(sceneResponse),
         groundPlanes: getGroundPlanes(sceneResponse),

diff --git a/react-components/src/hooks/useGroundPlaneFromScene.tsx b/react-components/src/hooks/useGroundPlaneFromScene.tsx
@@ -75,15 +75,28 @@ export const useGroundPlaneFromScene = (sceneExternalId: string, sceneSpaceId: s
     ) {
       return;
     }
+    const groundPlaneScaleFactor = 10000;
     const groundMeshes: CustomObject[] = [];
 
+    // New scale format was introduced as a bug in the Scenebuilder
+    // on August 1st, 2024. This is a temporary fix to handle both formats.
+    // This should be removed when we upgrade the Scene Data Model to a new version
+    const useNewScaleFormat = groundPlaneUsesNewScaleFormat(scene.sceneConfiguration.updatedAt);
+
     scene.groundPlanes.forEach((groundPlane, index) => {
       if (groundPlaneTextures?.[index] === undefined) {
         return;
       }
       const texture = groundPlaneTextures[index];
       const material = new MeshBasicMaterial({ map: texture, side: DoubleSide });
-      const geometry = new PlaneGeometry(10000 * groundPlane.scaleX, 10000 * groundPlane.scaleY);
+
+      const scaleX = groundPlane.scaleX;
+      const scaleY = useNewScaleFormat ? groundPlane.scaleZ : groundPlane.scaleY;
+
+      const geometry = new PlaneGeometry(
+        groundPlaneScaleFactor * scaleX,
+        groundPlaneScaleFactor * scaleY
+      );
 
       geometry.name = `CogniteGroundPlane`;
 
@@ -121,4 +134,16 @@ export const useGroundPlaneFromScene = (sceneExternalId: string, sceneSpaceId: s
       clear(groundMeshes);
     };
   }, [groundPlaneTextures]);
+
+  function groundPlaneUsesNewScaleFormat(lastUpdatedAt: string | undefined): boolean {
+    if (lastUpdatedAt === undefined) {
+      return false;
+    }
+
+    const dateModified = new Date(lastUpdatedAt);
+
+    const groundPlaneScaleFormatChangedDate = new Date('2024-08-01T10:44:00.000Z');
+
+    return dateModified > groundPlaneScaleFormatChangedDate;
+  }
 };