@itwin/saved-views-react 0.9.2 → 0.9.4

package/lib/applySavedView.js

@@ -2,9 +2,75 @@
  * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
  * See LICENSE.md in the project root for license terms and full copyright notice.
  *--------------------------------------------------------------------------------------------*/
-import { ViewPose, ViewState, } from "@itwin/core-frontend";
-import { createViewState } from "./createViewState.js";
+import { Camera, } from "@itwin/core-common";
+import { ViewPose, ViewPose2d, ViewPose3d, ViewState, } from "@itwin/core-frontend";
+import { YawPitchRollAngles } from "@itwin/core-geometry";
+import { createViewStateFromProps, createViewStateProps, } from "./createViewState.js";
 import { extensionHandlers, } from "./translation/SavedViewsExtensionHandlers.js";
+async function createSeedViewStateProps(iModel, viewport, savedViewData, settings = {}) {
+    if (settings.viewState !== "keep") {
+        return settings.viewState instanceof ViewState
+            ? settings.viewState.toProps()
+            : createViewStateProps(iModel, savedViewData.viewData);
+    }
+    return viewport.view.toProps();
+}
+function applyCameraOptions(seedViewStateProps, _iModel, viewport, savedViewData, settings) {
+    const setCameraInfo = (seedViewDef, cameraProps, viewDataType = "iTwin3d") => {
+        if (viewDataType === "iTwin3d") {
+            const viewDef = seedViewStateProps.viewDefinitionProps;
+            if (cameraProps instanceof ViewPose3d) {
+                viewDef.cameraOn = cameraProps.cameraOn;
+                viewDef.origin = cameraProps.origin;
+                viewDef.extents = cameraProps.extents;
+                viewDef.angles = YawPitchRollAngles.createFromMatrix3d(cameraProps.rotation)?.toJSON();
+                viewDef.camera = cameraProps.camera;
+            }
+            else {
+                const cameraProps3d = cameraProps;
+                viewDef.cameraOn = cameraProps3d.camera !== undefined;
+                viewDef.origin = cameraProps3d.origin;
+                viewDef.extents = cameraProps3d.extents;
+                viewDef.angles = cameraProps3d.angles;
+                viewDef.camera = cameraProps3d.camera ?? new Camera();
+            }
+        }
+        else {
+            //2d Sheet or Drawing
+            const viewDef = seedViewStateProps.viewDefinitionProps;
+            if (cameraProps instanceof ViewPose2d) {
+                viewDef.origin = cameraProps.origin;
+                viewDef.delta = cameraProps.delta;
+                viewDef.angle = cameraProps.angle;
+            }
+            else {
+                const cameraProps2d = cameraProps;
+                viewDef.origin = cameraProps2d.origin;
+                viewDef.delta = cameraProps2d.delta;
+                viewDef.angle = cameraProps2d.angle;
+            }
+        }
+        return seedViewDef;
+    };
+    const cameraProps = settings.camera instanceof ViewPose
+        ? settings.camera
+        : settings.camera === "keep"
+            ? viewport.view.toProps().viewDefinitionProps
+            : savedViewData.viewData;
+    setCameraInfo(seedViewStateProps, cameraProps, savedViewData.viewData.type);
+    return seedViewStateProps;
+}
+async function applyViewStateProps(viewStateProps, iModel, viewport, savedViewData, settings) {
+    // We use "hidden" as the default value for modelAndCategoryVisibilityFallback
+    // because users expect modelSelector.enabled and categorySelector.enabled to
+    // act as exclusive whitelists when modelSelector.disabled or categorySelector.disabled
+    // arrays are empty, respectively.
+    const { modelAndCategoryVisibilityFallback = "hidden" } = settings;
+    const viewState = await createViewStateFromProps(viewStateProps, iModel, savedViewData.viewData, {
+        modelAndCategoryVisibilityFallback,
+    });
+    viewport.changeView(viewState, settings.viewChangeOptions);
+}
 /**
  * Updates {@linkcode viewport} state to match captured Saved View.
  *
@@ -18,33 +84,23 @@ import { extensionHandlers, } from "./translation/SavedViewsExtensionHandlers.js
  * ]);
  */
 export async function applySavedView(iModel, viewport, savedViewData, settings = {}, overrides) {
-    if (settings.viewState !== "keep") {
-        // We use "hidden" as the default value for modelAndCategoryVisibilityFallback
-        // because users expect modelSelector.enabled and categorySelector.enabled to
-        // act as exclusive whitelists when modelSelector.disabled or categorySelector.disabled
-        // arrays are empty, respectively.
-        const { modelAndCategoryVisibilityFallback = "hidden" } = settings;
-        const viewState = settings.viewState instanceof ViewState
-            ? settings.viewState
-            : await createViewState(iModel, savedViewData.viewData, {
-                modelAndCategoryVisibilityFallback,
-            });
-        if (settings.camera instanceof ViewPose) {
-            viewState.applyPose(settings.camera);
-        }
-        else if (settings.camera === "keep") {
-            viewState.applyPose(viewport.view.savePose());
-        }
-        viewport.changeView(viewState, settings.viewChangeOptions);
+    let viewStateProps = await createSeedViewStateProps(iModel, viewport, savedViewData, settings);
+    viewStateProps = applyCameraOptions(viewStateProps, iModel, viewport, savedViewData, settings);
+    await applyViewStateProps(viewStateProps, iModel, viewport, savedViewData, settings);
+    // Reset each extension even if it's not present in the saved view data
+    if (settings.emphasis !== "keep") {
+        overrides?.emphasizeElements?.reset
+            ? overrides?.emphasizeElements.reset(viewport)
+            : extensionHandlers.emphasizeElements.reset(viewport);
+    }
+    if (settings.perModelCategoryVisibility !== "keep") {
+        overrides?.perModelCategoryVisibility?.reset
+            ? overrides?.perModelCategoryVisibility.reset(viewport)
+            : extensionHandlers.perModelCategoryVisibility.reset(viewport);
     }
     const extensions = findKnownExtensions(savedViewData.extensions ?? []);
     if (extensions.emphasis) {
         const override = overrides?.emphasizeElements;
-        if (settings.emphasis !== "keep") {
-            override?.reset
-                ? override.reset(viewport)
-                : extensionHandlers.emphasizeElements.reset(viewport);
-        }
         if (settings.emphasis === "apply") {
             override?.apply
                 ? override.apply(extensions.emphasis, viewport)
@@ -53,11 +109,6 @@ export async function applySavedView(iModel, viewport, savedViewData, settings =
     }
     if (extensions.perModelCategoryVisibility) {
         const override = overrides?.perModelCategoryVisibility;
-        if (settings.perModelCategoryVisibility !== "keep") {
-            override?.reset
-                ? override.reset(viewport)
-                : extensionHandlers.perModelCategoryVisibility.reset(viewport);
-        }
         if (settings.perModelCategoryVisibility === "apply") {
             override?.apply
                 ? override.apply(extensions.perModelCategoryVisibility, viewport)

package/lib/createViewState.d.ts

@@ -1,3 +1,4 @@
+import { type ViewStateProps } from "@itwin/core-common";
 import { type IModelConnection, type ViewState } from "@itwin/core-frontend";
 import type { ViewData } from "./SavedView.js";
 export interface ViewStateCreateSettings {
@@ -19,11 +20,39 @@ export interface ViewStateCreateSettings {
      */
     modelAndCategoryVisibilityFallback?: "visible" | "hidden" | undefined;
 }
+/**
+ * Creates {@link ViewStateProps} object out of Saved View data. It provides a lower-level
+ * access to view data for advanced use.
+ *
+ * @example
+ * const viewStateProps = await createViewStateProps(iModel, savedViewData.viewData);
+ * const viewState = createViewStateFromProps(viewStateProps);
+ * await applySavedView(iModel, viewport, savedViewData, { viewState });
+ *
+ * // The three lines above are equivalent to
+ * const viewState = await createViewState(iModel, savedViewData.viewData);
+ * await applySavedView(iModel, viewport, savedViewData, { viewState });
+ */
+export declare function createViewStateProps(iModel: IModelConnection, viewData: ViewData): Promise<ViewStateProps>;
 /**
  * Creates {@link ViewState} object out of Saved View data. It provides a lower-level
  * access to view data for advanced use.
  *
  * @example
+ * const viewStateProps = await createViewStateProps(iModel, savedViewData.viewData);
+ * const viewState = createViewStateFromProps(viewStateProps);
+ * await applySavedView(iModel, viewport, savedViewData, { viewState });
+ *
+ * // The three lines above are equivalent to
+ * const viewState = await createViewState(iModel, savedViewData.viewData);
+ * await applySavedView(iModel, viewport, savedViewData, { viewState });
+ */
+export declare function createViewStateFromProps(props: ViewStateProps, iModel: IModelConnection, viewData: ViewData, settings?: ViewStateCreateSettings): Promise<ViewState>;
+/**
+ * Creates {@link ViewState} object out of ViewStateProps. It provides a lower-level
+ * access to view data for advanced use.
+ *
+ * @example
  * const viewState = await createViewState(iModel, savedViewData.viewData);
  * await applySavedView(iModel, viewport, savedViewData, { viewState });
  *

package/lib/createViewState.js

@@ -1,17 +1,69 @@
 /*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
 import { Camera, } from "@itwin/core-common";
 import { DrawingViewState, SheetViewState, SpatialViewState, } from "@itwin/core-frontend";
-import { queryMissingCategories, queryMissingModels } from "./captureSavedViewData.js";
+import { queryMissingCategories, queryMissingModels, } from "./captureSavedViewData.js";
 import { extractClipVectors } from "./translation/clipVectorsExtractor.js";
-import { extractDisplayStyle, extractDisplayStyle3d } from "./translation/displayStyleExtractor.js";
+import { extractDisplayStyle, extractDisplayStyle3d, } from "./translation/displayStyleExtractor.js";
+/**
+ * Creates {@link ViewStateProps} object out of Saved View data. It provides a lower-level
+ * access to view data for advanced use.
+ *
+ * @example
+ * const viewStateProps = await createViewStateProps(iModel, savedViewData.viewData);
+ * const viewState = createViewStateFromProps(viewStateProps);
+ * await applySavedView(iModel, viewport, savedViewData, { viewState });
+ *
+ * // The three lines above are equivalent to
+ * const viewState = await createViewState(iModel, savedViewData.viewData);
+ * await applySavedView(iModel, viewport, savedViewData, { viewState });
+ */
+export async function createViewStateProps(iModel, viewData) {
+    const viewStateProps = await createViewStatePropsVariant(iModel, viewData);
+    return viewStateProps;
+}
+async function applyViewStateOptions(viewState, iModel, viewData, settings = {}) {
+    if (settings.modelAndCategoryVisibilityFallback === "visible") {
+        await unhideNewModelsAndCategories(iModel, viewState, viewData);
+    }
+    if (!settings.skipViewStateLoad) {
+        await viewState.load();
+    }
+}
 /**
  * Creates {@link ViewState} object out of Saved View data. It provides a lower-level
  * access to view data for advanced use.
  *
  * @example
+ * const viewStateProps = await createViewStateProps(iModel, savedViewData.viewData);
+ * const viewState = createViewStateFromProps(viewStateProps);
+ * await applySavedView(iModel, viewport, savedViewData, { viewState });
+ *
+ * // The three lines above are equivalent to
+ * const viewState = await createViewState(iModel, savedViewData.viewData);
+ * await applySavedView(iModel, viewport, savedViewData, { viewState });
+ */
+export async function createViewStateFromProps(props, iModel, viewData, settings = {}) {
+    let viewState;
+    if (viewData.type === "iTwinDrawing") {
+        viewState = DrawingViewState.createFromProps(props, iModel);
+    }
+    else if (viewData.type === "iTwinSheet") {
+        viewState = SheetViewState.createFromProps(props, iModel);
+    }
+    else {
+        viewState = SpatialViewState.createFromProps(props, iModel);
+    }
+    await applyViewStateOptions(viewState, iModel, viewData, settings);
+    return viewState;
+}
+/**
+ * Creates {@link ViewState} object out of ViewStateProps. It provides a lower-level
+ * access to view data for advanced use.
+ *
+ * @example
  * const viewState = await createViewState(iModel, savedViewData.viewData);
  * await applySavedView(iModel, viewport, savedViewData, { viewState });
  *
@@ -20,13 +72,17 @@ import { extractDisplayStyle, extractDisplayStyle3d } from "./translation/displa
  */
 export async function createViewState(iModel, viewData, settings = {}) {
     const viewState = await createViewStateVariant(iModel, viewData);
-    if (settings.modelAndCategoryVisibilityFallback === "visible") {
-        await unhideNewModelsAndCategories(iModel, viewState, viewData);
+    await applyViewStateOptions(viewState, iModel, viewData, settings);
+    return viewState;
+}
+async function createViewStatePropsVariant(iModel, viewData) {
+    if (viewData.type === "iTwinDrawing") {
+        return createDrawingViewStateProps(iModel, viewData);
     }
-    if (!settings.skipViewStateLoad) {
-        await viewState.load();
+    if (viewData.type === "iTwinSheet") {
+        return createSheetViewStateProps(iModel, viewData);
     }
-    return viewState;
+    return createSpatialViewStateProps(iModel, viewData);
 }
 async function createViewStateVariant(iModel, viewData) {
     if (viewData.type === "iTwinDrawing") {
@@ -37,8 +93,8 @@ async function createViewStateVariant(iModel, viewData) {
     }
     return createSpatialViewState(iModel, viewData);
 }
-async function createSpatialViewState(iModel, viewData) {
-    const seedViewState = await fetchIModelViewData(iModel, SpatialViewState.classFullName);
+async function createSpatialViewStateProps(iModel, viewData) {
+    const seedViewState = (await fetchIModelViewData(iModel, SpatialViewState.classFullName));
     const props = {
         viewDefinitionProps: {
             origin: viewData.origin,
@@ -78,10 +134,14 @@ async function createSpatialViewState(iModel, viewData) {
             },
         },
     };
+    return props;
+}
+async function createSpatialViewState(iModel, viewData) {
+    const props = await createSpatialViewStateProps(iModel, viewData);
     return SpatialViewState.createFromProps(props, iModel);
 }
-async function createDrawingViewState(iModel, viewData) {
-    const seedViewState = await fetchIModelViewData(iModel, DrawingViewState.classFullName);
+async function createDrawingViewStateProps(iModel, viewData) {
+    const seedViewState = (await fetchIModelViewData(iModel, DrawingViewState.classFullName));
     const props = {
         viewDefinitionProps: {
             classFullName: seedViewState.classFullName,
@@ -122,10 +182,14 @@ async function createDrawingViewState(iModel, viewData) {
             federationGuid: seedViewState.displayStyle.federationGuid,
         },
     };
+    return props;
+}
+async function createDrawingViewState(iModel, viewData) {
+    const props = await createDrawingViewStateProps(iModel, viewData);
     return DrawingViewState.createFromProps(props, iModel);
 }
-async function createSheetViewState(iModel, viewData) {
-    const seedViewState = await fetchIModelViewData(iModel, SheetViewState.classFullName);
+async function createSheetViewStateProps(iModel, viewData) {
+    const seedViewState = (await fetchIModelViewData(iModel, SheetViewState.classFullName));
     const props = {
         viewDefinitionProps: {
             classFullName: seedViewState.classFullName,
@@ -178,6 +242,10 @@ async function createSheetViewState(iModel, viewData) {
         },
         sheetAttachments: viewData.sheetAttachments,
     };
+    return props;
+}
+async function createSheetViewState(iModel, viewData) {
+    const props = await createSheetViewStateProps(iModel, viewData);
     return SheetViewState.createFromProps(props, iModel);
 }
 async function fetchIModelViewData(iModel, viewClassName) {
@@ -212,12 +280,18 @@ function createEmptyViewState(iModel, viewClassName) {
 async function getDefaultViewIdFromClassName(iModel, viewClassName) {
     // Check validity of default view
     const viewId = await iModel.views.queryDefaultViewId();
-    const viewProps = await iModel.elements.queryProps({ from: viewClassName, where: "ECInstanceId=" + viewId });
+    const viewProps = await iModel.elements.queryProps({
+        from: viewClassName,
+        where: "ECInstanceId=" + viewId,
+    });
     if (viewProps.length > 0) {
         return viewId;
     }
     // Return the first view we can find
-    const viewList = await iModel.views.getViewList({ from: viewClassName, wantPrivate: false });
+    const viewList = await iModel.views.getViewList({
+        from: viewClassName,
+        wantPrivate: false,
+    });
     if (viewList.length === 0) {
         return "";
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itwin/saved-views-react",
-  "version": "0.9.2",
+  "version": "0.9.4",
   "license": "MIT",
   "repository": {
     "type": "git",