@itwin/hypermodeling-frontend 3.7.5 → 3.7.6

package/lib/esm/HyperModelingDecorator.d.ts

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