@itwin/hypermodeling-frontend 3.0.0-dev.76 → 3.0.0-dev.80

package/lib/cjs/hypermodeling-frontend.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hypermodeling-frontend.js","sourceRoot":"","sources":["../../src/hypermodeling-frontend.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA;;;+FAG+F;AAC/F,kDAAgC;AAChC,wDAAsC;AACtC,2DAAyC;AACzC,yDAAuC;AACvC,gEAA8C;AAC9C,4DAA0C;AAC1C,mDAAiC;AAEjC;;GAEG;AAEH;;GAEG","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\nexport * from \"./HyperModeling\";\r\nexport * from \"./HyperModelingConfig\";\r\nexport * from \"./HyperModelingDecorator\";\r\nexport * from \"./SectionMarkerHandler\";\r\nexport * from \"./SectionDrawingLocationState\";\r\nexport * from \"./SectionGraphicsProvider\";\r\nexport * from \"./SectionMarkers\";\r\n\r\n/** @docs-package-description\r\n * The hypermodeling package enables visualization of section drawings in a spatial context.\r\n */\r\n\r\n/** @docs-group-description HyperModeling\r\n * APIs for controlling visualization of section drawings in a spatial context.\r\n */\r\n"]}

package/lib/esm/HyperModeling.d.ts

@@ -0,0 +1,109 @@
+/** @packageDocumentation
+ * @module HyperModeling
+ */
+import { SectionType } from "@itwin/core-common";
+import { IModelConnection, ScreenViewport } from "@itwin/core-frontend";
+import { HyperModelingDecorator } from "./HyperModelingDecorator";
+import { HyperModelingConfig, SectionGraphicsConfig, SectionMarkerConfig } from "./HyperModelingConfig";
+import { SectionMarkerHandler } from "./SectionMarkerHandler";
+/** @internal */
+export interface MarkerData {
+    readonly label: string;
+    readonly image: HTMLImageElement | undefined;
+}
+interface Resources {
+    readonly namespace?: string;
+    readonly markers: {
+        readonly section: MarkerData;
+        readonly plan: MarkerData;
+        readonly elevation: MarkerData;
+        readonly detail: MarkerData;
+    };
+}
+/** 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
+ */
+export declare class HyperModeling {
+    /** @internal */
+    static resources?: Resources;
+    private static _markerHandler?;
+    private static _markerConfig;
+    private static _graphicsConfig;
+    /** 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]].
+     * @see [[replaceConfiguration]] and [[updateConfiguration]] to modify the configuration after initialization.
+     */
+    static initialize(config?: HyperModelingConfig): Promise<void>;
+    private static ensureInitialized;
+    /** 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?: HyperModelingConfig): void;
+    /** 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: HyperModelingConfig): void;
+    /** 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(): SectionMarkerHandler;
+    /** 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(): SectionMarkerConfig;
+    /** This graphics options applied to graphics displayed by all [[HyperModelingDecorator]]s.
+     * @see [[updateConfiguration]] or [[replaceConfiguration]] to change the current configuration.
+     */
+    static get graphicsConfig(): SectionGraphicsConfig;
+    /** 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 isSupportedForIModel(imodel: IModelConnection): Promise<boolean>;
+    /** Returns whether hypermodeling is currently enabled for the specified viewport.
+     * @see [[startOrStop]] to enable or disable hypermodeling for a viewport.
+     */
+    static isEnabledForViewport(viewport: ScreenViewport): boolean;
+    /** 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 startOrStop(viewport: ScreenViewport, start?: boolean): Promise<HyperModelingDecorator | 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 start(viewport: ScreenViewport): Promise<HyperModelingDecorator | undefined>;
+    private static _start;
+    /** 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: ScreenViewport): void;
+    /** @internal */
+    static get namespace(): string | undefined;
+    /** @internal */
+    static getMarkerData(type: SectionType): MarkerData;
+}
+export {};
+//# sourceMappingURL=HyperModeling.d.ts.map

