Add support for realityModelDisplay (#175)

Fix for iTwin/itwin-saved-views-service#598

Author: hnn0003

.changeset/fine-cars-wink.md

@@ -0,0 +1,6 @@
+---
+"@itwin/saved-views-client": patch
+"@itwin/saved-views-react": patch
+---
+
+Add support for realityModelDisplay

package.json

@@ -36,16 +36,5 @@
     "npm-run-all": "^4.1.5",
     "tsx": "^4.15.4",
     "typescript": "^5.5.4"
-  },
-  "resolutions": {
-    "@babel/runtime": "^7.26.10",
-    "@eslint/plugin-kit": "^0.3.3",
-    "@isaacs/brace-expansion@<=5.0.0": ">=5.0.1",
-    "axios": "^1.13.5",
-    "brace-expansion": "^2.0.2",
-    "fast-xml-parser@>=4.3.6 <=5.3.3": ">=5.3.4",
-    "form-data": ">=4.0.4",
-    "lodash@>=4.0.0 <=4.17.22": ">=4.17.23",
-    "qs": ">=6.14.2"
   }
 }

packages/saved-views-client/package.json

@@ -46,7 +46,7 @@
     "happy-dom": "^20.0.0",
     "rimraf": "^6.1.2",
     "typescript": "^5.5.4",
-    "vite": "^6.0.0",
+    "vite": "^6.4.1",
     "vitest": "^4.0.16"
   }
 }

packages/saved-views-client/src/models/savedViews/DisplayStyles.ts

