@itwin/frontend-devtools 3.0.0-dev.78 → 3.0.0-dev.82

package/lib/esm/tools/DisplayStyleTools.d.ts

@@ -0,0 +1,99 @@
+/** @packageDocumentation
+ * @module Tools
+ */
+import { ViewFlags } from "@itwin/core-common";
+import { Tool, Viewport } from "@itwin/core-frontend";
+/** Modifies the selected viewport's DisplayStyleState.
+ * @beta
+ */
+export declare abstract class DisplayStyleTool extends Tool {
+    protected get require3d(): boolean;
+    protected abstract execute(vp: Viewport): boolean;
+    protected abstract parse(args: string[]): boolean;
+    run(): Promise<boolean>;
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
+/** Modifies the selected viewport's ViewFlags.
+ * The keyin syntax is as follows:
+ *  fdt change viewflags flag=value
+ * Where 'flag' is one of the BooleanFlagName values, or "renderMode"; and value is an integer.
+ * For boolean flags, value is 0 for false or 1 for true. For renderMode, value is one of the RenderMode enum values.
+ * Flag names are case-insensitive.
+ * @beta
+ */
+export declare class ChangeViewFlagsTool extends Tool {
+    static toolId: string;
+    static get maxArgs(): undefined;
+    static get minArgs(): number;
+    run(vf: ViewFlags, vp?: Viewport): Promise<boolean>;
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
+/** Toggles the skybox.
+ * @beta
+ */
+export declare class ToggleSkyboxTool extends DisplayStyleTool {
+    static toolId: string;
+    get require3d(): boolean;
+    parse(_args: string[]): boolean;
+    execute(vp: Viewport): boolean;
+}
+/** Outputs (and optionally copies to the clipboard) a "rendering style" as a partial DisplayStyle3dSettingsProps JSON object based
+ * on the current view's display style settings.
+ * All arguments are optional, of the form "name=value" where `value` is 0 for false or 1 for true. All arguments default to `false` if omitted.
+ * @see [DisplayStyleSettings.toOverrides]($common) for details.
+ * Arguments:
+ *  * `all`: include all settings.
+ *  * `imodel`: include iModel-specific settings.
+ *  * `project`: include iTwin-specific (formerly known as project) settings.
+ *  * `map`: include background map settings.
+ *  * `drawingaids`: include drawing aid decoration settings.
+ *  * `copy`: copy result to system clipboarad.
+ *  * `quote`: format the JSON so it can be parsed directly by [ApplyRenderingStyleTool].
+ * @beta
+ */
+export declare class SaveRenderingStyleTool extends DisplayStyleTool {
+    private _options;
+    private _copyToClipboard;
+    private _quote;
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    parse(inputArgs: string[]): boolean;
+    execute(vp: Viewport): boolean;
+}
+/** Given a "rendering style" as a partial DisplayStyle3dSettingsProperties JSON string, apply it to the selected viewport's display style.
+ * @see [DisplayStyleSettings.applyOverrides]($common) for details.
+ * @beta
+ */
+export declare class ApplyRenderingStyleTool extends DisplayStyleTool {
+    private _overrides?;
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    parse(args: string[]): boolean;
+    execute(vp: Viewport): boolean;
+}
+/** Apply appearance overrides to one or more subcategories in the active viewport.
+ * @beta
+ */
+export declare class OverrideSubCategoryTool extends DisplayStyleTool {
+    private _overrideProps;
+    private _subcategoryIds;
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    parse(inArgs: string[]): boolean;
+    execute(vp: Viewport): boolean;
+}
+/** Set whether background color is ignored when applying white-on-white reversal.
+ * @beta
+ */
+export declare class WoWIgnoreBackgroundTool extends DisplayStyleTool {
+    private _ignore?;
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    parse(args: string[]): boolean;
+    execute(vp: Viewport): boolean;
+}
+//# sourceMappingURL=DisplayStyleTools.d.ts.map

package/lib/esm/tools/DisplayStyleTools.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DisplayStyleTools.d.ts","sourceRoot":"","sources":["../../../src/tools/DisplayStyleTools.ts"],"names":[],"mappings":"AAKA;;GAEG;AAEH,OAAO,EAC8G,SAAS,EAE7H,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACqF,IAAI,EAAE,QAAQ,EACzG,MAAM,sBAAsB,CAAC;AAiB9B;;GAEG;AACH,8BAAsB,gBAAiB,SAAQ,IAAI;IACjD,SAAS,KAAK,SAAS,YAAoB;IAE3C,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,EAAE,QAAQ,GAAG,OAAO;IAEjD,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO;IAE3B,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC;IAQvB,WAAW,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAOvE;AAED;;;;;;;GAOG;AACH,qBAAa,mBAAoB,SAAQ,IAAI;IAC3C,OAAuB,MAAM,SAAqB;IAClD,WAA2B,OAAO,cAAwB;IAC1D,WAA2B,OAAO,WAAgB;IAE5B,GAAG,CAAC,EAAE,EAAE,SAAS,EAAE,EAAE,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IAOnD,WAAW,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CA2CvE;AAED;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,gBAAgB;IACpD,OAAuB,MAAM,SAAkB;IAE/C,IAAoB,SAAS,YAAmB;IAEzC,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE;IAErB,OAAO,CAAC,EAAE,EAAE,QAAQ,GAAG,OAAO;CAKtC;AAED;;;;;;;;;;;;;GAaG;AACH,qBAAa,sBAAuB,SAAQ,gBAAgB;IAC1D,OAAO,CAAC,QAAQ,CAAoC;IACpD,OAAO,CAAC,gBAAgB,CAAS;IACjC,OAAO,CAAC,MAAM,CAAS;IAEvB,OAAuB,MAAM,SAAwB;IAErD,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAE3C,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE;IAiBzB,OAAO,CAAC,EAAE,EAAE,QAAQ,GAAG,OAAO;CAWtC;AAED;;;GAGG;AACH,qBAAa,uBAAwB,SAAQ,gBAAgB;IAC3D,OAAO,CAAC,UAAU,CAAC,CAA8B;IAEjD,OAAuB,MAAM,SAAyB;IAEtD,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAE3C,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE;IAUpB,OAAO,CAAC,EAAE,EAAE,QAAQ,GAAG,OAAO;CAMtC;AAED;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,gBAAgB;IAC3D,OAAO,CAAC,cAAc,CAAmC;IACzD,OAAO,CAAC,eAAe,CAAgB;IAEvC,OAAuB,MAAM,SAAyB;IACtD,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAE3C,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO;IAkBhC,OAAO,CAAC,EAAE,EAAE,QAAQ,GAAG,OAAO;CAOtC;AAED;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,gBAAgB;IAC3D,OAAO,CAAC,OAAO,CAAC,CAAU;IAE1B,OAAuB,MAAM,SAAyB;IACtD,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAE3C,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO;IAS9B,OAAO,CAAC,EAAE,EAAE,QAAQ,GAAG,OAAO;CAKtC"}

package/lib/esm/tools/DisplayStyleTools.js

@@ -0,0 +1,232 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Tools
+ */
+import { RenderMode, SubCategoryOverride, ViewFlags, WhiteOnWhiteReversalSettings, } from "@itwin/core-common";
+import { Environment, IModelApp, NotifyMessageDetails, OutputMessagePriority, Tool, } from "@itwin/core-frontend";
+import { copyStringToClipboard } from "../ClipboardUtilities";
+import { parseArgs } from "./parseArgs";
+import { parseToggle } from "./parseToggle";
+// Compiler has the info to construct this array for us, but we have no access to it...
+const booleanFlagNames = [
+    "dimensions", "patterns", "weights", "styles", "transparency", "fill", "textures", "materials", "acsTriad", "grid", "visibleEdges",
+    "hiddenEdges", "lighting", "shadows", "clipVolume", "constructions", "monochrome", "backgroundMap", "ambientOcclusion", "forceSurfaceDiscard",
+];
+const lowercaseBooleanFlagNames = booleanFlagNames.map((name) => name.toLowerCase());
+/** Modifies the selected viewport's DisplayStyleState.
+ * @beta
+ */
+export class DisplayStyleTool extends Tool {
+    get require3d() { return false; }
+    async run() {
+        const vp = IModelApp.viewManager.selectedView;
+        if (undefined !== vp && (!this.require3d || vp.view.is3d()) && this.execute(vp))
+            vp.displayStyle = vp.view.displayStyle;
+        return true;
+    }
+    async parseAndRun(...args) {
+        const vp = IModelApp.viewManager.selectedView;
+        if (undefined !== vp && (!this.require3d || vp.view.is3d()) && this.parse(args))
+            return this.run();
+        else
+            return false;
+    }
+}
+/** Modifies the selected viewport's ViewFlags.
+ * The keyin syntax is as follows:
+ *  fdt change viewflags flag=value
+ * Where 'flag' is one of the BooleanFlagName values, or "renderMode"; and value is an integer.
+ * For boolean flags, value is 0 for false or 1 for true. For renderMode, value is one of the RenderMode enum values.
+ * Flag names are case-insensitive.
+ * @beta
+ */
+export class ChangeViewFlagsTool extends Tool {
+    static get maxArgs() { return undefined; }
+    static get minArgs() { return 1; }
+    async run(vf, vp) {
+        if (undefined !== vf && undefined !== vp)
+            vp.viewFlags = vf;
+        return true;
+    }
+    async parseAndRun(...args) {
+        const vp = IModelApp.viewManager.selectedView;
+        if (undefined === vp || 0 === args.length)
+            return true;
+        const vf = { ...vp.viewFlags };
+        for (const arg of args) {
+            const parts = arg.split("=");
+            if (2 !== parts.length)
+                continue;
+            const value = parseInt(parts[1], 10);
+            if (Number.isNaN(value))
+                continue;
+            const name = parts[0].toLowerCase();
+            if (name === "rendermode") {
+                switch (value) {
+                    case RenderMode.SmoothShade:
+                    case RenderMode.Wireframe:
+                    case RenderMode.HiddenLine:
+                    case RenderMode.SolidFill:
+                        vf.renderMode = value;
+                        vp.invalidateRenderPlan();
+                        break;
+                }
+                continue;
+            }
+            if (0 !== value && 1 !== value)
+                continue;
+            const index = lowercaseBooleanFlagNames.indexOf(name);
+            if (-1 !== index) {
+                const propName = booleanFlagNames[index];
+                vf[propName] = 0 !== value;
+                vp.invalidateRenderPlan();
+            }
+        }
+        return this.run(new ViewFlags(vf), vp);
+    }
+}
+ChangeViewFlagsTool.toolId = "ChangeViewFlags";
+/** Toggles the skybox.
+ * @beta
+ */
+export class ToggleSkyboxTool extends DisplayStyleTool {
+    get require3d() { return true; }
+    parse(_args) { return true; } // no arguments
+    execute(vp) {
+        const style = vp.view.displayStyle;
+        style.environment = new Environment({ sky: { display: !style.environment.sky.display } });
+        return true;
+    }
+}
+ToggleSkyboxTool.toolId = "ToggleSkybox";
+/** Outputs (and optionally copies to the clipboard) a "rendering style" as a partial DisplayStyle3dSettingsProps JSON object based
+ * on the current view's display style settings.
+ * All arguments are optional, of the form "name=value" where `value` is 0 for false or 1 for true. All arguments default to `false` if omitted.
+ * @see [DisplayStyleSettings.toOverrides]($common) for details.
+ * Arguments:
+ *  * `all`: include all settings.
+ *  * `imodel`: include iModel-specific settings.
+ *  * `project`: include iTwin-specific (formerly known as project) settings.
+ *  * `map`: include background map settings.
+ *  * `drawingaids`: include drawing aid decoration settings.
+ *  * `copy`: copy result to system clipboarad.
+ *  * `quote`: format the JSON so it can be parsed directly by [ApplyRenderingStyleTool].
+ * @beta
+ */
+export class SaveRenderingStyleTool extends DisplayStyleTool {
+    constructor() {
+        super(...arguments);
+        this._options = {};
+        this._copyToClipboard = false;
+        this._quote = false;
+    }
+    static get minArgs() { return 0; }
+    static get maxArgs() { return 7; }
+    parse(inputArgs) {
+        const args = parseArgs(inputArgs);
+        function getArg(name) {
+            return args.getBoolean(name) ? true : undefined;
+        }
+        this._options.includeAll = getArg("a");
+        this._options.includeIModelSpecific = getArg("i");
+        this._options.includeITwinSpecific = getArg("p"); // "p" for backwards compatibility with old "project" terminology
+        this._options.includeBackgroundMap = getArg("m");
+        this._options.includeDrawingAids = getArg("d");
+        this._copyToClipboard = true === getArg("c");
+        this._quote = true === getArg("q");
+        return true;
+    }
+    execute(vp) {
+        let json = JSON.stringify(vp.displayStyle.settings.toOverrides(this._options));
+        if (this._quote)
+            json = `"${json.replace(/"/g, '""')}"`;
+        IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info, "Rendering style saved", json));
+        if (this._copyToClipboard)
+            copyStringToClipboard(json);
+        return false;
+    }
+}
+SaveRenderingStyleTool.toolId = "SaveRenderingStyle";
+/** Given a "rendering style" as a partial DisplayStyle3dSettingsProperties JSON string, apply it to the selected viewport's display style.
+ * @see [DisplayStyleSettings.applyOverrides]($common) for details.
+ * @beta
+ */
+export class ApplyRenderingStyleTool extends DisplayStyleTool {
+    static get minArgs() { return 1; }
+    static get maxArgs() { return 1; }
+    parse(args) {
+        try {
+            this._overrides = JSON.parse(args[0]);
+            return true;
+        }
+        catch {
+            IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Error, "Invalid JSON"));
+            return false;
+        }
+    }
+    execute(vp) {
+        if (this._overrides)
+            vp.overrideDisplayStyle(this._overrides);
+        return false;
+    }
+}
+ApplyRenderingStyleTool.toolId = "ApplyRenderingStyle";
+/** Apply appearance overrides to one or more subcategories in the active viewport.
+ * @beta
+ */
+export class OverrideSubCategoryTool extends DisplayStyleTool {
+    constructor() {
+        super(...arguments);
+        this._overrideProps = {};
+        this._subcategoryIds = [];
+    }
+    static get minArgs() { return 1; }
+    static get maxArgs() { return 7; }
+    parse(inArgs) {
+        const args = parseArgs(inArgs);
+        const ids = args.get("i");
+        if (ids)
+            this._subcategoryIds = ids.split(",");
+        const props = this._overrideProps;
+        props.color = args.getInteger("c");
+        props.weight = args.getInteger("w");
+        props.priority = args.getInteger("p");
+        props.transp = args.getFloat("t");
+        props.material = args.get("m");
+        const visible = args.getBoolean("v");
+        props.invisible = typeof visible === "boolean" ? !visible : undefined;
+        return true;
+    }
+    execute(vp) {
+        const ovr = SubCategoryOverride.fromJSON(this._overrideProps);
+        for (const id of this._subcategoryIds)
+            vp.displayStyle.overrideSubCategory(id, ovr);
+        return true;
+    }
+}
+OverrideSubCategoryTool.toolId = "OverrideSubCategory";
+/** Set whether background color is ignored when applying white-on-white reversal.
+ * @beta
+ */
+export class WoWIgnoreBackgroundTool extends DisplayStyleTool {
+    static get minArgs() { return 0; }
+    static get maxArgs() { return 1; }
+    parse(args) {
+        const ignore = parseToggle(args[0]);
+        if (typeof ignore === "string")
+            return false;
+        this._ignore = ignore;
+        return true;
+    }
+    execute(vp) {
+        var _a;
+        const ignoreBackgroundColor = (_a = this._ignore) !== null && _a !== void 0 ? _a : !vp.displayStyle.settings.whiteOnWhiteReversal.ignoreBackgroundColor;
+        vp.displayStyle.settings.whiteOnWhiteReversal = WhiteOnWhiteReversalSettings.fromJSON({ ignoreBackgroundColor });
+        return true;
+    }
+}
+WoWIgnoreBackgroundTool.toolId = "WoWIgnoreBackground";
+//# sourceMappingURL=DisplayStyleTools.js.map