package/lib/esm/HyperModeling.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"HyperModeling.d.ts","sourceRoot":"","sources":["../../src/HyperModeling.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAa,gBAAgB,EAAE,cAAc,EAAqC,MAAM,sBAAsB,CAAC;AAEtH,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACxG,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAE9D,gBAAgB;AAChB,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,KAAK,EAAE,gBAAgB,GAAG,SAAS,CAAC;CAC9C;AAED,UAAU,SAAS;IACjB,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,OAAO,EAAE;QAChB,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC;QAC7B,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;QAC1B,QAAQ,CAAC,SAAS,EAAE,UAAU,CAAC;QAC/B,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC;KAC7B,CAAC;CACH;AAeD;;;;;GAKG;AACH,qBAAa,aAAa;IACxB,gBAAgB;IAChB,OAAc,SAAS,CAAC,EAAE,SAAS,CAAC;IACpC,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC,CAAuB;IACrD,OAAO,CAAC,MAAM,CAAC,aAAa,CAA2B;IACvD,OAAO,CAAC,MAAM,CAAC,eAAe,CAA6B;IAE3D;;;;;;;;OAQG;WACiB,UAAU,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;mBA+BtD,iBAAiB;IAOtC;;OAEG;WACW,oBAAoB,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI;IAOtE;;;OAGG;WACW,mBAAmB,CAAC,MAAM,EAAE,mBAAmB,GAAG,IAAI;IAuBpE;;;OAGG;IACH,WAAkB,aAAa,IAAI,oBAAoB,CAItD;IAED;;;;OAIG;IACH,WAAkB,YAAY,IAAI,mBAAmB,CAEpD;IAED;;OAEG;IACH,WAAkB,cAAc,IAAI,qBAAqB,CAExD;IAED;;;OAGG;WACiB,oBAAoB,CAAC,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC;IAUpF;;OAEG;WACW,oBAAoB,CAAC,QAAQ,EAAE,cAAc,GAAG,OAAO;IAIrE;;;;;;;;;OASG;WACiB,WAAW,CAAC,QAAQ,EAAE,cAAc,EAAE,KAAK,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,sBAAsB,GAAG,SAAS,CAAC;IAgBvH;;;;;OAKG;WACiB,KAAK,CAAC,QAAQ,EAAE,cAAc,GAAG,OAAO,CAAC,sBAAsB,GAAG,SAAS,CAAC;mBAK3E,MAAM;IAmB3B;;;OAGG;WACW,IAAI,CAAC,QAAQ,EAAE,cAAc,GAAG,IAAI;IAKlD,gBAAgB;IAChB,WAAkB,SAAS,IAAI,MAAM,GAAG,SAAS,CAGhD;IAED,gBAAgB;WACF,aAAa,CAAC,IAAI,EAAE,WAAW,GAAG,UAAU;CAa3D"}

package/lib/esm/HyperModeling.js

