@itwin/hypermodeling-frontend 4.0.0-dev.52 → 4.0.0-dev.55

package/lib/esm/SectionMarkerHandler.js

@@ -1,108 +1,108 @@
-/*---------------------------------------------------------------------------------------------
-* 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 { IModelApp } from "@itwin/core-frontend";
-/** Supplies interactions with [[SectionMarker]]s, including a mini-toolbar displayed when the mouse hovers over a marker and what action occurs when the user clicks a marker.
- * The base implementation supplies the following interactions:
- *  * Click: Toggle display of the section graphics and clip volume; apply the section's spatial view if toggling on.
- *  * Toolbar:
- *    * Apply Section: Applies the section location's spatial view to the viewport and displays the 2d section graphics.
- *    * Open Drawing: Navigates to the section drawing view. By default, this applies the section drawing view to the viewport.
- *    * Open Sheet: Navigates to the [ViewAttachment]($backend) of the section drawing on a [Sheet]($backend). Disabled if no such attachment exists.
- * @see [[HyperModelingConfig]] to override the default handler by supplying a subclass of `SectionMarkerHandler`.
- * @see [[HyperModelingDecorator]] for various methods that might be usefully wired up to marker click or toolbar actions.
- * @public
- */
-export class SectionMarkerHandler {
-    /** Respond to activation of the specified marker. Return true if the marker should become the active marker - i.e., if the marker was successfully activated.
-     * @see [[SectionMarkerHandler.deactivateMarker]].
-     */
-    async activateMarker(marker, decorator) {
-        return decorator.toggleSection(marker, true);
-    }
-    /** Respond to deactivation of the specified marker. Invoked when the user clicks on the marker while it is the active marker.
-     * This should perform the inverse of [[SectionMarkerHandler.activateMarker]]. The marker becomes inactive as a result.
-     */
-    async deactivateMarker(marker, decorator) {
-        await decorator.toggleSection(marker, false);
-    }
-    /** Return toolbar items for the specified marker. If the array of toolbar items is empty, no toolbar will be displayed.
-     * @see [[executeCommand]] to implement each toolbar command.
-     */
-    getToolbarProps(marker, _decorator) {
-        const localization = IModelApp.localization;
-        return {
-            items: [
-                {
-                    id: "apply_view",
-                    itemPriority: 10,
-                    label: localization.getLocalizedString("HyperModeling:Message.ApplyView"),
-                    icon: "icon-spatial-view-apply",
-                    execute: () => { },
-                    isDisabled: false,
-                },
-                {
-                    id: "open_section",
-                    itemPriority: 20,
-                    label: localization.getLocalizedString("HyperModeling:Message.OpenSection"),
-                    icon: "icon-plan-drawing",
-                    execute: () => { },
-                    isDisabled: false,
-                },
-                {
-                    id: "open_sheet",
-                    itemPriority: 30,
-                    label: localization.getLocalizedString("HyperModeling:Message.OpenSheet"),
-                    icon: "icon-plan-floor",
-                    execute: () => { },
-                    isDisabled: undefined === marker.state.viewAttachment?.viewId,
-                },
-            ],
-        };
-    }
-    /** Execute the command associated with the specified tool bar item.
-     * @see [[getToolbarProps]] to define the set of commands.
-     */
-    async executeCommand(commandId, marker, decorator) {
-        switch (commandId) {
-            case "apply_view":
-                await decorator.applySpatialView(marker);
-                break;
-            case "open_section":
-                await decorator.openSection(marker);
-                break;
-            case "open_sheet":
-                await decorator.openSheet(marker);
-                break;
-        }
-    }
-    /** Customize which markers are visible. [[HyperModelingDecorator]] determines marker visibility as follows:
-     *  - If a marker is currently active (selected), only that marker is visible.
-     *  - Otherwise, the marker is visible if this method returns `true`.
-     * The default implementation of this method determines visibility based on the [[SectionMarkerConfig]] as follows.
-     *  - If the marker is of a type included in the config's `hiddenSectionTypes`, it is invisible.
-     *  - If the marker belongs to a model not currently displayed in the viewport and the config's `ignoreModelSelector` is false, it is invisible.
-     *  - If the marker belongs to a category not currently displayed in the viewport and the config's `ignoreCategorySelector` is false, it is invisible,
-     *  - Otherwise, the marker is visible, unless this method returns `false`.
-     * The default implementation of this method always returns `true`
-     * @param marker The marker whose visibility is to be determined.
-     * @param decorator The hypermodeling decorator to which the marker belongs.
-     * @param config The configuration controlling marker visibility based on [SectionType]($common), [ModelSelectorState]($frontend), and [CategorySelectorState]($frontend).
-     * @returns true if the marker should be displayed; false to make it invisible.
-     * @see [[HyperModelingDecorator.requestSync]] to force the decorator to reevaluate marker visibility when the criterion used by your implementation of this method changes.
-     */
-    isMarkerVisible(marker, decorator, config) {
-        if (undefined !== config.hiddenSectionTypes && config.hiddenSectionTypes.includes(marker.state.sectionType))
-            return false;
-        if (!config.ignoreCategorySelector && !decorator.viewport.view.viewsCategory(marker.state.category))
-            return false;
-        if (!config.ignoreModelSelector && !decorator.viewport.view.viewsModel(marker.state.model))
-            return false;
-        return true;
-    }
-}
+/*---------------------------------------------------------------------------------------------
+* 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 { IModelApp } from "@itwin/core-frontend";
+/** Supplies interactions with [[SectionMarker]]s, including a mini-toolbar displayed when the mouse hovers over a marker and what action occurs when the user clicks a marker.
+ * The base implementation supplies the following interactions:
+ *  * Click: Toggle display of the section graphics and clip volume; apply the section's spatial view if toggling on.
+ *  * Toolbar:
+ *    * Apply Section: Applies the section location's spatial view to the viewport and displays the 2d section graphics.
+ *    * Open Drawing: Navigates to the section drawing view. By default, this applies the section drawing view to the viewport.
+ *    * Open Sheet: Navigates to the [ViewAttachment]($backend) of the section drawing on a [Sheet]($backend). Disabled if no such attachment exists.
+ * @see [[HyperModelingConfig]] to override the default handler by supplying a subclass of `SectionMarkerHandler`.
+ * @see [[HyperModelingDecorator]] for various methods that might be usefully wired up to marker click or toolbar actions.
+ * @public
+ */
+export class SectionMarkerHandler {
+    /** Respond to activation of the specified marker. Return true if the marker should become the active marker - i.e., if the marker was successfully activated.
+     * @see [[SectionMarkerHandler.deactivateMarker]].
+     */
+    async activateMarker(marker, decorator) {
+        return decorator.toggleSection(marker, true);
+    }
+    /** Respond to deactivation of the specified marker. Invoked when the user clicks on the marker while it is the active marker.
+     * This should perform the inverse of [[SectionMarkerHandler.activateMarker]]. The marker becomes inactive as a result.
+     */
+    async deactivateMarker(marker, decorator) {
+        await decorator.toggleSection(marker, false);
+    }
+    /** Return toolbar items for the specified marker. If the array of toolbar items is empty, no toolbar will be displayed.
+     * @see [[executeCommand]] to implement each toolbar command.
+     */
+    getToolbarProps(marker, _decorator) {
+        const localization = IModelApp.localization;
+        return {
+            items: [
+                {
+                    id: "apply_view",
+                    itemPriority: 10,
+                    label: localization.getLocalizedString("HyperModeling:Message.ApplyView"),
+                    icon: "icon-spatial-view-apply",
+                    execute: () => { },
+                    isDisabled: false,
+                },
+                {
+                    id: "open_section",
+                    itemPriority: 20,
+                    label: localization.getLocalizedString("HyperModeling:Message.OpenSection"),
+                    icon: "icon-plan-drawing",
+                    execute: () => { },
+                    isDisabled: false,
+                },
+                {
+                    id: "open_sheet",
+                    itemPriority: 30,
+                    label: localization.getLocalizedString("HyperModeling:Message.OpenSheet"),
+                    icon: "icon-plan-floor",
+                    execute: () => { },
+                    isDisabled: undefined === marker.state.viewAttachment?.viewId,
+                },
+            ],
+        };
+    }
+    /** Execute the command associated with the specified tool bar item.
+     * @see [[getToolbarProps]] to define the set of commands.
+     */
+    async executeCommand(commandId, marker, decorator) {
+        switch (commandId) {
+            case "apply_view":
+                await decorator.applySpatialView(marker);
+                break;
+            case "open_section":
+                await decorator.openSection(marker);
+                break;
+            case "open_sheet":
+                await decorator.openSheet(marker);
+                break;
+        }
+    }
+    /** Customize which markers are visible. [[HyperModelingDecorator]] determines marker visibility as follows:
+     *  - If a marker is currently active (selected), only that marker is visible.
+     *  - Otherwise, the marker is visible if this method returns `true`.
+     * The default implementation of this method determines visibility based on the [[SectionMarkerConfig]] as follows.
+     *  - If the marker is of a type included in the config's `hiddenSectionTypes`, it is invisible.
+     *  - If the marker belongs to a model not currently displayed in the viewport and the config's `ignoreModelSelector` is false, it is invisible.
+     *  - If the marker belongs to a category not currently displayed in the viewport and the config's `ignoreCategorySelector` is false, it is invisible,
+     *  - Otherwise, the marker is visible, unless this method returns `false`.
+     * The default implementation of this method always returns `true`
+     * @param marker The marker whose visibility is to be determined.
+     * @param decorator The hypermodeling decorator to which the marker belongs.
+     * @param config The configuration controlling marker visibility based on [SectionType]($common), [ModelSelectorState]($frontend), and [CategorySelectorState]($frontend).
+     * @returns true if the marker should be displayed; false to make it invisible.
+     * @see [[HyperModelingDecorator.requestSync]] to force the decorator to reevaluate marker visibility when the criterion used by your implementation of this method changes.
+     */
+    isMarkerVisible(marker, decorator, config) {
+        if (undefined !== config.hiddenSectionTypes && config.hiddenSectionTypes.includes(marker.state.sectionType))
+            return false;
+        if (!config.ignoreCategorySelector && !decorator.viewport.view.viewsCategory(marker.state.category))
+            return false;
+        if (!config.ignoreModelSelector && !decorator.viewport.view.viewsModel(marker.state.model))
+            return false;
+        return true;
+    }
+}
 //# sourceMappingURL=SectionMarkerHandler.js.map

