@itwin/frontend-devtools 4.0.0-dev.28 → 4.0.0-dev.30

package/lib/esm/tools/ClipTools.js

@@ -1,156 +1,156 @@
-/*---------------------------------------------------------------------------------------------
-* 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 { ClipStyle, ColorByName, ColorDef, LinePixels, RenderMode, RgbColor, } from "@itwin/core-common";
-import { IModelApp, Tool } from "@itwin/core-frontend";
-import { parseToggle } from "./parseToggle";
-import { parseBoolean } from "./parseBoolean";
-import { DisplayStyleTool } from "./DisplayStyleTools";
-/** This tool specifies or un-specifies a clip color to use for pixels inside or outside the clip region.
- * Arguments can be:
- * - clear
- * - inside   <color string> | clear
- * - outside  <color string> | clear
- * <color string> must be in one of the following forms:
- * "rgb(255,0,0)"
- * "rgba(255,0,0,255)"
- * "rgb(100%,0%,0%)"
- * "hsl(120,50%,50%)"
- * "#rrbbgg"
- * "blanchedAlmond" (see possible values from [[ColorByName]]). Case insensitive.
- * @see [ColorDef]
- * @beta
- */
-export class ClipColorTool extends Tool {
-    static get minArgs() { return 1; }
-    static get maxArgs() { return 2; }
-    _clearClipColors() {
-        const vp = IModelApp.viewManager.selectedView;
-        if (undefined !== vp) {
-            const props = vp.displayStyle.settings.clipStyle.toJSON() ?? {};
-            props.insideColor = props.outsideColor = undefined;
-            vp.displayStyle.settings.clipStyle = ClipStyle.fromJSON(props);
-        }
-    }
-    setClipColor(colStr, which) {
-        const vp = IModelApp.viewManager.selectedView;
-        if (vp) {
-            const props = vp.displayStyle.settings.clipStyle.toJSON() ?? {};
-            props[which] = colStr === "clear" ? undefined : RgbColor.fromColorDef(ColorDef.fromString(colStr));
-            vp.displayStyle.settings.clipStyle = ClipStyle.fromJSON(props);
-        }
-    }
-    /** This runs the tool using the given arguments, specifying or unspecifying a clip color to use for pixels inside or outside the clip region.
-     * Arguments can be:
-     * - clear
-     * - inside   <color string> | clear
-     * - outside  <color string> | clear
-     * <color string> must be in one of the following forms:
-     * "rgb(255,0,0)"
-     * "rgba(255,0,0,255)"
-     * "rgb(100%,0%,0%)"
-     * "hsl(120,50%,50%)"
-     * "#rrbbgg"
-     * "blanchedAlmond" (see possible values from [[ColorByName]]). Case insensitive.
-     * @beta
-     */
-    async parseAndRun(...args) {
-        if (1 === args.length) {
-            if (args[0] === "clear")
-                this._clearClipColors();
-            return true;
-        }
-        const which = args[0];
-        if (which === "inside" || which === "outside")
-            this.setClipColor(args[1], "inside" === which ? "insideColor" : "outsideColor");
-        return true;
-    }
-}
-ClipColorTool.toolId = "ClipColorTool";
-/** Controls a view state's view details' flag for producing cut geometry for a clip style.
- * @beta
- */
-export class ToggleSectionCutTool extends Tool {
-    static get minArgs() { return 0; }
-    static get maxArgs() { return 1; }
-    /** This method runs the tool, controlling a view state's view details' flag for producing cut geometry for a clip style.
-     * @param produceCutGeometry whether to produce cut geometry
-     */
-    async run(produceCutGeometry) {
-        const vp = IModelApp.viewManager.selectedView;
-        if (vp) {
-            const style = vp.view.displayStyle.settings.clipStyle;
-            produceCutGeometry = produceCutGeometry ?? !style.produceCutGeometry;
-            if (produceCutGeometry !== style.produceCutGeometry) {
-                const json = {
-                    ...vp.view.displayStyle.settings.clipStyle.toJSON(),
-                    produceCutGeometry,
-                };
-                vp.view.displayStyle.settings.clipStyle = ClipStyle.fromJSON(json);
-                vp.invalidateScene();
-            }
-        }
-        return true;
-    }
-    /** Executes this tool's run method with args[0] containing `produceCutGeometry`.
-     * @see [[run]]
-     */
-    async parseAndRun(...args) {
-        const enable = parseToggle(args[0]);
-        if (typeof enable !== "string")
-            await this.run(enable);
-        return true;
-    }
-}
-ToggleSectionCutTool.toolId = "ToggleSectionCut";
-/** Simple tool that toggles a hard-coded clip style overriding various aspects of the cut geometry appearance.
- * @beta
- */
-export class TestClipStyleTool extends DisplayStyleTool {
-    constructor() {
-        super(...arguments);
-        this._useStyle = false;
-    }
-    static get maxArgs() { return 1; }
-    static get minArgs() { return 1; }
-    get require3d() { return true; }
-    async parse(args) {
-        this._useStyle = parseBoolean(args[0]) ?? false;
-        return true;
-    }
-    async execute(vp) {
-        const props = { produceCutGeometry: true };
-        if (this._useStyle) {
-            props.cutStyle = {
-                viewflags: {
-                    renderMode: RenderMode.SmoothShade,
-                    visibleEdges: true,
-                    hiddenEdges: false,
-                },
-                appearance: {
-                    rgb: { r: 0xff, g: 0x7f, b: 0 },
-                    transparency: 0.5,
-                    nonLocatable: true,
-                },
-                hiddenLine: {
-                    visible: {
-                        ovrColor: true,
-                        color: ColorByName.blue,
-                        pattern: LinePixels.Solid,
-                        width: 3,
-                    },
-                },
-            };
-        }
-        vp.displayStyle.settings.clipStyle = ClipStyle.fromJSON(props);
-        vp.invalidateRenderPlan();
-        vp.setFeatureOverrideProviderChanged();
-        return true;
-    }
-}
-TestClipStyleTool.toolId = "TestClipStyle";
+/*---------------------------------------------------------------------------------------------
+* 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 { ClipStyle, ColorByName, ColorDef, LinePixels, RenderMode, RgbColor, } from "@itwin/core-common";
+import { IModelApp, Tool } from "@itwin/core-frontend";
+import { parseToggle } from "./parseToggle";
+import { parseBoolean } from "./parseBoolean";
+import { DisplayStyleTool } from "./DisplayStyleTools";
+/** This tool specifies or un-specifies a clip color to use for pixels inside or outside the clip region.
+ * Arguments can be:
+ * - clear
+ * - inside   <color string> | clear
+ * - outside  <color string> | clear
+ * <color string> must be in one of the following forms:
+ * "rgb(255,0,0)"
+ * "rgba(255,0,0,255)"
+ * "rgb(100%,0%,0%)"
+ * "hsl(120,50%,50%)"
+ * "#rrbbgg"
+ * "blanchedAlmond" (see possible values from [[ColorByName]]). Case insensitive.
+ * @see [ColorDef]
+ * @beta
+ */
+export class ClipColorTool extends Tool {
+    static get minArgs() { return 1; }
+    static get maxArgs() { return 2; }
+    _clearClipColors() {
+        const vp = IModelApp.viewManager.selectedView;
+        if (undefined !== vp) {
+            const props = vp.displayStyle.settings.clipStyle.toJSON() ?? {};
+            props.insideColor = props.outsideColor = undefined;
+            vp.displayStyle.settings.clipStyle = ClipStyle.fromJSON(props);
+        }
+    }
+    setClipColor(colStr, which) {
+        const vp = IModelApp.viewManager.selectedView;
+        if (vp) {
+            const props = vp.displayStyle.settings.clipStyle.toJSON() ?? {};
+            props[which] = colStr === "clear" ? undefined : RgbColor.fromColorDef(ColorDef.fromString(colStr));
+            vp.displayStyle.settings.clipStyle = ClipStyle.fromJSON(props);
+        }
+    }
+    /** This runs the tool using the given arguments, specifying or unspecifying a clip color to use for pixels inside or outside the clip region.
+     * Arguments can be:
+     * - clear
+     * - inside   <color string> | clear
+     * - outside  <color string> | clear
+     * <color string> must be in one of the following forms:
+     * "rgb(255,0,0)"
+     * "rgba(255,0,0,255)"
+     * "rgb(100%,0%,0%)"
+     * "hsl(120,50%,50%)"
+     * "#rrbbgg"
+     * "blanchedAlmond" (see possible values from [[ColorByName]]). Case insensitive.
+     * @beta
+     */
+    async parseAndRun(...args) {
+        if (1 === args.length) {
+            if (args[0] === "clear")
+                this._clearClipColors();
+            return true;
+        }
+        const which = args[0];
+        if (which === "inside" || which === "outside")
+            this.setClipColor(args[1], "inside" === which ? "insideColor" : "outsideColor");
+        return true;
+    }
+}
+ClipColorTool.toolId = "ClipColorTool";
+/** Controls a view state's view details' flag for producing cut geometry for a clip style.
+ * @beta
+ */
+export class ToggleSectionCutTool extends Tool {
+    static get minArgs() { return 0; }
+    static get maxArgs() { return 1; }
+    /** This method runs the tool, controlling a view state's view details' flag for producing cut geometry for a clip style.
+     * @param produceCutGeometry whether to produce cut geometry
+     */
+    async run(produceCutGeometry) {
+        const vp = IModelApp.viewManager.selectedView;
+        if (vp) {
+            const style = vp.view.displayStyle.settings.clipStyle;
+            produceCutGeometry = produceCutGeometry ?? !style.produceCutGeometry;
+            if (produceCutGeometry !== style.produceCutGeometry) {
+                const json = {
+                    ...vp.view.displayStyle.settings.clipStyle.toJSON(),
+                    produceCutGeometry,
+                };
+                vp.view.displayStyle.settings.clipStyle = ClipStyle.fromJSON(json);
+                vp.invalidateScene();
+            }
+        }
+        return true;
+    }
+    /** Executes this tool's run method with args[0] containing `produceCutGeometry`.
+     * @see [[run]]
+     */
+    async parseAndRun(...args) {
+        const enable = parseToggle(args[0]);
+        if (typeof enable !== "string")
+            await this.run(enable);
+        return true;
+    }
+}
+ToggleSectionCutTool.toolId = "ToggleSectionCut";
+/** Simple tool that toggles a hard-coded clip style overriding various aspects of the cut geometry appearance.
+ * @beta
+ */
+export class TestClipStyleTool extends DisplayStyleTool {
+    constructor() {
+        super(...arguments);
+        this._useStyle = false;
+    }
+    static get maxArgs() { return 1; }
+    static get minArgs() { return 1; }
+    get require3d() { return true; }
+    async parse(args) {
+        this._useStyle = parseBoolean(args[0]) ?? false;
+        return true;
+    }
+    async execute(vp) {
+        const props = { produceCutGeometry: true };
+        if (this._useStyle) {
+            props.cutStyle = {
+                viewflags: {
+                    renderMode: RenderMode.SmoothShade,
+                    visibleEdges: true,
+                    hiddenEdges: false,
+                },
+                appearance: {
+                    rgb: { r: 0xff, g: 0x7f, b: 0 },
+                    transparency: 0.5,
+                    nonLocatable: true,
+                },
+                hiddenLine: {
+                    visible: {
+                        ovrColor: true,
+                        color: ColorByName.blue,
+                        pattern: LinePixels.Solid,
+                        width: 3,
+                    },
+                },
+            };
+        }
+        vp.displayStyle.settings.clipStyle = ClipStyle.fromJSON(props);
+        vp.invalidateRenderPlan();
+        vp.setFeatureOverrideProviderChanged();
+        return true;
+    }
+}
+TestClipStyleTool.toolId = "TestClipStyle";
 //# sourceMappingURL=ClipTools.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"ClipTools.js","sourceRoot":"","sources":["../../../src/tools/ClipTools.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F;;GAEG;AAEH,OAAO,EACL,SAAS,EAAkB,WAAW,EAAE,QAAQ,EAAE,UAAU,EAAE,UAAU,EAAE,QAAQ,GACnF,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAE,IAAI,EAAY,MAAM,sBAAsB,CAAC;AACjE,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAEvD;;;;;;;;;;;;;;GAcG;AACH,MAAM,OAAO,aAAc,SAAQ,IAAI;IAE9B,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAE1C,gBAAgB;QACtB,MAAM,EAAE,GAAG,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC;QAC9C,IAAI,SAAS,KAAK,EAAE,EAAE;YACpB,MAAM,KAAK,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC;YAChE,KAAK,CAAC,WAAW,GAAG,KAAK,CAAC,YAAY,GAAG,SAAS,CAAC;YACnD,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,SAAS,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;SAChE;IACH,CAAC;IAEO,YAAY,CAAC,MAAc,EAAE,KAAqC;QACxE,MAAM,EAAE,GAAG,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC;QAC9C,IAAI,EAAE,EAAE;YACN,MAAM,KAAK,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC;YAChE,KAAK,CAAC,KAAK,CAAC,GAAG,MAAM,KAAK,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;YACnG,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,SAAS,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;SAChE;IACH,CAAC;IAED;;;;;;;;;;;;;OAaG;IACa,KAAK,CAAC,WAAW,CAAC,GAAG,IAAc;QACjD,IAAI,CAAC,KAAK,IAAI,CAAC,MAAM,EAAE;YACrB,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,OAAO;gBACrB,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAE1B,OAAO,IAAI,CAAC;SACb;QAED,MAAM,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QACtB,IAAI,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,SAAS;YAC3C,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,QAAQ,KAAK,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC;QAElF,OAAO,IAAI,CAAC;IACd,CAAC;;AAjDsB,oBAAM,GAAG,eAAe,CAAC;AAoDlD;;GAEG;AACH,MAAM,OAAO,oBAAqB,SAAQ,IAAI;IAErC,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAElD;;OAEG;IACa,KAAK,CAAC,GAAG,CAAC,kBAA4B;QACpD,MAAM,EAAE,GAAG,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC;QAC9C,IAAI,EAAE,EAAE;YACN,MAAM,KAAK,GAAG,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,SAAS,CAAC;YACtD,kBAAkB,GAAG,kBAAkB,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC;YACrE,IAAI,kBAAkB,KAAK,KAAK,CAAC,kBAAkB,EAAE;gBACnD,MAAM,IAAI,GAAG;oBACX,GAAG,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,SAAS,CAAC,MAAM,EAAE;oBACnD,kBAAkB;iBACnB,CAAC;gBAEF,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,SAAS,GAAG,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;gBACnE,EAAE,CAAC,eAAe,EAAE,CAAC;aACtB;SACF;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACa,KAAK,CAAC,WAAW,CAAC,GAAG,IAAc;QACjD,MAAM,MAAM,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QACpC,IAAI,OAAO,MAAM,KAAK,QAAQ;YAC5B,MAAM,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAEzB,OAAO,IAAI,CAAC;IACd,CAAC;;AAnCsB,2BAAM,GAAG,kBAAkB,CAAC;AAsCrD;;GAEG;AACH,MAAM,OAAO,iBAAkB,SAAQ,gBAAgB;IAAvD;;QAKU,cAAS,GAAG,KAAK,CAAC;IAwC5B,CAAC;IA3CQ,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAIlD,IAAuB,SAAS,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IAEzC,KAAK,CAAC,KAAK,CAAC,IAAc;QAClC,IAAI,CAAC,SAAS,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC;QAChD,OAAO,IAAI,CAAC;IACd,CAAC;IAES,KAAK,CAAC,OAAO,CAAC,EAAY;QAClC,MAAM,KAAK,GAAmB,EAAE,kBAAkB,EAAE,IAAI,EAAE,CAAC;QAC3D,IAAI,IAAI,CAAC,SAAS,EAAE;YAClB,KAAK,CAAC,QAAQ,GAAG;gBACf,SAAS,EAAE;oBACT,UAAU,EAAE,UAAU,CAAC,WAAW;oBAClC,YAAY,EAAE,IAAI;oBAClB,WAAW,EAAE,KAAK;iBACnB;gBACD,UAAU,EAAE;oBACV,GAAG,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,EAAE;oBAC/B,YAAY,EAAE,GAAG;oBACjB,YAAY,EAAE,IAAI;iBACnB;gBACD,UAAU,EAAE;oBACV,OAAO,EAAE;wBACP,QAAQ,EAAE,IAAI;wBACd,KAAK,EAAE,WAAW,CAAC,IAAI;wBACvB,OAAO,EAAE,UAAU,CAAC,KAAK;wBACzB,KAAK,EAAE,CAAC;qBACT;iBACF;aACF,CAAC;SACH;QAED,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,SAAS,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAC/D,EAAE,CAAC,oBAAoB,EAAE,CAAC;QAC1B,EAAE,CAAC,iCAAiC,EAAE,CAAC;QAEvC,OAAO,IAAI,CAAC;IACd,CAAC;;AA3CsB,wBAAM,GAAG,eAAe,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n\n/** @packageDocumentation\n * @module Tools\n */\n\nimport {\n  ClipStyle, ClipStyleProps, ColorByName, ColorDef, LinePixels, RenderMode, RgbColor,\n} from \"@itwin/core-common\";\nimport { IModelApp, Tool, Viewport } from \"@itwin/core-frontend\";\nimport { parseToggle } from \"./parseToggle\";\nimport { parseBoolean } from \"./parseBoolean\";\nimport { DisplayStyleTool } from \"./DisplayStyleTools\";\n\n/** This tool specifies or un-specifies a clip color to use for pixels inside or outside the clip region.\n * Arguments can be:\n * - clear\n * - inside   <color string> | clear\n * - outside  <color string> | clear\n * <color string> must be in one of the following forms:\n * \"rgb(255,0,0)\"\n * \"rgba(255,0,0,255)\"\n * \"rgb(100%,0%,0%)\"\n * \"hsl(120,50%,50%)\"\n * \"#rrbbgg\"\n * \"blanchedAlmond\" (see possible values from [[ColorByName]]). Case insensitive.\n * @see [ColorDef]\n * @beta\n */\nexport class ClipColorTool extends Tool {\n  public static override toolId = \"ClipColorTool\";\n  public static override get minArgs() { return 1; }\n  public static override get maxArgs() { return 2; }\n\n  private _clearClipColors() {\n    const vp = IModelApp.viewManager.selectedView;\n    if (undefined !== vp) {\n      const props = vp.displayStyle.settings.clipStyle.toJSON() ?? {};\n      props.insideColor = props.outsideColor = undefined;\n      vp.displayStyle.settings.clipStyle = ClipStyle.fromJSON(props);\n    }\n  }\n\n  private setClipColor(colStr: string, which: \"insideColor\" | \"outsideColor\") {\n    const vp = IModelApp.viewManager.selectedView;\n    if (vp) {\n      const props = vp.displayStyle.settings.clipStyle.toJSON() ?? {};\n      props[which] = colStr === \"clear\" ? undefined : RgbColor.fromColorDef(ColorDef.fromString(colStr));\n      vp.displayStyle.settings.clipStyle = ClipStyle.fromJSON(props);\n    }\n  }\n\n  /** This runs the tool using the given arguments, specifying or unspecifying a clip color to use for pixels inside or outside the clip region.\n   * Arguments can be:\n   * - clear\n   * - inside   <color string> | clear\n   * - outside  <color string> | clear\n   * <color string> must be in one of the following forms:\n   * \"rgb(255,0,0)\"\n   * \"rgba(255,0,0,255)\"\n   * \"rgb(100%,0%,0%)\"\n   * \"hsl(120,50%,50%)\"\n   * \"#rrbbgg\"\n   * \"blanchedAlmond\" (see possible values from [[ColorByName]]). Case insensitive.\n   * @beta\n   */\n  public override async parseAndRun(...args: string[]): Promise<boolean> {\n    if (1 === args.length) {\n      if (args[0] === \"clear\")\n        this._clearClipColors();\n\n      return true;\n    }\n\n    const which = args[0];\n    if (which === \"inside\" || which === \"outside\")\n      this.setClipColor(args[1], \"inside\" === which ? \"insideColor\" : \"outsideColor\");\n\n    return true;\n  }\n}\n\n/** Controls a view state's view details' flag for producing cut geometry for a clip style.\n * @beta\n */\nexport class ToggleSectionCutTool extends Tool {\n  public static override toolId = \"ToggleSectionCut\";\n  public static override get minArgs() { return 0; }\n  public static override get maxArgs() { return 1; }\n\n  /** This method runs the tool, controlling a view state's view details' flag for producing cut geometry for a clip style.\n   * @param produceCutGeometry whether to produce cut geometry\n   */\n  public override async run(produceCutGeometry?: boolean): Promise<boolean> {\n    const vp = IModelApp.viewManager.selectedView;\n    if (vp) {\n      const style = vp.view.displayStyle.settings.clipStyle;\n      produceCutGeometry = produceCutGeometry ?? !style.produceCutGeometry;\n      if (produceCutGeometry !== style.produceCutGeometry) {\n        const json = {\n          ...vp.view.displayStyle.settings.clipStyle.toJSON(),\n          produceCutGeometry,\n        };\n\n        vp.view.displayStyle.settings.clipStyle = ClipStyle.fromJSON(json);\n        vp.invalidateScene();\n      }\n    }\n\n    return true;\n  }\n\n  /** Executes this tool's run method with args[0] containing `produceCutGeometry`.\n   * @see [[run]]\n   */\n  public override async parseAndRun(...args: string[]): Promise<boolean> {\n    const enable = parseToggle(args[0]);\n    if (typeof enable !== \"string\")\n      await this.run(enable);\n\n    return true;\n  }\n}\n\n/** Simple tool that toggles a hard-coded clip style overriding various aspects of the cut geometry appearance.\n * @beta\n */\nexport class TestClipStyleTool extends DisplayStyleTool {\n  public static override toolId = \"TestClipStyle\";\n  public static override get maxArgs() { return 1; }\n  public static override get minArgs() { return 1; }\n\n  private _useStyle = false;\n\n  protected override get require3d() { return true; }\n\n  protected async parse(args: string[]): Promise<boolean> {\n    this._useStyle = parseBoolean(args[0]) ?? false;\n    return true;\n  }\n\n  protected async execute(vp: Viewport) {\n    const props: ClipStyleProps = { produceCutGeometry: true };\n    if (this._useStyle) {\n      props.cutStyle = {\n        viewflags: {\n          renderMode: RenderMode.SmoothShade,\n          visibleEdges: true,\n          hiddenEdges: false,\n        },\n        appearance: {\n          rgb: { r: 0xff, g: 0x7f, b: 0 },\n          transparency: 0.5,\n          nonLocatable: true,\n        },\n        hiddenLine: {\n          visible: {\n            ovrColor: true,\n            color: ColorByName.blue,\n            pattern: LinePixels.Solid,\n            width: 3,\n          },\n        },\n      };\n    }\n\n    vp.displayStyle.settings.clipStyle = ClipStyle.fromJSON(props);\n    vp.invalidateRenderPlan();\n    vp.setFeatureOverrideProviderChanged();\n\n    return true;\n  }\n}\n"]}
