@itwin/frontend-devtools 3.0.0-dev.72

package/lib/tools/PlanarMaskTools.d.ts

@@ -0,0 +1,182 @@
+/** @packageDocumentation
+ * @module Tools
+ */
+import { Id64String } from "@itwin/core-bentley";
+import { PlanarClipMaskSettings } from "@itwin/core-common";
+import { BeButtonEvent, ContextRealityModelState, EventHandled, HitDetail, LocateFilterStatus, LocateResponse, PrimitiveTool, ScreenViewport, Tool } from "@itwin/core-frontend";
+/** Set Map Masking by selected models.
+ * @beta
+ */
+export declare class SetMapHigherPriorityMasking extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    run(transparency?: number): Promise<boolean>;
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
+/** Unmask Mask.
+ * @beta
+ */
+export declare class UnmaskMapTool extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    run(): Promise<boolean>;
+}
+/** Base class for the reality model planar masking tools.
+ * @beta
+ */
+export declare abstract class PlanarMaskBaseTool extends PrimitiveTool {
+    protected readonly _acceptedModelIds: Set<string>;
+    protected readonly _acceptedSubCategoryIds: Set<string>;
+    protected readonly _acceptedElementIds: Set<string>;
+    protected _transparency?: number;
+    protected _useSelection: boolean;
+    protected _targetMaskModel?: Id64String | ContextRealityModelState;
+    requireWriteableTarget(): boolean;
+    onPostInstall(): Promise<void>;
+    onUnsuspend(): Promise<void>;
+    private setupAndPromptForNextAction;
+    protected targetModelRequired(): boolean;
+    protected elementRequired(): boolean;
+    protected allowSelection(): boolean;
+    protected abstract showPrompt(): void;
+    protected abstract createToolInstance(): PlanarMaskBaseTool;
+    protected abstract applyMask(vp: ScreenViewport): void;
+    private clearIds;
+    exitTool(): Promise<void>;
+    onRestartTool(): Promise<void>;
+    parseAndRun(...args: string[]): Promise<boolean>;
+    onCleanup(): Promise<void>;
+    filterHit(hit: HitDetail, _out?: LocateResponse): Promise<LocateFilterStatus>;
+    onDataButtonDown(ev: BeButtonEvent): Promise<EventHandled>;
+    protected createSubCategoryMask(): PlanarClipMaskSettings;
+    protected createElementMask(option: "include" | "exclude"): PlanarClipMaskSettings;
+    protected createModelMask(): PlanarClipMaskSettings;
+    protected setRealityModelMask(vp: ScreenViewport, mask: PlanarClipMaskSettings): void;
+}
+/** Tool to mask background map by elements
+ * @beta
+ */
+export declare class MaskBackgroundMapByElementTool extends PlanarMaskBaseTool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    protected targetModelRequired(): boolean;
+    protected showPrompt(): void;
+    protected createToolInstance(): PlanarMaskBaseTool;
+    protected applyMask(vp: ScreenViewport): void;
+}
+/** Tool to mask background map by excluded elements
+ * @beta
+ */
+export declare class MaskBackgroundMapByExcludedElementTool extends PlanarMaskBaseTool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    protected targetModelRequired(): boolean;
+    protected showPrompt(): void;
+    protected createToolInstance(): PlanarMaskBaseTool;
+    protected applyMask(vp: ScreenViewport): void;
+}
+/** Tool to mask background map by SubCategories
+ * @beta
+ */
+export declare class MaskBackgroundMapBySubCategoryTool extends PlanarMaskBaseTool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    protected targetModelRequired(): boolean;
+    protected allowSelection(): boolean;
+    protected showPrompt(): void;
+    protected createToolInstance(): PlanarMaskBaseTool;
+    protected applyMask(vp: ScreenViewport): void;
+}
+/** Tool to mask background map by geometric models
+ * @beta
+ */
+export declare class MaskBackgroundMapByModelTool extends PlanarMaskBaseTool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    protected targetModelRequired(): boolean;
+    protected showPrompt(): void;
+    protected createToolInstance(): PlanarMaskBaseTool;
+    protected applyMask(vp: ScreenViewport): void;
+}
+/** Tool to mask reality model by elements
+ * @beta
+ */
+export declare class MaskRealityModelByElementTool extends PlanarMaskBaseTool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    protected targetModelRequired(): boolean;
+    protected showPrompt(): void;
+    protected createToolInstance(): PlanarMaskBaseTool;
+    protected applyMask(vp: ScreenViewport): void;
+}
+/** Tool to mask reality model by excluded elements
+ * @beta
+ */
+export declare class MaskRealityModelByExcludedElementTool extends PlanarMaskBaseTool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    protected targetModelRequired(): boolean;
+    protected showPrompt(): void;
+    protected createToolInstance(): PlanarMaskBaseTool;
+    protected applyMask(vp: ScreenViewport): void;
+}
+/** Tool to mask reality model by geometric models
+ * @beta
+ */
+export declare class MaskRealityModelByModelTool extends PlanarMaskBaseTool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    protected targetModelRequired(): boolean;
+    protected showPrompt(): void;
+    protected createToolInstance(): PlanarMaskBaseTool;
+    protected applyMask(vp: ScreenViewport): void;
+}
+/** Tool to mask reality model by SubCategories
+ * @beta
+ */
+export declare class MaskRealityModelBySubCategoryTool extends PlanarMaskBaseTool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    protected targetModelRequired(): boolean;
+    protected allowSelection(): boolean;
+    protected showPrompt(): void;
+    protected createToolInstance(): PlanarMaskBaseTool;
+    protected applyMask(vp: ScreenViewport): void;
+}
+/** Tool to mask reality model by higher priority models.
+ * @beta
+ */
+export declare class SetHigherPriorityRealityModelMasking extends PlanarMaskBaseTool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    protected targetModelRequired(): boolean;
+    protected elementRequired(): boolean;
+    private _priority;
+    protected showPrompt(): void;
+    protected createToolInstance(): PlanarMaskBaseTool;
+    protected applyMask(vp: ScreenViewport): void;
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
+/** Remove masks from reality model.
+ * @beta
+ */
+export declare class UnmaskRealityModelTool extends PlanarMaskBaseTool {
+    static toolId: string;
+    protected targetModelRequired(): boolean;
+    protected showPrompt(): void;
+    protected createToolInstance(): PlanarMaskBaseTool;
+    protected applyMask(vp: ScreenViewport): void;
+    onDataButtonDown(ev: BeButtonEvent): Promise<EventHandled>;
+}
+//# sourceMappingURL=PlanarMaskTools.d.ts.map