@@ -0,0 +1,221 @@
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+import { assert } from "@itwin/core-bentley";
+import { SectionType } from "@itwin/core-common";
+import { IModelApp, tryImageElementFromUrl, ViewManip } from "@itwin/core-frontend";
+import { registerTools } from "./Tools";
+import { HyperModelingDecorator } from "./HyperModelingDecorator";
+import { SectionMarkerHandler } from "./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
+ */
+export class HyperModeling {
+    /** 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]].
+     * @see [[replaceConfiguration]] and [[updateConfiguration]] to modify the configuration after initialization.
+     */
+    static async initialize(config) {
+        if (undefined !== this.resources) {
+            this.replaceConfiguration(config);
+            return;
+        }
+        const namespace = "HyperModeling";
+        await IModelApp.localization.registerNamespace(namespace);
+        const loadImages = [
+            tryImageElementFromUrl("section-marker.svg"),
+            tryImageElementFromUrl("detail-marker.svg"),
+            tryImageElementFromUrl("elevation-marker.svg"),
+            tryImageElementFromUrl("plan-marker.svg"),
+        ];
+        const images = await Promise.all(loadImages);
+        this.resources = {
+            namespace,
+            markers: {
+                section: { image: images[0], label: IModelApp.localization.getLocalizedString("HyperModeling:Message.SectionCallout") },
+                detail: { image: images[1], label: IModelApp.localization.getLocalizedString("HyperModeling:Message.DetailCallout") },
+                elevation: { image: images[2], label: IModelApp.localization.getLocalizedString("HyperModeling:Message.ElevationCallout") },
+                plan: { image: images[3], label: IModelApp.localization.getLocalizedString("HyperModeling:Message.PlanCallout") },
+            },
+        };
+        registerTools(namespace, IModelApp.localization);
+        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();
+        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,
+            };
+            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);
+        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.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.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.getForViewport(viewport);
+        if (!decorator)
+            decorator = await 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();
+            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.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 SectionType.Plan:
+                return this.resources.markers.plan;
+            case SectionType.Elevation:
+                return this.resources.markers.elevation;
+            case SectionType.Detail:
+                return this.resources.markers.detail;
+            default:
+                return this.resources.markers.section;
+        }
+    }
+}
+HyperModeling._markerConfig = {};
+HyperModeling._graphicsConfig = {};
+//# sourceMappingURL=HyperModeling.js.map

