@itwin/frontend-devtools 3.4.0-dev.48 → 3.4.0-dev.55

package/lib/cjs/tools/PlanarMaskTools.js

@@ -1,391 +1,394 @@
-"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");
-const parseBoolean_1 = require("./parseBoolean");
-/** Set Map Masking by selected models.
- * @beta
- */
-class SetMapHigherPriorityMasking extends core_frontend_1.Tool {
-    static get minArgs() { return 0; }
-    static get maxArgs() { return 2; }
-    async run(transparency, invert) {
-        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, invert } });
-        vp.invalidateRenderPlan();
-        return true;
-    }
-    async parseAndRun(...args) {
-        const transparency = parseFloat(args[0]);
-        let invert;
-        if (args.length > 1)
-            invert = (0, parseBoolean_1.parseBoolean)(args[1]);
-        return this.run((transparency !== undefined && transparency < 1.0) ? transparency : 0, invert === true);
-    }
-}
-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, transparency: 0, invert: false } });
-        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._transparency = 0;
-        this._useSelection = false;
-        this._invert = 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 = 0;
-    }
-    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 : 0;
-        if (args.length > 1)
-            this._invert = (0, parseBoolean_1.parseBoolean)(args[1]) === true;
-        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.create({
-            subCategoryIds: this._acceptedSubCategoryIds,
-            modelIds: this._acceptedModelIds,
-            transparency: this._transparency,
-            invert: this._invert,
-        });
-    }
-    createElementMask(option) {
-        return core_common_1.PlanarClipMaskSettings.create({
-            elementIds: this._acceptedElementIds,
-            exclude: "exclude" === option,
-            modelIds: this._acceptedModelIds,
-            transparency: this._transparency,
-            invert: this._invert,
-        });
-    }
-    createModelMask() {
-        return core_common_1.PlanarClipMaskSettings.create({ modelIds: this._acceptedModelIds, transparency: this._transparency, invert: this._invert });
-    }
-    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 2; }
-    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 2; }
-    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 2; }
-    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 2; }
-    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 2; }
-    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 2; }
-    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 2; }
-    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 2; }
-    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 3; }
-    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.create({ priority: basePriority + this._priority, transparency: this._transparency, invert: this._invert }));
-    }
-    async parseAndRun(...args) {
-        await super.parseAndRun(...args);
-        const priority = parseInt(args[0], 10);
-        this._priority = (priority === undefined || isNaN(priority)) ? 0 : priority;
-        if (args.length > 1) {
-            const value = parseInt(args[1], 10);
-            if (!isNaN(value) && value >= 0 && value <= 1)
-                this._transparency = value;
-        }
-        if (args.length > 2)
-            this._invert = (0, parseBoolean_1.parseBoolean)(args[2]) === true;
-        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.create({ subCategoryIds: this._acceptedSubCategoryIds, modelIds: 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";
+"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");
+const parseBoolean_1 = require("./parseBoolean");
+/** Set Map Masking by selected models.
+ * @beta
+ */
+class SetMapHigherPriorityMasking extends core_frontend_1.Tool {
+    static get minArgs() { return 0; }
+    static get maxArgs() { return 2; }
+    async run(transparency, invert) {
+        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, invert } });
+        vp.invalidateRenderPlan();
+        return true;
+    }
+    async parseAndRun(...args) {
+        const transparency = parseFloat(args[0]);
+        let invert;
+        if (args.length > 1)
+            invert = (0, parseBoolean_1.parseBoolean)(args[1]);
+        return this.run((transparency !== undefined && transparency < 1.0) ? transparency : 0, invert === true);
+    }
+}
+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, transparency: 0, invert: false } });
+        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._transparency = 0;
+        this._useSelection = false;
+        this._invert = 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 = 0;
+    }
+    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 : 0;
+        if (args.length > 1)
+            this._invert = (0, parseBoolean_1.parseBoolean)(args[1]) === true;
+        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.create({
+            subCategoryIds: this._acceptedSubCategoryIds,
+            modelIds: this._acceptedModelIds,
+            transparency: this._transparency,
+            invert: this._invert,
+        });
+    }
+    createElementMask(option) {
+        return core_common_1.PlanarClipMaskSettings.create({
+            elementIds: this._acceptedElementIds,
+            exclude: "exclude" === option,
+            modelIds: this._acceptedModelIds,
+            transparency: this._transparency,
+            invert: this._invert,
+        });
+    }
+    createModelMask() {
+        return core_common_1.PlanarClipMaskSettings.create({ modelIds: this._acceptedModelIds, transparency: this._transparency, invert: this._invert });
+    }
+    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 2; }
+    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 2; }
+    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 2; }
+    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 2; }
+    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 2; }
+    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 2; }
+    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 2; }
+    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 2; }
+    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 3; }
+    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.create({ priority: basePriority + this._priority, transparency: this._transparency, invert: this._invert }));
+    }
+    async parseAndRun(...args) {
+        await super.parseAndRun(...args);
+        const priority = parseInt(args[0], 10);
+        this._priority = (priority === undefined || isNaN(priority)) ? 0 : priority;
+        if (args.length > 1) {
+            const value = parseInt(args[1], 10);
+            if (!isNaN(value) && value >= 0 && value <= 1)
+                this._transparency = value;
+        }
+        if (args.length > 2)
+            this._invert = (0, parseBoolean_1.parseBoolean)(args[2]) === true;
+        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.create({ subCategoryIds: this._acceptedSubCategoryIds, modelIds: 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