package/lib/esm/tools/DisplayStyleTools.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DisplayStyleTools.js","sourceRoot":"","sources":["../../../src/tools/DisplayStyleTools.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F;;GAEG;AAEH,OAAO,EACsD,UAAU,EAAyB,mBAAmB,EAAE,SAAS,EAC5H,4BAA4B,GAC7B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACgB,WAAW,EAAE,SAAS,EAAE,oBAAoB,EAAE,qBAAqB,EAAE,IAAI,GAC/F,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AAC9D,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAM5C,uFAAuF;AACvF,MAAM,gBAAgB,GAAsB;IAC1C,YAAY,EAAE,UAAU,EAAE,SAAS,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,EAAE,cAAc;IAClI,aAAa,EAAE,UAAU,EAAE,SAAS,EAAE,YAAY,EAAE,eAAe,EAAE,YAAY,EAAE,eAAe,EAAE,kBAAkB,EAAE,qBAAqB;CAC9I,CAAC;AAEF,MAAM,yBAAyB,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;AAErF;;GAEG;AACH,MAAM,OAAgB,gBAAiB,SAAQ,IAAI;IACjD,IAAc,SAAS,KAAK,OAAO,KAAK,CAAC,CAAC,CAAC;IAM3B,KAAK,CAAC,GAAG;QACvB,MAAM,EAAE,GAAG,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC;QAC9C,IAAI,SAAS,KAAK,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,SAAS,IAAI,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YAC7E,EAAE,CAAC,YAAY,GAAG,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC;QAEzC,OAAO,IAAI,CAAC;IACd,CAAC;IAEe,KAAK,CAAC,WAAW,CAAC,GAAG,IAAc;QACjD,MAAM,EAAE,GAAG,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC;QAC9C,IAAI,SAAS,KAAK,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,SAAS,IAAI,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;YAC7E,OAAO,IAAI,CAAC,GAAG,EAAE,CAAC;;YAElB,OAAO,KAAK,CAAC;IACjB,CAAC;CACF;AAED;;;;;;;GAOG;AACH,MAAM,OAAO,mBAAoB,SAAQ,IAAI;IAEpC,MAAM,KAAc,OAAO,KAAK,OAAO,SAAS,CAAC,CAAC,CAAC;IACnD,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAElC,KAAK,CAAC,GAAG,CAAC,EAAa,EAAE,EAAa;QACpD,IAAI,SAAS,KAAK,EAAE,IAAI,SAAS,KAAK,EAAE;YACtC,EAAE,CAAC,SAAS,GAAG,EAAE,CAAC;QAEpB,OAAO,IAAI,CAAC;IACd,CAAC;IAEe,KAAK,CAAC,WAAW,CAAC,GAAG,IAAc;QACjD,MAAM,EAAE,GAAG,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC;QAC9C,IAAI,SAAS,KAAK,EAAE,IAAI,CAAC,KAAK,IAAI,CAAC,MAAM;YACvC,OAAO,IAAI,CAAC;QAEd,MAAM,EAAE,GAAiC,EAAE,GAAG,EAAE,CAAC,SAAS,EAAE,CAAC;QAC7D,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;YACtB,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAC7B,IAAI,CAAC,KAAK,KAAK,CAAC,MAAM;gBACpB,SAAS;YAEX,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YACrC,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC;gBACrB,SAAS;YAEX,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;YACpC,IAAI,IAAI,KAAK,YAAY,EAAE;gBACzB,QAAQ,KAAK,EAAE;oBACb,KAAK,UAAU,CAAC,WAAW,CAAC;oBAC5B,KAAK,UAAU,CAAC,SAAS,CAAC;oBAC1B,KAAK,UAAU,CAAC,UAAU,CAAC;oBAC3B,KAAK,UAAU,CAAC,SAAS;wBACvB,EAAE,CAAC,UAAU,GAAG,KAAK,CAAC;wBACtB,EAAE,CAAC,oBAAoB,EAAE,CAAC;wBAC1B,MAAM;iBACT;gBAED,SAAS;aACV;YAED,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC,KAAK,KAAK;gBAC5B,SAAS;YAEX,MAAM,KAAK,GAAG,yBAAyB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YACtD,IAAI,CAAC,CAAC,KAAK,KAAK,EAAE;gBAChB,MAAM,QAAQ,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAAC;gBACzC,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,KAAK,CAAC;gBAC3B,EAAE,CAAC,oBAAoB,EAAE,CAAC;aAC3B;SACF;QAED,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,SAAS,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;IACzC,CAAC;;AArDsB,0BAAM,GAAG,iBAAiB,CAAC;AAwDpD;;GAEG;AACH,MAAM,OAAO,gBAAiB,SAAQ,gBAAgB;IAGpD,IAAoB,SAAS,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IAEzC,KAAK,CAAC,KAAe,IAAI,OAAO,IAAI,CAAC,CAAC,CAAC,CAAC,eAAe;IAEvD,OAAO,CAAC,EAAY;QACzB,MAAM,KAAK,GAAG,EAAE,CAAC,IAAI,CAAC,YAAmC,CAAC;QAC1D,KAAK,CAAC,WAAW,GAAG,IAAI,WAAW,CAAC,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;QAC1F,OAAO,IAAI,CAAC;IACd,CAAC;;AAVsB,uBAAM,GAAG,cAAc,CAAC;AAajD;;;;;;;;;;;;;GAaG;AACH,MAAM,OAAO,sBAAuB,SAAQ,gBAAgB;IAA5D;;QACU,aAAQ,GAAiC,EAAE,CAAC;QAC5C,qBAAgB,GAAG,KAAK,CAAC;QACzB,WAAM,GAAG,KAAK,CAAC;IAmCzB,CAAC;IA/BQ,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAE3C,KAAK,CAAC,SAAmB;QAC9B,MAAM,IAAI,GAAG,SAAS,CAAC,SAAS,CAAC,CAAC;QAClC,SAAS,MAAM,CAAC,IAAY;YAC1B,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;QAClD,CAAC;QAED,IAAI,CAAC,QAAQ,CAAC,UAAU,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QACvC,IAAI,CAAC,QAAQ,CAAC,qBAAqB,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QAClD,IAAI,CAAC,QAAQ,CAAC,oBAAoB,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,iEAAiE;QACnH,IAAI,CAAC,QAAQ,CAAC,oBAAoB,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QACjD,IAAI,CAAC,QAAQ,CAAC,kBAAkB,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QAC/C,IAAI,CAAC,gBAAgB,GAAG,IAAI,KAAK,MAAM,CAAC,GAAG,CAAC,CAAC;QAC7C,IAAI,CAAC,MAAM,GAAG,IAAI,KAAK,MAAM,CAAC,GAAG,CAAC,CAAC;QAEnC,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,OAAO,CAAC,EAAY;QACzB,IAAI,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC/E,IAAI,IAAI,CAAC,MAAM;YACb,IAAI,GAAG,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC;QAEzC,SAAS,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,oBAAoB,CAAC,qBAAqB,CAAC,IAAI,EAAE,uBAAuB,EAAE,IAAI,CAAC,CAAC,CAAC;QAC3H,IAAI,IAAI,CAAC,gBAAgB;YACvB,qBAAqB,CAAC,IAAI,CAAC,CAAC;QAE9B,OAAO,KAAK,CAAC;IACf,CAAC;;AAhCsB,6BAAM,GAAG,oBAAoB,CAAC;AAmCvD;;;GAGG;AACH,MAAM,OAAO,uBAAwB,SAAQ,gBAAgB;IAKpD,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAE3C,KAAK,CAAC,IAAc;QACzB,IAAI;YACF,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YACtC,OAAO,IAAI,CAAC;SACb;QAAC,MAAM;YACN,SAAS,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,oBAAoB,CAAC,qBAAqB,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC,CAAC;YAC7G,OAAO,KAAK,CAAC;SACd;IACH,CAAC;IAEM,OAAO,CAAC,EAAY;QACzB,IAAI,IAAI,CAAC,UAAU;YACjB,EAAE,CAAC,oBAAoB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAE3C,OAAO,KAAK,CAAC;IACf,CAAC;;AApBsB,8BAAM,GAAG,qBAAqB,CAAC;AAuBxD;;GAEG;AACH,MAAM,OAAO,uBAAwB,SAAQ,gBAAgB;IAA7D;;QACU,mBAAc,GAAgC,EAAE,CAAC;QACjD,oBAAe,GAAa,EAAE,CAAC;IA+BzC,CAAC;IA5BQ,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAE3C,KAAK,CAAC,MAAgB;QAC3B,MAAM,IAAI,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC;QAC/B,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC1B,IAAI,GAAG;YACL,IAAI,CAAC,eAAe,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAExC,MAAM,KAAK,GAAG,IAAI,CAAC,cAAc,CAAC;QAClC,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QACnC,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QACpC,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QACtC,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QAClC,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAE/B,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QACrC,KAAK,CAAC,SAAS,GAAG,OAAO,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;QACtE,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,OAAO,CAAC,EAAY;QACzB,MAAM,GAAG,GAAG,mBAAmB,CAAC,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC9D,KAAK,MAAM,EAAE,IAAI,IAAI,CAAC,eAAe;YACnC,EAAE,CAAC,YAAY,CAAC,mBAAmB,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;QAE/C,OAAO,IAAI,CAAC;IACd,CAAC;;AA5BsB,8BAAM,GAAG,qBAAqB,CAAC;AA+BxD;;GAEG;AACH,MAAM,OAAO,uBAAwB,SAAQ,gBAAgB;IAIpD,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAE3C,KAAK,CAAC,IAAc;QACzB,MAAM,MAAM,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QACpC,IAAI,OAAO,MAAM,KAAK,QAAQ;YAC5B,OAAO,KAAK,CAAC;QAEf,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,OAAO,CAAC,EAAY;;QACzB,MAAM,qBAAqB,GAAG,MAAA,IAAI,CAAC,OAAO,mCAAI,CAAC,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,oBAAoB,CAAC,qBAAqB,CAAC;QACnH,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,oBAAoB,GAAG,4BAA4B,CAAC,QAAQ,CAAC,EAAE,qBAAqB,EAAE,CAAC,CAAC;QACjH,OAAO,IAAI,CAAC;IACd,CAAC;;AAjBsB,8BAAM,GAAG,qBAAqB,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 {\r\n  DisplayStyle3dSettingsProps, DisplayStyleOverridesOptions, RenderMode, SubCategoryAppearance, SubCategoryOverride, ViewFlags, ViewFlagsProperties,\r\n  WhiteOnWhiteReversalSettings,\r\n} from \"@itwin/core-common\";\r\nimport {\r\n  DisplayStyle3dState, Environment, IModelApp, NotifyMessageDetails, OutputMessagePriority, Tool, Viewport,\r\n} from \"@itwin/core-frontend\";\r\nimport { copyStringToClipboard } from \"../ClipboardUtilities\";\r\nimport { parseArgs } from \"./parseArgs\";\r\nimport { parseToggle } from \"./parseToggle\";\r\n\r\ntype BooleanFlagName =\r\n  \"dimensions\" | \"patterns\" | \"weights\" | \"styles\" | \"transparency\" | \"fill\" | \"textures\" | \"materials\" | \"acsTriad\" | \"grid\" | \"visibleEdges\" |\r\n  \"hiddenEdges\" | \"lighting\" | \"shadows\" | \"clipVolume\" | \"constructions\" | \"monochrome\" | \"backgroundMap\" | \"ambientOcclusion\" | \"forceSurfaceDiscard\";\r\n\r\n// Compiler has the info to construct this array for us, but we have no access to it...\r\nconst booleanFlagNames: BooleanFlagName[] = [\r\n  \"dimensions\", \"patterns\", \"weights\", \"styles\", \"transparency\", \"fill\", \"textures\", \"materials\", \"acsTriad\", \"grid\", \"visibleEdges\",\r\n  \"hiddenEdges\", \"lighting\", \"shadows\", \"clipVolume\", \"constructions\", \"monochrome\", \"backgroundMap\", \"ambientOcclusion\", \"forceSurfaceDiscard\",\r\n];\r\n\r\nconst lowercaseBooleanFlagNames = booleanFlagNames.map((name) => name.toLowerCase());\r\n\r\n/** Modifies the selected viewport's DisplayStyleState.\r\n * @beta\r\n */\r\nexport abstract class DisplayStyleTool extends Tool {\r\n  protected get require3d() { return false; }\r\n  // Return true if the display style was modified - we will invalidate the viewport's render plan.\r\n  protected abstract execute(vp: Viewport): boolean;\r\n  // Return false if failed to parse.\r\n  protected abstract parse(args: string[]): boolean;\r\n\r\n  public override async run(): Promise<boolean> {\r\n    const vp = IModelApp.viewManager.selectedView;\r\n    if (undefined !== vp && (!this.require3d || vp.view.is3d()) && this.execute(vp))\r\n      vp.displayStyle = vp.view.displayStyle;\r\n\r\n    return true;\r\n  }\r\n\r\n  public override async parseAndRun(...args: string[]): Promise<boolean> {\r\n    const vp = IModelApp.viewManager.selectedView;\r\n    if (undefined !== vp && (!this.require3d || vp.view.is3d()) && this.parse(args))\r\n      return this.run();\r\n    else\r\n      return false;\r\n  }\r\n}\r\n\r\n/** Modifies the selected viewport's ViewFlags.\r\n * The keyin syntax is as follows:\r\n *  fdt change viewflags flag=value\r\n * Where 'flag' is one of the BooleanFlagName values, or \"renderMode\"; and value is an integer.\r\n * For boolean flags, value is 0 for false or 1 for true. For renderMode, value is one of the RenderMode enum values.\r\n * Flag names are case-insensitive.\r\n * @beta\r\n */\r\nexport class ChangeViewFlagsTool extends Tool {\r\n  public static override toolId = \"ChangeViewFlags\";\r\n  public static override get maxArgs() { return undefined; }\r\n  public static override get minArgs() { return 1; }\r\n\r\n  public override async run(vf: ViewFlags, vp?: Viewport): Promise<boolean> {\r\n    if (undefined !== vf && undefined !== vp)\r\n      vp.viewFlags = vf;\r\n\r\n    return true;\r\n  }\r\n\r\n  public override async parseAndRun(...args: string[]): Promise<boolean> {\r\n    const vp = IModelApp.viewManager.selectedView;\r\n    if (undefined === vp || 0 === args.length)\r\n      return true;\r\n\r\n    const vf: Partial<ViewFlagsProperties> = { ...vp.viewFlags };\r\n    for (const arg of args) {\r\n      const parts = arg.split(\"=\");\r\n      if (2 !== parts.length)\r\n        continue;\r\n\r\n      const value = parseInt(parts[1], 10);\r\n      if (Number.isNaN(value))\r\n        continue;\r\n\r\n      const name = parts[0].toLowerCase();\r\n      if (name === \"rendermode\") {\r\n        switch (value) {\r\n          case RenderMode.SmoothShade:\r\n          case RenderMode.Wireframe:\r\n          case RenderMode.HiddenLine:\r\n          case RenderMode.SolidFill:\r\n            vf.renderMode = value;\r\n            vp.invalidateRenderPlan();\r\n            break;\r\n        }\r\n\r\n        continue;\r\n      }\r\n\r\n      if (0 !== value && 1 !== value)\r\n        continue;\r\n\r\n      const index = lowercaseBooleanFlagNames.indexOf(name);\r\n      if (-1 !== index) {\r\n        const propName = booleanFlagNames[index];\r\n        vf[propName] = 0 !== value;\r\n        vp.invalidateRenderPlan();\r\n      }\r\n    }\r\n\r\n    return this.run(new ViewFlags(vf), vp);\r\n  }\r\n}\r\n\r\n/** Toggles the skybox.\r\n * @beta\r\n */\r\nexport class ToggleSkyboxTool extends DisplayStyleTool {\r\n  public static override toolId = \"ToggleSkybox\";\r\n\r\n  public override get require3d() { return true; }\r\n\r\n  public parse(_args: string[]) { return true; } // no arguments\r\n\r\n  public execute(vp: Viewport): boolean {\r\n    const style = vp.view.displayStyle as DisplayStyle3dState;\r\n    style.environment = new Environment({ sky: { display: !style.environment.sky.display } });\r\n    return true;\r\n  }\r\n}\r\n\r\n/** Outputs (and optionally copies to the clipboard) a \"rendering style\" as a partial DisplayStyle3dSettingsProps JSON object based\r\n * on the current view's display style settings.\r\n * All arguments are optional, of the form \"name=value\" where `value` is 0 for false or 1 for true. All arguments default to `false` if omitted.\r\n * @see [DisplayStyleSettings.toOverrides]($common) for details.\r\n * Arguments:\r\n *  * `all`: include all settings.\r\n *  * `imodel`: include iModel-specific settings.\r\n *  * `project`: include iTwin-specific (formerly known as project) settings.\r\n *  * `map`: include background map settings.\r\n *  * `drawingaids`: include drawing aid decoration settings.\r\n *  * `copy`: copy result to system clipboarad.\r\n *  * `quote`: format the JSON so it can be parsed directly by [ApplyRenderingStyleTool].\r\n * @beta\r\n */\r\nexport class SaveRenderingStyleTool extends DisplayStyleTool {\r\n  private _options: DisplayStyleOverridesOptions = {};\r\n  private _copyToClipboard = false;\r\n  private _quote = false;\r\n\r\n  public static override toolId = \"SaveRenderingStyle\";\r\n\r\n  public static override get minArgs() { return 0; }\r\n  public static override get maxArgs() { return 7; }\r\n\r\n  public parse(inputArgs: string[]) {\r\n    const args = parseArgs(inputArgs);\r\n    function getArg(name: string): true | undefined {\r\n      return args.getBoolean(name) ? true : undefined;\r\n    }\r\n\r\n    this._options.includeAll = getArg(\"a\");\r\n    this._options.includeIModelSpecific = getArg(\"i\");\r\n    this._options.includeITwinSpecific = getArg(\"p\"); // \"p\" for backwards compatibility with old \"project\" terminology\r\n    this._options.includeBackgroundMap = getArg(\"m\");\r\n    this._options.includeDrawingAids = getArg(\"d\");\r\n    this._copyToClipboard = true === getArg(\"c\");\r\n    this._quote = true === getArg(\"q\");\r\n\r\n    return true;\r\n  }\r\n\r\n  public execute(vp: Viewport): boolean {\r\n    let json = JSON.stringify(vp.displayStyle.settings.toOverrides(this._options));\r\n    if (this._quote)\r\n      json = `\"${json.replace(/\"/g, '\"\"')}\"`;\r\n\r\n    IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info, \"Rendering style saved\", json));\r\n    if (this._copyToClipboard)\r\n      copyStringToClipboard(json);\r\n\r\n    return false;\r\n  }\r\n}\r\n\r\n/** Given a \"rendering style\" as a partial DisplayStyle3dSettingsProperties JSON string, apply it to the selected viewport's display style.\r\n * @see [DisplayStyleSettings.applyOverrides]($common) for details.\r\n * @beta\r\n */\r\nexport class ApplyRenderingStyleTool extends DisplayStyleTool {\r\n  private _overrides?: DisplayStyle3dSettingsProps;\r\n\r\n  public static override toolId = \"ApplyRenderingStyle\";\r\n\r\n  public static override get minArgs() { return 1; }\r\n  public static override get maxArgs() { return 1; }\r\n\r\n  public parse(args: string[]) {\r\n    try {\r\n      this._overrides = JSON.parse(args[0]);\r\n      return true;\r\n    } catch {\r\n      IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Error, \"Invalid JSON\"));\r\n      return false;\r\n    }\r\n  }\r\n\r\n  public execute(vp: Viewport): boolean {\r\n    if (this._overrides)\r\n      vp.overrideDisplayStyle(this._overrides);\r\n\r\n    return false;\r\n  }\r\n}\r\n\r\n/** Apply appearance overrides to one or more subcategories in the active viewport.\r\n * @beta\r\n */\r\nexport class OverrideSubCategoryTool extends DisplayStyleTool {\r\n  private _overrideProps: SubCategoryAppearance.Props = {};\r\n  private _subcategoryIds: string[] = [];\r\n\r\n  public static override toolId = \"OverrideSubCategory\";\r\n  public static override get minArgs() { return 1; }\r\n  public static override get maxArgs() { return 7; }\r\n\r\n  public parse(inArgs: string[]): boolean {\r\n    const args = parseArgs(inArgs);\r\n    const ids = args.get(\"i\");\r\n    if (ids)\r\n      this._subcategoryIds = ids.split(\",\");\r\n\r\n    const props = this._overrideProps;\r\n    props.color = args.getInteger(\"c\");\r\n    props.weight = args.getInteger(\"w\");\r\n    props.priority = args.getInteger(\"p\");\r\n    props.transp = args.getFloat(\"t\");\r\n    props.material = args.get(\"m\");\r\n\r\n    const visible = args.getBoolean(\"v\");\r\n    props.invisible = typeof visible === \"boolean\" ? !visible : undefined;\r\n    return true;\r\n  }\r\n\r\n  public execute(vp: Viewport): boolean {\r\n    const ovr = SubCategoryOverride.fromJSON(this._overrideProps);\r\n    for (const id of this._subcategoryIds)\r\n      vp.displayStyle.overrideSubCategory(id, ovr);\r\n\r\n    return true;\r\n  }\r\n}\r\n\r\n/** Set whether background color is ignored when applying white-on-white reversal.\r\n * @beta\r\n */\r\nexport class WoWIgnoreBackgroundTool extends DisplayStyleTool {\r\n  private _ignore?: boolean;\r\n\r\n  public static override toolId = \"WoWIgnoreBackground\";\r\n  public static override get minArgs() { return 0; }\r\n  public static override get maxArgs() { return 1; }\r\n\r\n  public parse(args: string[]): boolean {\r\n    const ignore = parseToggle(args[0]);\r\n    if (typeof ignore === \"string\")\r\n      return false;\r\n\r\n    this._ignore = ignore;\r\n    return true;\r\n  }\r\n\r\n  public execute(vp: Viewport): boolean {\r\n    const ignoreBackgroundColor = this._ignore ?? !vp.displayStyle.settings.whiteOnWhiteReversal.ignoreBackgroundColor;\r\n    vp.displayStyle.settings.whiteOnWhiteReversal = WhiteOnWhiteReversalSettings.fromJSON({ ignoreBackgroundColor });\r\n    return true;\r\n  }\r\n}\r\n"]}