package/lib/esm/HyperModeling.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HyperModeling.js","sourceRoot":"","sources":["../../src/HyperModeling.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,SAAS,EAAoC,sBAAsB,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACtH,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AACxC,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAElE,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;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,MAAM,OAAO,aAAa;IAOxB;;;;;;;;OAQG;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,MAAM,SAAS,GAAG,eAAe,CAAC;QAClC,MAAM,SAAS,CAAC,YAAY,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC;QAE1D,MAAM,UAAU,GAAG;YACjB,sBAAsB,CAAC,oBAAoB,CAAC;YAC5C,sBAAsB,CAAC,mBAAmB,CAAC;YAC3C,sBAAsB,CAAC,sBAAsB,CAAC;YAC9C,sBAAsB,CAAC,iBAAiB,CAAC;SAC1C,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,SAAS,CAAC,YAAY,CAAC,kBAAkB,CAAC,sCAAsC,CAAC,EAAE;gBACvH,MAAM,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,SAAS,CAAC,YAAY,CAAC,kBAAkB,CAAC,qCAAqC,CAAC,EAAE;gBACrH,SAAS,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,SAAS,CAAC,YAAY,CAAC,kBAAkB,CAAC,wCAAwC,CAAC,EAAE;gBAC3H,IAAI,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,SAAS,CAAC,YAAY,CAAC,kBAAkB,CAAC,mCAAmC,CAAC,EAAE;aAClH;SACF,CAAC;QAEF,aAAa,CAAC,SAAS,EAAE,SAAS,CAAC,YAAY,CAAC,CAAC;QACjD,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,oBAAoB,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,SAAS,CAAC,WAAW,CAAC,wBAAwB,EAAE,CAAC;SAClD;IACH,CAAC;IAED;;;OAGG;IACI,MAAM,KAAK,aAAa;QAC7B,iBAAiB,CAAC,IAAI,CAAC,CAAC;QACxB,MAAM,CAAC,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,sBAAsB,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,sBAAsB,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,sBAAsB,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QAChE,IAAI,CAAC,SAAS;YACZ,SAAS,GAAG,MAAM,sBAAsB,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,SAAS,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,sBAAsB,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,WAAW,CAAC,IAAI;gBACnB,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC;YACrC,KAAK,WAAW,CAAC,SAAS;gBACxB,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,SAAS,CAAC;YAC1C,KAAK,WAAW,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;;AA1Nc,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  /** 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   * @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    const namespace = \"HyperModeling\";\r\n    await IModelApp.localization.registerNamespace(namespace);\r\n\r\n    const loadImages = [\r\n      tryImageElementFromUrl(\"section-marker.svg\"),\r\n      tryImageElementFromUrl(\"detail-marker.svg\"),\r\n      tryImageElementFromUrl(\"elevation-marker.svg\"),\r\n      tryImageElementFromUrl(\"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, IModelApp.localization);\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"]}

package/lib/esm/HyperModelingConfig.d.ts

@@ -0,0 +1,55 @@
+/** @packageDocumentation
+ * @module HyperModeling
+ */
+import { SectionType } from "@itwin/core-common";
+import { SectionMarkerHandler } from "./SectionMarkerHandler";
+/** Configures display of [[SectionMarker]]s for [[HyperModelingDecorator]]s.
+ * @see [[HyperModelingDecorator.updateConfiguration]] or [[HyperModelingDecorator.replaceConfiguration]] to change the configuration for a specific decorator.
+ * @see [[HyperModeling.initialize]] to set the default configuration for all decorators at package initialization.
+ * @see [[HyperModeling.updateConfiguration]] or [[HyperModeling.replaceConfiguration]] to change the default configuration for all subsequently created decorators.
+ * @see [[HyperModelingConfig]].
+ * @public
+ */
+export interface SectionMarkerConfig {
+    /** Whether to hide markers belonging to models that are not present in the view's [ModelSelector]($backend). If true, markers are displayed regardless of their models. */
+    readonly ignoreModelSelector?: boolean;
+    /** Whether to hide markers belonging to categories that are not present in the view's [CategorySelector]($backend). If true, markers are displayed regardless of their categories. */
+    readonly ignoreCategorySelector?: boolean;
+    /** A list of types of section markers that shouold not be displayed. By default, markers for all section types are displayed. */
+    readonly hiddenSectionTypes?: SectionType[];
+}
+/** Configures how 2d graphics are displayed by a [[HyperModelingDecorator]] when hypermodeling is active.
+ * This configuration is used primarily for debugging, and applies globally to section graphics associated with all [[HyperModelingDecorator]]s.
+ * @see [[HyperModeling.initialize]] to set this configuration at package initialization.
+ * @see [[HyperModeling.updateConfiguration]] or [[HyperModeling.replaceConfiguration]] to change this configuration after package initialization.
+ * @see [[HyperModelingConfig]].
+ * @public
+ */
+export interface SectionGraphicsConfig {
+    /** If true, 2d graphics will not be clipped. */
+    readonly ignoreClip?: boolean;
+    /** If true, clip volumes for 2d graphics are displayed as shapes. */
+    readonly debugClipVolumes?: boolean;
+    /** If true, [SectionDrawing]($backend) graphics will not be displayed.
+     * @see [[hideSheetAnnotations]]
+     */
+    readonly hideSectionGraphics?: boolean;
+    /** If true, [Sheet]($backend) annotation graphics will not be displayed.
+     * @see [[hideSectionGraphics]]
+     */
+    readonly hideSheetAnnotations?: boolean;
+}
+/** Configuration options for the hyper-modeling package.
+ * @see [[HyperModeling.initialize]] to set the configuration at package initialization.
+ * @see [[HyperModeling.updateConfiguration]] or [[HyperModeling.replaceConfiguration]] to modify the configuration after package initialization.
+ * @public
+ */
+export interface HyperModelingConfig {
+    /** Specifies how the user interacts with [[SectionMarker]]s. If omitted, the default interactions will be used. */
+    readonly markerHandler?: SectionMarkerHandler;
+    /** Default [[SectionMarker]] display configuration used when creating a new [[HyperModelingDecorator]]. */
+    readonly markers?: SectionMarkerConfig;
+    /** Global section graphics configuration used by all [[HyperModelingDecorator]]s when displaying drawings and sheets in a spatial view. Primarily for debugging. */
+    readonly graphics?: SectionGraphicsConfig;
+}
+//# sourceMappingURL=HyperModelingConfig.d.ts.map

