@itwin/hypermodeling-frontend 3.6.0-dev.36 → 3.6.0-dev.38

package/lib/cjs/HyperModeling.d.ts

@@ -1,115 +1,115 @@
-/** @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;
-    private static shutdown;
-    /** Returns whether the hypermodeling package is initialized.
-     * @see [[HyperModeling.initialize]] to initialize the package.
-     */
-    static get isInitialized(): boolean;
-    /** 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 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 {};
+/** @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;
+    private static shutdown;
+    /** Returns whether the hypermodeling package is initialized.
+     * @see [[HyperModeling.initialize]] to initialize the package.
+     */
+    static get isInitialized(): boolean;
+    /** 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 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