@itwin/hypermodeling-frontend 4.0.0-dev.8 → 4.0.0-dev.80

package/lib/cjs/HyperModeling.js

@@ -1,240 +1,238 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module HyperModeling
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.HyperModeling = void 0;
-const core_bentley_1 = require("@itwin/core-bentley");
-const core_common_1 = require("@itwin/core-common");
-const core_frontend_1 = require("@itwin/core-frontend");
-const Tools_1 = require("./Tools");
-const HyperModelingDecorator_1 = require("./HyperModelingDecorator");
-const SectionMarkerHandler_1 = require("./SectionMarkerHandler");
-function assertInitialized(maybe) {
-    if (undefined === maybe.resources)
-        throw new Error("You must call HyperModeling.initialize before using the hypermodeling package");
-}
-/** The API entry point for the hypermodeling package. Applications must call [[initialize]] and await the result before using the package.
- * The behavior of the package can be customized via a [[HyperModelingConfig]] supplied to [[initialize]], [[updateConfiguration]], or [[replaceConfiguration]].
- * Hypermodeling mode can be enabled or disabled via [[startOrStop]], which returns a [[HyperModelingDecorator]] when enabling hypermodeling.
- * Consult the package's `README.md` for a description of the available functionality.
- * @public
- */
-class HyperModeling {
-    static shutdown() {
-        this.resources = undefined;
-        this._markerHandler = undefined;
-        this._markerConfig = {};
-        this._graphicsConfig = {};
-    }
-    /** Returns whether the hypermodeling package is initialized.
-     * @see [[HyperModeling.initialize]] to initialize the package.
-     */
-    static get isInitialized() {
-        return undefined !== this.resources;
-    }
-    /** Invoke this method to initialize the hypermodeling package for use. You *must* await the result before using any of this package's APIs.
-     * Typically an application would invoke this after [IModelApp.startup]($frontend), e.g.,
-     * ```ts
-     *  await IModelApp.startup();
-     *  await HyperModeling.initialize();
-     * ```
-     * Calling this method again after the first initialization behaves the same as calling [[HyperModeling.replaceConfiguration]].
-     * @note The hypermodeling package will be reset to uninitialized after [IModelApp.shutdown]($frontend) is invoked.
-     * @see [[replaceConfiguration]] and [[updateConfiguration]] to modify the configuration after initialization.
-     */
-    static async initialize(config) {
-        if (undefined !== this.resources) {
-            this.replaceConfiguration(config);
-            return;
-        }
-        // clean up if we're being shut down
-        core_frontend_1.IModelApp.onBeforeShutdown.addListener(() => this.shutdown());
-        const namespace = "HyperModeling";
-        await core_frontend_1.IModelApp.localization.registerNamespace(namespace);
-        const loadImages = [
-            (0, core_frontend_1.tryImageElementFromUrl)(`${core_frontend_1.IModelApp.publicPath}section-marker.svg`),
-            (0, core_frontend_1.tryImageElementFromUrl)(`${core_frontend_1.IModelApp.publicPath}detail-marker.svg`),
-            (0, core_frontend_1.tryImageElementFromUrl)(`${core_frontend_1.IModelApp.publicPath}elevation-marker.svg`),
-            (0, core_frontend_1.tryImageElementFromUrl)(`${core_frontend_1.IModelApp.publicPath}plan-marker.svg`),
-        ];
-        const images = await Promise.all(loadImages);
-        this.resources = {
-            namespace,
-            markers: {
-                section: { image: images[0], label: core_frontend_1.IModelApp.localization.getLocalizedString("HyperModeling:Message.SectionCallout") },
-                detail: { image: images[1], label: core_frontend_1.IModelApp.localization.getLocalizedString("HyperModeling:Message.DetailCallout") },
-                elevation: { image: images[2], label: core_frontend_1.IModelApp.localization.getLocalizedString("HyperModeling:Message.ElevationCallout") },
-                plan: { image: images[3], label: core_frontend_1.IModelApp.localization.getLocalizedString("HyperModeling:Message.PlanCallout") },
-            },
-        };
-        (0, Tools_1.registerTools)(namespace);
-        this.replaceConfiguration(config);
-    }
-    static async ensureInitialized() {
-        if (undefined === this.resources)
-            await this.initialize();
-        assertInitialized(this);
-    }
-    /** Replaces the current package configuration, overwriting all previous settings. Passing `undefined` resets all settings to defaults.
-     * @see [[HyperModeling.updateConfiguration]] for overriding specific aspects of the configuration.
-     */
-    static replaceConfiguration(config) {
-        var _a;
-        config = config !== null && config !== void 0 ? config : {};
-        this._markerHandler = (_a = config.markerHandler) !== null && _a !== void 0 ? _a : new SectionMarkerHandler_1.SectionMarkerHandler();
-        this._markerConfig = config.markers ? { ...config.markers } : {};
-        this._graphicsConfig = config.graphics ? { ...config.graphics } : {};
-    }
-    /** Overrides specific aspects of the current package configuration. Any field that is not `undefined` will be replaced in the current configuration;
-     * the rest will retain their current values.
-     * @see [[HyperModeling.replaceConfiguration]].
-     */
-    static updateConfiguration(config) {
-        var _a, _b, _c, _d, _e, _f, _g, _h;
-        this._markerHandler = (_a = config.markerHandler) !== null && _a !== void 0 ? _a : this._markerHandler;
-        if (config.markers) {
-            this._markerConfig = {
-                ignoreModelSelector: (_b = config.markers.ignoreModelSelector) !== null && _b !== void 0 ? _b : this._markerConfig.ignoreModelSelector,
-                ignoreCategorySelector: (_c = config.markers.ignoreCategorySelector) !== null && _c !== void 0 ? _c : this._markerConfig.ignoreCategorySelector,
-                hiddenSectionTypes: (_d = config.markers.hiddenSectionTypes) !== null && _d !== void 0 ? _d : this._markerConfig.hiddenSectionTypes,
-            };
-        }
-        if (config.graphics) {
-            this._graphicsConfig = {
-                ignoreClip: (_e = config.graphics.ignoreClip) !== null && _e !== void 0 ? _e : this._graphicsConfig.ignoreClip,
-                debugClipVolumes: (_f = config.graphics.debugClipVolumes) !== null && _f !== void 0 ? _f : this._graphicsConfig.debugClipVolumes,
-                hideSectionGraphics: (_g = config.graphics.hideSectionGraphics) !== null && _g !== void 0 ? _g : this._graphicsConfig.hideSectionGraphics,
-                hideSheetAnnotations: (_h = config.graphics.hideSheetAnnotations) !== null && _h !== void 0 ? _h : this._graphicsConfig.hideSheetAnnotations,
-            };
-            core_frontend_1.IModelApp.viewManager.invalidateViewportScenes();
-        }
-    }
-    /** The handler that defines interactions with [[SectionMarker]]s.
-     * @see [[initialize]] to override the default handler at package initialization.
-     * @see [[updateConfiguration]] or [[replaceConfiguration]] to change the current handler.
-     */
-    static get markerHandler() {
-        assertInitialized(this);
-        (0, core_bentley_1.assert)(undefined !== this._markerHandler);
-        return this._markerHandler;
-    }
-    /** The current marker display configuration applied to any newly-created [[HyperModelingDecorator]]s.
-     * @see [[initialize]] to override the default configuration at package initialization.
-     * @see [[updateConfiguration]] or [[replaceConfiguration]] to change the current configuration.
-     * @see [[HyperModelingDecorator.replaceConfiguration]] or [[HyperModelingDecorator.updateConfiguration]] to change the configuration for an existing decorator.
-     */
-    static get markerConfig() {
-        return this._markerConfig;
-    }
-    /** This graphics options applied to graphics displayed by all [[HyperModelingDecorator]]s.
-     * @see [[updateConfiguration]] or [[replaceConfiguration]] to change the current configuration.
-     */
-    static get graphicsConfig() {
-        return this._graphicsConfig;
-    }
-    /** Returns true if the specified iModel contains any [SectionDrawingLocation]($backend)s. Hypermodeling is based on section drawing locations,
-     * so if none are present, hypermodeling features are not relevant to the iModel. Attempting to use those features with such an iModel is fine,
-     * but probably not useful.
-     */
-    static async isSupportedForIModel(imodel) {
-        try {
-            const nRows = await imodel.queryRowCount("SELECT ECInstanceId FROM bis.SectionDrawingLocation LIMIT 1");
-            return nRows > 0;
-        }
-        catch {
-            // An iModel with a version of BisCore older than 1.0.11 will produce an expected "table not found" on the SectionDrawingLocation ECClass.
-            return false;
-        }
-    }
-    /** Returns whether hypermodeling is currently enabled for the specified viewport.
-     * @see [[startOrStop]] to enable or disable hypermodeling for a viewport.
-     */
-    static isEnabledForViewport(viewport) {
-        return undefined !== HyperModelingDecorator_1.HyperModelingDecorator.getForViewport(viewport);
-    }
-    /** Start or stop hypermodeling mode for the specified viewport.
-     * Enabling hypermodeling registers and returns a [[HyperModelingDecorator]] to display [[SectionMarker]]s within the viewport.
-     * Disabling hypermodeling removes that decorator.
-     * @param viewport The hypermodeling viewport
-     * @param start `true` to enter hypermodeling mode, `false` to exit, or `undefined` to toggle the current mode.
-     * @returns The new decorator is hypermodeling was successfully enabled.
-     * @note Enabling hypermodeling may fail if the viewport is not viewing a spatial model or if the viewport's iModel does not support hypermodeling.
-     * @see [[start]] and [[stop]].
-     * @see [[isSupportedForIModel]].
-     */
-    static async startOrStop(viewport, start) {
-        // Help out the caller since we're async anyway...
-        await this.ensureInitialized();
-        const decorator = HyperModelingDecorator_1.HyperModelingDecorator.getForViewport(viewport);
-        if (undefined === start)
-            start = undefined === decorator;
-        if (start) {
-            return this._start(viewport);
-        }
-        else {
-            decorator === null || decorator === void 0 ? void 0 : decorator.dispose();
-            return undefined;
-        }
-    }
-    /** Start hypermodeling mode for the specified viewport if it is not currently enabled.
-     * If hypermodeling is already enabled for the viewport, the existing decorator is returned; otherwise, a new decorator is created.
-     * @param viewport The viewport for which to enable hypermodeling
-     * @returns The decorator that implements hypermodeling features for the viewport, or `undefined` if hypermodeling could not be enabled.
-     * @note Enabling hypermodeling may fail if the viewport is not viewing a spatial model or if the viewport's iModel does not support hypermodeling.
-     */
-    static async start(viewport) {
-        await this.ensureInitialized();
-        return this._start(viewport);
-    }
-    static async _start(viewport) {
-        assertInitialized(this);
-        if (!viewport.view.isSpatialView())
-            return undefined;
-        let decorator = HyperModelingDecorator_1.HyperModelingDecorator.getForViewport(viewport);
-        if (!decorator)
-            decorator = await HyperModelingDecorator_1.HyperModelingDecorator.create(viewport, this._markerConfig);
-        if (undefined !== decorator && viewport.view.isCameraOn) {
-            // We want the 2d graphics to align with the 3d geometry. Perspective ruins that.
-            viewport.view.turnCameraOff();
-            core_frontend_1.ViewManip.fitView(viewport, false, { noSaveInUndo: true });
-            viewport.clearViewUndo();
-        }
-        return decorator;
-    }
-    /** Stop hypermodeling mode for the specified viewport if it is currently enabled. This disposes of the [[HyperModelingDecorator]] associated with the viewport.
-     * @see [[start]] to enable hypermodeling for a viewport.
-     * @see [[startOrStop]] to toggle hypermodeling mode.
-     */
-    static stop(viewport) {
-        const decorator = HyperModelingDecorator_1.HyperModelingDecorator.getForViewport(viewport);
-        decorator === null || decorator === void 0 ? void 0 : decorator.dispose();
-    }
-    /** @internal */
-    static get namespace() {
-        assertInitialized(this);
-        return this.resources.namespace;
-    }
-    /** @internal */
-    static getMarkerData(type) {
-        assertInitialized(this);
-        switch (type) {
-            case core_common_1.SectionType.Plan:
-                return this.resources.markers.plan;
-            case core_common_1.SectionType.Elevation:
-                return this.resources.markers.elevation;
-            case core_common_1.SectionType.Detail:
-                return this.resources.markers.detail;
-            default:
-                return this.resources.markers.section;
-        }
-    }
-}
-exports.HyperModeling = HyperModeling;
-HyperModeling._markerConfig = {};
-HyperModeling._graphicsConfig = {};
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module HyperModeling
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HyperModeling = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+const core_common_1 = require("@itwin/core-common");
+const core_frontend_1 = require("@itwin/core-frontend");
+const Tools_1 = require("./Tools");
+const HyperModelingDecorator_1 = require("./HyperModelingDecorator");
+const SectionMarkerHandler_1 = require("./SectionMarkerHandler");
+function assertInitialized(maybe) {
+    if (undefined === maybe.resources)
+        throw new Error("You must call HyperModeling.initialize before using the hypermodeling package");
+}
+/** The API entry point for the hypermodeling package. Applications must call [[initialize]] and await the result before using the package.
+ * The behavior of the package can be customized via a [[HyperModelingConfig]] supplied to [[initialize]], [[updateConfiguration]], or [[replaceConfiguration]].
+ * Hypermodeling mode can be enabled or disabled via [[startOrStop]], which returns a [[HyperModelingDecorator]] when enabling hypermodeling.
+ * Consult the package's `README.md` for a description of the available functionality.
+ * @public
+ */
+class HyperModeling {
+    static shutdown() {
+        this.resources = undefined;
+        this._markerHandler = undefined;
+        this._markerConfig = {};
+        this._graphicsConfig = {};
+    }
+    /** Returns whether the hypermodeling package is initialized.
+     * @see [[HyperModeling.initialize]] to initialize the package.
+     */
+    static get isInitialized() {
+        return undefined !== this.resources;
+    }
+    /** Invoke this method to initialize the hypermodeling package for use. You *must* await the result before using any of this package's APIs.
+     * Typically an application would invoke this after [IModelApp.startup]($frontend), e.g.,
+     * ```ts
+     *  await IModelApp.startup();
+     *  await HyperModeling.initialize();
+     * ```
+     * Calling this method again after the first initialization behaves the same as calling [[HyperModeling.replaceConfiguration]].
+     * @note The hypermodeling package will be reset to uninitialized after [IModelApp.shutdown]($frontend) is invoked.
+     * @see [[replaceConfiguration]] and [[updateConfiguration]] to modify the configuration after initialization.
+     */
+    static async initialize(config) {
+        if (undefined !== this.resources) {
+            this.replaceConfiguration(config);
+            return;
+        }
+        // clean up if we're being shut down
+        core_frontend_1.IModelApp.onBeforeShutdown.addListener(() => this.shutdown());
+        const namespace = "HyperModeling";
+        await core_frontend_1.IModelApp.localization.registerNamespace(namespace);
+        const loadImages = [
+            (0, core_frontend_1.tryImageElementFromUrl)(`${core_frontend_1.IModelApp.publicPath}section-marker.svg`),
+            (0, core_frontend_1.tryImageElementFromUrl)(`${core_frontend_1.IModelApp.publicPath}detail-marker.svg`),
+            (0, core_frontend_1.tryImageElementFromUrl)(`${core_frontend_1.IModelApp.publicPath}elevation-marker.svg`),
+            (0, core_frontend_1.tryImageElementFromUrl)(`${core_frontend_1.IModelApp.publicPath}plan-marker.svg`),
+        ];
+        const images = await Promise.all(loadImages);
+        this.resources = {
+            namespace,
+            markers: {
+                section: { image: images[0], label: core_frontend_1.IModelApp.localization.getLocalizedString("HyperModeling:Message.SectionCallout") },
+                detail: { image: images[1], label: core_frontend_1.IModelApp.localization.getLocalizedString("HyperModeling:Message.DetailCallout") },
+                elevation: { image: images[2], label: core_frontend_1.IModelApp.localization.getLocalizedString("HyperModeling:Message.ElevationCallout") },
+                plan: { image: images[3], label: core_frontend_1.IModelApp.localization.getLocalizedString("HyperModeling:Message.PlanCallout") },
+            },
+        };
+        (0, Tools_1.registerTools)(namespace);
+        this.replaceConfiguration(config);
+    }
+    static async ensureInitialized() {
+        if (undefined === this.resources)
+            await this.initialize();
+        assertInitialized(this);
+    }
+    /** Replaces the current package configuration, overwriting all previous settings. Passing `undefined` resets all settings to defaults.
+     * @see [[HyperModeling.updateConfiguration]] for overriding specific aspects of the configuration.
+     */
+    static replaceConfiguration(config) {
+        config = config ?? {};
+        this._markerHandler = config.markerHandler ?? new SectionMarkerHandler_1.SectionMarkerHandler();
+        this._markerConfig = config.markers ? { ...config.markers } : {};
+        this._graphicsConfig = config.graphics ? { ...config.graphics } : {};
+    }
+    /** Overrides specific aspects of the current package configuration. Any field that is not `undefined` will be replaced in the current configuration;
+     * the rest will retain their current values.
+     * @see [[HyperModeling.replaceConfiguration]].
+     */
+    static updateConfiguration(config) {
+        this._markerHandler = config.markerHandler ?? this._markerHandler;
+        if (config.markers) {
+            this._markerConfig = {
+                ignoreModelSelector: config.markers.ignoreModelSelector ?? this._markerConfig.ignoreModelSelector,
+                ignoreCategorySelector: config.markers.ignoreCategorySelector ?? this._markerConfig.ignoreCategorySelector,
+                hiddenSectionTypes: config.markers.hiddenSectionTypes ?? this._markerConfig.hiddenSectionTypes,
+            };
+        }
+        if (config.graphics) {
+            this._graphicsConfig = {
+                ignoreClip: config.graphics.ignoreClip ?? this._graphicsConfig.ignoreClip,
+                debugClipVolumes: config.graphics.debugClipVolumes ?? this._graphicsConfig.debugClipVolumes,
+                hideSectionGraphics: config.graphics.hideSectionGraphics ?? this._graphicsConfig.hideSectionGraphics,
+                hideSheetAnnotations: config.graphics.hideSheetAnnotations ?? this._graphicsConfig.hideSheetAnnotations,
+            };
+            core_frontend_1.IModelApp.viewManager.invalidateViewportScenes();
+        }
+    }
+    /** The handler that defines interactions with [[SectionMarker]]s.
+     * @see [[initialize]] to override the default handler at package initialization.
+     * @see [[updateConfiguration]] or [[replaceConfiguration]] to change the current handler.
+     */
+    static get markerHandler() {
+        assertInitialized(this);
+        (0, core_bentley_1.assert)(undefined !== this._markerHandler);
+        return this._markerHandler;
+    }
+    /** The current marker display configuration applied to any newly-created [[HyperModelingDecorator]]s.
+     * @see [[initialize]] to override the default configuration at package initialization.
+     * @see [[updateConfiguration]] or [[replaceConfiguration]] to change the current configuration.
+     * @see [[HyperModelingDecorator.replaceConfiguration]] or [[HyperModelingDecorator.updateConfiguration]] to change the configuration for an existing decorator.
+     */
+    static get markerConfig() {
+        return this._markerConfig;
+    }
+    /** This graphics options applied to graphics displayed by all [[HyperModelingDecorator]]s.
+     * @see [[updateConfiguration]] or [[replaceConfiguration]] to change the current configuration.
+     */
+    static get graphicsConfig() {
+        return this._graphicsConfig;
+    }
+    /** Returns true if the specified iModel contains any [SectionDrawingLocation]($backend)s. Hypermodeling is based on section drawing locations,
+     * so if none are present, hypermodeling features are not relevant to the iModel. Attempting to use those features with such an iModel is fine,
+     * but probably not useful.
+     */
+    static async isSupportedForIModel(imodel) {
+        try {
+            const reader = imodel.createQueryReader("SELECT ECInstanceId FROM bis.SectionDrawingLocation LIMIT 1");
+            return await reader.step(); // i.e., are any results are returned?
+        }
+        catch {
+            // An iModel with a version of BisCore older than 1.0.11 will produce an expected "table not found" on the SectionDrawingLocation ECClass.
+            return false;
+        }
+    }
+    /** Returns whether hypermodeling is currently enabled for the specified viewport.
+     * @see [[startOrStop]] to enable or disable hypermodeling for a viewport.
+     */
+    static isEnabledForViewport(viewport) {
+        return undefined !== HyperModelingDecorator_1.HyperModelingDecorator.getForViewport(viewport);
+    }
+    /** Start or stop hypermodeling mode for the specified viewport.
+     * Enabling hypermodeling registers and returns a [[HyperModelingDecorator]] to display [[SectionMarker]]s within the viewport.
+     * Disabling hypermodeling removes that decorator.
+     * @param viewport The hypermodeling viewport
+     * @param start `true` to enter hypermodeling mode, `false` to exit, or `undefined` to toggle the current mode.
+     * @returns The new decorator is hypermodeling was successfully enabled.
+     * @note Enabling hypermodeling may fail if the viewport is not viewing a spatial model or if the viewport's iModel does not support hypermodeling.
+     * @see [[start]] and [[stop]].
+     * @see [[isSupportedForIModel]].
+     */
+    static async startOrStop(viewport, start) {
+        // Help out the caller since we're async anyway...
+        await this.ensureInitialized();
+        const decorator = HyperModelingDecorator_1.HyperModelingDecorator.getForViewport(viewport);
+        if (undefined === start)
+            start = undefined === decorator;
+        if (start) {
+            return this._start(viewport);
+        }
+        else {
+            decorator?.dispose();
+            return undefined;
+        }
+    }
+    /** Start hypermodeling mode for the specified viewport if it is not currently enabled.
+     * If hypermodeling is already enabled for the viewport, the existing decorator is returned; otherwise, a new decorator is created.
+     * @param viewport The viewport for which to enable hypermodeling
+     * @returns The decorator that implements hypermodeling features for the viewport, or `undefined` if hypermodeling could not be enabled.
+     * @note Enabling hypermodeling may fail if the viewport is not viewing a spatial model or if the viewport's iModel does not support hypermodeling.
+     */
+    static async start(viewport) {
+        await this.ensureInitialized();
+        return this._start(viewport);
+    }
+    static async _start(viewport) {
+        assertInitialized(this);
+        if (!viewport.view.isSpatialView())
+            return undefined;
+        let decorator = HyperModelingDecorator_1.HyperModelingDecorator.getForViewport(viewport);
+        if (!decorator)
+            decorator = await HyperModelingDecorator_1.HyperModelingDecorator.create(viewport, this._markerConfig);
+        if (undefined !== decorator && viewport.view.isCameraOn) {
+            // We want the 2d graphics to align with the 3d geometry. Perspective ruins that.
+            viewport.view.turnCameraOff();
+            core_frontend_1.ViewManip.fitView(viewport, false, { noSaveInUndo: true });
+            viewport.clearViewUndo();
+        }
+        return decorator;
+    }
+    /** Stop hypermodeling mode for the specified viewport if it is currently enabled. This disposes of the [[HyperModelingDecorator]] associated with the viewport.
+     * @see [[start]] to enable hypermodeling for a viewport.
+     * @see [[startOrStop]] to toggle hypermodeling mode.
+     */
+    static stop(viewport) {
+        const decorator = HyperModelingDecorator_1.HyperModelingDecorator.getForViewport(viewport);
+        decorator?.dispose();
+    }
+    /** @internal */
+    static get namespace() {
+        assertInitialized(this);
+        return this.resources.namespace;
+    }
+    /** @internal */
+    static getMarkerData(type) {
+        assertInitialized(this);
+        switch (type) {
+            case core_common_1.SectionType.Plan:
+                return this.resources.markers.plan;
+            case core_common_1.SectionType.Elevation:
+                return this.resources.markers.elevation;
+            case core_common_1.SectionType.Detail:
+                return this.resources.markers.detail;
+            default:
+                return this.resources.markers.section;
+        }
+    }
+}
+HyperModeling._markerConfig = {};
+HyperModeling._graphicsConfig = {};
+exports.HyperModeling = HyperModeling;
 //# sourceMappingURL=HyperModeling.js.map