package/lib/esm/HyperModelingConfig.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"HyperModelingConfig.d.ts","sourceRoot":"","sources":["../../src/HyperModelingConfig.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAE9D;;;;;;GAMG;AACH,MAAM,WAAW,mBAAmB;IAClC,2KAA2K;IAC3K,QAAQ,CAAC,mBAAmB,CAAC,EAAE,OAAO,CAAC;IACvC,sLAAsL;IACtL,QAAQ,CAAC,sBAAsB,CAAC,EAAE,OAAO,CAAC;IAC1C,iIAAiI;IACjI,QAAQ,CAAC,kBAAkB,CAAC,EAAE,WAAW,EAAE,CAAC;CAC7C;AAED;;;;;;GAMG;AACH,MAAM,WAAW,qBAAqB;IACpC,gDAAgD;IAChD,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC;IAC9B,qEAAqE;IACrE,QAAQ,CAAC,gBAAgB,CAAC,EAAE,OAAO,CAAC;IACpC;;OAEG;IACH,QAAQ,CAAC,mBAAmB,CAAC,EAAE,OAAO,CAAC;IACvC;;OAEG;IACH,QAAQ,CAAC,oBAAoB,CAAC,EAAE,OAAO,CAAC;CACzC;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,mHAAmH;IACnH,QAAQ,CAAC,aAAa,CAAC,EAAE,oBAAoB,CAAC;IAC9C,2GAA2G;IAC3G,QAAQ,CAAC,OAAO,CAAC,EAAE,mBAAmB,CAAC;IACvC,oKAAoK;IACpK,QAAQ,CAAC,QAAQ,CAAC,EAAE,qBAAqB,CAAC;CAC3C"}

package/lib/esm/HyperModelingConfig.js

@@ -0,0 +1,9 @@
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+export {};
+//# sourceMappingURL=HyperModelingConfig.js.map

package/lib/esm/HyperModelingConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HyperModelingConfig.js","sourceRoot":"","sources":["../../src/HyperModelingConfig.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG","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 { SectionType } from \"@itwin/core-common\";\r\nimport { SectionMarkerHandler } from \"./SectionMarkerHandler\";\r\n\r\n/** Configures display of [[SectionMarker]]s for [[HyperModelingDecorator]]s.\r\n * @see [[HyperModelingDecorator.updateConfiguration]] or [[HyperModelingDecorator.replaceConfiguration]] to change the configuration for a specific decorator.\r\n * @see [[HyperModeling.initialize]] to set the default configuration for all decorators at package initialization.\r\n * @see [[HyperModeling.updateConfiguration]] or [[HyperModeling.replaceConfiguration]] to change the default configuration for all subsequently created decorators.\r\n * @see [[HyperModelingConfig]].\r\n * @public\r\n */\r\nexport interface SectionMarkerConfig {\r\n  /** Whether to hide markers belonging to models that are not present in the view's [ModelSelector]($backend). If true, markers are displayed regardless of their models. */\r\n  readonly ignoreModelSelector?: boolean;\r\n  /** Whether to hide markers belonging to categories that are not present in the view's [CategorySelector]($backend). If true, markers are displayed regardless of their categories. */\r\n  readonly ignoreCategorySelector?: boolean;\r\n  /** A list of types of section markers that shouold not be displayed. By default, markers for all section types are displayed. */\r\n  readonly hiddenSectionTypes?: SectionType[];\r\n}\r\n\r\n/** Configures how 2d graphics are displayed by a [[HyperModelingDecorator]] when hypermodeling is active.\r\n * This configuration is used primarily for debugging, and applies globally to section graphics associated with all [[HyperModelingDecorator]]s.\r\n * @see [[HyperModeling.initialize]] to set this configuration at package initialization.\r\n * @see [[HyperModeling.updateConfiguration]] or [[HyperModeling.replaceConfiguration]] to change this configuration after package initialization.\r\n * @see [[HyperModelingConfig]].\r\n * @public\r\n */\r\nexport interface SectionGraphicsConfig {\r\n  /** If true, 2d graphics will not be clipped. */\r\n  readonly ignoreClip?: boolean;\r\n  /** If true, clip volumes for 2d graphics are displayed as shapes. */\r\n  readonly debugClipVolumes?: boolean;\r\n  /** If true, [SectionDrawing]($backend) graphics will not be displayed.\r\n   * @see [[hideSheetAnnotations]]\r\n   */\r\n  readonly hideSectionGraphics?: boolean;\r\n  /** If true, [Sheet]($backend) annotation graphics will not be displayed.\r\n   * @see [[hideSectionGraphics]]\r\n   */\r\n  readonly hideSheetAnnotations?: boolean;\r\n}\r\n\r\n/** Configuration options for the hyper-modeling package.\r\n * @see [[HyperModeling.initialize]] to set the configuration at package initialization.\r\n * @see [[HyperModeling.updateConfiguration]] or [[HyperModeling.replaceConfiguration]] to modify the configuration after package initialization.\r\n * @public\r\n */\r\nexport interface HyperModelingConfig {\r\n  /** Specifies how the user interacts with [[SectionMarker]]s. If omitted, the default interactions will be used. */\r\n  readonly markerHandler?: SectionMarkerHandler;\r\n  /** Default [[SectionMarker]] display configuration used when creating a new [[HyperModelingDecorator]]. */\r\n  readonly markers?: SectionMarkerConfig;\r\n  /** Global section graphics configuration used by all [[HyperModelingDecorator]]s when displaying drawings and sheets in a spatial view. Primarily for debugging. */\r\n  readonly graphics?: SectionGraphicsConfig;\r\n}\r\n"]}