@@ -204,6 +204,7 @@ export interface DisplayStyleSettingsProps {
   backgroundColor?: RgbatColorProps;
   monochromeColor?: RgbatColorProps;
   monochromeMode?: MonochromeMode;
+  // Omit scheduleScript - may cause excessively large JSON.
   renderTimeline?: string;
   /**
    * The point in time reflected by the view, in UNIX seconds. This identifies a point on the timeline of the style's
@@ -218,6 +219,7 @@ export interface DisplayStyleSettingsProps {
   mapImagery?: MapImageryProps;
   // Original name: modelOvr
   modelOverrides?: DisplayStyleModelAppearanceProps[];
+  realityModelDisplay?: DisplayStyleRealityModelDisplayProps[];
   clipStyle?: ClipStyleProps;
   // Original name: planarClipOvr
   planarClipOverrides?: DisplayStylePlanarClipMaskProps[];
@@ -370,16 +372,68 @@ export enum GlobeMode {
   Plane = 1,
 }
 
+/**
+ * Specifies how the sizes of the individual points within a point cloud are computed.
+ *  - "pixel": Each point is an exact number of pixels in diameter, as specified by [[PointCloudDisplaySettings.pixelSize]].
+ *  - "voxel": Each point is the size of a "voxel" in meters, as specified by the [Tile]($frontend) to which the point belongs.
+ */
+export type PointCloudSizeMode = "voxel" | "pixel";
+
+/**
+ * Specifies the shape drawn for each individual point within a point cloud.
+ *  - "round": Each point is drawn as a circle.
+ *  - "square": Each point is drawn as a square.
+ */
+export type PointCloudShape = "square" | "round";
+
+/**
+ * Specifies the Eye-Dome Lighting mode used for a point cloud.
+ *  - "off": EDL is not calculated
+ *  - "on": EDL is calculated using a single pass.
+ *  - "full" EDL is calculated with full algorithm including optional filtering
+ */
+export type PointCloudEDLMode = "off" | "on" | "full";
+
+/** The JSON representation of PointCloudDisplaySettings. */
+export interface PointCloudDisplayProps {
+  sizeMode?: PointCloudSizeMode;
+  voxelScale?: number;
+  minPixelsPerVoxel?: number;
+  maxPixelsPerVoxel?: number;
+  pixelSize?: number;
+  shape?: PointCloudShape;
+  edlMode?: PointCloudEDLMode;
+  edlStrength?: number;
+  edlRadius?: number;
+  edlFilter?: number;
+  edlMixWts1?: number;
+  edlMixWts2?: number;
+  edlMixWts4?: number;
+}
+
+/** The JSON representation of RealityModelDisplaySettings. */
+export interface RealityModelDisplayProps {
+  pointCloud?: PointCloudDisplayProps;
+  overrideColorRatio?: number;
+}
+
+/** A RealityModelDisplayProps applied to a specific model to override its reality model display within the context of a DisplayStyle. */
+export interface DisplayStyleRealityModelDisplayProps extends RealityModelDisplayProps {
+  modelId?: string;
+}
+
 /** JSON representation of a ContextRealityModel. */
 export interface ContextRealityModelProps {
   realityDataSourceKey?: RealityDataSourceKey;
   tilesetUrl: string;
+  // Omit orbitGtBlob - marked as @alpha
   realityDataId?: string;
   name?: string;
   description?: string;
   classifiers?: SpatialClassifierProps[];
   planarClipMask?: PlanarClipMaskProps;
   appearanceOverrides?: FeatureAppearanceProps;
+  displaySettings?: RealityModelDisplayProps;
 }
 
 /** JSON representation of a SpatialClassifier. */

packages/saved-views-react/package.json

@@ -60,7 +60,7 @@
     "react-dom": "^18.0.0",
     "recursive-readdir": "^2.2.3",
     "typescript": "^5.5.4",
-    "vite": "^6.0.0",
+    "vite": "^6.4.1",
     "vitest": "^4.0.16"
   },
   "peerDependencies": {

packages/saved-views-react/src/LayeredDropdownMenu/LayeredDropdownMenu.tsx

@@ -16,7 +16,7 @@ interface LayeredDropdownMenuProps {
   menuItems: ReactElement[] | ((close: () => void) => ReactElement[]);
 
   /** Dropdown menu trigger to pass to iTwinUI `<DropdownMenu />` component. */
-  children: ReactNode;
+  children: React.JSX.Element;
 }
 
 /**
@@ -61,7 +61,7 @@ export function LayeredDropdownMenu(props: LayeredDropdownMenuProps): ReactEleme
   return (
     <layeredDropdownMenuContext.Provider value={{ activeMenuItem, setActiveMenuItem }}>
       <DropdownMenu menuItems={menuItems} onVisibleChange={(visible) => !visible && setActiveMenuItem(undefined)}>
-        {props.children}
+        {props.children as React.JSX.Element}
       </DropdownMenu>
     </layeredDropdownMenuContext.Provider>
   );

packages/saved-views-react/src/captureSavedViewData.ts

@@ -215,7 +215,7 @@ function createSheetSavedViewObject(
     },
     width: viewState.sheetSize.x,
     height: viewState.sheetSize.y,
-    sheetAttachments: viewState.attachmentIds,
+    sheetAttachments: [...viewState.attachmentIds],
     viewDetails: extractViewDetails2dFromLegacy(viewDefinitionProps),
   };
 }

packages/saved-views-react/src/translation/displayStyleExtractor.ts

@@ -164,6 +164,33 @@ const displayStyleModelAppearanceLegacyMappings: ExtractionFunc<void, void>[] =
   extractString("modelId"),
 ];
 
+export const realityModelDisplayMappings: ExtractionFunc<void, void>[] = [
+  extractObject(
+    [
+      extractString("sizeMode"),
+      extractNumber("voxelScale"),
+      extractNumber("minPixelsPerVoxel"),
+      extractNumber("maxPixelsPerVoxel"),
+      extractNumber("pixelSize"),
+      extractString("shape"),
+      extractString("edlMode"),
+      extractNumber("edlStrength"),
+      extractNumber("edlRadius"),
+      extractNumber("edlFilter"),
+      extractNumber("edlMixWts1"),
+      extractNumber("edlMixWts2"),
+      extractNumber("edlMixWts4"),
+    ],
+    "pointCloud",
+  ),
+  extractNumber("overrideColorRatio"),
+];
+
+const displayStyleRealityModelDisplayMappings: ExtractionFunc<void, void>[] = [
+  ...realityModelDisplayMappings,
+  extractString("modelId"),
+];
+
 const contextRealityModelsMappings: ExtractionFunc<void, void>[] = [
   extractObject(
     [
@@ -198,6 +225,7 @@ const contextRealityModelsMappings: ExtractionFunc<void, void>[] = [
   ),
   extractObject(planarClipMaskMappings, "planarClipMask"),
   extractObject(featureAppearanceMappings, "appearanceOverrides"),
+  extractObject(realityModelDisplayMappings, "displaySettings"),
 ];
 
 const contextRealityModelsLegacyMappings: ExtractionFunc<void, void>[] = [
@@ -234,6 +262,7 @@ const contextRealityModelsLegacyMappings: ExtractionFunc<void, void>[] = [
   ),
   extractObject(planarClipMaskMappings, "planarClipMask"),
   extractObject(featureAppearanceLegacyMappings, "appearanceOverrides"),
+  extractObject(realityModelDisplayMappings, "displaySettings"),
 ];
 
 const commonMapLayerPropsMapping: ExtractionFunc<void, void>[] = [
@@ -511,6 +540,7 @@ const displayStylesMapping: ExtractionFunc<void, void>[] = [
     "modelOverrides",
     "modelOvr",
   ),
+  extractArray(displayStyleRealityModelDisplayMappings, "realityModelDisplay"),
   extractObject(clipStyleMappings, "clipStyle"),
   extractArray(
     displayStylePlanarClipMaskMappings,
@@ -536,6 +566,11 @@ const displayStylesLegacyMapping: ExtractionFunc<void, void>[] = [
   extractStringOrArray("excludedElements"),
   extractObject(mapImageryLegacyMapping, "mapImagery"),
   extractArray(displayStyleModelAppearanceLegacyMappings, "modelOvr", "modelOverrides"),
+  extractArrayElementsConditionally(
+    (value) => value && !value.invisible,
+    displayStyleRealityModelDisplayMappings,
+    "realityModelDisplay",
+  ),
   extractObject(clipStyleLegacyMappings, "clipStyle"),
   extractArray(displayStylePlanarClipMaskMappings, "planarClipOvr", "planarClipOverrides"),
 ];

packages/test-app-backend/package.json

@@ -21,6 +21,8 @@
     "@types/dotenv-flow": "^3.2.0",
     "@types/node": "^18.0.0",
     "dotenv-flow": "^3.2.0",
+    "inversify": "^8.1.0",
+    "reflect-metadata": "^0.2.2",
     "tsx": "^4.15.4",
     "typescript": "^5.5.4"
   }

packages/test-app-frontend/package.json

@@ -46,9 +46,9 @@
     "react-redux": "^7.2.2",
     "react-router-dom": "^6.11.2",
     "redux": "^4.1.0",
-    "sass": "^1.64.1",
+    "sass": "^1.98.0",
     "typescript": "^5.5.4",
-    "vite": "^6.0.0",
+    "vite": "^6.4.1",
     "vite-plugin-static-copy": "^2.3.2",
     "vite-tsconfig-paths": "^4.3.1"
   }