package/lib/esm/tools/EmphasizeElementsTool.d.ts

@@ -0,0 +1,61 @@
+/** @packageDocumentation
+ * @module Tools
+ */
+import { EmphasizeElements, ScreenViewport, Tool } from "@itwin/core-frontend";
+/** Applies the `EmphasizeElements` API in some way to the selected Viewport.
+ * @beta
+ */
+export declare abstract class EmphasizeElementsTool extends Tool {
+    protected get _wantCreate(): boolean;
+    protected get _wantClear(): boolean;
+    protected abstract execute(emph: EmphasizeElements, vp: ScreenViewport): void;
+    run(_args: any[]): Promise<boolean>;
+}
+/** If any elements are selected, emphasize them all by overriding their color to be orange; and de-emphasize all other elements by drawing them transparent grey.
+ * @beta
+ */
+export declare class EmphasizeSelectedElementsTool extends EmphasizeElementsTool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    private _type;
+    execute(emph: EmphasizeElements, vp: ScreenViewport): void;
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
+/** Isolate all selected elements so that *only* those elements will be drawn.
+ * @beta
+ */
+export declare class IsolateSelectedElementsTool extends EmphasizeElementsTool {
+    static toolId: string;
+    execute(emph: EmphasizeElements, vp: ScreenViewport): void;
+}
+/** Clear the set of isolated elements.
+ * @beta
+ */
+export declare class ClearIsolatedElementsTool extends EmphasizeElementsTool {
+    static toolId: string;
+    protected get _wantCreate(): boolean;
+    execute(emph: EmphasizeElements, vp: ScreenViewport): void;
+}
+/** Reset [EmphasizeElements]($frontend) for the active [Viewport]($frontend).
+ * @beta
+ */
+export declare class ClearEmphasizedElementsTool extends EmphasizeElementsTool {
+    static toolId: string;
+    protected get _wantCreate(): boolean;
+    protected get _wantClear(): boolean;
+    execute(emph: EmphasizeElements, vp: ScreenViewport): void;
+}
+/** Emphasize the set of elements currently visible in the view based on [Viewport.queryVisibleFeatures]($frontend).
+ * @beta
+ */
+export declare class EmphasizeVisibleElementsTool extends EmphasizeElementsTool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    private _options;
+    protected get _wantClear(): boolean;
+    parseAndRun(...input: string[]): Promise<boolean>;
+    execute(emph: EmphasizeElements, vp: ScreenViewport): void;
+}
+//# sourceMappingURL=EmphasizeElementsTool.d.ts.map