+{"version":3,"file":"ClipTools.js","sourceRoot":"","sources":["../../../src/tools/ClipTools.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F;;GAEG;AAEH,OAAO,EACL,SAAS,EAAkB,WAAW,EAAE,QAAQ,EAAE,UAAU,EAAE,UAAU,EAAE,QAAQ,GACnF,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAE,IAAI,EAAY,MAAM,sBAAsB,CAAC;AACjE,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAEvD;;;;;;;;;;;;;;GAcG;AACH,MAAM,OAAO,aAAc,SAAQ,IAAI;IAE9B,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAE1C,gBAAgB;QACtB,MAAM,EAAE,GAAG,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC;QAC9C,IAAI,SAAS,KAAK,EAAE,EAAE;YACpB,MAAM,KAAK,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC;YAChE,KAAK,CAAC,WAAW,GAAG,KAAK,CAAC,YAAY,GAAG,SAAS,CAAC;YACnD,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,SAAS,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;SAChE;IACH,CAAC;IAEO,YAAY,CAAC,MAAc,EAAE,KAAqC;QACxE,MAAM,EAAE,GAAG,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC;QAC9C,IAAI,EAAE,EAAE;YACN,MAAM,KAAK,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC;YAChE,KAAK,CAAC,KAAK,CAAC,GAAG,MAAM,KAAK,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;YACnG,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,SAAS,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;SAChE;IACH,CAAC;IAED;;;;;;;;;;;;;OAaG;IACa,KAAK,CAAC,WAAW,CAAC,GAAG,IAAc;QACjD,IAAI,CAAC,KAAK,IAAI,CAAC,MAAM,EAAE;YACrB,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,OAAO;gBACrB,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAE1B,OAAO,IAAI,CAAC;SACb;QAED,MAAM,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QACtB,IAAI,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,SAAS;YAC3C,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,QAAQ,KAAK,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC;QAElF,OAAO,IAAI,CAAC;IACd,CAAC;;AAjDsB,oBAAM,GAAG,eAAe,CAAC;AAoDlD;;GAEG;AACH,MAAM,OAAO,oBAAqB,SAAQ,IAAI;IAErC,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAElD;;OAEG;IACa,KAAK,CAAC,GAAG,CAAC,kBAA4B;QACpD,MAAM,EAAE,GAAG,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC;QAC9C,IAAI,EAAE,EAAE;YACN,MAAM,KAAK,GAAG,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,SAAS,CAAC;YACtD,kBAAkB,GAAG,kBAAkB,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC;YACrE,IAAI,kBAAkB,KAAK,KAAK,CAAC,kBAAkB,EAAE;gBACnD,MAAM,IAAI,GAAG;oBACX,GAAG,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,SAAS,CAAC,MAAM,EAAE;oBACnD,kBAAkB;iBACnB,CAAC;gBAEF,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,SAAS,GAAG,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;gBACnE,EAAE,CAAC,eAAe,EAAE,CAAC;aACtB;SACF;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACa,KAAK,CAAC,WAAW,CAAC,GAAG,IAAc;QACjD,MAAM,MAAM,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QACpC,IAAI,OAAO,MAAM,KAAK,QAAQ;YAC5B,MAAM,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAEzB,OAAO,IAAI,CAAC;IACd,CAAC;;AAnCsB,2BAAM,GAAG,kBAAkB,CAAC;AAsCrD;;GAEG;AACH,MAAM,OAAO,iBAAkB,SAAQ,gBAAgB;IAAvD;;QAKU,cAAS,GAAG,KAAK,CAAC;IAwC5B,CAAC;IA3CQ,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAIlD,IAAuB,SAAS,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IAEzC,KAAK,CAAC,KAAK,CAAC,IAAc;QAClC,IAAI,CAAC,SAAS,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC;QAChD,OAAO,IAAI,CAAC;IACd,CAAC;IAES,KAAK,CAAC,OAAO,CAAC,EAAY;QAClC,MAAM,KAAK,GAAmB,EAAE,kBAAkB,EAAE,IAAI,EAAE,CAAC;QAC3D,IAAI,IAAI,CAAC,SAAS,EAAE;YAClB,KAAK,CAAC,QAAQ,GAAG;gBACf,SAAS,EAAE;oBACT,UAAU,EAAE,UAAU,CAAC,WAAW;oBAClC,YAAY,EAAE,IAAI;oBAClB,WAAW,EAAE,KAAK;iBACnB;gBACD,UAAU,EAAE;oBACV,GAAG,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,EAAE;oBAC/B,YAAY,EAAE,GAAG;oBACjB,YAAY,EAAE,IAAI;iBACnB;gBACD,UAAU,EAAE;oBACV,OAAO,EAAE;wBACP,QAAQ,EAAE,IAAI;wBACd,KAAK,EAAE,WAAW,CAAC,IAAI;wBACvB,OAAO,EAAE,UAAU,CAAC,KAAK;wBACzB,KAAK,EAAE,CAAC;qBACT;iBACF;aACF,CAAC;SACH;QAED,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,SAAS,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAC/D,EAAE,CAAC,oBAAoB,EAAE,CAAC;QAC1B,EAAE,CAAC,iCAAiC,EAAE,CAAC;QAEvC,OAAO,IAAI,CAAC;IACd,CAAC;;AA3CsB,wBAAM,GAAG,eAAe,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  ClipStyle, ClipStyleProps, ColorByName, ColorDef, LinePixels, RenderMode, RgbColor,\r\n} from \"@itwin/core-common\";\r\nimport { IModelApp, Tool, Viewport } from \"@itwin/core-frontend\";\r\nimport { parseToggle } from \"./parseToggle\";\r\nimport { parseBoolean } from \"./parseBoolean\";\r\nimport { DisplayStyleTool } from \"./DisplayStyleTools\";\r\n\r\n/** This tool specifies or un-specifies a clip color to use for pixels inside or outside the clip region.\r\n * Arguments can be:\r\n * - clear\r\n * - inside   <color string> | clear\r\n * - outside  <color string> | clear\r\n * <color string> must be in one of the following forms:\r\n * \"rgb(255,0,0)\"\r\n * \"rgba(255,0,0,255)\"\r\n * \"rgb(100%,0%,0%)\"\r\n * \"hsl(120,50%,50%)\"\r\n * \"#rrbbgg\"\r\n * \"blanchedAlmond\" (see possible values from [[ColorByName]]). Case insensitive.\r\n * @see [ColorDef]\r\n * @beta\r\n */\r\nexport class ClipColorTool extends Tool {\r\n  public static override toolId = \"ClipColorTool\";\r\n  public static override get minArgs() { return 1; }\r\n  public static override get maxArgs() { return 2; }\r\n\r\n  private _clearClipColors() {\r\n    const vp = IModelApp.viewManager.selectedView;\r\n    if (undefined !== vp) {\r\n      const props = vp.displayStyle.settings.clipStyle.toJSON() ?? {};\r\n      props.insideColor = props.outsideColor = undefined;\r\n      vp.displayStyle.settings.clipStyle = ClipStyle.fromJSON(props);\r\n    }\r\n  }\r\n\r\n  private setClipColor(colStr: string, which: \"insideColor\" | \"outsideColor\") {\r\n    const vp = IModelApp.viewManager.selectedView;\r\n    if (vp) {\r\n      const props = vp.displayStyle.settings.clipStyle.toJSON() ?? {};\r\n      props[which] = colStr === \"clear\" ? undefined : RgbColor.fromColorDef(ColorDef.fromString(colStr));\r\n      vp.displayStyle.settings.clipStyle = ClipStyle.fromJSON(props);\r\n    }\r\n  }\r\n\r\n  /** This runs the tool using the given arguments, specifying or unspecifying a clip color to use for pixels inside or outside the clip region.\r\n   * Arguments can be:\r\n   * - clear\r\n   * - inside   <color string> | clear\r\n   * - outside  <color string> | clear\r\n   * <color string> must be in one of the following forms:\r\n   * \"rgb(255,0,0)\"\r\n   * \"rgba(255,0,0,255)\"\r\n   * \"rgb(100%,0%,0%)\"\r\n   * \"hsl(120,50%,50%)\"\r\n   * \"#rrbbgg\"\r\n   * \"blanchedAlmond\" (see possible values from [[ColorByName]]). Case insensitive.\r\n   * @beta\r\n   */\r\n  public override async parseAndRun(...args: string[]): Promise<boolean> {\r\n    if (1 === args.length) {\r\n      if (args[0] === \"clear\")\r\n        this._clearClipColors();\r\n\r\n      return true;\r\n    }\r\n\r\n    const which = args[0];\r\n    if (which === \"inside\" || which === \"outside\")\r\n      this.setClipColor(args[1], \"inside\" === which ? \"insideColor\" : \"outsideColor\");\r\n\r\n    return true;\r\n  }\r\n}\r\n\r\n/** Controls a view state's view details' flag for producing cut geometry for a clip style.\r\n * @beta\r\n */\r\nexport class ToggleSectionCutTool extends Tool {\r\n  public static override toolId = \"ToggleSectionCut\";\r\n  public static override get minArgs() { return 0; }\r\n  public static override get maxArgs() { return 1; }\r\n\r\n  /** This method runs the tool, controlling a view state's view details' flag for producing cut geometry for a clip style.\r\n   * @param produceCutGeometry whether to produce cut geometry\r\n   */\r\n  public override async run(produceCutGeometry?: boolean): Promise<boolean> {\r\n    const vp = IModelApp.viewManager.selectedView;\r\n    if (vp) {\r\n      const style = vp.view.displayStyle.settings.clipStyle;\r\n      produceCutGeometry = produceCutGeometry ?? !style.produceCutGeometry;\r\n      if (produceCutGeometry !== style.produceCutGeometry) {\r\n        const json = {\r\n          ...vp.view.displayStyle.settings.clipStyle.toJSON(),\r\n          produceCutGeometry,\r\n        };\r\n\r\n        vp.view.displayStyle.settings.clipStyle = ClipStyle.fromJSON(json);\r\n        vp.invalidateScene();\r\n      }\r\n    }\r\n\r\n    return true;\r\n  }\r\n\r\n  /** Executes this tool's run method with args[0] containing `produceCutGeometry`.\r\n   * @see [[run]]\r\n   */\r\n  public override async parseAndRun(...args: string[]): Promise<boolean> {\r\n    const enable = parseToggle(args[0]);\r\n    if (typeof enable !== \"string\")\r\n      await this.run(enable);\r\n\r\n    return true;\r\n  }\r\n}\r\n\r\n/** Simple tool that toggles a hard-coded clip style overriding various aspects of the cut geometry appearance.\r\n * @beta\r\n */\r\nexport class TestClipStyleTool extends DisplayStyleTool {\r\n  public static override toolId = \"TestClipStyle\";\r\n  public static override get maxArgs() { return 1; }\r\n  public static override get minArgs() { return 1; }\r\n\r\n  private _useStyle = false;\r\n\r\n  protected override get require3d() { return true; }\r\n\r\n  protected async parse(args: string[]): Promise<boolean> {\r\n    this._useStyle = parseBoolean(args[0]) ?? false;\r\n    return true;\r\n  }\r\n\r\n  protected async execute(vp: Viewport) {\r\n    const props: ClipStyleProps = { produceCutGeometry: true };\r\n    if (this._useStyle) {\r\n      props.cutStyle = {\r\n        viewflags: {\r\n          renderMode: RenderMode.SmoothShade,\r\n          visibleEdges: true,\r\n          hiddenEdges: false,\r\n        },\r\n        appearance: {\r\n          rgb: { r: 0xff, g: 0x7f, b: 0 },\r\n          transparency: 0.5,\r\n          nonLocatable: true,\r\n        },\r\n        hiddenLine: {\r\n          visible: {\r\n            ovrColor: true,\r\n            color: ColorByName.blue,\r\n            pattern: LinePixels.Solid,\r\n            width: 3,\r\n          },\r\n        },\r\n      };\r\n    }\r\n\r\n    vp.displayStyle.settings.clipStyle = ClipStyle.fromJSON(props);\r\n    vp.invalidateRenderPlan();\r\n    vp.setFeatureOverrideProviderChanged();\r\n\r\n    return true;\r\n  }\r\n}\r\n"]}

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