package/lib/tools/PlanarMaskTools.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PlanarMaskTools.d.ts","sourceRoot":"","sources":["../../src/tools/PlanarMaskTools.ts"],"names":[],"mappings":"AAKA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAA8C,sBAAsB,EAAE,MAAM,oBAAoB,CAAC;AACxG,OAAO,EACL,aAAa,EAAE,wBAAwB,EAAE,YAAY,EAAE,SAAS,EAAa,kBAAkB,EAAE,cAAc,EAAE,aAAa,EAAE,cAAc,EAAE,IAAI,EACrJ,MAAM,sBAAsB,CAAC;AAE9B;;GAEG;AACH,qBAAa,2BAA4B,SAAQ,IAAI;IACnD,OAAuB,MAAM,SAA8B;IAC3D,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAE5B,GAAG,CAAC,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAU5C,WAAW,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAIvE;AAED;;GAEG;AACH,qBAAa,aAAc,SAAQ,IAAI;IACrC,OAAuB,MAAM,SAAe;IAC5C,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAE5B,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC;CAS9C;AAED;;GAEG;AACH,8BAAsB,kBAAmB,SAAQ,aAAa;IAC5D,SAAS,CAAC,QAAQ,CAAC,iBAAiB,cAAyB;IAC7D,SAAS,CAAC,QAAQ,CAAC,uBAAuB,cAAyB;IACnE,SAAS,CAAC,QAAQ,CAAC,mBAAmB,cAAyB;IAC/D,SAAS,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IACjC,SAAS,CAAC,aAAa,EAAE,OAAO,CAAS;IACzC,SAAS,CAAC,gBAAgB,CAAC,EAAE,UAAU,GAAG,wBAAwB,CAAC;IAEnD,sBAAsB,IAAI,OAAO;IAC3B,aAAa;IAEb,WAAW;IACjC,OAAO,CAAC,2BAA2B;IAMnC,SAAS,CAAC,mBAAmB,IAAI,OAAO;IACxC,SAAS,CAAC,eAAe,IAAI,OAAO;IACpC,SAAS,CAAC,cAAc,IAAI,OAAO;IACnC,SAAS,CAAC,QAAQ,CAAC,UAAU,IAAI,IAAI;IACrC,SAAS,CAAC,QAAQ,CAAC,kBAAkB,IAAI,kBAAkB;IAC3D,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,EAAE,cAAc,GAAG,IAAI;IACtD,OAAO,CAAC,QAAQ;IAIM,QAAQ;IAKjB,aAAa;IAQJ,WAAW,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IAMhD,SAAS;IAMT,SAAS,CAAC,GAAG,EAAE,SAAS,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAc7E,gBAAgB,CAAC,EAAE,EAAE,aAAa,GAAG,OAAO,CAAC,YAAY,CAAC;IAuChF,SAAS,CAAC,qBAAqB;IAI/B,SAAS,CAAC,iBAAiB,CAAC,MAAM,EAAE,SAAS,GAAG,SAAS;IAKzD,SAAS,CAAC,eAAe;IAIzB,SAAS,CAAC,mBAAmB,CAAC,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,sBAAsB,GAAG,IAAI;CAMtF;AACD;;GAEG;AACH,qBAAa,8BAA+B,SAAQ,kBAAkB;IACpE,OAAuB,MAAM,SAAgC;IAC7D,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;cAC/B,mBAAmB;IACtC,SAAS,CAAC,UAAU,IAAI,IAAI;IAG5B,SAAS,CAAC,kBAAkB,IAAI,kBAAkB;IAClD,SAAS,CAAC,SAAS,CAAC,EAAE,EAAE,cAAc,GAAG,IAAI;CAG9C;AACD;;GAEG;AACH,qBAAa,sCAAuC,SAAQ,kBAAkB;IAC5E,OAAuB,MAAM,SAAwC;IACrE,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;cAC/B,mBAAmB;IACtC,SAAS,CAAC,UAAU,IAAI,IAAI;IAG5B,SAAS,CAAC,kBAAkB,IAAI,kBAAkB;IAClD,SAAS,CAAC,SAAS,CAAC,EAAE,EAAE,cAAc,GAAG,IAAI;CAG9C;AAED;;GAEG;AACH,qBAAa,kCAAmC,SAAQ,kBAAkB;IACxE,OAAuB,MAAM,SAAoC;IACjE,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;cAC/B,mBAAmB;cACnB,cAAc,IAAI,OAAO;IAC5C,SAAS,CAAC,UAAU,IAAI,IAAI;IAG5B,SAAS,CAAC,kBAAkB,IAAI,kBAAkB;IAClD,SAAS,CAAC,SAAS,CAAC,EAAE,EAAE,cAAc,GAAG,IAAI;CAG9C;AAED;;GAEG;AACH,qBAAa,4BAA6B,SAAQ,kBAAkB;IAClE,OAAuB,MAAM,SAA8B;IAC3D,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;cAC/B,mBAAmB;IACtC,SAAS,CAAC,UAAU,IAAI,IAAI;IAG5B,SAAS,CAAC,kBAAkB,IAAI,kBAAkB;IAClD,SAAS,CAAC,SAAS,CAAC,EAAE,EAAE,cAAc,GAAG,IAAI;CAG9C;AAED;;GAEG;AACH,qBAAa,6BAA8B,SAAQ,kBAAkB;IACnE,OAAuB,MAAM,SAA+B;IAC5D,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;cAC/B,mBAAmB;IAEtC,SAAS,CAAC,UAAU,IAAI,IAAI;IAI5B,SAAS,CAAC,kBAAkB,IAAI,kBAAkB;IAClD,SAAS,CAAC,SAAS,CAAC,EAAE,EAAE,cAAc,GAAG,IAAI;CAG9C;AAED;;GAEG;AACH,qBAAa,qCAAsC,SAAQ,kBAAkB;IAC3E,OAAuB,MAAM,SAAuC;IACpE,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;cAC/B,mBAAmB;IAEtC,SAAS,CAAC,UAAU,IAAI,IAAI;IAI5B,SAAS,CAAC,kBAAkB,IAAI,kBAAkB;IAClD,SAAS,CAAC,SAAS,CAAC,EAAE,EAAE,cAAc,GAAG,IAAI;CAG9C;AAED;;GAEG;AAEH,qBAAa,2BAA4B,SAAQ,kBAAkB;IACjE,OAAuB,MAAM,SAA6B;IAC1D,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;cAE/B,mBAAmB;IAEtC,SAAS,CAAC,UAAU,IAAI,IAAI;IAI5B,SAAS,CAAC,kBAAkB,IAAI,kBAAkB;IAClD,SAAS,CAAC,SAAS,CAAC,EAAE,EAAE,cAAc,GAAG,IAAI;CAG9C;AAED;;GAEG;AACH,qBAAa,iCAAkC,SAAQ,kBAAkB;IACvE,OAAuB,MAAM,SAAmC;IAChE,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;cAC/B,mBAAmB;cACnB,cAAc,IAAI,OAAO;IAE5C,SAAS,CAAC,UAAU,IAAI,IAAI;IAI5B,SAAS,CAAC,kBAAkB,IAAI,kBAAkB;IAClD,SAAS,CAAC,SAAS,CAAC,EAAE,EAAE,cAAc,GAAG,IAAI;CAG9C;AAED;;GAEG;AACH,qBAAa,oCAAqC,SAAQ,kBAAkB;IAC1E,OAAuB,MAAM,SAA0C;IACvE,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;cAC/B,mBAAmB;cACnB,eAAe;IAClC,OAAO,CAAC,SAAS,CAAK;IAEtB,SAAS,CAAC,UAAU,IAAI,IAAI;IAG5B,SAAS,CAAC,kBAAkB,IAAI,kBAAkB;IAClD,SAAS,CAAC,SAAS,CAAC,EAAE,EAAE,cAAc,GAAG,IAAI;IAKvB,WAAW,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAMvE;AAED;;GAEG;AACH,qBAAa,sBAAuB,SAAQ,kBAAkB;IAC5D,OAAuB,MAAM,SAAwB;cAClC,mBAAmB;IAEtC,SAAS,CAAC,UAAU,IAAI,IAAI;IAG5B,SAAS,CAAC,kBAAkB,IAAI,kBAAkB;IAClD,SAAS,CAAC,SAAS,CAAC,EAAE,EAAE,cAAc,GAAG,IAAI;IAIvB,gBAAgB,CAAC,EAAE,EAAE,aAAa,GAAG,OAAO,CAAC,YAAY,CAAC;CAcjF"}

package/lib/tools/PlanarMaskTools.js