package/lib/esm/tools/EmphasizeElementsTool.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EmphasizeElementsTool.d.ts","sourceRoot":"","sources":["../../../src/tools/EmphasizeElementsTool.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,EAAE,iBAAiB,EAA0C,cAAc,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAGvH;;GAEG;AACH,8BAAsB,qBAAsB,SAAQ,IAAI;IACtD,SAAS,KAAK,WAAW,IAAI,OAAO,CAAiB;IACrD,SAAS,KAAK,UAAU,IAAI,OAAO,CAAkB;IACrD,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,iBAAiB,EAAE,EAAE,EAAE,cAAc,GAAG,IAAI;IAEvD,GAAG,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAc1D;AASD;;GAEG;AACH,qBAAa,6BAA8B,SAAQ,qBAAqB;IACtE,OAAuB,MAAM,SAA+B;IAC5D,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAClD,OAAO,CAAC,KAAK,CAAqB;IAE3B,OAAO,CAAC,IAAI,EAAE,iBAAiB,EAAE,EAAE,EAAE,cAAc,GAAG,IAAI;IAe3C,WAAW,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAmBvE;AAED;;GAEG;AACH,qBAAa,2BAA4B,SAAQ,qBAAqB;IACpE,OAAuB,MAAM,SAA6B;IACnD,OAAO,CAAC,IAAI,EAAE,iBAAiB,EAAE,EAAE,EAAE,cAAc,GAAG,IAAI;CAGlE;AAED;;GAEG;AACH,qBAAa,yBAA0B,SAAQ,qBAAqB;IAClE,OAAuB,MAAM,SAA2B;IACxD,cAAuB,WAAW,YAAoB;IAC/C,OAAO,CAAC,IAAI,EAAE,iBAAiB,EAAE,EAAE,EAAE,cAAc,GAAG,IAAI;CAGlE;AAED;;GAEG;AACH,qBAAa,2BAA4B,SAAQ,qBAAqB;IACpE,OAAuB,MAAM,SAA6B;IAC1D,cAAuB,WAAW,YAAoB;IACtD,cAAuB,UAAU,YAAmB;IAE7C,OAAO,CAAC,IAAI,EAAE,iBAAiB,EAAE,EAAE,EAAE,cAAc,GAAG,IAAI;CAIlE;AAED;;GAEG;AACH,qBAAa,4BAA6B,SAAQ,qBAAqB;IACrE,OAAuB,MAAM,SAA8B;IAC3D,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAClD,OAAO,CAAC,QAAQ,CAAqD;IACrE,cAAuB,UAAU,YAAmB;IAE9B,WAAW,CAAC,GAAG,KAAK,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IAmBhE,OAAO,CAAC,IAAI,EAAE,iBAAiB,EAAE,EAAE,EAAE,cAAc,GAAG,IAAI;CAalE"}