package/lib/cjs/HyperModeling.js.map

@@ -1 +1 @@
-{"version":3,"file":"HyperModeling.js","sourceRoot":"","sources":["../../src/HyperModeling.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA6C;AAC7C,oDAAiD;AACjD,wDAAsH;AACtH,mCAAwC;AACxC,qEAAkE;AAElE,iEAA8D;AA0B9D,SAAS,iBAAiB,CAAC,KAAuB;IAChD,IAAI,SAAS,KAAK,KAAK,CAAC,SAAS;QAC/B,MAAM,IAAI,KAAK,CAAC,+EAA+E,CAAC,CAAC;AACrG,CAAC;AAED;;;;;GAKG;AACH,MAAa,aAAa;IAOhB,MAAM,CAAC,QAAQ;QACrB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC;QAChC,IAAI,CAAC,aAAa,GAAG,EAAE,CAAC;QACxB,IAAI,CAAC,eAAe,GAAG,EAAE,CAAC;IAC5B,CAAC;IAED;;OAEG;IACI,MAAM,KAAK,aAAa;QAC7B,OAAO,SAAS,KAAK,IAAI,CAAC,SAAS,CAAC;IACtC,CAAC;IAED;;;;;;;;;OASG;IACI,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,MAA4B;QACzD,IAAI,SAAS,KAAK,IAAI,CAAC,SAAS,EAAE;YAChC,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;YAClC,OAAO;SACR;QAED,oCAAoC;QACpC,yBAAS,CAAC,gBAAgB,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QAE9D,MAAM,SAAS,GAAG,eAAe,CAAC;QAClC,MAAM,yBAAS,CAAC,YAAY,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC;QAE1D,MAAM,UAAU,GAAG;YACjB,IAAA,sCAAsB,EAAC,GAAG,yBAAS,CAAC,UAAU,oBAAoB,CAAC;YACnE,IAAA,sCAAsB,EAAC,GAAG,yBAAS,CAAC,UAAU,mBAAmB,CAAC;YAClE,IAAA,sCAAsB,EAAC,GAAG,yBAAS,CAAC,UAAU,sBAAsB,CAAC;YACrE,IAAA,sCAAsB,EAAC,GAAG,yBAAS,CAAC,UAAU,iBAAiB,CAAC;SACjE,CAAC;QAEF,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAC7C,IAAI,CAAC,SAAS,GAAG;YACf,SAAS;YACT,OAAO,EAAE;gBACP,OAAO,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,yBAAS,CAAC,YAAY,CAAC,kBAAkB,CAAC,sCAAsC,CAAC,EAAE;gBACvH,MAAM,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,yBAAS,CAAC,YAAY,CAAC,kBAAkB,CAAC,qCAAqC,CAAC,EAAE;gBACrH,SAAS,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,yBAAS,CAAC,YAAY,CAAC,kBAAkB,CAAC,wCAAwC,CAAC,EAAE;gBAC3H,IAAI,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,yBAAS,CAAC,YAAY,CAAC,kBAAkB,CAAC,mCAAmC,CAAC,EAAE;aAClH;SACF,CAAC;QAEF,IAAA,qBAAa,EAAC,SAAS,CAAC,CAAC;QACzB,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;IACpC,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,iBAAiB;QACpC,IAAI,SAAS,KAAK,IAAI,CAAC,SAAS;YAC9B,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;QAE1B,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,oBAAoB,CAAC,MAA4B;;QAC7D,MAAM,GAAG,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC;QACtB,IAAI,CAAC,cAAc,GAAG,MAAA,MAAM,CAAC,aAAa,mCAAI,IAAI,2CAAoB,EAAE,CAAC;QACzE,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACjE,IAAI,CAAC,eAAe,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IACvE,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,mBAAmB,CAAC,MAA2B;;QAC3D,IAAI,CAAC,cAAc,GAAG,MAAA,MAAM,CAAC,aAAa,mCAAI,IAAI,CAAC,cAAc,CAAC;QAElE,IAAI,MAAM,CAAC,OAAO,EAAE;YAClB,IAAI,CAAC,aAAa,GAAG;gBACnB,mBAAmB,EAAE,MAAA,MAAM,CAAC,OAAO,CAAC,mBAAmB,mCAAI,IAAI,CAAC,aAAa,CAAC,mBAAmB;gBACjG,sBAAsB,EAAE,MAAA,MAAM,CAAC,OAAO,CAAC,sBAAsB,mCAAI,IAAI,CAAC,aAAa,CAAC,sBAAsB;gBAC1G,kBAAkB,EAAE,MAAA,MAAM,CAAC,OAAO,CAAC,kBAAkB,mCAAI,IAAI,CAAC,aAAa,CAAC,kBAAkB;aAC/F,CAAC;SACH;QAED,IAAI,MAAM,CAAC,QAAQ,EAAE;YACnB,IAAI,CAAC,eAAe,GAAG;gBACrB,UAAU,EAAE,MAAA,MAAM,CAAC,QAAQ,CAAC,UAAU,mCAAI,IAAI,CAAC,eAAe,CAAC,UAAU;gBACzE,gBAAgB,EAAE,MAAA,MAAM,CAAC,QAAQ,CAAC,gBAAgB,mCAAI,IAAI,CAAC,eAAe,CAAC,gBAAgB;gBAC3F,mBAAmB,EAAE,MAAA,MAAM,CAAC,QAAQ,CAAC,mBAAmB,mCAAI,IAAI,CAAC,eAAe,CAAC,mBAAmB;gBACpG,oBAAoB,EAAE,MAAA,MAAM,CAAC,QAAQ,CAAC,oBAAoB,mCAAI,IAAI,CAAC,eAAe,CAAC,oBAAoB;aACxG,CAAC;YAEF,yBAAS,CAAC,WAAW,CAAC,wBAAwB,EAAE,CAAC;SAClD;IACH,CAAC;IAED;;;OAGG;IACI,MAAM,KAAK,aAAa;QAC7B,iBAAiB,CAAC,IAAI,CAAC,CAAC;QACxB,IAAA,qBAAM,EAAC,SAAS,KAAK,IAAI,CAAC,cAAc,CAAC,CAAC;QAC1C,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACI,MAAM,KAAK,YAAY;QAC5B,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED;;OAEG;IACI,MAAM,KAAK,cAAc;QAC9B,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,KAAK,CAAC,oBAAoB,CAAC,MAAwB;QAC/D,IAAI;YACF,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,6DAA6D,CAAC,CAAC;YACxG,OAAO,KAAK,GAAG,CAAC,CAAC;SAClB;QAAC,MAAM;YACN,0IAA0I;YAC1I,OAAO,KAAK,CAAC;SACd;IACH,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,oBAAoB,CAAC,QAAwB;QACzD,OAAO,SAAS,KAAK,+CAAsB,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;OASG;IACI,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,QAAwB,EAAE,KAAe;QACvE,kDAAkD;QAClD,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAE/B,MAAM,SAAS,GAAG,+CAAsB,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QAClE,IAAI,SAAS,KAAK,KAAK;YACrB,KAAK,GAAG,SAAS,KAAK,SAAS,CAAC;QAElC,IAAI,KAAK,EAAE;YACT,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;SAC9B;aAAM;YACL,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,OAAO,EAAE,CAAC;YACrB,OAAO,SAAS,CAAC;SAClB;IACH,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,QAAwB;QAChD,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAC/B,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAC/B,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,QAAwB;QAClD,iBAAiB,CAAC,IAAI,CAAC,CAAC;QACxB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,EAAE;YAChC,OAAO,SAAS,CAAC;QAEnB,IAAI,SAAS,GAAG,+CAAsB,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QAChE,IAAI,CAAC,SAAS;YACZ,SAAS,GAAG,MAAM,+CAAsB,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;QAEhF,IAAI,SAAS,KAAK,SAAS,IAAI,QAAQ,CAAC,IAAI,CAAC,UAAU,EAAE;YACvD,iFAAiF;YACjF,QAAQ,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;YAC9B,yBAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,CAAC;YAC3D,QAAQ,CAAC,aAAa,EAAE,CAAC;SAC1B;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,IAAI,CAAC,QAAwB;QACzC,MAAM,SAAS,GAAG,+CAAsB,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QAClE,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,OAAO,EAAE,CAAC;IACvB,CAAC;IAED,gBAAgB;IACT,MAAM,KAAK,SAAS;QACzB,iBAAiB,CAAC,IAAI,CAAC,CAAC;QACxB,OAAO,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC;IAClC,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,aAAa,CAAC,IAAiB;QAC3C,iBAAiB,CAAC,IAAI,CAAC,CAAC;QACxB,QAAQ,IAAI,EAAE;YACZ,KAAK,yBAAW,CAAC,IAAI;gBACnB,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC;YACrC,KAAK,yBAAW,CAAC,SAAS;gBACxB,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,SAAS,CAAC;YAC1C,KAAK,yBAAW,CAAC,MAAM;gBACrB,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC;YACvC;gBACE,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC;SACzC;IACH,CAAC;;AAhPH,sCAiPC;AA7OgB,2BAAa,GAAwB,EAAE,CAAC;AACxC,6BAAe,GAA0B,EAAE,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module HyperModeling\r\n */\r\n\r\nimport { assert } from \"@itwin/core-bentley\";\r\nimport { SectionType } from \"@itwin/core-common\";\r\nimport { IModelApp, IModelConnection, ScreenViewport, tryImageElementFromUrl, ViewManip } from \"@itwin/core-frontend\";\r\nimport { registerTools } from \"./Tools\";\r\nimport { HyperModelingDecorator } from \"./HyperModelingDecorator\";\r\nimport { HyperModelingConfig, SectionGraphicsConfig, SectionMarkerConfig } from \"./HyperModelingConfig\";\r\nimport { SectionMarkerHandler } from \"./SectionMarkerHandler\";\r\n\r\n/** @internal */\r\nexport interface MarkerData {\r\n  readonly label: string;\r\n  readonly image: HTMLImageElement | undefined;\r\n}\r\n\r\ninterface Resources {\r\n  readonly namespace?: string;\r\n  readonly markers: {\r\n    readonly section: MarkerData;\r\n    readonly plan: MarkerData;\r\n    readonly elevation: MarkerData;\r\n    readonly detail: MarkerData;\r\n  };\r\n}\r\n\r\ninterface MaybeInitialized {\r\n  resources?: Resources;\r\n}\r\n\r\ninterface Initialized {\r\n  resources: Resources;\r\n}\r\n\r\nfunction assertInitialized(maybe: MaybeInitialized): asserts maybe is Initialized {\r\n  if (undefined === maybe.resources)\r\n    throw new Error(\"You must call HyperModeling.initialize before using the hypermodeling package\");\r\n}\r\n\r\n/** The API entry point for the hypermodeling package. Applications must call [[initialize]] and await the result before using the package.\r\n * The behavior of the package can be customized via a [[HyperModelingConfig]] supplied to [[initialize]], [[updateConfiguration]], or [[replaceConfiguration]].\r\n * Hypermodeling mode can be enabled or disabled via [[startOrStop]], which returns a [[HyperModelingDecorator]] when enabling hypermodeling.\r\n * Consult the package's `README.md` for a description of the available functionality.\r\n * @public\r\n */\r\nexport class HyperModeling {\r\n  /** @internal */\r\n  public static resources?: Resources;\r\n  private static _markerHandler?: SectionMarkerHandler;\r\n  private static _markerConfig: SectionMarkerConfig = {};\r\n  private static _graphicsConfig: SectionGraphicsConfig = {};\r\n\r\n  private static shutdown() {\r\n    this.resources = undefined;\r\n    this._markerHandler = undefined;\r\n    this._markerConfig = {};\r\n    this._graphicsConfig = {};\r\n  }\r\n\r\n  /** Returns whether the hypermodeling package is initialized.\r\n   * @see [[HyperModeling.initialize]] to initialize the package.\r\n   */\r\n  public static get isInitialized(): boolean {\r\n    return undefined !== this.resources;\r\n  }\r\n\r\n  /** Invoke this method to initialize the hypermodeling package for use. You *must* await the result before using any of this package's APIs.\r\n   * Typically an application would invoke this after [IModelApp.startup]($frontend), e.g.,\r\n   * ```ts\r\n   *  await IModelApp.startup();\r\n   *  await HyperModeling.initialize();\r\n   * ```\r\n   * Calling this method again after the first initialization behaves the same as calling [[HyperModeling.replaceConfiguration]].\r\n   * @note The hypermodeling package will be reset to uninitialized after [IModelApp.shutdown]($frontend) is invoked.\r\n   * @see [[replaceConfiguration]] and [[updateConfiguration]] to modify the configuration after initialization.\r\n   */\r\n  public static async initialize(config?: HyperModelingConfig): Promise<void> {\r\n    if (undefined !== this.resources) {\r\n      this.replaceConfiguration(config);\r\n      return;\r\n    }\r\n\r\n    // clean up if we're being shut down\r\n    IModelApp.onBeforeShutdown.addListener(() => this.shutdown());\r\n\r\n    const namespace = \"HyperModeling\";\r\n    await IModelApp.localization.registerNamespace(namespace);\r\n\r\n    const loadImages = [\r\n      tryImageElementFromUrl(`${IModelApp.publicPath}section-marker.svg`),\r\n      tryImageElementFromUrl(`${IModelApp.publicPath}detail-marker.svg`),\r\n      tryImageElementFromUrl(`${IModelApp.publicPath}elevation-marker.svg`),\r\n      tryImageElementFromUrl(`${IModelApp.publicPath}plan-marker.svg`),\r\n    ];\r\n\r\n    const images = await Promise.all(loadImages);\r\n    this.resources = {\r\n      namespace,\r\n      markers: {\r\n        section: { image: images[0], label: IModelApp.localization.getLocalizedString(\"HyperModeling:Message.SectionCallout\") },\r\n        detail: { image: images[1], label: IModelApp.localization.getLocalizedString(\"HyperModeling:Message.DetailCallout\") },\r\n        elevation: { image: images[2], label: IModelApp.localization.getLocalizedString(\"HyperModeling:Message.ElevationCallout\") },\r\n        plan: { image: images[3], label: IModelApp.localization.getLocalizedString(\"HyperModeling:Message.PlanCallout\") },\r\n      },\r\n    };\r\n\r\n    registerTools(namespace);\r\n    this.replaceConfiguration(config);\r\n  }\r\n\r\n  private static async ensureInitialized(): Promise<void> {\r\n    if (undefined === this.resources)\r\n      await this.initialize();\r\n\r\n    assertInitialized(this);\r\n  }\r\n\r\n  /** Replaces the current package configuration, overwriting all previous settings. Passing `undefined` resets all settings to defaults.\r\n   * @see [[HyperModeling.updateConfiguration]] for overriding specific aspects of the configuration.\r\n   */\r\n  public static replaceConfiguration(config?: HyperModelingConfig): void {\r\n    config = config ?? {};\r\n    this._markerHandler = config.markerHandler ?? new SectionMarkerHandler();\r\n    this._markerConfig = config.markers ? { ...config.markers } : {};\r\n    this._graphicsConfig = config.graphics ? { ...config.graphics } : {};\r\n  }\r\n\r\n  /** Overrides specific aspects of the current package configuration. Any field that is not `undefined` will be replaced in the current configuration;\r\n   * the rest will retain their current values.\r\n   * @see [[HyperModeling.replaceConfiguration]].\r\n   */\r\n  public static updateConfiguration(config: HyperModelingConfig): void {\r\n    this._markerHandler = config.markerHandler ?? this._markerHandler;\r\n\r\n    if (config.markers) {\r\n      this._markerConfig = {\r\n        ignoreModelSelector: config.markers.ignoreModelSelector ?? this._markerConfig.ignoreModelSelector,\r\n        ignoreCategorySelector: config.markers.ignoreCategorySelector ?? this._markerConfig.ignoreCategorySelector,\r\n        hiddenSectionTypes: config.markers.hiddenSectionTypes ?? this._markerConfig.hiddenSectionTypes,\r\n      };\r\n    }\r\n\r\n    if (config.graphics) {\r\n      this._graphicsConfig = {\r\n        ignoreClip: config.graphics.ignoreClip ?? this._graphicsConfig.ignoreClip,\r\n        debugClipVolumes: config.graphics.debugClipVolumes ?? this._graphicsConfig.debugClipVolumes,\r\n        hideSectionGraphics: config.graphics.hideSectionGraphics ?? this._graphicsConfig.hideSectionGraphics,\r\n        hideSheetAnnotations: config.graphics.hideSheetAnnotations ?? this._graphicsConfig.hideSheetAnnotations,\r\n      };\r\n\r\n      IModelApp.viewManager.invalidateViewportScenes();\r\n    }\r\n  }\r\n\r\n  /** The handler that defines interactions with [[SectionMarker]]s.\r\n   * @see [[initialize]] to override the default handler at package initialization.\r\n   * @see [[updateConfiguration]] or [[replaceConfiguration]] to change the current handler.\r\n   */\r\n  public static get markerHandler(): SectionMarkerHandler {\r\n    assertInitialized(this);\r\n    assert(undefined !== this._markerHandler);\r\n    return this._markerHandler;\r\n  }\r\n\r\n  /** The current marker display configuration applied to any newly-created [[HyperModelingDecorator]]s.\r\n   * @see [[initialize]] to override the default configuration at package initialization.\r\n   * @see [[updateConfiguration]] or [[replaceConfiguration]] to change the current configuration.\r\n   * @see [[HyperModelingDecorator.replaceConfiguration]] or [[HyperModelingDecorator.updateConfiguration]] to change the configuration for an existing decorator.\r\n   */\r\n  public static get markerConfig(): SectionMarkerConfig {\r\n    return this._markerConfig;\r\n  }\r\n\r\n  /** This graphics options applied to graphics displayed by all [[HyperModelingDecorator]]s.\r\n   * @see [[updateConfiguration]] or [[replaceConfiguration]] to change the current configuration.\r\n   */\r\n  public static get graphicsConfig(): SectionGraphicsConfig {\r\n    return this._graphicsConfig;\r\n  }\r\n\r\n  /** Returns true if the specified iModel contains any [SectionDrawingLocation]($backend)s. Hypermodeling is based on section drawing locations,\r\n   * so if none are present, hypermodeling features are not relevant to the iModel. Attempting to use those features with such an iModel is fine,\r\n   * but probably not useful.\r\n   */\r\n  public static async isSupportedForIModel(imodel: IModelConnection): Promise<boolean> {\r\n    try {\r\n      const nRows = await imodel.queryRowCount(\"SELECT ECInstanceId FROM bis.SectionDrawingLocation LIMIT 1\");\r\n      return nRows > 0;\r\n    } catch {\r\n      // An iModel with a version of BisCore older than 1.0.11 will produce an expected \"table not found\" on the SectionDrawingLocation ECClass.\r\n      return false;\r\n    }\r\n  }\r\n\r\n  /** Returns whether hypermodeling is currently enabled for the specified viewport.\r\n   * @see [[startOrStop]] to enable or disable hypermodeling for a viewport.\r\n   */\r\n  public static isEnabledForViewport(viewport: ScreenViewport): boolean {\r\n    return undefined !== HyperModelingDecorator.getForViewport(viewport);\r\n  }\r\n\r\n  /** Start or stop hypermodeling mode for the specified viewport.\r\n   * Enabling hypermodeling registers and returns a [[HyperModelingDecorator]] to display [[SectionMarker]]s within the viewport.\r\n   * Disabling hypermodeling removes that decorator.\r\n   * @param viewport The hypermodeling viewport\r\n   * @param start `true` to enter hypermodeling mode, `false` to exit, or `undefined` to toggle the current mode.\r\n   * @returns The new decorator is hypermodeling was successfully enabled.\r\n   * @note Enabling hypermodeling may fail if the viewport is not viewing a spatial model or if the viewport's iModel does not support hypermodeling.\r\n   * @see [[start]] and [[stop]].\r\n   * @see [[isSupportedForIModel]].\r\n   */\r\n  public static async startOrStop(viewport: ScreenViewport, start?: boolean): Promise<HyperModelingDecorator | undefined> {\r\n    // Help out the caller since we're async anyway...\r\n    await this.ensureInitialized();\r\n\r\n    const decorator = HyperModelingDecorator.getForViewport(viewport);\r\n    if (undefined === start)\r\n      start = undefined === decorator;\r\n\r\n    if (start) {\r\n      return this._start(viewport);\r\n    } else {\r\n      decorator?.dispose();\r\n      return undefined;\r\n    }\r\n  }\r\n\r\n  /** Start hypermodeling mode for the specified viewport if it is not currently enabled.\r\n   * If hypermodeling is already enabled for the viewport, the existing decorator is returned; otherwise, a new decorator is created.\r\n   * @param viewport The viewport for which to enable hypermodeling\r\n   * @returns The decorator that implements hypermodeling features for the viewport, or `undefined` if hypermodeling could not be enabled.\r\n   * @note Enabling hypermodeling may fail if the viewport is not viewing a spatial model or if the viewport's iModel does not support hypermodeling.\r\n   */\r\n  public static async start(viewport: ScreenViewport): Promise<HyperModelingDecorator | undefined> {\r\n    await this.ensureInitialized();\r\n    return this._start(viewport);\r\n  }\r\n\r\n  private static async _start(viewport: ScreenViewport): Promise<HyperModelingDecorator | undefined> {\r\n    assertInitialized(this);\r\n    if (!viewport.view.isSpatialView())\r\n      return undefined;\r\n\r\n    let decorator = HyperModelingDecorator.getForViewport(viewport);\r\n    if (!decorator)\r\n      decorator = await HyperModelingDecorator.create(viewport, this._markerConfig);\r\n\r\n    if (undefined !== decorator && viewport.view.isCameraOn) {\r\n      // We want the 2d graphics to align with the 3d geometry. Perspective ruins that.\r\n      viewport.view.turnCameraOff();\r\n      ViewManip.fitView(viewport, false, { noSaveInUndo: true });\r\n      viewport.clearViewUndo();\r\n    }\r\n\r\n    return decorator;\r\n  }\r\n\r\n  /** Stop hypermodeling mode for the specified viewport if it is currently enabled. This disposes of the [[HyperModelingDecorator]] associated with the viewport.\r\n   * @see [[start]] to enable hypermodeling for a viewport.\r\n   * @see [[startOrStop]] to toggle hypermodeling mode.\r\n   */\r\n  public static stop(viewport: ScreenViewport): void {\r\n    const decorator = HyperModelingDecorator.getForViewport(viewport);\r\n    decorator?.dispose();\r\n  }\r\n\r\n  /** @internal */\r\n  public static get namespace(): string | undefined {\r\n    assertInitialized(this);\r\n    return this.resources.namespace;\r\n  }\r\n\r\n  /** @internal */\r\n  public static getMarkerData(type: SectionType): MarkerData {\r\n    assertInitialized(this);\r\n    switch (type) {\r\n      case SectionType.Plan:\r\n        return this.resources.markers.plan;\r\n      case SectionType.Elevation:\r\n        return this.resources.markers.elevation;\r\n      case SectionType.Detail:\r\n        return this.resources.markers.detail;\r\n      default:\r\n        return this.resources.markers.section;\r\n    }\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"HyperModeling.js","sourceRoot":"","sources":["../../src/HyperModeling.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA6C;AAC7C,oDAAiD;AACjD,wDAAsH;AACtH,mCAAwC;AACxC,qEAAkE;AAElE,iEAA8D;AA0B9D,SAAS,iBAAiB,CAAC,KAAuB;IAChD,IAAI,SAAS,KAAK,KAAK,CAAC,SAAS;QAC/B,MAAM,IAAI,KAAK,CAAC,+EAA+E,CAAC,CAAC;AACrG,CAAC;AAED;;;;;GAKG;AACH,MAAa,aAAa;IAOhB,MAAM,CAAC,QAAQ;QACrB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC;QAChC,IAAI,CAAC,aAAa,GAAG,EAAE,CAAC;QACxB,IAAI,CAAC,eAAe,GAAG,EAAE,CAAC;IAC5B,CAAC;IAED;;OAEG;IACI,MAAM,KAAK,aAAa;QAC7B,OAAO,SAAS,KAAK,IAAI,CAAC,SAAS,CAAC;IACtC,CAAC;IAED;;;;;;;;;OASG;IACI,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,MAA4B;QACzD,IAAI,SAAS,KAAK,IAAI,CAAC,SAAS,EAAE;YAChC,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;YAClC,OAAO;SACR;QAED,oCAAoC;QACpC,yBAAS,CAAC,gBAAgB,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QAE9D,MAAM,SAAS,GAAG,eAAe,CAAC;QAClC,MAAM,yBAAS,CAAC,YAAY,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC;QAE1D,MAAM,UAAU,GAAG;YACjB,IAAA,sCAAsB,EAAC,GAAG,yBAAS,CAAC,UAAU,oBAAoB,CAAC;YACnE,IAAA,sCAAsB,EAAC,GAAG,yBAAS,CAAC,UAAU,mBAAmB,CAAC;YAClE,IAAA,sCAAsB,EAAC,GAAG,yBAAS,CAAC,UAAU,sBAAsB,CAAC;YACrE,IAAA,sCAAsB,EAAC,GAAG,yBAAS,CAAC,UAAU,iBAAiB,CAAC;SACjE,CAAC;QAEF,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAC7C,IAAI,CAAC,SAAS,GAAG;YACf,SAAS;YACT,OAAO,EAAE;gBACP,OAAO,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,yBAAS,CAAC,YAAY,CAAC,kBAAkB,CAAC,sCAAsC,CAAC,EAAE;gBACvH,MAAM,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,yBAAS,CAAC,YAAY,CAAC,kBAAkB,CAAC,qCAAqC,CAAC,EAAE;gBACrH,SAAS,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,yBAAS,CAAC,YAAY,CAAC,kBAAkB,CAAC,wCAAwC,CAAC,EAAE;gBAC3H,IAAI,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,yBAAS,CAAC,YAAY,CAAC,kBAAkB,CAAC,mCAAmC,CAAC,EAAE;aAClH;SACF,CAAC;QAEF,IAAA,qBAAa,EAAC,SAAS,CAAC,CAAC;QACzB,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;IACpC,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,iBAAiB;QACpC,IAAI,SAAS,KAAK,IAAI,CAAC,SAAS;YAC9B,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;QAE1B,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,oBAAoB,CAAC,MAA4B;QAC7D,MAAM,GAAG,MAAM,IAAI,EAAE,CAAC;QACtB,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC,aAAa,IAAI,IAAI,2CAAoB,EAAE,CAAC;QACzE,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACjE,IAAI,CAAC,eAAe,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IACvE,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,mBAAmB,CAAC,MAA2B;QAC3D,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC,aAAa,IAAI,IAAI,CAAC,cAAc,CAAC;QAElE,IAAI,MAAM,CAAC,OAAO,EAAE;YAClB,IAAI,CAAC,aAAa,GAAG;gBACnB,mBAAmB,EAAE,MAAM,CAAC,OAAO,CAAC,mBAAmB,IAAI,IAAI,CAAC,aAAa,CAAC,mBAAmB;gBACjG,sBAAsB,EAAE,MAAM,CAAC,OAAO,CAAC,sBAAsB,IAAI,IAAI,CAAC,aAAa,CAAC,sBAAsB;gBAC1G,kBAAkB,EAAE,MAAM,CAAC,OAAO,CAAC,kBAAkB,IAAI,IAAI,CAAC,aAAa,CAAC,kBAAkB;aAC/F,CAAC;SACH;QAED,IAAI,MAAM,CAAC,QAAQ,EAAE;YACnB,IAAI,CAAC,eAAe,GAAG;gBACrB,UAAU,EAAE,MAAM,CAAC,QAAQ,CAAC,UAAU,IAAI,IAAI,CAAC,eAAe,CAAC,UAAU;gBACzE,gBAAgB,EAAE,MAAM,CAAC,QAAQ,CAAC,gBAAgB,IAAI,IAAI,CAAC,eAAe,CAAC,gBAAgB;gBAC3F,mBAAmB,EAAE,MAAM,CAAC,QAAQ,CAAC,mBAAmB,IAAI,IAAI,CAAC,eAAe,CAAC,mBAAmB;gBACpG,oBAAoB,EAAE,MAAM,CAAC,QAAQ,CAAC,oBAAoB,IAAI,IAAI,CAAC,eAAe,CAAC,oBAAoB;aACxG,CAAC;YAEF,yBAAS,CAAC,WAAW,CAAC,wBAAwB,EAAE,CAAC;SAClD;IACH,CAAC;IAED;;;OAGG;IACI,MAAM,KAAK,aAAa;QAC7B,iBAAiB,CAAC,IAAI,CAAC,CAAC;QACxB,IAAA,qBAAM,EAAC,SAAS,KAAK,IAAI,CAAC,cAAc,CAAC,CAAC;QAC1C,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACI,MAAM,KAAK,YAAY;QAC5B,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED;;OAEG;IACI,MAAM,KAAK,cAAc;QAC9B,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,KAAK,CAAC,oBAAoB,CAAC,MAAwB;QAC/D,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,CAAC,iBAAiB,CAAC,6DAA6D,CAAC,CAAC;YACvG,OAAO,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,sCAAsC;SACnE;QAAC,MAAM;YACN,0IAA0I;YAC1I,OAAO,KAAK,CAAC;SACd;IACH,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,oBAAoB,CAAC,QAAwB;QACzD,OAAO,SAAS,KAAK,+CAAsB,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;OASG;IACI,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,QAAwB,EAAE,KAAe;QACvE,kDAAkD;QAClD,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAE/B,MAAM,SAAS,GAAG,+CAAsB,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QAClE,IAAI,SAAS,KAAK,KAAK;YACrB,KAAK,GAAG,SAAS,KAAK,SAAS,CAAC;QAElC,IAAI,KAAK,EAAE;YACT,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;SAC9B;aAAM;YACL,SAAS,EAAE,OAAO,EAAE,CAAC;YACrB,OAAO,SAAS,CAAC;SAClB;IACH,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,QAAwB;QAChD,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAC/B,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAC/B,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,QAAwB;QAClD,iBAAiB,CAAC,IAAI,CAAC,CAAC;QACxB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,EAAE;YAChC,OAAO,SAAS,CAAC;QAEnB,IAAI,SAAS,GAAG,+CAAsB,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QAChE,IAAI,CAAC,SAAS;YACZ,SAAS,GAAG,MAAM,+CAAsB,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;QAEhF,IAAI,SAAS,KAAK,SAAS,IAAI,QAAQ,CAAC,IAAI,CAAC,UAAU,EAAE;YACvD,iFAAiF;YACjF,QAAQ,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;YAC9B,yBAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,CAAC;YAC3D,QAAQ,CAAC,aAAa,EAAE,CAAC;SAC1B;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,IAAI,CAAC,QAAwB;QACzC,MAAM,SAAS,GAAG,+CAAsB,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QAClE,SAAS,EAAE,OAAO,EAAE,CAAC;IACvB,CAAC;IAED,gBAAgB;IACT,MAAM,KAAK,SAAS;QACzB,iBAAiB,CAAC,IAAI,CAAC,CAAC;QACxB,OAAO,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC;IAClC,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,aAAa,CAAC,IAAiB;QAC3C,iBAAiB,CAAC,IAAI,CAAC,CAAC;QACxB,QAAQ,IAAI,EAAE;YACZ,KAAK,yBAAW,CAAC,IAAI;gBACnB,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC;YACrC,KAAK,yBAAW,CAAC,SAAS;gBACxB,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,SAAS,CAAC;YAC1C,KAAK,yBAAW,CAAC,MAAM;gBACrB,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC;YACvC;gBACE,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC;SACzC;IACH,CAAC;;AA5Oc,2BAAa,GAAwB,EAAE,CAAC;AACxC,6BAAe,GAA0B,EAAE,CAAC;AALhD,sCAAa","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module HyperModeling\r\n */\r\n\r\nimport { assert } from \"@itwin/core-bentley\";\r\nimport { SectionType } from \"@itwin/core-common\";\r\nimport { IModelApp, IModelConnection, ScreenViewport, tryImageElementFromUrl, ViewManip } from \"@itwin/core-frontend\";\r\nimport { registerTools } from \"./Tools\";\r\nimport { HyperModelingDecorator } from \"./HyperModelingDecorator\";\r\nimport { HyperModelingConfig, SectionGraphicsConfig, SectionMarkerConfig } from \"./HyperModelingConfig\";\r\nimport { SectionMarkerHandler } from \"./SectionMarkerHandler\";\r\n\r\n/** @internal */\r\nexport interface MarkerData {\r\n  readonly label: string;\r\n  readonly image: HTMLImageElement | undefined;\r\n}\r\n\r\ninterface Resources {\r\n  readonly namespace?: string;\r\n  readonly markers: {\r\n    readonly section: MarkerData;\r\n    readonly plan: MarkerData;\r\n    readonly elevation: MarkerData;\r\n    readonly detail: MarkerData;\r\n  };\r\n}\r\n\r\ninterface MaybeInitialized {\r\n  resources?: Resources;\r\n}\r\n\r\ninterface Initialized {\r\n  resources: Resources;\r\n}\r\n\r\nfunction assertInitialized(maybe: MaybeInitialized): asserts maybe is Initialized {\r\n  if (undefined === maybe.resources)\r\n    throw new Error(\"You must call HyperModeling.initialize before using the hypermodeling package\");\r\n}\r\n\r\n/** The API entry point for the hypermodeling package. Applications must call [[initialize]] and await the result before using the package.\r\n * The behavior of the package can be customized via a [[HyperModelingConfig]] supplied to [[initialize]], [[updateConfiguration]], or [[replaceConfiguration]].\r\n * Hypermodeling mode can be enabled or disabled via [[startOrStop]], which returns a [[HyperModelingDecorator]] when enabling hypermodeling.\r\n * Consult the package's `README.md` for a description of the available functionality.\r\n * @public\r\n */\r\nexport class HyperModeling {\r\n  /** @internal */\r\n  public static resources?: Resources;\r\n  private static _markerHandler?: SectionMarkerHandler;\r\n  private static _markerConfig: SectionMarkerConfig = {};\r\n  private static _graphicsConfig: SectionGraphicsConfig = {};\r\n\r\n  private static shutdown() {\r\n    this.resources = undefined;\r\n    this._markerHandler = undefined;\r\n    this._markerConfig = {};\r\n    this._graphicsConfig = {};\r\n  }\r\n\r\n  /** Returns whether the hypermodeling package is initialized.\r\n   * @see [[HyperModeling.initialize]] to initialize the package.\r\n   */\r\n  public static get isInitialized(): boolean {\r\n    return undefined !== this.resources;\r\n  }\r\n\r\n  /** Invoke this method to initialize the hypermodeling package for use. You *must* await the result before using any of this package's APIs.\r\n   * Typically an application would invoke this after [IModelApp.startup]($frontend), e.g.,\r\n   * ```ts\r\n   *  await IModelApp.startup();\r\n   *  await HyperModeling.initialize();\r\n   * ```\r\n   * Calling this method again after the first initialization behaves the same as calling [[HyperModeling.replaceConfiguration]].\r\n   * @note The hypermodeling package will be reset to uninitialized after [IModelApp.shutdown]($frontend) is invoked.\r\n   * @see [[replaceConfiguration]] and [[updateConfiguration]] to modify the configuration after initialization.\r\n   */\r\n  public static async initialize(config?: HyperModelingConfig): Promise<void> {\r\n    if (undefined !== this.resources) {\r\n      this.replaceConfiguration(config);\r\n      return;\r\n    }\r\n\r\n    // clean up if we're being shut down\r\n    IModelApp.onBeforeShutdown.addListener(() => this.shutdown());\r\n\r\n    const namespace = \"HyperModeling\";\r\n    await IModelApp.localization.registerNamespace(namespace);\r\n\r\n    const loadImages = [\r\n      tryImageElementFromUrl(`${IModelApp.publicPath}section-marker.svg`),\r\n      tryImageElementFromUrl(`${IModelApp.publicPath}detail-marker.svg`),\r\n      tryImageElementFromUrl(`${IModelApp.publicPath}elevation-marker.svg`),\r\n      tryImageElementFromUrl(`${IModelApp.publicPath}plan-marker.svg`),\r\n    ];\r\n\r\n    const images = await Promise.all(loadImages);\r\n    this.resources = {\r\n      namespace,\r\n      markers: {\r\n        section: { image: images[0], label: IModelApp.localization.getLocalizedString(\"HyperModeling:Message.SectionCallout\") },\r\n        detail: { image: images[1], label: IModelApp.localization.getLocalizedString(\"HyperModeling:Message.DetailCallout\") },\r\n        elevation: { image: images[2], label: IModelApp.localization.getLocalizedString(\"HyperModeling:Message.ElevationCallout\") },\r\n        plan: { image: images[3], label: IModelApp.localization.getLocalizedString(\"HyperModeling:Message.PlanCallout\") },\r\n      },\r\n    };\r\n\r\n    registerTools(namespace);\r\n    this.replaceConfiguration(config);\r\n  }\r\n\r\n  private static async ensureInitialized(): Promise<void> {\r\n    if (undefined === this.resources)\r\n      await this.initialize();\r\n\r\n    assertInitialized(this);\r\n  }\r\n\r\n  /** Replaces the current package configuration, overwriting all previous settings. Passing `undefined` resets all settings to defaults.\r\n   * @see [[HyperModeling.updateConfiguration]] for overriding specific aspects of the configuration.\r\n   */\r\n  public static replaceConfiguration(config?: HyperModelingConfig): void {\r\n    config = config ?? {};\r\n    this._markerHandler = config.markerHandler ?? new SectionMarkerHandler();\r\n    this._markerConfig = config.markers ? { ...config.markers } : {};\r\n    this._graphicsConfig = config.graphics ? { ...config.graphics } : {};\r\n  }\r\n\r\n  /** Overrides specific aspects of the current package configuration. Any field that is not `undefined` will be replaced in the current configuration;\r\n   * the rest will retain their current values.\r\n   * @see [[HyperModeling.replaceConfiguration]].\r\n   */\r\n  public static updateConfiguration(config: HyperModelingConfig): void {\r\n    this._markerHandler = config.markerHandler ?? this._markerHandler;\r\n\r\n    if (config.markers) {\r\n      this._markerConfig = {\r\n        ignoreModelSelector: config.markers.ignoreModelSelector ?? this._markerConfig.ignoreModelSelector,\r\n        ignoreCategorySelector: config.markers.ignoreCategorySelector ?? this._markerConfig.ignoreCategorySelector,\r\n        hiddenSectionTypes: config.markers.hiddenSectionTypes ?? this._markerConfig.hiddenSectionTypes,\r\n      };\r\n    }\r\n\r\n    if (config.graphics) {\r\n      this._graphicsConfig = {\r\n        ignoreClip: config.graphics.ignoreClip ?? this._graphicsConfig.ignoreClip,\r\n        debugClipVolumes: config.graphics.debugClipVolumes ?? this._graphicsConfig.debugClipVolumes,\r\n        hideSectionGraphics: config.graphics.hideSectionGraphics ?? this._graphicsConfig.hideSectionGraphics,\r\n        hideSheetAnnotations: config.graphics.hideSheetAnnotations ?? this._graphicsConfig.hideSheetAnnotations,\r\n      };\r\n\r\n      IModelApp.viewManager.invalidateViewportScenes();\r\n    }\r\n  }\r\n\r\n  /** The handler that defines interactions with [[SectionMarker]]s.\r\n   * @see [[initialize]] to override the default handler at package initialization.\r\n   * @see [[updateConfiguration]] or [[replaceConfiguration]] to change the current handler.\r\n   */\r\n  public static get markerHandler(): SectionMarkerHandler {\r\n    assertInitialized(this);\r\n    assert(undefined !== this._markerHandler);\r\n    return this._markerHandler;\r\n  }\r\n\r\n  /** The current marker display configuration applied to any newly-created [[HyperModelingDecorator]]s.\r\n   * @see [[initialize]] to override the default configuration at package initialization.\r\n   * @see [[updateConfiguration]] or [[replaceConfiguration]] to change the current configuration.\r\n   * @see [[HyperModelingDecorator.replaceConfiguration]] or [[HyperModelingDecorator.updateConfiguration]] to change the configuration for an existing decorator.\r\n   */\r\n  public static get markerConfig(): SectionMarkerConfig {\r\n    return this._markerConfig;\r\n  }\r\n\r\n  /** This graphics options applied to graphics displayed by all [[HyperModelingDecorator]]s.\r\n   * @see [[updateConfiguration]] or [[replaceConfiguration]] to change the current configuration.\r\n   */\r\n  public static get graphicsConfig(): SectionGraphicsConfig {\r\n    return this._graphicsConfig;\r\n  }\r\n\r\n  /** Returns true if the specified iModel contains any [SectionDrawingLocation]($backend)s. Hypermodeling is based on section drawing locations,\r\n   * so if none are present, hypermodeling features are not relevant to the iModel. Attempting to use those features with such an iModel is fine,\r\n   * but probably not useful.\r\n   */\r\n  public static async isSupportedForIModel(imodel: IModelConnection): Promise<boolean> {\r\n    try {\r\n      const reader = imodel.createQueryReader(\"SELECT ECInstanceId FROM bis.SectionDrawingLocation LIMIT 1\");\r\n      return await reader.step(); // i.e., are any results are returned?\r\n    } catch {\r\n      // An iModel with a version of BisCore older than 1.0.11 will produce an expected \"table not found\" on the SectionDrawingLocation ECClass.\r\n      return false;\r\n    }\r\n  }\r\n\r\n  /** Returns whether hypermodeling is currently enabled for the specified viewport.\r\n   * @see [[startOrStop]] to enable or disable hypermodeling for a viewport.\r\n   */\r\n  public static isEnabledForViewport(viewport: ScreenViewport): boolean {\r\n    return undefined !== HyperModelingDecorator.getForViewport(viewport);\r\n  }\r\n\r\n  /** Start or stop hypermodeling mode for the specified viewport.\r\n   * Enabling hypermodeling registers and returns a [[HyperModelingDecorator]] to display [[SectionMarker]]s within the viewport.\r\n   * Disabling hypermodeling removes that decorator.\r\n   * @param viewport The hypermodeling viewport\r\n   * @param start `true` to enter hypermodeling mode, `false` to exit, or `undefined` to toggle the current mode.\r\n   * @returns The new decorator is hypermodeling was successfully enabled.\r\n   * @note Enabling hypermodeling may fail if the viewport is not viewing a spatial model or if the viewport's iModel does not support hypermodeling.\r\n   * @see [[start]] and [[stop]].\r\n   * @see [[isSupportedForIModel]].\r\n   */\r\n  public static async startOrStop(viewport: ScreenViewport, start?: boolean): Promise<HyperModelingDecorator | undefined> {\r\n    // Help out the caller since we're async anyway...\r\n    await this.ensureInitialized();\r\n\r\n    const decorator = HyperModelingDecorator.getForViewport(viewport);\r\n    if (undefined === start)\r\n      start = undefined === decorator;\r\n\r\n    if (start) {\r\n      return this._start(viewport);\r\n    } else {\r\n      decorator?.dispose();\r\n      return undefined;\r\n    }\r\n  }\r\n\r\n  /** Start hypermodeling mode for the specified viewport if it is not currently enabled.\r\n   * If hypermodeling is already enabled for the viewport, the existing decorator is returned; otherwise, a new decorator is created.\r\n   * @param viewport The viewport for which to enable hypermodeling\r\n   * @returns The decorator that implements hypermodeling features for the viewport, or `undefined` if hypermodeling could not be enabled.\r\n   * @note Enabling hypermodeling may fail if the viewport is not viewing a spatial model or if the viewport's iModel does not support hypermodeling.\r\n   */\r\n  public static async start(viewport: ScreenViewport): Promise<HyperModelingDecorator | undefined> {\r\n    await this.ensureInitialized();\r\n    return this._start(viewport);\r\n  }\r\n\r\n  private static async _start(viewport: ScreenViewport): Promise<HyperModelingDecorator | undefined> {\r\n    assertInitialized(this);\r\n    if (!viewport.view.isSpatialView())\r\n      return undefined;\r\n\r\n    let decorator = HyperModelingDecorator.getForViewport(viewport);\r\n    if (!decorator)\r\n      decorator = await HyperModelingDecorator.create(viewport, this._markerConfig);\r\n\r\n    if (undefined !== decorator && viewport.view.isCameraOn) {\r\n      // We want the 2d graphics to align with the 3d geometry. Perspective ruins that.\r\n      viewport.view.turnCameraOff();\r\n      ViewManip.fitView(viewport, false, { noSaveInUndo: true });\r\n      viewport.clearViewUndo();\r\n    }\r\n\r\n    return decorator;\r\n  }\r\n\r\n  /** Stop hypermodeling mode for the specified viewport if it is currently enabled. This disposes of the [[HyperModelingDecorator]] associated with the viewport.\r\n   * @see [[start]] to enable hypermodeling for a viewport.\r\n   * @see [[startOrStop]] to toggle hypermodeling mode.\r\n   */\r\n  public static stop(viewport: ScreenViewport): void {\r\n    const decorator = HyperModelingDecorator.getForViewport(viewport);\r\n    decorator?.dispose();\r\n  }\r\n\r\n  /** @internal */\r\n  public static get namespace(): string | undefined {\r\n    assertInitialized(this);\r\n    return this.resources.namespace;\r\n  }\r\n\r\n  /** @internal */\r\n  public static getMarkerData(type: SectionType): MarkerData {\r\n    assertInitialized(this);\r\n    switch (type) {\r\n      case SectionType.Plan:\r\n        return this.resources.markers.plan;\r\n      case SectionType.Elevation:\r\n        return this.resources.markers.elevation;\r\n      case SectionType.Detail:\r\n        return this.resources.markers.detail;\r\n      default:\r\n        return this.resources.markers.section;\r\n    }\r\n  }\r\n}\r\n"]}