@itwin/frontend-devtools 4.0.0-dev.44 → 4.0.0-dev.48

package/lib/esm/tools/DisplayStyleTools.js

@@ -1,355 +1,355 @@
-/*---------------------------------------------------------------------------------------------
-* 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 { ColorDef, RenderMode, SkyCube, SkySphere, SubCategoryOverride, ViewFlags, WhiteOnWhiteReversalSettings, } from "@itwin/core-common";
-import { 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",
-    "wiremesh",
-];
-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()) && await 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()) && await this.parse(args, vp))
-            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; }
-    async parse(_args) { return true; } // no arguments
-    async execute(vp) {
-        const style = vp.view.displayStyle;
-        style.environment = style.environment.withDisplay({ sky: !style.environment.displaySky });
-        return true;
-    }
-}
-ToggleSkyboxTool.toolId = "ToggleSkybox";
-/** Defines a [SkySphere]($common) to apply to the current view.
- * @beta
- */
-export class SkySphereTool extends DisplayStyleTool {
-    static get minArgs() { return 1; }
-    static get maxArgs() { return 1; }
-    get require3d() { return true; }
-    async parse(args) {
-        this._image = args[0];
-        return true;
-    }
-    async execute(vp) {
-        if (this._image && vp.view.is3d()) {
-            vp.view.displayStyle.environment = vp.view.displayStyle.environment.clone({
-                displaySky: true,
-                sky: new SkySphere(this._image),
-            });
-        }
-        return true;
-    }
-}
-SkySphereTool.toolId = "SetSkySphere";
-/** Defines a [SkyCube]($common) to apply to the current view.
- * @beta
- */
-export class SkyCubeTool extends DisplayStyleTool {
-    constructor() {
-        super(...arguments);
-        this._images = [];
-    }
-    static get minArgs() { return 1; }
-    static get maxArgs() { return 6; }
-    get require3d() { return true; }
-    async parse(args) {
-        this._images = [...args];
-        return true;
-    }
-    async execute(vp) {
-        const imgs = this._images;
-        if (imgs.length === 0 || !vp.view.is3d())
-            return true;
-        let top, bottom, left, right, front, back;
-        switch (imgs.length) {
-            case 1:
-                top = bottom = left = right = front = back = imgs[0];
-                break;
-            case 2:
-                top = bottom = imgs[0];
-                left = right = front = back = imgs[1];
-                break;
-            case 3:
-                top = bottom = imgs[0];
-                left = right = imgs[1];
-                front = back = imgs[2];
-                break;
-            case 4:
-                top = imgs[0];
-                bottom = imgs[1];
-                left = right = imgs[2];
-                front = back = imgs[3];
-                break;
-            case 5:
-                top = bottom = imgs[0];
-                left = imgs[1];
-                right = imgs[2];
-                front = imgs[3];
-                back = imgs[4];
-                break;
-            default:
-                top = imgs[0];
-                bottom = imgs[1];
-                left = imgs[2];
-                right = imgs[3];
-                front = imgs[4];
-                back = imgs[5];
-                break;
-        }
-        vp.view.displayStyle.environment = vp.view.displayStyle.environment.clone({
-            displaySky: true,
-            sky: new SkyCube({ top, bottom, left, right, front, back }),
-        });
-        return true;
-    }
-}
-SkyCubeTool.toolId = "SetSkyCube";
-/** 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 clipboard.
- *  * `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; }
-    async 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;
-    }
-    async 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; }
-    async parse(args) {
-        try {
-            this._overrides = JSON.parse(args[0]);
-            return true;
-        }
-        catch {
-            IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Error, "Invalid JSON"));
-            return false;
-        }
-    }
-    async 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; }
-    async 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;
-    }
-    async 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; }
-    async parse(args) {
-        const ignore = parseToggle(args[0]);
-        if (typeof ignore === "string")
-            return false;
-        this._ignore = ignore;
-        return true;
-    }
-    async execute(vp) {
-        const ignoreBackgroundColor = this._ignore ?? !vp.displayStyle.settings.whiteOnWhiteReversal.ignoreBackgroundColor;
-        vp.displayStyle.settings.whiteOnWhiteReversal = WhiteOnWhiteReversalSettings.fromJSON({ ignoreBackgroundColor });
-        return true;
-    }
-}
-WoWIgnoreBackgroundTool.toolId = "WoWIgnoreBackground";
-/** Toggle whether surfaces display with overlaid wiremesh in the active viewport.
- * @see [ViewFlags.wiremesh]($common).
- * @beta
- */
-export class ToggleWiremeshTool extends DisplayStyleTool {
-    static get minArgs() { return 0; }
-    static get maxArgs() { return 1; }
-    async parse(args) {
-        const enable = parseToggle(args[0]);
-        if (typeof enable === "string")
-            return false;
-        this._enable = enable;
-        return true;
-    }
-    async execute(vp) {
-        vp.viewFlags = vp.viewFlags.with("wiremesh", this._enable ?? !vp.viewFlags.wiremesh);
-        return true;
-    }
-}
-ToggleWiremeshTool.toolId = "ToggleWiremesh";
-/** Change the background color of the active viewport and optionally its transparency.
- * @beta
- */
-export class ChangeBackgroundColorTool extends DisplayStyleTool {
-    static get minArgs() { return 1; }
-    static get maxArgs() { return 1; }
-    async parse(args) {
-        this._color = ColorDef.fromString(args[0]);
-        return true;
-    }
-    async execute(vp) {
-        if (!this._color)
-            return false;
-        vp.displayStyle.backgroundColor = this._color;
-        return true;
-    }
-}
-ChangeBackgroundColorTool.toolId = "ChangeBackgroundColor";
+/*---------------------------------------------------------------------------------------------
+* 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 { ColorDef, RenderMode, SkyCube, SkySphere, SubCategoryOverride, ViewFlags, WhiteOnWhiteReversalSettings, } from "@itwin/core-common";
+import { 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",
+    "wiremesh",
+];
+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()) && await 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()) && await this.parse(args, vp))
+            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; }
+    async parse(_args) { return true; } // no arguments
+    async execute(vp) {
+        const style = vp.view.displayStyle;
+        style.environment = style.environment.withDisplay({ sky: !style.environment.displaySky });
+        return true;
+    }
+}
+ToggleSkyboxTool.toolId = "ToggleSkybox";
+/** Defines a [SkySphere]($common) to apply to the current view.
+ * @beta
+ */
+export class SkySphereTool extends DisplayStyleTool {
+    static get minArgs() { return 1; }
+    static get maxArgs() { return 1; }
+    get require3d() { return true; }
+    async parse(args) {
+        this._image = args[0];
+        return true;
+    }
+    async execute(vp) {
+        if (this._image && vp.view.is3d()) {
+            vp.view.displayStyle.environment = vp.view.displayStyle.environment.clone({
+                displaySky: true,
+                sky: new SkySphere(this._image),
+            });
+        }
+        return true;
+    }
+}
+SkySphereTool.toolId = "SetSkySphere";
+/** Defines a [SkyCube]($common) to apply to the current view.
+ * @beta
+ */
+export class SkyCubeTool extends DisplayStyleTool {
+    constructor() {
+        super(...arguments);
+        this._images = [];
+    }
+    static get minArgs() { return 1; }
+    static get maxArgs() { return 6; }
+    get require3d() { return true; }
+    async parse(args) {
+        this._images = [...args];
+        return true;
+    }
+    async execute(vp) {
+        const imgs = this._images;
+        if (imgs.length === 0 || !vp.view.is3d())
+            return true;
+        let top, bottom, left, right, front, back;
+        switch (imgs.length) {
+            case 1:
+                top = bottom = left = right = front = back = imgs[0];
+                break;
+            case 2:
+                top = bottom = imgs[0];
+                left = right = front = back = imgs[1];
+                break;
+            case 3:
+                top = bottom = imgs[0];
+                left = right = imgs[1];
+                front = back = imgs[2];
+                break;
+            case 4:
+                top = imgs[0];
+                bottom = imgs[1];
+                left = right = imgs[2];
+                front = back = imgs[3];
+                break;
+            case 5:
+                top = bottom = imgs[0];
+                left = imgs[1];
+                right = imgs[2];
+                front = imgs[3];
+                back = imgs[4];
+                break;
+            default:
+                top = imgs[0];
+                bottom = imgs[1];
+                left = imgs[2];
+                right = imgs[3];
+                front = imgs[4];
+                back = imgs[5];
+                break;
+        }
+        vp.view.displayStyle.environment = vp.view.displayStyle.environment.clone({
+            displaySky: true,
+            sky: new SkyCube({ top, bottom, left, right, front, back }),
+        });
+        return true;
+    }
+}
+SkyCubeTool.toolId = "SetSkyCube";
+/** 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 clipboard.
+ *  * `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; }
+    async 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;
+    }
+    async 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; }
+    async parse(args) {
+        try {
+            this._overrides = JSON.parse(args[0]);
+            return true;
+        }
+        catch {
+            IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Error, "Invalid JSON"));
+            return false;
+        }
+    }
+    async 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; }
+    async 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;
+    }
+    async 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; }
+    async parse(args) {
+        const ignore = parseToggle(args[0]);
+        if (typeof ignore === "string")
+            return false;
+        this._ignore = ignore;
+        return true;
+    }
+    async execute(vp) {
+        const ignoreBackgroundColor = this._ignore ?? !vp.displayStyle.settings.whiteOnWhiteReversal.ignoreBackgroundColor;
+        vp.displayStyle.settings.whiteOnWhiteReversal = WhiteOnWhiteReversalSettings.fromJSON({ ignoreBackgroundColor });
+        return true;
+    }
+}
+WoWIgnoreBackgroundTool.toolId = "WoWIgnoreBackground";
+/** Toggle whether surfaces display with overlaid wiremesh in the active viewport.
+ * @see [ViewFlags.wiremesh]($common).
+ * @beta
+ */
+export class ToggleWiremeshTool extends DisplayStyleTool {
+    static get minArgs() { return 0; }
+    static get maxArgs() { return 1; }
+    async parse(args) {
+        const enable = parseToggle(args[0]);
+        if (typeof enable === "string")
+            return false;
+        this._enable = enable;
+        return true;
+    }
+    async execute(vp) {
+        vp.viewFlags = vp.viewFlags.with("wiremesh", this._enable ?? !vp.viewFlags.wiremesh);
+        return true;
+    }
+}
+ToggleWiremeshTool.toolId = "ToggleWiremesh";
+/** Change the background color of the active viewport and optionally its transparency.
+ * @beta
+ */
+export class ChangeBackgroundColorTool extends DisplayStyleTool {
+    static get minArgs() { return 1; }
+    static get maxArgs() { return 1; }
+    async parse(args) {
+        this._color = ColorDef.fromString(args[0]);
+        return true;
+    }
+    async execute(vp) {
+        if (!this._color)
+            return false;
+        vp.displayStyle.backgroundColor = this._color;
+        return true;
+    }
+}
+ChangeBackgroundColorTool.toolId = "ChangeBackgroundColor";
 //# sourceMappingURL=DisplayStyleTools.js.map