package/lib/esm/tools/EmphasizeElementsTool.js

@@ -0,0 +1,146 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Tools
+ */
+import { Id64 } from "@itwin/core-bentley";
+import { ColorDef } from "@itwin/core-common";
+import { EmphasizeElements, IModelApp, Tool } from "@itwin/core-frontend";
+import { parseArgs } from "./parseArgs";
+/** Applies the `EmphasizeElements` API in some way to the selected Viewport.
+ * @beta
+ */
+export class EmphasizeElementsTool extends Tool {
+    get _wantCreate() { return true; }
+    get _wantClear() { return false; }
+    async run(_args) {
+        const vp = IModelApp.viewManager.selectedView;
+        if (undefined === vp)
+            return true;
+        if (this._wantClear)
+            EmphasizeElements.clear(vp);
+        const emph = this._wantCreate ? EmphasizeElements.getOrCreate(vp) : EmphasizeElements.get(vp);
+        if (undefined !== emph)
+            this.execute(emph, vp);
+        return true;
+    }
+}
+/** If any elements are selected, emphasize them all by overriding their color to be orange; and de-emphasize all other elements by drawing them transparent grey.
+ * @beta
+ */
+export class EmphasizeSelectedElementsTool extends EmphasizeElementsTool {
+    constructor() {
+        super(...arguments);
+        this._type = 0 /* None */;
+    }
+    static get minArgs() { return 0; }
+    static get maxArgs() { return 1; }
+    execute(emph, vp) {
+        if (0 /* None */ === (this._type & 1 /* Color */) || emph.overrideSelectedElements(vp, ColorDef.white, undefined, true, false)) {
+            emph.wantEmphasis = 0 /* None */ !== (this._type & 2 /* Emphasis */);
+            if (emph.emphasizeSelectedElements(vp, undefined, true)) {
+                vp.isFadeOutActive = true;
+                return;
+            }
+        }
+        // Empty selection set - clear any previous overrides.
+        EmphasizeElements.clear(vp);
+        emph.wantEmphasis = false;
+        vp.isFadeOutActive = false;
+    }
+    async parseAndRun(...args) {
+        if (1 === args.length) {
+            switch (args[0].toLowerCase()[0]) {
+                case "n":
+                    break;
+                case "c":
+                    this._type = 1 /* Color */;
+                    break;
+                case "e":
+                    this._type = 2 /* Emphasis */;
+                    break;
+                case "b":
+                    this._type = 3 /* Both */;
+                    break;
+            }
+        }
+        return this.run(args);
+    }
+}
+EmphasizeSelectedElementsTool.toolId = "EmphasizeSelectedElements";
+/** Isolate all selected elements so that *only* those elements will be drawn.
+ * @beta
+ */
+export class IsolateSelectedElementsTool extends EmphasizeElementsTool {
+    execute(emph, vp) {
+        emph.isolateSelectedElements(vp, true, true);
+    }
+}
+IsolateSelectedElementsTool.toolId = "IsolateSelectedElements";
+/** Clear the set of isolated elements.
+ * @beta
+ */
+export class ClearIsolatedElementsTool extends EmphasizeElementsTool {
+    get _wantCreate() { return false; }
+    execute(emph, vp) {
+        emph.clearIsolatedElements(vp);
+    }
+}
+ClearIsolatedElementsTool.toolId = "ClearIsolatedElements";
+/** Reset [EmphasizeElements]($frontend) for the active [Viewport]($frontend).
+ * @beta
+ */
+export class ClearEmphasizedElementsTool extends EmphasizeElementsTool {
+    get _wantCreate() { return false; }
+    get _wantClear() { return true; }
+    execute(emph, vp) {
+        emph.clearEmphasizedElements(vp);
+        vp.isFadeOutActive = false;
+    }
+}
+ClearEmphasizedElementsTool.toolId = "ClearEmphasizedElements";
+/** Emphasize the set of elements currently visible in the view based on [Viewport.queryVisibleFeatures]($frontend).
+ * @beta
+ */
+export class EmphasizeVisibleElementsTool extends EmphasizeElementsTool {
+    constructor() {
+        super(...arguments);
+        this._options = { source: "screen" };
+    }
+    static get minArgs() { return 1; }
+    static get maxArgs() { return 2; }
+    get _wantClear() { return true; }
+    async parseAndRun(...input) {
+        const args = parseArgs(input);
+        const includeNonLocatable = args.getBoolean("n");
+        let source;
+        switch (input[0].toLowerCase()) {
+            case "screen":
+                source = "screen";
+                break;
+            case "tiles":
+                source = "tiles";
+                break;
+            default:
+                return false;
+        }
+        this._options = { source, includeNonLocatable };
+        return this.run(input);
+    }
+    execute(emph, vp) {
+        const elementIds = new Set();
+        vp.queryVisibleFeatures(this._options, (features) => {
+            for (const feature of features) {
+                if (feature.iModel === vp.iModel && Id64.isValid(feature.elementId))
+                    elementIds.add(feature.elementId);
+            }
+        });
+        emph.wantEmphasis = true;
+        if (emph.emphasizeElements(elementIds, vp))
+            vp.isFadeOutActive = true;
+    }
+}
+EmphasizeVisibleElementsTool.toolId = "EmphasizeVisibleElements";
+//# sourceMappingURL=EmphasizeElementsTool.js.map