@@ -1,146 +1,146 @@
-/** @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): Promise<boolean>;
-    protected abstract parse(args: string[], vp: Viewport): Promise<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[]): Promise<boolean>;
-    execute(vp: Viewport): Promise<boolean>;
-}
-/** Defines a [SkySphere]($common) to apply to the current view.
- * @beta
- */
-export declare class SkySphereTool extends DisplayStyleTool {
-    private _image?;
-    static toolId: string;
-    static get minArgs(): number;
-    static get maxArgs(): number;
-    get require3d(): boolean;
-    parse(args: string[]): Promise<boolean>;
-    execute(vp: Viewport): Promise<boolean>;
-}
-/** Defines a [SkyCube]($common) to apply to the current view.
- * @beta
- */
-export declare class SkyCubeTool extends DisplayStyleTool {
-    private _images;
-    static toolId: string;
-    static get minArgs(): number;
-    static get maxArgs(): number;
-    get require3d(): boolean;
-    parse(args: string[]): Promise<boolean>;
-    execute(vp: Viewport): Promise<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 clipboard.
- *  * `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[]): Promise<boolean>;
-    execute(vp: Viewport): Promise<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[]): Promise<boolean>;
-    execute(vp: Viewport): Promise<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[]): Promise<boolean>;
-    execute(vp: Viewport): Promise<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[]): Promise<boolean>;
-    execute(vp: Viewport): Promise<boolean>;
-}
-/** Toggle whether surfaces display with overlaid wiremesh in the active viewport.
- * @see [ViewFlags.wiremesh]($common).
- * @beta
- */
-export declare class ToggleWiremeshTool extends DisplayStyleTool {
-    private _enable?;
-    static toolId: string;
-    static get minArgs(): number;
-    static get maxArgs(): number;
-    parse(args: string[]): Promise<boolean>;
-    execute(vp: Viewport): Promise<boolean>;
-}
-/** Change the background color of the active viewport and optionally its transparency.
- * @beta
- */
-export declare class ChangeBackgroundColorTool extends DisplayStyleTool {
-    private _color?;
-    static toolId: string;
-    static get minArgs(): number;
-    static get maxArgs(): number;
-    parse(args: string[]): Promise<boolean>;
-    execute(vp: Viewport): Promise<boolean>;
-}
+/** @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): Promise<boolean>;
+    protected abstract parse(args: string[], vp: Viewport): Promise<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[]): Promise<boolean>;
+    execute(vp: Viewport): Promise<boolean>;
+}
+/** Defines a [SkySphere]($common) to apply to the current view.
+ * @beta
+ */
+export declare class SkySphereTool extends DisplayStyleTool {
+    private _image?;
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    get require3d(): boolean;
+    parse(args: string[]): Promise<boolean>;
+    execute(vp: Viewport): Promise<boolean>;
+}
+/** Defines a [SkyCube]($common) to apply to the current view.
+ * @beta
+ */
+export declare class SkyCubeTool extends DisplayStyleTool {
+    private _images;
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    get require3d(): boolean;
+    parse(args: string[]): Promise<boolean>;
+    execute(vp: Viewport): Promise<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 clipboard.
+ *  * `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[]): Promise<boolean>;
+    execute(vp: Viewport): Promise<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[]): Promise<boolean>;
+    execute(vp: Viewport): Promise<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[]): Promise<boolean>;
+    execute(vp: Viewport): Promise<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[]): Promise<boolean>;
+    execute(vp: Viewport): Promise<boolean>;
+}
+/** Toggle whether surfaces display with overlaid wiremesh in the active viewport.
+ * @see [ViewFlags.wiremesh]($common).
+ * @beta
+ */
+export declare class ToggleWiremeshTool extends DisplayStyleTool {
+    private _enable?;
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    parse(args: string[]): Promise<boolean>;
+    execute(vp: Viewport): Promise<boolean>;
+}
+/** Change the background color of the active viewport and optionally its transparency.
+ * @beta
+ */
+export declare class ChangeBackgroundColorTool extends DisplayStyleTool {
+    private _color?;
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    parse(args: string[]): Promise<boolean>;
+    execute(vp: Viewport): Promise<boolean>;
+}
 //# sourceMappingURL=DisplayStyleTools.d.ts.map