@@ -0,0 +1,366 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UnmaskRealityModelTool = exports.SetHigherPriorityRealityModelMasking = exports.MaskRealityModelBySubCategoryTool = exports.MaskRealityModelByModelTool = exports.MaskRealityModelByExcludedElementTool = exports.MaskRealityModelByElementTool = exports.MaskBackgroundMapByModelTool = exports.MaskBackgroundMapBySubCategoryTool = exports.MaskBackgroundMapByExcludedElementTool = exports.MaskBackgroundMapByElementTool = exports.PlanarMaskBaseTool = exports.UnmaskMapTool = exports.SetMapHigherPriorityMasking = void 0;
+const core_common_1 = require("@itwin/core-common");
+const core_frontend_1 = require("@itwin/core-frontend");
+/** Set Map Masking by selected models.
+ * @beta
+ */
+class SetMapHigherPriorityMasking extends core_frontend_1.Tool {
+    static get minArgs() { return 0; }
+    static get maxArgs() { return 1; }
+    async run(transparency) {
+        const vp = core_frontend_1.IModelApp.viewManager.selectedView;
+        if (undefined === vp)
+            return false;
+        vp.changeBackgroundMapProps({ planarClipMask: { mode: core_common_1.PlanarClipMaskMode.Priority, priority: core_common_1.PlanarClipMaskPriority.BackgroundMap, transparency } });
+        vp.invalidateRenderPlan();
+        return true;
+    }
+    async parseAndRun(...args) {
+        const transparency = parseFloat(args[0]);
+        return this.run((transparency !== undefined && transparency < 1.0) ? transparency : undefined);
+    }
+}
+exports.SetMapHigherPriorityMasking = SetMapHigherPriorityMasking;
+SetMapHigherPriorityMasking.toolId = "SetMapHigherPriorityMask";
+/** Unmask Mask.
+ * @beta
+ */
+class UnmaskMapTool extends core_frontend_1.Tool {
+    static get minArgs() { return 0; }
+    static get maxArgs() { return 0; }
+    async run() {
+        const vp = core_frontend_1.IModelApp.viewManager.selectedView;
+        if (undefined === vp)
+            return false;
+        vp.changeBackgroundMapProps({ planarClipMask: { mode: core_common_1.PlanarClipMaskMode.None } });
+        vp.invalidateRenderPlan();
+        return true;
+    }
+}
+exports.UnmaskMapTool = UnmaskMapTool;
+UnmaskMapTool.toolId = "UnmaskMap";
+/** Base class for the reality model planar masking tools.
+ * @beta
+ */
+class PlanarMaskBaseTool extends core_frontend_1.PrimitiveTool {
+    constructor() {
+        super(...arguments);
+        this._acceptedModelIds = new Set();
+        this._acceptedSubCategoryIds = new Set();
+        this._acceptedElementIds = new Set();
+        this._useSelection = false;
+    }
+    requireWriteableTarget() { return false; }
+    async onPostInstall() { await super.onPostInstall(); this.setupAndPromptForNextAction(); }
+    async onUnsuspend() { this.showPrompt(); }
+    setupAndPromptForNextAction() {
+        this._useSelection = (undefined !== this.targetView && this.iModel.selectionSet.isActive);
+        this.initLocateElements(!this._useSelection || (this.targetModelRequired() && !this._targetMaskModel));
+        core_frontend_1.IModelApp.locateManager.options.allowDecorations = true; // So we can select "contextual" reality models.
+        this.showPrompt();
+    }
+    targetModelRequired() { return true; }
+    elementRequired() { return true; }
+    allowSelection() { return true; }
+    clearIds() {
+        this._acceptedElementIds.clear();
+        this._acceptedModelIds.clear();
+    }
+    async exitTool() {
+        await super.exitTool();
+        this._transparency = undefined;
+    }
+    async onRestartTool() {
+        this.clearIds();
+        this._acceptedSubCategoryIds.clear();
+        const tool = this.createToolInstance();
+        if (!await tool.run())
+            await this.exitTool();
+    }
+    async parseAndRun(...args) {
+        const transparency = parseFloat(args[0]);
+        this._transparency = (transparency !== undefined && transparency < 1.0) ? transparency : undefined;
+        return this.run();
+    }
+    async onCleanup() {
+        if (0 !== this._acceptedElementIds.size)
+            this.iModel.hilited.setHilite(this._acceptedElementIds, false);
+        this.clearIds();
+    }
+    async filterHit(hit, _out) {
+        var _a;
+        if (!hit.modelId)
+            return core_frontend_1.LocateFilterStatus.Reject;
+        if (undefined === this._targetMaskModel && this.targetModelRequired()) {
+            if (undefined !== hit.viewport.displayStyle.contextRealityModelStates.find((x) => x.modelId === hit.modelId))
+                return core_frontend_1.LocateFilterStatus.Accept;
+            const model = (_a = this.iModel.models.getLoaded(hit.modelId)) === null || _a === void 0 ? void 0 : _a.asSpatialModel;
+            return (model === null || model === void 0 ? void 0 : model.isRealityModel) ? core_frontend_1.LocateFilterStatus.Accept : core_frontend_1.LocateFilterStatus.Reject;
+        }
+        else
+            return (hit.isElementHit && !hit.isModelHit && !this._acceptedElementIds.has(hit.sourceId)) ? core_frontend_1.LocateFilterStatus.Accept : core_frontend_1.LocateFilterStatus.Reject;
+    }
+    async onDataButtonDown(ev) {
+        var _a;
+        const hit = await core_frontend_1.IModelApp.locateManager.doLocate(new core_frontend_1.LocateResponse(), true, ev.point, ev.viewport, ev.inputSource);
+        const vp = core_frontend_1.IModelApp.viewManager.selectedView;
+        if (undefined === vp)
+            return core_frontend_1.EventHandled.No;
+        if (undefined !== hit && undefined === this._targetMaskModel && this.targetModelRequired()) {
+            if (hit.modelId) {
+                this._targetMaskModel = (_a = hit.viewport.displayStyle.contextRealityModelStates.find((x) => x.modelId === hit.modelId)) !== null && _a !== void 0 ? _a : hit.modelId;
+                if (!this.elementRequired()) {
+                    this.applyMask(vp);
+                    await this.onRestartTool();
+                }
+            }
+        }
+        else if (this._useSelection && this.iModel.selectionSet.isActive) {
+            const elements = await this.iModel.elements.getProps(this.iModel.selectionSet.elements);
+            for (const element of elements) {
+                if (element.id && element.model) {
+                    this._acceptedElementIds.add(element.id);
+                    this._acceptedModelIds.add(element.model);
+                }
+            }
+            this.applyMask(vp);
+            await this.exitTool();
+            return core_frontend_1.EventHandled.No;
+        }
+        else if (undefined !== hit && hit.isElementHit) {
+            const sourceId = hit.sourceId;
+            if (!this._acceptedElementIds.has(sourceId)) {
+                this._acceptedElementIds.add(sourceId);
+                this._acceptedModelIds.add(hit.modelId);
+                if (hit.subCategoryId)
+                    this._acceptedSubCategoryIds.add(hit.subCategoryId);
+                this.applyMask(vp);
+            }
+        }
+        this.setupAndPromptForNextAction();
+        return core_frontend_1.EventHandled.No;
+    }
+    createSubCategoryMask() {
+        return core_common_1.PlanarClipMaskSettings.createForElementsOrSubCategories(core_common_1.PlanarClipMaskMode.IncludeSubCategories, this._acceptedSubCategoryIds, this._acceptedModelIds, this._transparency);
+    }
+    createElementMask(option) {
+        const mode = "include" === option ? core_common_1.PlanarClipMaskMode.IncludeElements : core_common_1.PlanarClipMaskMode.ExcludeElements;
+        return core_common_1.PlanarClipMaskSettings.createForElementsOrSubCategories(mode, this._acceptedElementIds, this._acceptedModelIds, this._transparency);
+    }
+    createModelMask() {
+        return core_common_1.PlanarClipMaskSettings.createForModels(this._acceptedModelIds, this._transparency);
+    }
+    setRealityModelMask(vp, mask) {
+        if (typeof this._targetMaskModel === "string")
+            vp.displayStyle.settings.planarClipMasks.set(this._targetMaskModel, mask);
+        else if (undefined !== this._targetMaskModel)
+            this._targetMaskModel.planarClipMaskSettings = mask;
+    }
+}
+exports.PlanarMaskBaseTool = PlanarMaskBaseTool;
+/** Tool to mask background map by elements
+ * @beta
+ */
+class MaskBackgroundMapByElementTool extends PlanarMaskBaseTool {
+    static get minArgs() { return 0; }
+    static get maxArgs() { return 1; }
+    targetModelRequired() { return false; }
+    showPrompt() {
+        core_frontend_1.IModelApp.notifications.outputPromptByKey(`FrontendDevTools:tools.MaskBackgroundMapByElement.Prompts.${this._useSelection ? "AcceptSelection" : "IdentifyMaskElement"}`);
+    }
+    createToolInstance() { return new MaskBackgroundMapByElementTool(); }
+    applyMask(vp) {
+        vp.changeBackgroundMapProps({ planarClipMask: this.createElementMask("include").toJSON() });
+    }
+}
+exports.MaskBackgroundMapByElementTool = MaskBackgroundMapByElementTool;
+MaskBackgroundMapByElementTool.toolId = "MaskBackgroundMapByElement";
+/** Tool to mask background map by excluded elements
+ * @beta
+ */
+class MaskBackgroundMapByExcludedElementTool extends PlanarMaskBaseTool {
+    static get minArgs() { return 0; }
+    static get maxArgs() { return 1; }
+    targetModelRequired() { return false; }
+    showPrompt() {
+        core_frontend_1.IModelApp.notifications.outputPromptByKey(`FrontendDevTools:tools.MaskBackgroundMapByExcludedElement.Prompts.${this._useSelection ? "AcceptSelection" : "IdentifyMaskElement"}`);
+    }
+    createToolInstance() { return new MaskBackgroundMapByExcludedElementTool(); }
+    applyMask(vp) {
+        vp.changeBackgroundMapProps({ planarClipMask: this.createElementMask("exclude").toJSON() });
+    }
+}
+exports.MaskBackgroundMapByExcludedElementTool = MaskBackgroundMapByExcludedElementTool;
+MaskBackgroundMapByExcludedElementTool.toolId = "MaskBackgroundMapByExcludedElement";
+/** Tool to mask background map by SubCategories
+ * @beta
+ */
+class MaskBackgroundMapBySubCategoryTool extends PlanarMaskBaseTool {
+    static get minArgs() { return 0; }
+    static get maxArgs() { return 1; }
+    targetModelRequired() { return false; }
+    allowSelection() { return false; } // Need picking to get subcategory.
+    showPrompt() {
+        core_frontend_1.IModelApp.notifications.outputPromptByKey("FrontendDevTools:tools.MaskBackgroundMapBySubCategory.Prompts.IdentifyMaskSubCategory");
+    }
+    createToolInstance() { return new MaskBackgroundMapBySubCategoryTool(); }
+    applyMask(vp) {
+        vp.changeBackgroundMapProps({ planarClipMask: this.createSubCategoryMask().toJSON() });
+    }
+}
+exports.MaskBackgroundMapBySubCategoryTool = MaskBackgroundMapBySubCategoryTool;
+MaskBackgroundMapBySubCategoryTool.toolId = "MaskBackgroundMapBySubCategory";
+/** Tool to mask background map by geometric models
+ * @beta
+ */
+class MaskBackgroundMapByModelTool extends PlanarMaskBaseTool {
+    static get minArgs() { return 0; }
+    static get maxArgs() { return 1; }
+    targetModelRequired() { return false; }
+    showPrompt() {
+        core_frontend_1.IModelApp.notifications.outputPromptByKey(`FrontendDevTools:tools.MaskBackgroundMapByModel.Prompts.${this._useSelection ? "AcceptSelection" : "IdentifyMaskModel"}`);
+    }
+    createToolInstance() { return new MaskBackgroundMapByModelTool(); }
+    applyMask(vp) {
+        vp.changeBackgroundMapProps({ planarClipMask: this.createModelMask().toJSON() });
+    }
+}
+exports.MaskBackgroundMapByModelTool = MaskBackgroundMapByModelTool;
+MaskBackgroundMapByModelTool.toolId = "MaskBackgroundMapByModel";
+/** Tool to mask reality model by elements
+ * @beta
+ */
+class MaskRealityModelByElementTool extends PlanarMaskBaseTool {
+    static get minArgs() { return 0; }
+    static get maxArgs() { return 1; }
+    targetModelRequired() { return true; }
+    showPrompt() {
+        const key = `FrontendDevTools:tools.MaskRealityModelByElement.Prompts.${this._targetMaskModel === undefined ? "IdentifyRealityModel" : (this._useSelection ? "AcceptSelection" : "IdentifyMaskElement")}`;
+        core_frontend_1.IModelApp.notifications.outputPromptByKey(key);
+    }
+    createToolInstance() { return new MaskRealityModelByElementTool(); }
+    applyMask(vp) {
+        this.setRealityModelMask(vp, this.createElementMask("include"));
+    }
+}
+exports.MaskRealityModelByElementTool = MaskRealityModelByElementTool;
+MaskRealityModelByElementTool.toolId = "MaskRealityModelByElement";
+/** Tool to mask reality model by excluded elements
+ * @beta
+ */
+class MaskRealityModelByExcludedElementTool extends PlanarMaskBaseTool {
+    static get minArgs() { return 0; }
+    static get maxArgs() { return 1; }
+    targetModelRequired() { return true; }
+    showPrompt() {
+        const key = `FrontendDevTools:tools.MaskRealityModelByExcludedElement.Prompts.${this._targetMaskModel === undefined ? "IdentifyRealityModel" : (this._useSelection ? "AcceptSelection" : "IdentifyMaskElement")}`;
+        core_frontend_1.IModelApp.notifications.outputPromptByKey(key);
+    }
+    createToolInstance() { return new MaskRealityModelByExcludedElementTool(); }
+    applyMask(vp) {
+        this.setRealityModelMask(vp, this.createElementMask("exclude"));
+    }
+}
+exports.MaskRealityModelByExcludedElementTool = MaskRealityModelByExcludedElementTool;
+MaskRealityModelByExcludedElementTool.toolId = "MaskRealityModelByExcludedElement";
+/** Tool to mask reality model by geometric models
+ * @beta
+ */
+class MaskRealityModelByModelTool extends PlanarMaskBaseTool {
+    static get minArgs() { return 0; }
+    static get maxArgs() { return 1; }
+    targetModelRequired() { return true; }
+    showPrompt() {
+        const key = `FrontendDevTools:tools.MaskRealityModelByModel.Prompts.${this._targetMaskModel === undefined ? "IdentifyRealityModel" : (this._useSelection ? "AcceptSelection" : "IdentifyMaskModel")}`;
+        core_frontend_1.IModelApp.notifications.outputPromptByKey(key);
+    }
+    createToolInstance() { return new MaskRealityModelByModelTool(); }
+    applyMask(vp) {
+        this.setRealityModelMask(vp, this.createModelMask());
+    }
+}
+exports.MaskRealityModelByModelTool = MaskRealityModelByModelTool;
+MaskRealityModelByModelTool.toolId = "MaskRealityModelByModel";
+/** Tool to mask reality model by SubCategories
+ * @beta
+ */
+class MaskRealityModelBySubCategoryTool extends PlanarMaskBaseTool {
+    static get minArgs() { return 0; }
+    static get maxArgs() { return 1; }
+    targetModelRequired() { return true; }
+    allowSelection() { return false; } // Need picking to get subcategory.
+    showPrompt() {
+        const key = `FrontendDevTools:tools.MaskRealityModelByModel.Prompts.${this._targetMaskModel === undefined ? "IdentifyRealityModel" : "IdentifyMaskSubCategory"}`;
+        core_frontend_1.IModelApp.notifications.outputPromptByKey(key);
+    }
+    createToolInstance() { return new MaskRealityModelBySubCategoryTool(); }
+    applyMask(vp) {
+        this.setRealityModelMask(vp, this.createSubCategoryMask());
+    }
+}
+exports.MaskRealityModelBySubCategoryTool = MaskRealityModelBySubCategoryTool;
+MaskRealityModelBySubCategoryTool.toolId = "MaskRealityModelBySubCategory";
+/** Tool to mask reality model by higher priority models.
+ * @beta
+ */
+class SetHigherPriorityRealityModelMasking extends PlanarMaskBaseTool {
+    constructor() {
+        super(...arguments);
+        this._priority = 0;
+    }
+    static get minArgs() { return 0; }
+    static get maxArgs() { return 2; }
+    targetModelRequired() { return true; }
+    elementRequired() { return false; }
+    showPrompt() {
+        core_frontend_1.IModelApp.notifications.outputPromptByKey("FrontendDevTools:tools.SetHigherPriorityRealityModelMasking.Prompts.IdentifyRealityModel");
+    }
+    createToolInstance() { return new SetHigherPriorityRealityModelMasking(); }
+    applyMask(vp) {
+        const basePriority = this._targetMaskModel === vp.displayStyle.getOSMBuildingRealityModel() ? core_common_1.PlanarClipMaskPriority.GlobalRealityModel : core_common_1.PlanarClipMaskPriority.RealityModel;
+        this.setRealityModelMask(vp, core_common_1.PlanarClipMaskSettings.createByPriority(basePriority + this._priority, this._transparency));
+    }
+    async parseAndRun(...args) {
+        await super.parseAndRun(...args);
+        const priority = parseInt(args[0], 10);
+        this._priority = (priority === undefined || isNaN(priority)) ? 0 : priority;
+        return this.run();
+    }
+}
+exports.SetHigherPriorityRealityModelMasking = SetHigherPriorityRealityModelMasking;
+SetHigherPriorityRealityModelMasking.toolId = "SetHigherPriorityRealityModelMasking";
+/** Remove masks from reality model.
+ * @beta
+ */
+class UnmaskRealityModelTool extends PlanarMaskBaseTool {
+    targetModelRequired() { return true; }
+    showPrompt() {
+        core_frontend_1.IModelApp.notifications.outputPromptByKey("FrontendDevTools:tools.UnmaskRealityModel.Prompts.IdentifyRealityModel");
+    }
+    createToolInstance() { return new UnmaskRealityModelTool(); }
+    applyMask(vp) {
+        const settings = core_common_1.PlanarClipMaskSettings.createForElementsOrSubCategories(core_common_1.PlanarClipMaskMode.IncludeSubCategories, this._acceptedSubCategoryIds, this._acceptedModelIds);
+        this.setRealityModelMask(vp, settings);
+    }
+    async onDataButtonDown(ev) {
+        const hit = await core_frontend_1.IModelApp.locateManager.doLocate(new core_frontend_1.LocateResponse(), true, ev.point, ev.viewport, ev.inputSource);
+        if (hit === null || hit === void 0 ? void 0 : hit.modelId) {
+            const model = hit.viewport.displayStyle.contextRealityModelStates.find((x) => x.modelId === hit.modelId);
+            if (model)
+                model.planarClipMaskSettings = undefined;
+            else
+                hit.viewport.displayStyle.settings.planarClipMasks.delete(hit.modelId);
+            await this.onRestartTool();
+        }
+        return core_frontend_1.EventHandled.No;
+    }
+}
+exports.UnmaskRealityModelTool = UnmaskRealityModelTool;
+UnmaskRealityModelTool.toolId = "UnmaskRealityModel";
+//# sourceMappingURL=PlanarMaskTools.js.map