package/lib/esm/tools/EmphasizeElementsTool.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EmphasizeElementsTool.js","sourceRoot":"","sources":["../../../src/tools/EmphasizeElementsTool.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAC3C,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,iBAAiB,EAAE,SAAS,EAA+C,IAAI,EAAE,MAAM,sBAAsB,CAAC;AACvH,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC;;GAEG;AACH,MAAM,OAAgB,qBAAsB,SAAQ,IAAI;IACtD,IAAc,WAAW,KAAc,OAAO,IAAI,CAAC,CAAC,CAAC;IACrD,IAAc,UAAU,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAGrC,KAAK,CAAC,GAAG,CAAC,KAAY;QACpC,MAAM,EAAE,GAAG,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC;QAC9C,IAAI,SAAS,KAAK,EAAE;YAClB,OAAO,IAAI,CAAC;QAEd,IAAI,IAAI,CAAC,UAAU;YACjB,iBAAiB,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAE9B,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,iBAAiB,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAC9F,IAAI,SAAS,KAAK,IAAI;YACpB,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QAEzB,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AASD;;GAEG;AACH,MAAM,OAAO,6BAA8B,SAAQ,qBAAqB;IAAxE;;QAIU,UAAK,gBAAqB;IAoCpC,CAAC;IAtCQ,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAG3C,OAAO,CAAC,IAAuB,EAAE,EAAkB;QACxD,IAAI,iBAAsB,CAAC,IAAI,CAAC,KAAK,gBAAqB,CAAC,IAAI,IAAI,CAAC,wBAAwB,CAAC,EAAE,EAAE,QAAQ,CAAC,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,CAAC,EAAE;YACxI,IAAI,CAAC,YAAY,GAAG,iBAAsB,CAAC,IAAI,CAAC,KAAK,mBAAwB,CAAC,CAAC;YAC/E,IAAI,IAAI,CAAC,yBAAyB,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,CAAC,EAAE;gBACvD,EAAE,CAAC,eAAe,GAAG,IAAI,CAAC;gBAC1B,OAAO;aACR;SACF;QAED,sDAAsD;QACtD,iBAAiB,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAC5B,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;QAC1B,EAAE,CAAC,eAAe,GAAG,KAAK,CAAC;IAC7B,CAAC;IAEe,KAAK,CAAC,WAAW,CAAC,GAAG,IAAc;QACjD,IAAI,CAAC,KAAK,IAAI,CAAC,MAAM,EAAE;YACrB,QAAQ,IAAI,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE;gBAChC,KAAK,GAAG;oBACN,MAAM;gBACR,KAAK,GAAG;oBACN,IAAI,CAAC,KAAK,gBAAqB,CAAC;oBAChC,MAAM;gBACR,KAAK,GAAG;oBACN,IAAI,CAAC,KAAK,mBAAwB,CAAC;oBACnC,MAAM;gBACR,KAAK,GAAG;oBACN,IAAI,CAAC,KAAK,eAAoB,CAAC;oBAC/B,MAAM;aACT;SACF;QAED,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC;;AAtCsB,oCAAM,GAAG,2BAA2B,CAAC;AAyC9D;;GAEG;AACH,MAAM,OAAO,2BAA4B,SAAQ,qBAAqB;IAE7D,OAAO,CAAC,IAAuB,EAAE,EAAkB;QACxD,IAAI,CAAC,uBAAuB,CAAC,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IAC/C,CAAC;;AAHsB,kCAAM,GAAG,yBAAyB,CAAC;AAM5D;;GAEG;AACH,MAAM,OAAO,yBAA0B,SAAQ,qBAAqB;IAElE,IAAuB,WAAW,KAAK,OAAO,KAAK,CAAC,CAAC,CAAC;IAC/C,OAAO,CAAC,IAAuB,EAAE,EAAkB;QACxD,IAAI,CAAC,qBAAqB,CAAC,EAAE,CAAC,CAAC;IACjC,CAAC;;AAJsB,gCAAM,GAAG,uBAAuB,CAAC;AAO1D;;GAEG;AACH,MAAM,OAAO,2BAA4B,SAAQ,qBAAqB;IAEpE,IAAuB,WAAW,KAAK,OAAO,KAAK,CAAC,CAAC,CAAC;IACtD,IAAuB,UAAU,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IAE7C,OAAO,CAAC,IAAuB,EAAE,EAAkB;QACxD,IAAI,CAAC,uBAAuB,CAAC,EAAE,CAAC,CAAC;QACjC,EAAE,CAAC,eAAe,GAAG,KAAK,CAAC;IAC7B,CAAC;;AAPsB,kCAAM,GAAG,yBAAyB,CAAC;AAU5D;;GAEG;AACH,MAAM,OAAO,4BAA6B,SAAQ,qBAAqB;IAAvE;;QAIU,aAAQ,GAAgC,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;IAmCvE,CAAC;IArCQ,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAElD,IAAuB,UAAU,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IAEpC,KAAK,CAAC,WAAW,CAAC,GAAG,KAAe;QAClD,MAAM,IAAI,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC;QAC9B,MAAM,mBAAmB,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QACjD,IAAI,MAA0B,CAAC;QAC/B,QAAQ,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,EAAE;YAC9B,KAAK,QAAQ;gBACX,MAAM,GAAG,QAAQ,CAAC;gBAClB,MAAM;YACR,KAAK,OAAO;gBACV,MAAM,GAAG,OAAO,CAAC;gBACjB,MAAM;YACR;gBACE,OAAO,KAAK,CAAC;SAChB;QAED,IAAI,CAAC,QAAQ,GAAG,EAAE,MAAM,EAAE,mBAAmB,EAAE,CAAC;QAChD,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACzB,CAAC;IAEM,OAAO,CAAC,IAAuB,EAAE,EAAkB;QACxD,MAAM,UAAU,GAAG,IAAI,GAAG,EAAU,CAAC;QACrC,EAAE,CAAC,oBAAoB,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,EAAE;YAClD,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE;gBAC9B,IAAI,OAAO,CAAC,MAAM,KAAK,EAAE,CAAC,MAAM,IAAI,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC;oBACjE,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;aACrC;QACH,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;QACzB,IAAI,IAAI,CAAC,iBAAiB,CAAC,UAAU,EAAE,EAAE,CAAC;YACxC,EAAE,CAAC,eAAe,GAAG,IAAI,CAAC;IAC9B,CAAC;;AArCsB,mCAAM,GAAG,0BAA0B,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/** @packageDocumentation\r\n * @module Tools\r\n */\r\n\r\nimport { Id64 } from \"@itwin/core-bentley\";\r\nimport { ColorDef } from \"@itwin/core-common\";\r\nimport { EmphasizeElements, IModelApp, QueryVisibleFeaturesOptions, ScreenViewport, Tool } from \"@itwin/core-frontend\";\r\nimport { parseArgs } from \"./parseArgs\";\r\n\r\n/** Applies the `EmphasizeElements` API in some way to the selected Viewport.\r\n * @beta\r\n */\r\nexport abstract class EmphasizeElementsTool extends Tool {\r\n  protected get _wantCreate(): boolean { return true; }\r\n  protected get _wantClear(): boolean { return false; }\r\n  protected abstract execute(emph: EmphasizeElements, vp: ScreenViewport): void;\r\n\r\n  public override async run(_args: any[]): Promise<boolean> {\r\n    const vp = IModelApp.viewManager.selectedView;\r\n    if (undefined === vp)\r\n      return true;\r\n\r\n    if (this._wantClear)\r\n      EmphasizeElements.clear(vp);\r\n\r\n    const emph = this._wantCreate ? EmphasizeElements.getOrCreate(vp) : EmphasizeElements.get(vp);\r\n    if (undefined !== emph)\r\n      this.execute(emph, vp);\r\n\r\n    return true;\r\n  }\r\n}\r\n\r\nconst enum OverrideType { // eslint-disable-line no-restricted-syntax\r\n  None = 0,\r\n  Color = 1 << 0,\r\n  Emphasis = 1 << 1,\r\n  Both = Color | Emphasis,\r\n}\r\n\r\n/** If any elements are selected, emphasize them all by overriding their color to be orange; and de-emphasize all other elements by drawing them transparent grey.\r\n * @beta\r\n */\r\nexport class EmphasizeSelectedElementsTool extends EmphasizeElementsTool {\r\n  public static override toolId = \"EmphasizeSelectedElements\";\r\n  public static override get minArgs() { return 0; }\r\n  public static override get maxArgs() { return 1; }\r\n  private _type = OverrideType.None;\r\n\r\n  public execute(emph: EmphasizeElements, vp: ScreenViewport): void {\r\n    if (OverrideType.None === (this._type & OverrideType.Color) || emph.overrideSelectedElements(vp, ColorDef.white, undefined, true, false)) {\r\n      emph.wantEmphasis = OverrideType.None !== (this._type & OverrideType.Emphasis);\r\n      if (emph.emphasizeSelectedElements(vp, undefined, true)) {\r\n        vp.isFadeOutActive = true;\r\n        return;\r\n      }\r\n    }\r\n\r\n    // Empty selection set - clear any previous overrides.\r\n    EmphasizeElements.clear(vp);\r\n    emph.wantEmphasis = false;\r\n    vp.isFadeOutActive = false;\r\n  }\r\n\r\n  public override async parseAndRun(...args: string[]): Promise<boolean> {\r\n    if (1 === args.length) {\r\n      switch (args[0].toLowerCase()[0]) {\r\n        case \"n\":\r\n          break;\r\n        case \"c\":\r\n          this._type = OverrideType.Color;\r\n          break;\r\n        case \"e\":\r\n          this._type = OverrideType.Emphasis;\r\n          break;\r\n        case \"b\":\r\n          this._type = OverrideType.Both;\r\n          break;\r\n      }\r\n    }\r\n\r\n    return this.run(args);\r\n  }\r\n}\r\n\r\n/** Isolate all selected elements so that *only* those elements will be drawn.\r\n * @beta\r\n */\r\nexport class IsolateSelectedElementsTool extends EmphasizeElementsTool {\r\n  public static override toolId = \"IsolateSelectedElements\";\r\n  public execute(emph: EmphasizeElements, vp: ScreenViewport): void {\r\n    emph.isolateSelectedElements(vp, true, true);\r\n  }\r\n}\r\n\r\n/** Clear the set of isolated elements.\r\n * @beta\r\n */\r\nexport class ClearIsolatedElementsTool extends EmphasizeElementsTool {\r\n  public static override toolId = \"ClearIsolatedElements\";\r\n  protected override get _wantCreate() { return false; }\r\n  public execute(emph: EmphasizeElements, vp: ScreenViewport): void {\r\n    emph.clearIsolatedElements(vp);\r\n  }\r\n}\r\n\r\n/** Reset [EmphasizeElements]($frontend) for the active [Viewport]($frontend).\r\n * @beta\r\n */\r\nexport class ClearEmphasizedElementsTool extends EmphasizeElementsTool {\r\n  public static override toolId = \"ClearEmphasizedElements\";\r\n  protected override get _wantCreate() { return false; }\r\n  protected override get _wantClear() { return true; }\r\n\r\n  public execute(emph: EmphasizeElements, vp: ScreenViewport): void {\r\n    emph.clearEmphasizedElements(vp);\r\n    vp.isFadeOutActive = false;\r\n  }\r\n}\r\n\r\n/** Emphasize the set of elements currently visible in the view based on [Viewport.queryVisibleFeatures]($frontend).\r\n * @beta\r\n */\r\nexport class EmphasizeVisibleElementsTool extends EmphasizeElementsTool {\r\n  public static override toolId = \"EmphasizeVisibleElements\";\r\n  public static override get minArgs() { return 1; }\r\n  public static override get maxArgs() { return 2; }\r\n  private _options: QueryVisibleFeaturesOptions = { source: \"screen\" };\r\n  protected override get _wantClear() { return true; }\r\n\r\n  public override async parseAndRun(...input: string[]): Promise<boolean> {\r\n    const args = parseArgs(input);\r\n    const includeNonLocatable = args.getBoolean(\"n\");\r\n    let source: \"screen\" | \"tiles\";\r\n    switch (input[0].toLowerCase()) {\r\n      case \"screen\":\r\n        source = \"screen\";\r\n        break;\r\n      case \"tiles\":\r\n        source = \"tiles\";\r\n        break;\r\n      default:\r\n        return false;\r\n    }\r\n\r\n    this._options = { source, includeNonLocatable };\r\n    return this.run(input);\r\n  }\r\n\r\n  public execute(emph: EmphasizeElements, vp: ScreenViewport): void {\r\n    const elementIds = new Set<string>();\r\n    vp.queryVisibleFeatures(this._options, (features) => {\r\n      for (const feature of features) {\r\n        if (feature.iModel === vp.iModel && Id64.isValid(feature.elementId))\r\n          elementIds.add(feature.elementId);\r\n      }\r\n    });\r\n\r\n    emph.wantEmphasis = true;\r\n    if (emph.emphasizeElements(elementIds, vp))\r\n      vp.isFadeOutActive = true;\r\n  }\r\n}\r\n"]}