package/lib/esm/HyperModelingDecorator.d.ts

@@ -0,0 +1,111 @@
+/** @packageDocumentation
+ * @module HyperModeling
+ */
+import { DecorateContext, Decorator, ScreenViewport } from "@itwin/core-frontend";
+import { SectionMarker, SectionMarkerSet } from "./SectionMarkers";
+import { SectionMarkerConfig } from "./HyperModelingConfig";
+/** A [Decorator]($frontend) that displays a [[SectionMarker]] for each [SectionDrawingLocation]($backend) in the view.
+ * Clicking on a marker toggles the section and the display of associated 2d graphics.
+ * Hovering over a marker opens a mini toolbar with additional interactions.
+ * @see [[SectionMarkerHandler]] to customize the marker interactions.
+ * @see [[HyperModeling.startOrStop]] to enable or disable the decorator for a viewport.
+ * @public
+ */
+export declare class HyperModelingDecorator implements Decorator {
+    /** The set of [[SectionMarker]]s controlled by this decorator. */
+    readonly markers: SectionMarkerSet;
+    private _config;
+    private readonly _removeEventListeners;
+    private readonly _iModel;
+    private _needSync;
+    private _toolbarProvider?;
+    private _tiledGraphicsProvider?;
+    private _activeMarker?;
+    private _appliedSpatialView?;
+    /** @internal */
+    syncImmediately: boolean;
+    /** Create a new decorator and register it with the [ViewManager]($frontend). Typically invoked indirectly via [[HyperModeling.startOrStop]]. */
+    static create(vp: ScreenViewport, config: SectionMarkerConfig): Promise<HyperModelingDecorator | undefined>;
+    /** Obtain the decorator associated with the specified viewport, if any. */
+    static getForViewport(vp: ScreenViewport): HyperModelingDecorator | undefined;
+    /** The viewport into which this decorator draws its [[SectionMarker]]s. */
+    get viewport(): ScreenViewport;
+    /** The currently active marker. A marker typically becomes active when the user clicks on it.
+     * @see [[setActiveMarker]] to change the active marker without user interaction.
+     */
+    get activeMarker(): SectionMarker | undefined;
+    /** @internal */
+    get config(): SectionMarkerConfig;
+    /** Replaces the current marker display configuration, overwriting all previous settings. Passing `undefined` resets all settings to defaults.
+     * @see [[updateConfiguration]] to override specific aspects of the configuration
+     * @see [[HyperModeling.replaceConfiguration]] to replace the global configuration.
+     */
+    replaceConfiguration(config?: SectionMarkerConfig): void;
+    /** Overrides specific aspects of the current marker display configuration.
+     * Any field that is not `undefined` will be replaced in the current configuration; the rest will retain their current values.
+     * @see [[replaceConfiguration]] to override all settings.
+     * @see [[HyperModeling.updateConfiguration]] to update the global configuration.
+     */
+    updateConfiguration(config: SectionMarkerConfig): void;
+    /** Sets the currently active marker. This function is invoked when the user clicks on a marker, but may also be called manually to produce the same result.
+     * Changing the active marker first deactivates the currently active marker, if any; then activates the specified marker, if supplied.
+     * Returns false if marker activation fails.
+     * @see [[activeMarker]] to obtain the currently active section marker.
+     * @see [[SectionMarkerHandler.activateMarker]] to control what happens when a marker is activated.
+     * @see [[SectionMarkerHandler.deactivateMarker]] to control what happens when a marker is deactivated.
+     */
+    setActiveMarker(marker: SectionMarker | undefined): Promise<boolean>;
+    /** @internal */
+    readonly useCachedDecorations = true;
+    /** @internal */
+    decorate(context: DecorateContext): void;
+    private constructor();
+    private onViewportChanged;
+    private toggleMarker;
+    private dropTiledGraphicsProvider;
+    /** @internal */
+    dispose(): void;
+    private showToolbarAfterTimeout;
+    /** Toggles whether the clip volume associated with the specified marker is applied to the view. */
+    toggleClipVolume(marker: SectionMarker, enable: boolean): void;
+    /** Toggles the specified section marker.
+     * Enabling the section applies the frustum and clip volume of the marker's spatial view to the viewport, and displays the 2d section graphics and sheet annotations.
+     * Disabling the section disables the clip volume and 2d graphics.
+     * @see [[toggleClipVolume]] to toggle only the clip volume.
+     * @see [[toggleAttachment]] to toggle only the attachment graphics.
+     */
+    toggleSection(marker: SectionMarker, enable: boolean): Promise<boolean>;
+    /** Toggles display of 2d section graphics and sheet annotations for the specified marker.
+     * @see [[toggleSection]] to apply the spatial view and clip volume in addition to the attachment graphics.
+     */
+    toggleAttachment(marker: SectionMarker, enable: boolean): Promise<boolean>;
+    /** Aligns the viewport to face the specified marker's section plane. */
+    alignView(marker: SectionMarker): void;
+    /** Opens the marker's drawing view in the decorator's viewport. Returns false if the drawing view could not be loaded. */
+    openSection(marker: SectionMarker): Promise<boolean>;
+    /** Opens marker's sheet view in the decorator's viewport and zooms in on the associated [ViewAttachment]($backend). Returns false if no view
+     * attachment exists or the sheet view could not be loaded.
+     */
+    openSheet(marker: SectionMarker): Promise<boolean>;
+    /** Aligns the view to match the frustum of the spatial view associated with the specified marker.
+     * @param marker The marker whose spatial view's frustum should be applied.
+     * @returns false if the frustum could not be applied, e.g. because the spatial view could not be loaded or the viewport is viewing a 2d model.
+     * @see [[alignView]] to align to the *section plane*, which may differ.
+     * @see [[toggleSection]] to also apply the clip volume.
+     */
+    alignToSpatialView(marker: SectionMarker): Promise<boolean>;
+    /** Applies the marker's spatial view - including its clip volume - to the decorator's viewport.
+     * Returns false if the spatial view could not be loaded.
+     * @see [[toggleSection]].
+     * @see [[toggleClipVolume]].
+     */
+    applySpatialView(marker: SectionMarker): Promise<boolean>;
+    /** Request that the visibility of the section markers be recomputed. It is only necessary to call this if you have overridden [[SectionMarkerHandler.isMarkerVisible]]; if so, you should invoke
+     * this method when the criteria governing your `isMarkerVisible` method have changed.
+     */
+    requestSync(): void;
+    private sync;
+    private isMarkerVisible;
+    private updateMarkerVisibility;
+}
+//# sourceMappingURL=HyperModelingDecorator.d.ts.map