package/lib/tools/PlanarMaskTools.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PlanarMaskTools.js","sourceRoot":"","sources":["../../src/tools/PlanarMaskTools.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAO/F,oDAAwG;AACxG,wDAE8B;AAE9B;;GAEG;AACH,MAAa,2BAA4B,SAAQ,oBAAI;IAE5C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAElC,KAAK,CAAC,GAAG,CAAC,YAAqB;QAC7C,MAAM,EAAE,GAAG,yBAAS,CAAC,WAAW,CAAC,YAAY,CAAC;QAC9C,IAAI,SAAS,KAAK,EAAE;YAClB,OAAO,KAAK,CAAC;QAEf,EAAE,CAAC,wBAAwB,CAAC,EAAE,cAAc,EAAE,EAAE,IAAI,EAAE,gCAAkB,CAAC,QAAQ,EAAE,QAAQ,EAAE,oCAAsB,CAAC,aAAa,EAAE,YAAY,EAAE,EAAE,CAAC,CAAC;QACrJ,EAAE,CAAC,oBAAoB,EAAE,CAAC;QAC1B,OAAO,IAAI,CAAC;IACd,CAAC;IAEe,KAAK,CAAC,WAAW,CAAC,GAAG,IAAc;QACjD,MAAM,YAAY,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QACzC,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,YAAY,KAAK,SAAS,IAAI,YAAY,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IACjG,CAAC;;AAlBH,kEAmBC;AAlBwB,kCAAM,GAAG,0BAA0B,CAAC;AAoB7D;;GAEG;AACH,MAAa,aAAc,SAAQ,oBAAI;IAE9B,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAElC,KAAK,CAAC,GAAG;QACvB,MAAM,EAAE,GAAG,yBAAS,CAAC,WAAW,CAAC,YAAY,CAAC;QAC9C,IAAI,SAAS,KAAK,EAAE;YAClB,OAAO,KAAK,CAAC;QAEf,EAAE,CAAC,wBAAwB,CAAC,EAAE,cAAc,EAAE,EAAE,IAAI,EAAE,gCAAkB,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACnF,EAAE,CAAC,oBAAoB,EAAE,CAAC;QAC1B,OAAO,IAAI,CAAC;IACd,CAAC;;AAbH,sCAcC;AAbwB,oBAAM,GAAG,WAAW,CAAC;AAe9C;;GAEG;AACH,MAAsB,kBAAmB,SAAQ,6BAAa;IAA9D;;QACqB,sBAAiB,GAAG,IAAI,GAAG,EAAc,CAAC;QAC1C,4BAAuB,GAAG,IAAI,GAAG,EAAc,CAAC;QAChD,wBAAmB,GAAG,IAAI,GAAG,EAAc,CAAC;QAErD,kBAAa,GAAY,KAAK,CAAC;IAwH3C,CAAC;IArHiB,sBAAsB,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IACnD,KAAK,CAAC,aAAa,KAAK,MAAM,KAAK,CAAC,aAAa,EAAE,CAAC,CAAC,IAAI,CAAC,2BAA2B,EAAE,CAAC,CAAC,CAAC;IAE1F,KAAK,CAAC,WAAW,KAAK,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;IAClD,2BAA2B;QACjC,IAAI,CAAC,aAAa,GAAG,CAAC,SAAS,KAAK,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QAC1F,IAAI,CAAC,kBAAkB,CAAC,CAAC,IAAI,CAAC,aAAa,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC;QACvG,yBAAS,CAAC,aAAa,CAAC,OAAO,CAAC,gBAAgB,GAAG,IAAI,CAAC,CAAI,gDAAgD;QAC5G,IAAI,CAAC,UAAU,EAAE,CAAC;IACpB,CAAC;IACS,mBAAmB,KAAc,OAAO,IAAI,CAAC,CAAC,CAAC;IAC/C,eAAe,KAAc,OAAO,IAAI,CAAC,CAAC,CAAC;IAC3C,cAAc,KAAc,OAAO,IAAI,CAAC,CAAC,CAAC;IAI5C,QAAQ;QACd,IAAI,CAAC,mBAAmB,CAAC,KAAK,EAAE,CAAC;QACjC,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,CAAC;IACjC,CAAC;IACe,KAAK,CAAC,QAAQ;QAC5B,MAAM,KAAK,CAAC,QAAQ,EAAE,CAAC;QACvB,IAAI,CAAC,aAAa,GAAG,SAAS,CAAC;IACjC,CAAC;IAEM,KAAK,CAAC,aAAa;QACxB,IAAI,CAAC,QAAQ,EAAE,CAAC;QAChB,IAAI,CAAC,uBAAuB,CAAC,KAAK,EAAE,CAAC;QACrC,MAAM,IAAI,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;QACvC,IAAI,CAAC,MAAM,IAAI,CAAC,GAAG,EAAE;YACnB,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC;IAC1B,CAAC;IAEe,KAAK,CAAC,WAAW,CAAC,GAAG,IAAc;QACjD,MAAM,YAAY,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QACzC,IAAI,CAAC,aAAa,GAAG,CAAC,YAAY,KAAK,SAAS,IAAI,YAAY,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;QACnG,OAAO,IAAI,CAAC,GAAG,EAAE,CAAC;IACpB,CAAC;IAEe,KAAK,CAAC,SAAS;QAC7B,IAAI,CAAC,KAAK,IAAI,CAAC,mBAAmB,CAAC,IAAI;YACrC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,mBAAmB,EAAE,KAAK,CAAC,CAAC;QACjE,IAAI,CAAC,QAAQ,EAAE,CAAC;IAClB,CAAC;IAEe,KAAK,CAAC,SAAS,CAAC,GAAc,EAAE,IAAqB;;QACnE,IAAI,CAAC,GAAG,CAAC,OAAO;YACd,OAAO,kCAAkB,CAAC,MAAM,CAAC;QAEnC,IAAI,SAAS,KAAK,IAAI,CAAC,gBAAgB,IAAI,IAAI,CAAC,mBAAmB,EAAE,EAAE;YACrE,IAAI,SAAS,KAAK,GAAG,CAAC,QAAQ,CAAC,YAAY,CAAC,yBAAyB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,KAAK,GAAG,CAAC,OAAO,CAAC;gBAC1G,OAAO,kCAAkB,CAAC,MAAM,CAAC;YAEnC,MAAM,KAAK,GAAG,MAAA,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,0CAAE,cAAc,CAAC;YACxE,OAAO,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,cAAc,EAAC,CAAC,CAAC,kCAAkB,CAAC,MAAM,CAAC,CAAC,CAAC,kCAAkB,CAAC,MAAM,CAAC;SACtF;;YACC,OAAO,CAAC,GAAG,CAAC,YAAY,IAAI,CAAC,GAAG,CAAC,UAAU,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,kCAAkB,CAAC,MAAM,CAAC,CAAC,CAAC,kCAAkB,CAAC,MAAM,CAAC;IACxJ,CAAC;IAEe,KAAK,CAAC,gBAAgB,CAAC,EAAiB;;QACtD,MAAM,GAAG,GAAG,MAAM,yBAAS,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI,8BAAc,EAAE,EAAE,IAAI,EAAE,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,WAAW,CAAC,CAAC;QACtH,MAAM,EAAE,GAAG,yBAAS,CAAC,WAAW,CAAC,YAAY,CAAC;QAC9C,IAAI,SAAS,KAAK,EAAE;YAClB,OAAO,4BAAY,CAAC,EAAE,CAAC;QAEzB,IAAI,SAAS,KAAK,GAAG,IAAI,SAAS,KAAK,IAAI,CAAC,gBAAgB,IAAI,IAAI,CAAC,mBAAmB,EAAE,EAAE;YAC1F,IAAI,GAAG,CAAC,OAAO,EAAE;gBACf,IAAI,CAAC,gBAAgB,GAAG,MAAA,GAAG,CAAC,QAAQ,CAAC,YAAY,CAAC,yBAAyB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,KAAK,GAAG,CAAC,OAAO,CAAC,mCAAI,GAAG,CAAC,OAAO,CAAC;gBAClI,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE;oBAC3B,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;oBACnB,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;iBAC5B;aACF;SACF;aAAM,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,QAAQ,EAAE;YAClE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;YACxF,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE;gBAC9B,IAAI,OAAO,CAAC,EAAE,IAAI,OAAO,CAAC,KAAK,EAAE;oBAC/B,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;oBACzC,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;iBAC3C;aACF;YACD,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;YACnB,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC;YACtB,OAAO,4BAAY,CAAC,EAAE,CAAC;SACxB;aAAM,IAAI,SAAS,KAAK,GAAG,IAAI,GAAG,CAAC,YAAY,EAAE;YAChD,MAAM,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;YAC9B,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE;gBAC3C,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;gBACvC,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,GAAG,CAAC,OAAQ,CAAC,CAAC;gBACzC,IAAI,GAAG,CAAC,aAAa;oBACnB,IAAI,CAAC,uBAAuB,CAAC,GAAG,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;gBACtD,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;aACpB;SACF;QACD,IAAI,CAAC,2BAA2B,EAAE,CAAC;QACnC,OAAO,4BAAY,CAAC,EAAE,CAAC;IACzB,CAAC;IAES,qBAAqB;QAC7B,OAAO,oCAAsB,CAAC,gCAAgC,CAAC,gCAAkB,CAAC,oBAAoB,EAAE,IAAI,CAAC,uBAAuB,EAAE,IAAI,CAAC,iBAAiB,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;IACpL,CAAC;IAES,iBAAiB,CAAC,MAA6B;QACvD,MAAM,IAAI,GAAG,SAAS,KAAK,MAAM,CAAC,CAAC,CAAC,gCAAkB,CAAC,eAAe,CAAC,CAAC,CAAC,gCAAkB,CAAC,eAAe,CAAC;QAC5G,OAAO,oCAAsB,CAAC,gCAAgC,CAAC,IAAI,EAAE,IAAI,CAAC,mBAAmB,EAAE,IAAI,CAAC,iBAAiB,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;IAC7I,CAAC;IAES,eAAe;QACvB,OAAO,oCAAsB,CAAC,eAAe,CAAC,IAAI,CAAC,iBAAiB,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;IAC5F,CAAC;IAES,mBAAmB,CAAC,EAAkB,EAAE,IAA4B;QAC5E,IAAI,OAAO,IAAI,CAAC,gBAAgB,KAAK,QAAQ;YAC3C,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,eAAe,CAAC,GAAG,CAAC,IAAI,CAAC,gBAAgB,EAAE,IAAI,CAAC,CAAC;aACvE,IAAI,SAAS,KAAK,IAAI,CAAC,gBAAgB;YAC1C,IAAI,CAAC,gBAAgB,CAAC,sBAAsB,GAAG,IAAI,CAAC;IACxD,CAAC;CACF;AA7HD,gDA6HC;AACD;;GAEG;AACH,MAAa,8BAA+B,SAAQ,kBAAkB;IAE7D,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC/B,mBAAmB,KAAK,OAAO,KAAK,CAAC,CAAC,CAAC;IAChD,UAAU;QAClB,yBAAS,CAAC,aAAa,CAAC,iBAAiB,CAAC,6DAA6D,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,qBAAqB,EAAE,CAAC,CAAC;IAC3K,CAAC;IACS,kBAAkB,KAAyB,OAAO,IAAI,8BAA8B,EAAE,CAAC,CAAC,CAAC;IACzF,SAAS,CAAC,EAAkB;QACpC,EAAE,CAAC,wBAAwB,CAAC,EAAE,cAAc,EAAE,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAC9F,CAAC;;AAXH,wEAYC;AAXwB,qCAAM,GAAG,4BAA4B,CAAC;AAY/D;;GAEG;AACH,MAAa,sCAAuC,SAAQ,kBAAkB;IAErE,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC/B,mBAAmB,KAAK,OAAO,KAAK,CAAC,CAAC,CAAC;IAChD,UAAU;QAClB,yBAAS,CAAC,aAAa,CAAC,iBAAiB,CAAC,qEAAqE,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,qBAAqB,EAAE,CAAC,CAAC;IACnL,CAAC;IACS,kBAAkB,KAAyB,OAAO,IAAI,sCAAsC,EAAE,CAAC,CAAC,CAAC;IACjG,SAAS,CAAC,EAAkB;QACpC,EAAE,CAAC,wBAAwB,CAAC,EAAE,cAAc,EAAE,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAC9F,CAAC;;AAXH,wFAYC;AAXwB,6CAAM,GAAG,oCAAoC,CAAC;AAavE;;GAEG;AACH,MAAa,kCAAmC,SAAQ,kBAAkB;IAEjE,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC/B,mBAAmB,KAAK,OAAO,KAAK,CAAC,CAAC,CAAC;IACvC,cAAc,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC,CAAG,mCAAmC;IAC1F,UAAU;QAClB,yBAAS,CAAC,aAAa,CAAC,iBAAiB,CAAC,uFAAuF,CAAC,CAAC;IACrI,CAAC;IACS,kBAAkB,KAAyB,OAAO,IAAI,kCAAkC,EAAE,CAAC,CAAC,CAAC;IAC7F,SAAS,CAAC,EAAkB;QACpC,EAAE,CAAC,wBAAwB,CAAC,EAAE,cAAc,EAAE,IAAI,CAAC,qBAAqB,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IACzF,CAAC;;AAZH,gFAaC;AAZwB,yCAAM,GAAG,gCAAgC,CAAC;AAcnE;;GAEG;AACH,MAAa,4BAA6B,SAAQ,kBAAkB;IAE3D,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC/B,mBAAmB,KAAK,OAAO,KAAK,CAAC,CAAC,CAAC;IAChD,UAAU;QAClB,yBAAS,CAAC,aAAa,CAAC,iBAAiB,CAAC,2DAA2D,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,mBAAmB,EAAE,CAAC,CAAC;IACvK,CAAC;IACS,kBAAkB,KAAyB,OAAO,IAAI,4BAA4B,EAAE,CAAC,CAAC,CAAC;IACvF,SAAS,CAAC,EAAkB;QACpC,EAAE,CAAC,wBAAwB,CAAC,EAAE,cAAc,EAAE,IAAI,CAAC,eAAe,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IACnF,CAAC;;AAXH,oEAYC;AAXwB,mCAAM,GAAG,0BAA0B,CAAC;AAa7D;;GAEG;AACH,MAAa,6BAA8B,SAAQ,kBAAkB;IAE5D,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC/B,mBAAmB,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IAE/C,UAAU;QAClB,MAAM,GAAG,GAAG,4DAA4D,IAAI,CAAC,gBAAgB,KAAK,SAAS,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,qBAAqB,CAAC,EAAE,CAAC;QAC1M,yBAAS,CAAC,aAAa,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC;IACjD,CAAC;IACS,kBAAkB,KAAyB,OAAO,IAAI,6BAA6B,EAAE,CAAC,CAAC,CAAC;IACxF,SAAS,CAAC,EAAkB;QACpC,IAAI,CAAC,mBAAmB,CAAC,EAAE,EAAE,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,CAAC;IAClE,CAAC;;AAbH,sEAcC;AAbwB,oCAAM,GAAG,2BAA2B,CAAC;AAe9D;;GAEG;AACH,MAAa,qCAAsC,SAAQ,kBAAkB;IAEpE,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC/B,mBAAmB,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IAE/C,UAAU;QAClB,MAAM,GAAG,GAAG,oEAAoE,IAAI,CAAC,gBAAgB,KAAK,SAAS,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,qBAAqB,CAAC,EAAE,CAAC;QAClN,yBAAS,CAAC,aAAa,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC;IACjD,CAAC;IACS,kBAAkB,KAAyB,OAAO,IAAI,qCAAqC,EAAE,CAAC,CAAC,CAAC;IAChG,SAAS,CAAC,EAAkB;QACpC,IAAI,CAAC,mBAAmB,CAAC,EAAE,EAAE,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,CAAC;IAClE,CAAC;;AAbH,sFAcC;AAbwB,4CAAM,GAAG,mCAAmC,CAAC;AAetE;;GAEG;AAEH,MAAa,2BAA4B,SAAQ,kBAAkB;IAE1D,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAE/B,mBAAmB,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IAE/C,UAAU;QAClB,MAAM,GAAG,GAAG,0DAA0D,IAAI,CAAC,gBAAgB,KAAK,SAAS,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,mBAAmB,CAAC,EAAE,CAAC;QACtM,yBAAS,CAAC,aAAa,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC;IACjD,CAAC;IACS,kBAAkB,KAAyB,OAAO,IAAI,2BAA2B,EAAE,CAAC,CAAC,CAAC;IACtF,SAAS,CAAC,EAAkB;QACpC,IAAI,CAAC,mBAAmB,CAAC,EAAE,EAAE,IAAI,CAAC,eAAe,EAAE,CAAC,CAAC;IACvD,CAAC;;AAdH,kEAeC;AAdwB,kCAAM,GAAG,yBAAyB,CAAC;AAgB5D;;GAEG;AACH,MAAa,iCAAkC,SAAQ,kBAAkB;IAEhE,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC/B,mBAAmB,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IACtC,cAAc,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC,CAAG,mCAAmC;IAE1F,UAAU;QAClB,MAAM,GAAG,GAAG,0DAA0D,IAAI,CAAC,gBAAgB,KAAK,SAAS,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC,yBAAyB,EAAE,CAAC;QACjK,yBAAS,CAAC,aAAa,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC;IACjD,CAAC;IACS,kBAAkB,KAAyB,OAAO,IAAI,iCAAiC,EAAE,CAAC,CAAC,CAAC;IAC5F,SAAS,CAAC,EAAkB;QACpC,IAAI,CAAC,mBAAmB,CAAC,EAAE,EAAE,IAAI,CAAC,qBAAqB,EAAE,CAAC,CAAC;IAC7D,CAAC;;AAdH,8EAeC;AAdwB,wCAAM,GAAG,+BAA+B,CAAC;AAgBlE;;GAEG;AACH,MAAa,oCAAqC,SAAQ,kBAAkB;IAA5E;;QAMU,cAAS,GAAG,CAAC,CAAC;IAiBxB,CAAC;IArBQ,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC/B,mBAAmB,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IACtC,eAAe,KAAK,OAAO,KAAK,CAAC,CAAC,CAAC;IAG5C,UAAU;QAClB,yBAAS,CAAC,aAAa,CAAC,iBAAiB,CAAC,0FAA0F,CAAC,CAAC;IACxI,CAAC;IACS,kBAAkB,KAAyB,OAAO,IAAI,oCAAoC,EAAE,CAAC,CAAC,CAAC;IAC/F,SAAS,CAAC,EAAkB;QACpC,MAAM,YAAY,GAAG,IAAI,CAAC,gBAAgB,KAAK,EAAE,CAAC,YAAY,CAAC,0BAA0B,EAAE,CAAC,CAAC,CAAC,oCAAsB,CAAC,kBAAkB,CAAC,CAAC,CAAC,oCAAsB,CAAC,YAAY,CAAC;QAC9K,IAAI,CAAC,mBAAmB,CAAC,EAAE,EAAE,oCAAsB,CAAC,gBAAgB,CAAC,YAAY,GAAG,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,aAAa,CAAE,CAAC,CAAC;IAC5H,CAAC;IAEe,KAAK,CAAC,WAAW,CAAC,GAAG,IAAc;QACjD,MAAM,KAAK,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,CAAC;QACjC,MAAM,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACvC,IAAI,CAAC,SAAS,GAAG,CAAC,QAAQ,KAAK,SAAS,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;QAC5E,OAAO,IAAI,CAAC,GAAG,EAAE,CAAC;IACpB,CAAC;;AAtBH,oFAuBC;AAtBwB,2CAAM,GAAG,sCAAsC,CAAC;AAwBzE;;GAEG;AACH,MAAa,sBAAuB,SAAQ,kBAAkB;IAEzC,mBAAmB,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IAE/C,UAAU;QAClB,yBAAS,CAAC,aAAa,CAAC,iBAAiB,CAAC,wEAAwE,CAAC,CAAC;IACtH,CAAC;IACS,kBAAkB,KAAyB,OAAO,IAAI,sBAAsB,EAAE,CAAC,CAAC,CAAC;IACjF,SAAS,CAAC,EAAkB;QACpC,MAAM,QAAQ,GAAG,oCAAsB,CAAC,gCAAgC,CAAC,gCAAkB,CAAC,oBAAoB,EAAE,IAAI,CAAC,uBAAuB,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAC;QACxK,IAAI,CAAC,mBAAmB,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;IACzC,CAAC;IACe,KAAK,CAAC,gBAAgB,CAAC,EAAiB;QACtD,MAAM,GAAG,GAAG,MAAM,yBAAS,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI,8BAAc,EAAE,EAAE,IAAI,EAAE,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,WAAW,CAAC,CAAC;QACtH,IAAI,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,OAAO,EAAE;YAChB,MAAM,KAAK,GAAG,GAAG,CAAC,QAAQ,CAAC,YAAY,CAAC,yBAAyB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,KAAK,GAAG,CAAC,OAAO,CAAC,CAAC;YACzG,IAAI,KAAK;gBACP,KAAK,CAAC,sBAAsB,GAAG,SAAS,CAAC;;gBAEzC,GAAG,CAAC,QAAQ,CAAC,YAAY,CAAC,QAAQ,CAAC,eAAe,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YAEzE,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;SAC5B;QAED,OAAO,4BAAY,CAAC,EAAE,CAAC;IACzB,CAAC;;AAzBH,wDA0BC;AAzBwB,6BAAM,GAAG,oBAAoB,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n\r\n/** @packageDocumentation\r\n * @module Tools\r\n */\r\n\r\nimport { Id64String } from \"@itwin/core-bentley\";\r\nimport { PlanarClipMaskMode, PlanarClipMaskPriority, PlanarClipMaskSettings } from \"@itwin/core-common\";\r\nimport {\r\n  BeButtonEvent, ContextRealityModelState, EventHandled, HitDetail, IModelApp, LocateFilterStatus, LocateResponse, PrimitiveTool, ScreenViewport, Tool,\r\n} from \"@itwin/core-frontend\";\r\n\r\n/** Set Map Masking by selected models.\r\n * @beta\r\n */\r\nexport class SetMapHigherPriorityMasking extends Tool {\r\n  public static override toolId = \"SetMapHigherPriorityMask\";\r\n  public static override get minArgs() { return 0; }\r\n  public static override get maxArgs() { return 1; }\r\n\r\n  public override async run(transparency?: number): Promise<boolean> {\r\n    const vp = IModelApp.viewManager.selectedView;\r\n    if (undefined === vp)\r\n      return false;\r\n\r\n    vp.changeBackgroundMapProps({ planarClipMask: { mode: PlanarClipMaskMode.Priority, priority: PlanarClipMaskPriority.BackgroundMap, transparency } });\r\n    vp.invalidateRenderPlan();\r\n    return true;\r\n  }\r\n\r\n  public override async parseAndRun(...args: string[]): Promise<boolean> {\r\n    const transparency = parseFloat(args[0]);\r\n    return this.run((transparency !== undefined && transparency < 1.0) ? transparency : undefined);\r\n  }\r\n}\r\n\r\n/** Unmask Mask.\r\n * @beta\r\n */\r\nexport class UnmaskMapTool extends Tool {\r\n  public static override toolId = \"UnmaskMap\";\r\n  public static override get minArgs() { return 0; }\r\n  public static override get maxArgs() { return 0; }\r\n\r\n  public override async run(): Promise<boolean> {\r\n    const vp = IModelApp.viewManager.selectedView;\r\n    if (undefined === vp)\r\n      return false;\r\n\r\n    vp.changeBackgroundMapProps({ planarClipMask: { mode: PlanarClipMaskMode.None } });\r\n    vp.invalidateRenderPlan();\r\n    return true;\r\n  }\r\n}\r\n\r\n/** Base class for the reality model planar masking tools.\r\n * @beta\r\n */\r\nexport abstract class PlanarMaskBaseTool extends PrimitiveTool {\r\n  protected readonly _acceptedModelIds = new Set<Id64String>();\r\n  protected readonly _acceptedSubCategoryIds = new Set<Id64String>();\r\n  protected readonly _acceptedElementIds = new Set<Id64String>();\r\n  protected _transparency?: number;\r\n  protected _useSelection: boolean = false;\r\n  protected _targetMaskModel?: Id64String | ContextRealityModelState;\r\n\r\n  public override requireWriteableTarget(): boolean { return false; }\r\n  public override async onPostInstall() { await super.onPostInstall(); this.setupAndPromptForNextAction(); }\r\n\r\n  public override async onUnsuspend() { this.showPrompt(); }\r\n  private setupAndPromptForNextAction(): void {\r\n    this._useSelection = (undefined !== this.targetView && this.iModel.selectionSet.isActive);\r\n    this.initLocateElements(!this._useSelection || (this.targetModelRequired() && !this._targetMaskModel));\r\n    IModelApp.locateManager.options.allowDecorations = true;    // So we can select \"contextual\" reality models.\r\n    this.showPrompt();\r\n  }\r\n  protected targetModelRequired(): boolean { return true; }\r\n  protected elementRequired(): boolean { return true; }\r\n  protected allowSelection(): boolean { return true; }\r\n  protected abstract showPrompt(): void;\r\n  protected abstract createToolInstance(): PlanarMaskBaseTool;\r\n  protected abstract applyMask(vp: ScreenViewport): void;\r\n  private clearIds() {\r\n    this._acceptedElementIds.clear();\r\n    this._acceptedModelIds.clear();\r\n  }\r\n  public override async exitTool() {\r\n    await super.exitTool();\r\n    this._transparency = undefined;\r\n  }\r\n\r\n  public async onRestartTool() {\r\n    this.clearIds();\r\n    this._acceptedSubCategoryIds.clear();\r\n    const tool = this.createToolInstance();\r\n    if (!await tool.run())\r\n      await this.exitTool();\r\n  }\r\n\r\n  public override async parseAndRun(...args: string[]): Promise<boolean> {\r\n    const transparency = parseFloat(args[0]);\r\n    this._transparency = (transparency !== undefined && transparency < 1.0) ? transparency : undefined;\r\n    return this.run();\r\n  }\r\n\r\n  public override async onCleanup() {\r\n    if (0 !== this._acceptedElementIds.size)\r\n      this.iModel.hilited.setHilite(this._acceptedElementIds, false);\r\n    this.clearIds();\r\n  }\r\n\r\n  public override async filterHit(hit: HitDetail, _out?: LocateResponse): Promise<LocateFilterStatus> {\r\n    if (!hit.modelId)\r\n      return LocateFilterStatus.Reject;\r\n\r\n    if (undefined === this._targetMaskModel && this.targetModelRequired()) {\r\n      if (undefined !== hit.viewport.displayStyle.contextRealityModelStates.find((x) => x.modelId === hit.modelId))\r\n        return LocateFilterStatus.Accept;\r\n\r\n      const model = this.iModel.models.getLoaded(hit.modelId)?.asSpatialModel;\r\n      return model?.isRealityModel ? LocateFilterStatus.Accept : LocateFilterStatus.Reject;\r\n    } else\r\n      return (hit.isElementHit && !hit.isModelHit && !this._acceptedElementIds.has(hit.sourceId)) ? LocateFilterStatus.Accept : LocateFilterStatus.Reject;\r\n  }\r\n\r\n  public override async onDataButtonDown(ev: BeButtonEvent): Promise<EventHandled> {\r\n    const hit = await IModelApp.locateManager.doLocate(new LocateResponse(), true, ev.point, ev.viewport, ev.inputSource);\r\n    const vp = IModelApp.viewManager.selectedView;\r\n    if (undefined === vp)\r\n      return EventHandled.No;\r\n\r\n    if (undefined !== hit && undefined === this._targetMaskModel && this.targetModelRequired()) {\r\n      if (hit.modelId) {\r\n        this._targetMaskModel = hit.viewport.displayStyle.contextRealityModelStates.find((x) => x.modelId === hit.modelId) ?? hit.modelId;\r\n        if (!this.elementRequired()) {\r\n          this.applyMask(vp);\r\n          await this.onRestartTool();\r\n        }\r\n      }\r\n    } else if (this._useSelection && this.iModel.selectionSet.isActive) {\r\n      const elements = await this.iModel.elements.getProps(this.iModel.selectionSet.elements);\r\n      for (const element of elements) {\r\n        if (element.id && element.model) {\r\n          this._acceptedElementIds.add(element.id);\r\n          this._acceptedModelIds.add(element.model);\r\n        }\r\n      }\r\n      this.applyMask(vp);\r\n      await this.exitTool();\r\n      return EventHandled.No;\r\n    } else if (undefined !== hit && hit.isElementHit) {\r\n      const sourceId = hit.sourceId;\r\n      if (!this._acceptedElementIds.has(sourceId)) {\r\n        this._acceptedElementIds.add(sourceId);\r\n        this._acceptedModelIds.add(hit.modelId!);\r\n        if (hit.subCategoryId)\r\n          this._acceptedSubCategoryIds.add(hit.subCategoryId);\r\n        this.applyMask(vp);\r\n      }\r\n    }\r\n    this.setupAndPromptForNextAction();\r\n    return EventHandled.No;\r\n  }\r\n\r\n  protected createSubCategoryMask() {\r\n    return PlanarClipMaskSettings.createForElementsOrSubCategories(PlanarClipMaskMode.IncludeSubCategories, this._acceptedSubCategoryIds, this._acceptedModelIds, this._transparency);\r\n  }\r\n\r\n  protected createElementMask(option: \"include\" | \"exclude\") {\r\n    const mode = \"include\" === option ? PlanarClipMaskMode.IncludeElements : PlanarClipMaskMode.ExcludeElements;\r\n    return PlanarClipMaskSettings.createForElementsOrSubCategories(mode, this._acceptedElementIds, this._acceptedModelIds, this._transparency);\r\n  }\r\n\r\n  protected createModelMask() {\r\n    return PlanarClipMaskSettings.createForModels(this._acceptedModelIds, this._transparency);\r\n  }\r\n\r\n  protected setRealityModelMask(vp: ScreenViewport, mask: PlanarClipMaskSettings): void {\r\n    if (typeof this._targetMaskModel === \"string\")\r\n      vp.displayStyle.settings.planarClipMasks.set(this._targetMaskModel, mask);\r\n    else if (undefined !== this._targetMaskModel)\r\n      this._targetMaskModel.planarClipMaskSettings = mask;\r\n  }\r\n}\r\n/** Tool to mask background map by elements\r\n * @beta\r\n */\r\nexport class MaskBackgroundMapByElementTool extends PlanarMaskBaseTool {\r\n  public static override toolId = \"MaskBackgroundMapByElement\";\r\n  public static override get minArgs() { return 0; }\r\n  public static override get maxArgs() { return 1; }\r\n  protected override targetModelRequired() { return false; }\r\n  protected showPrompt(): void {\r\n    IModelApp.notifications.outputPromptByKey(`FrontendDevTools:tools.MaskBackgroundMapByElement.Prompts.${this._useSelection ? \"AcceptSelection\" : \"IdentifyMaskElement\"}`);\r\n  }\r\n  protected createToolInstance(): PlanarMaskBaseTool { return new MaskBackgroundMapByElementTool(); }\r\n  protected applyMask(vp: ScreenViewport): void {\r\n    vp.changeBackgroundMapProps({ planarClipMask: this.createElementMask(\"include\").toJSON() });\r\n  }\r\n}\r\n/** Tool to mask background map by excluded elements\r\n * @beta\r\n */\r\nexport class MaskBackgroundMapByExcludedElementTool extends PlanarMaskBaseTool {\r\n  public static override toolId = \"MaskBackgroundMapByExcludedElement\";\r\n  public static override get minArgs() { return 0; }\r\n  public static override get maxArgs() { return 1; }\r\n  protected override targetModelRequired() { return false; }\r\n  protected showPrompt(): void {\r\n    IModelApp.notifications.outputPromptByKey(`FrontendDevTools:tools.MaskBackgroundMapByExcludedElement.Prompts.${this._useSelection ? \"AcceptSelection\" : \"IdentifyMaskElement\"}`);\r\n  }\r\n  protected createToolInstance(): PlanarMaskBaseTool { return new MaskBackgroundMapByExcludedElementTool(); }\r\n  protected applyMask(vp: ScreenViewport): void {\r\n    vp.changeBackgroundMapProps({ planarClipMask: this.createElementMask(\"exclude\").toJSON() });\r\n  }\r\n}\r\n\r\n/** Tool to mask background map by SubCategories\r\n * @beta\r\n */\r\nexport class MaskBackgroundMapBySubCategoryTool extends PlanarMaskBaseTool {\r\n  public static override toolId = \"MaskBackgroundMapBySubCategory\";\r\n  public static override get minArgs() { return 0; }\r\n  public static override get maxArgs() { return 1; }\r\n  protected override targetModelRequired() { return false; }\r\n  protected override allowSelection(): boolean { return false; }   // Need picking to get subcategory.\r\n  protected showPrompt(): void {\r\n    IModelApp.notifications.outputPromptByKey(\"FrontendDevTools:tools.MaskBackgroundMapBySubCategory.Prompts.IdentifyMaskSubCategory\");\r\n  }\r\n  protected createToolInstance(): PlanarMaskBaseTool { return new MaskBackgroundMapBySubCategoryTool(); }\r\n  protected applyMask(vp: ScreenViewport): void {\r\n    vp.changeBackgroundMapProps({ planarClipMask: this.createSubCategoryMask().toJSON() });\r\n  }\r\n}\r\n\r\n/** Tool to mask background map by geometric models\r\n * @beta\r\n */\r\nexport class MaskBackgroundMapByModelTool extends PlanarMaskBaseTool {\r\n  public static override toolId = \"MaskBackgroundMapByModel\";\r\n  public static override get minArgs() { return 0; }\r\n  public static override get maxArgs() { return 1; }\r\n  protected override targetModelRequired() { return false; }\r\n  protected showPrompt(): void {\r\n    IModelApp.notifications.outputPromptByKey(`FrontendDevTools:tools.MaskBackgroundMapByModel.Prompts.${this._useSelection ? \"AcceptSelection\" : \"IdentifyMaskModel\"}`);\r\n  }\r\n  protected createToolInstance(): PlanarMaskBaseTool { return new MaskBackgroundMapByModelTool(); }\r\n  protected applyMask(vp: ScreenViewport): void {\r\n    vp.changeBackgroundMapProps({ planarClipMask: this.createModelMask().toJSON() });\r\n  }\r\n}\r\n\r\n/** Tool to mask reality model by elements\r\n * @beta\r\n */\r\nexport class MaskRealityModelByElementTool extends PlanarMaskBaseTool {\r\n  public static override toolId = \"MaskRealityModelByElement\";\r\n  public static override get minArgs() { return 0; }\r\n  public static override get maxArgs() { return 1; }\r\n  protected override targetModelRequired() { return true; }\r\n\r\n  protected showPrompt(): void {\r\n    const key = `FrontendDevTools:tools.MaskRealityModelByElement.Prompts.${this._targetMaskModel === undefined ? \"IdentifyRealityModel\" : (this._useSelection ? \"AcceptSelection\" : \"IdentifyMaskElement\")}`;\r\n    IModelApp.notifications.outputPromptByKey(key);\r\n  }\r\n  protected createToolInstance(): PlanarMaskBaseTool { return new MaskRealityModelByElementTool(); }\r\n  protected applyMask(vp: ScreenViewport): void {\r\n    this.setRealityModelMask(vp, this.createElementMask(\"include\"));\r\n  }\r\n}\r\n\r\n/** Tool to mask reality model by excluded elements\r\n * @beta\r\n */\r\nexport class MaskRealityModelByExcludedElementTool extends PlanarMaskBaseTool {\r\n  public static override toolId = \"MaskRealityModelByExcludedElement\";\r\n  public static override get minArgs() { return 0; }\r\n  public static override get maxArgs() { return 1; }\r\n  protected override targetModelRequired() { return true; }\r\n\r\n  protected showPrompt(): void {\r\n    const key = `FrontendDevTools:tools.MaskRealityModelByExcludedElement.Prompts.${this._targetMaskModel === undefined ? \"IdentifyRealityModel\" : (this._useSelection ? \"AcceptSelection\" : \"IdentifyMaskElement\")}`;\r\n    IModelApp.notifications.outputPromptByKey(key);\r\n  }\r\n  protected createToolInstance(): PlanarMaskBaseTool { return new MaskRealityModelByExcludedElementTool(); }\r\n  protected applyMask(vp: ScreenViewport): void {\r\n    this.setRealityModelMask(vp, this.createElementMask(\"exclude\"));\r\n  }\r\n}\r\n\r\n/** Tool to mask reality model by geometric models\r\n * @beta\r\n */\r\n\r\nexport class MaskRealityModelByModelTool extends PlanarMaskBaseTool {\r\n  public static override toolId = \"MaskRealityModelByModel\";\r\n  public static override get minArgs() { return 0; }\r\n  public static override get maxArgs() { return 1; }\r\n\r\n  protected override targetModelRequired() { return true; }\r\n\r\n  protected showPrompt(): void {\r\n    const key = `FrontendDevTools:tools.MaskRealityModelByModel.Prompts.${this._targetMaskModel === undefined ? \"IdentifyRealityModel\" : (this._useSelection ? \"AcceptSelection\" : \"IdentifyMaskModel\")}`;\r\n    IModelApp.notifications.outputPromptByKey(key);\r\n  }\r\n  protected createToolInstance(): PlanarMaskBaseTool { return new MaskRealityModelByModelTool(); }\r\n  protected applyMask(vp: ScreenViewport): void {\r\n    this.setRealityModelMask(vp, this.createModelMask());\r\n  }\r\n}\r\n\r\n/** Tool to mask reality model by SubCategories\r\n * @beta\r\n */\r\nexport class MaskRealityModelBySubCategoryTool extends PlanarMaskBaseTool {\r\n  public static override toolId = \"MaskRealityModelBySubCategory\";\r\n  public static override get minArgs() { return 0; }\r\n  public static override get maxArgs() { return 1; }\r\n  protected override targetModelRequired() { return true; }\r\n  protected override allowSelection(): boolean { return false; }   // Need picking to get subcategory.\r\n\r\n  protected showPrompt(): void {\r\n    const key = `FrontendDevTools:tools.MaskRealityModelByModel.Prompts.${this._targetMaskModel === undefined ? \"IdentifyRealityModel\" : \"IdentifyMaskSubCategory\"}`;\r\n    IModelApp.notifications.outputPromptByKey(key);\r\n  }\r\n  protected createToolInstance(): PlanarMaskBaseTool { return new MaskRealityModelBySubCategoryTool(); }\r\n  protected applyMask(vp: ScreenViewport): void {\r\n    this.setRealityModelMask(vp, this.createSubCategoryMask());\r\n  }\r\n}\r\n\r\n/** Tool to mask reality model by higher priority models.\r\n * @beta\r\n */\r\nexport class SetHigherPriorityRealityModelMasking extends PlanarMaskBaseTool {\r\n  public static override toolId = \"SetHigherPriorityRealityModelMasking\";\r\n  public static override get minArgs() { return 0; }\r\n  public static override get maxArgs() { return 2; }\r\n  protected override targetModelRequired() { return true; }\r\n  protected override elementRequired() { return false; }\r\n  private _priority = 0;\r\n\r\n  protected showPrompt(): void {\r\n    IModelApp.notifications.outputPromptByKey(\"FrontendDevTools:tools.SetHigherPriorityRealityModelMasking.Prompts.IdentifyRealityModel\");\r\n  }\r\n  protected createToolInstance(): PlanarMaskBaseTool { return new SetHigherPriorityRealityModelMasking(); }\r\n  protected applyMask(vp: ScreenViewport): void {\r\n    const basePriority = this._targetMaskModel === vp.displayStyle.getOSMBuildingRealityModel() ? PlanarClipMaskPriority.GlobalRealityModel : PlanarClipMaskPriority.RealityModel;\r\n    this.setRealityModelMask(vp, PlanarClipMaskSettings.createByPriority(basePriority + this._priority, this._transparency)!);\r\n  }\r\n\r\n  public override async parseAndRun(...args: string[]): Promise<boolean> {\r\n    await super.parseAndRun(...args);\r\n    const priority = parseInt(args[0], 10);\r\n    this._priority = (priority === undefined || isNaN(priority)) ? 0 : priority;\r\n    return this.run();\r\n  }\r\n}\r\n\r\n/** Remove masks from reality model.\r\n * @beta\r\n */\r\nexport class UnmaskRealityModelTool extends PlanarMaskBaseTool {\r\n  public static override toolId = \"UnmaskRealityModel\";\r\n  protected override targetModelRequired() { return true; }\r\n\r\n  protected showPrompt(): void {\r\n    IModelApp.notifications.outputPromptByKey(\"FrontendDevTools:tools.UnmaskRealityModel.Prompts.IdentifyRealityModel\");\r\n  }\r\n  protected createToolInstance(): PlanarMaskBaseTool { return new UnmaskRealityModelTool(); }\r\n  protected applyMask(vp: ScreenViewport): void {\r\n    const settings = PlanarClipMaskSettings.createForElementsOrSubCategories(PlanarClipMaskMode.IncludeSubCategories, this._acceptedSubCategoryIds, this._acceptedModelIds);\r\n    this.setRealityModelMask(vp, settings);\r\n  }\r\n  public override async onDataButtonDown(ev: BeButtonEvent): Promise<EventHandled> {\r\n    const hit = await IModelApp.locateManager.doLocate(new LocateResponse(), true, ev.point, ev.viewport, ev.inputSource);\r\n    if (hit?.modelId) {\r\n      const model = hit.viewport.displayStyle.contextRealityModelStates.find((x) => x.modelId === hit.modelId);\r\n      if (model)\r\n        model.planarClipMaskSettings = undefined;\r\n      else\r\n        hit.viewport.displayStyle.settings.planarClipMasks.delete(hit.modelId);\r\n\r\n      await this.onRestartTool();\r\n    }\r\n\r\n    return EventHandled.No;\r\n  }\r\n}\r\n"]}