@itwin/hypermodeling-frontend 3.7.17 → 3.8.0

package/lib/esm/HyperModeling.js

@@ -1,237 +1,237 @@
-/*---------------------------------------------------------------------------------------------
-* 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 {
-    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
-        IModelApp.onBeforeShutdown.addListener(() => this.shutdown());
-        const namespace = "HyperModeling";
-        await IModelApp.localization.registerNamespace(namespace);
-        const loadImages = [
-            tryImageElementFromUrl(`${IModelApp.publicPath}section-marker.svg`),
-            tryImageElementFromUrl(`${IModelApp.publicPath}detail-marker.svg`),
-            tryImageElementFromUrl(`${IModelApp.publicPath}elevation-marker.svg`),
-            tryImageElementFromUrl(`${IModelApp.publicPath}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);
-        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 {
-            // eslint-disable-next-line deprecation/deprecation
-            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 = {};
+/*---------------------------------------------------------------------------------------------
+* 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 {
+    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
+        IModelApp.onBeforeShutdown.addListener(() => this.shutdown());
+        const namespace = "HyperModeling";
+        await IModelApp.localization.registerNamespace(namespace);
+        const loadImages = [
+            tryImageElementFromUrl(`${IModelApp.publicPath}section-marker.svg`),
+            tryImageElementFromUrl(`${IModelApp.publicPath}detail-marker.svg`),
+            tryImageElementFromUrl(`${IModelApp.publicPath}elevation-marker.svg`),
+            tryImageElementFromUrl(`${IModelApp.publicPath}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);
+        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 {
+            // eslint-disable-next-line deprecation/deprecation
+            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/HyperModelingConfig.d.ts

@@ -1,55 +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;
-}
+/** @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.js

@@ -1,9 +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 {};
+/*---------------------------------------------------------------------------------------------
+* 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

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