package/lib/esm/SectionMarkers.d.ts

@@ -1,83 +1,83 @@
-/** @packageDocumentation
- * @module HyperModeling
- */
-import { BeEvent, Id64String } from "@itwin/core-bentley";
-import { XAndY, XYAndZ } from "@itwin/core-geometry";
-import { BeButtonEvent, Cluster, DecorateContext, Marker, MarkerImage, MarkerSet, ScreenViewport } from "@itwin/core-frontend";
-import { SectionDrawingLocationState } from "./SectionDrawingLocationState";
-/** A [Marker]($frontend) associated with a [[SectionDrawingLocationState]], displayed as a canvas decoration at the location of the section.
- * Clicking on the marker toggles display of the section graphics. Mousing over the marker produces a toolbar with additional interactions.
- * @see [[HyperModelingDecorator]] for a [Decorator]($frontend) capable of displaying section markers for each section drawing location.
- * @see [[SectionMarkerHandler]] to customize the marker interactions.
- * @public
- */
-export declare class SectionMarker extends Marker {
-    /** The section drawing location state associated with the marker. */
-    readonly state: SectionDrawingLocationState;
-    /** A description displayed as part of the tooltip when this marker is clustered with other markers. */
-    readonly description: string;
-    /** @internal */
-    readonly onMouseEnterEvent: BeEvent<(marker: SectionMarker) => void>;
-    /** @internal */
-    readonly onMouseButtonEvent: BeEvent<(marker: SectionMarker) => void>;
-    /** @internal */
-    private _isActive;
-    /** Constructor, typically invoked indirectly via [[HyperModelingDecorator]].
-     * @param state The section drawing location state this marker will represent.
-     * @param pos The world coordinates at which to display the marker.
-     * @param description A brief description of this marker, used as part of the tooltip when this marker is part of a cluster.
-     * @param icon The icon displayed by the marker.
-     * @param tooltip Optional detailed tooltip displayed on mouse hover. If undefined, the `description` is used instead.
-     */
-    constructor(state: SectionDrawingLocationState);
-    /** @internal */
-    get isHilited(): boolean;
-    /** Returns true if this is the "active" section marker. At most one marker is active at a given time.
-     * @see [[HyperModelingDecorator.activeMarker]].
-     * @see [[HyperModelingDecorator.setActiveMarker]].
-     * @see [[SectionMarkerHandler.toggleMarker]].
-     */
-    get isActive(): boolean;
-    /** @internal */
-    setActive(active: boolean): void;
-    /** @internal */
-    protected drawActive(ctx: CanvasRenderingContext2D): boolean;
-    /** @internal */
-    drawDecoration(ctx: CanvasRenderingContext2D): void;
-    /** @internal */
-    onMouseEnter(ev: BeButtonEvent): void;
-    /** @internal */
-    onMouseButton(ev: BeButtonEvent): boolean;
-    /** @internal */
-    addMarker(context: DecorateContext): void;
-}
-/** A Marker used to show a cluster of section locations.
- * @internal
- */
-export declare class SectionMarkerCluster extends Marker {
-    /** Create a new cluster marker */
-    constructor(location: XYAndZ, size: XAndY, cluster: Cluster<SectionMarker>, image: MarkerImage | Promise<MarkerImage> | undefined);
-    /** Show the cluster as a white circle with an outline */
-    drawFunc(ctx: CanvasRenderingContext2D): void;
-    onMouseButton(_ev: BeButtonEvent): boolean;
-}
-/** A [MarkerSet]($frontend) containing [[SectionMarker]]s identifying [SectionDrawingLocation]($backend)s within a spatial view.
- * Typically used indirectly via [[HyperModelingDecorator]].
- * @public
- */
-export declare class SectionMarkerSet extends MarkerSet<SectionMarker> {
-    minimumClusterSize: number;
-    /** Constructor
-     * @param viewport The viewport in which the markers are to be displayed.
-     * @param markers The markers to be displayed.
-     * @note Each marker's [[SectionDrawingLocationState]] must be associated with the same [IModelConnection]($frontend) as the viewport; any markers from other iModels will be omitted.
-     */
-    constructor(viewport: ScreenViewport, markers: SectionMarker[]);
-    /** The viewport in which the markers are to be displayed. */
-    get viewport(): ScreenViewport;
-    /** @internal */
-    protected getClusterMarker(cluster: Cluster<SectionMarker>): Marker;
-    /** Find the SectionMarker corresponding to the specified [SectionDrawingLocation]($backend) Id. */
-    findMarkerById(sectionDrawingLocationId: Id64String): SectionMarker | undefined;
-}
+/** @packageDocumentation
+ * @module HyperModeling
+ */
+import { BeEvent, Id64String } from "@itwin/core-bentley";
+import { XAndY, XYAndZ } from "@itwin/core-geometry";
+import { BeButtonEvent, Cluster, DecorateContext, Marker, MarkerImage, MarkerSet, ScreenViewport } from "@itwin/core-frontend";
+import { SectionDrawingLocationState } from "./SectionDrawingLocationState";
+/** A [Marker]($frontend) associated with a [[SectionDrawingLocationState]], displayed as a canvas decoration at the location of the section.
+ * Clicking on the marker toggles display of the section graphics. Mousing over the marker produces a toolbar with additional interactions.
+ * @see [[HyperModelingDecorator]] for a [Decorator]($frontend) capable of displaying section markers for each section drawing location.
+ * @see [[SectionMarkerHandler]] to customize the marker interactions.
+ * @public
+ */
+export declare class SectionMarker extends Marker {
+    /** The section drawing location state associated with the marker. */
+    readonly state: SectionDrawingLocationState;
+    /** A description displayed as part of the tooltip when this marker is clustered with other markers. */
+    readonly description: string;
+    /** @internal */
+    readonly onMouseEnterEvent: BeEvent<(marker: SectionMarker) => void>;
+    /** @internal */
+    readonly onMouseButtonEvent: BeEvent<(marker: SectionMarker) => void>;
+    /** @internal */
+    private _isActive;
+    /** Constructor, typically invoked indirectly via [[HyperModelingDecorator]].
+     * @param state The section drawing location state this marker will represent.
+     * @param pos The world coordinates at which to display the marker.
+     * @param description A brief description of this marker, used as part of the tooltip when this marker is part of a cluster.
+     * @param icon The icon displayed by the marker.
+     * @param tooltip Optional detailed tooltip displayed on mouse hover. If undefined, the `description` is used instead.
+     */
+    constructor(state: SectionDrawingLocationState);
+    /** @internal */
+    get isHilited(): boolean;
+    /** Returns true if this is the "active" section marker. At most one marker is active at a given time.
+     * @see [[HyperModelingDecorator.activeMarker]].
+     * @see [[HyperModelingDecorator.setActiveMarker]].
+     * @see [[SectionMarkerHandler.toggleMarker]].
+     */
+    get isActive(): boolean;
+    /** @internal */
+    setActive(active: boolean): void;
+    /** @internal */
+    protected drawActive(ctx: CanvasRenderingContext2D): boolean;
+    /** @internal */
+    drawDecoration(ctx: CanvasRenderingContext2D): void;
+    /** @internal */
+    onMouseEnter(ev: BeButtonEvent): void;
+    /** @internal */
+    onMouseButton(ev: BeButtonEvent): boolean;
+    /** @internal */
+    addMarker(context: DecorateContext): void;
+}
+/** A Marker used to show a cluster of section locations.
+ * @internal
+ */
+export declare class SectionMarkerCluster extends Marker {
+    /** Create a new cluster marker */
+    constructor(location: XYAndZ, size: XAndY, cluster: Cluster<SectionMarker>, image: MarkerImage | Promise<MarkerImage> | undefined);
+    /** Show the cluster as a white circle with an outline */
+    drawFunc(ctx: CanvasRenderingContext2D): void;
+    onMouseButton(_ev: BeButtonEvent): boolean;
+}
+/** A [MarkerSet]($frontend) containing [[SectionMarker]]s identifying [SectionDrawingLocation]($backend)s within a spatial view.
+ * Typically used indirectly via [[HyperModelingDecorator]].
+ * @public
+ */
+export declare class SectionMarkerSet extends MarkerSet<SectionMarker> {
+    minimumClusterSize: number;
+    /** Constructor
+     * @param viewport The viewport in which the markers are to be displayed.
+     * @param markers The markers to be displayed.
+     * @note Each marker's [[SectionDrawingLocationState]] must be associated with the same [IModelConnection]($frontend) as the viewport; any markers from other iModels will be omitted.
+     */
+    constructor(viewport: ScreenViewport, markers: SectionMarker[]);
+    /** The viewport in which the markers are to be displayed. */
+    get viewport(): ScreenViewport;
+    /** @internal */
+    protected getClusterMarker(cluster: Cluster<SectionMarker>): Marker;
+    /** Find the SectionMarker corresponding to the specified [SectionDrawingLocation]($backend) Id. */
+    findMarkerById(sectionDrawingLocationId: Id64String): SectionMarker | undefined;
+}
 //# sourceMappingURL=SectionMarkers.d.ts.map