package/lib/esm/HyperModelingDecorator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"HyperModelingDecorator.d.ts","sourceRoot":"","sources":["../../src/HyperModelingDecorator.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,EACQ,eAAe,EAAE,SAAS,EAA+B,cAAc,EACrF,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAKnE,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAwC5D;;;;;;GAMG;AACH,qBAAa,sBAAuB,YAAW,SAAS;IACtD,kEAAkE;IAClE,SAAgB,OAAO,EAAE,gBAAgB,CAAC;IAC1C,OAAO,CAAC,OAAO,CAAsB;IACrC,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAA2B;IACjE,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAmB;IAC3C,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,gBAAgB,CAAC,CAAwB;IACjD,OAAO,CAAC,sBAAsB,CAAC,CAAwB;IACvD,OAAO,CAAC,aAAa,CAAC,CAAgB;IACtC,OAAO,CAAC,mBAAmB,CAAC,CAAmB;IAC/C,gBAAgB;IACT,eAAe,UAAS;IAE/B,gJAAgJ;WAC5H,MAAM,CAAC,EAAE,EAAE,cAAc,EAAE,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,sBAAsB,GAAG,SAAS,CAAC;IAKxH,2EAA2E;WAC7D,cAAc,CAAC,EAAE,EAAE,cAAc,GAAG,sBAAsB,GAAG,SAAS;IAQpF,2EAA2E;IAC3E,IAAW,QAAQ,IAAI,cAAc,CAEpC;IAED;;OAEG;IACH,IAAW,YAAY,IAAI,aAAa,GAAG,SAAS,CAEnD;IAED,gBAAgB;IAChB,IAAW,MAAM,IAAI,mBAAmB,CAEvC;IAED;;;OAGG;IACI,oBAAoB,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI;IAK/D;;;;OAIG;IACI,mBAAmB,CAAC,MAAM,EAAE,mBAAmB,GAAG,IAAI;IAU7D;;;;;;OAMG;IACU,eAAe,CAAC,MAAM,EAAE,aAAa,GAAG,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC;IAwBjF,gBAAgB;IAChB,SAAgB,oBAAoB,QAAQ;IAE5C,gBAAgB;IACT,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,IAAI;IAK/C,OAAO;IAqBP,OAAO,CAAC,iBAAiB;YAkBX,YAAY;IAI1B,OAAO,CAAC,yBAAyB;IAQjC,gBAAgB;IACT,OAAO,IAAI,IAAI;IAUtB,OAAO,CAAC,uBAAuB;IAO/B,mGAAmG;IAC5F,gBAAgB,CAAC,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,OAAO,GAAG,IAAI;IAKrE;;;;;OAKG;IACU,aAAa,CAAC,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAwBpF;;OAEG;IACU,gBAAgB,CAAC,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAUvF,wEAAwE;IACjE,SAAS,CAAC,MAAM,EAAE,aAAa,GAAG,IAAI;IAqB7C,0HAA0H;IAC7G,WAAW,CAAC,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC;IAQjE;;OAEG;IACU,SAAS,CAAC,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC;IAa/D;;;;;OAKG;IACU,kBAAkB,CAAC,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC;IAgBxE;;;;OAIG;IACU,gBAAgB,CAAC,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC;IAUtE;;OAEG;IACI,WAAW,IAAI,IAAI;IAS1B,OAAO,CAAC,IAAI;IAQZ,OAAO,CAAC,eAAe;IAOvB,OAAO,CAAC,sBAAsB;CAU/B"}