@itwin/frontend-devtools 4.0.0-dev.7 → 4.0.0-dev.70

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

@@ -1 +1 @@
-{"version":3,"file":"AnimationIntervalTool.js","sourceRoot":"","sources":["../../../src/tools/AnimationIntervalTool.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAEvD;;GAEG;AACH,MAAM,OAAO,qBAAsB,SAAQ,IAAI;IAEtC,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAElC,KAAK,CAAC,GAAG,CAAC,QAAqB;QAC7C,SAAS,CAAC,iBAAiB,GAAG,QAAQ,CAAC;QACvC,OAAO,IAAI,CAAC;IACd,CAAC;IAEe,KAAK,CAAC,WAAW,CAAC,GAAG,IAAc;QACjD,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QAC5C,MAAM,QAAQ,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACzF,OAAO,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC5B,CAAC;;AAbsB,4BAAM,GAAG,mBAAmB,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 { BeDuration } from \"@itwin/core-bentley\";\r\nimport { IModelApp, Tool } from \"@itwin/core-frontend\";\r\n\r\n/** Changes the [IModelApp.animationInterval]($frontend). Specify the interval in integer milliseconds; or pass any string not parseable as an integer to disable the animation interval callback.\r\n * @beta\r\n */\r\nexport class AnimationIntervalTool extends Tool {\r\n  public static override toolId = \"AnimationInterval\";\r\n  public static override get minArgs() { return 1; }\r\n  public static override get maxArgs() { return 1; }\r\n\r\n  public override async run(interval?: BeDuration): Promise<boolean> {\r\n    IModelApp.animationInterval = interval;\r\n    return true;\r\n  }\r\n\r\n  public override async parseAndRun(...args: string[]): Promise<boolean> {\r\n    const millis = Number.parseInt(args[0], 10);\r\n    const interval = !Number.isNaN(millis) ? BeDuration.fromMilliseconds(millis) : undefined;\r\n    return this.run(interval);\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"AnimationIntervalTool.js","sourceRoot":"","sources":["../../../src/tools/AnimationIntervalTool.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAEvD;;GAEG;AACH,MAAa,qBAAsB,SAAQ,IAAI;IAEtC,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAElC,KAAK,CAAC,GAAG,CAAC,QAAqB;QAC7C,SAAS,CAAC,iBAAiB,GAAG,QAAQ,CAAC;QACvC,OAAO,IAAI,CAAC;IACd,CAAC;IAEe,KAAK,CAAC,WAAW,CAAC,GAAG,IAAc;QACjD,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QAC5C,MAAM,QAAQ,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACzF,OAAO,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC5B,CAAC;;AAbsB,4BAAM,GAAG,mBAAmB,CAAC;SADzC,qBAAqB","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 { BeDuration } from \"@itwin/core-bentley\";\r\nimport { IModelApp, Tool } from \"@itwin/core-frontend\";\r\n\r\n/** Changes the [IModelApp.animationInterval]($frontend). Specify the interval in integer milliseconds; or pass any string not parseable as an integer to disable the animation interval callback.\r\n * @beta\r\n */\r\nexport class AnimationIntervalTool extends Tool {\r\n  public static override toolId = \"AnimationInterval\";\r\n  public static override get minArgs() { return 1; }\r\n  public static override get maxArgs() { return 1; }\r\n\r\n  public override async run(interval?: BeDuration): Promise<boolean> {\r\n    IModelApp.animationInterval = interval;\r\n    return true;\r\n  }\r\n\r\n  public override async parseAndRun(...args: string[]): Promise<boolean> {\r\n    const millis = Number.parseInt(args[0], 10);\r\n    const interval = !Number.isNaN(millis) ? BeDuration.fromMilliseconds(millis) : undefined;\r\n    return this.run(interval);\r\n  }\r\n}\r\n"]}

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

@@ -1,16 +1,16 @@
-/** @packageDocumentation
- * @module Tools
- */
-import { Tool } from "@itwin/core-frontend";
-/** Controls whether quantities are formatted using imperial or metric units.
- * Such formatting is used in many places; one example is the output of the MeasureTool.
- * @beta
- */
-export declare class ChangeUnitsTool extends Tool {
-    static toolId: string;
-    static get minArgs(): number;
-    static get maxArgs(): number;
-    run(useMetric?: boolean): Promise<boolean>;
-    parseAndRun(...args: string[]): Promise<boolean>;
-}
+/** @packageDocumentation
+ * @module Tools
+ */
+import { Tool } from "@itwin/core-frontend";
+/** Controls whether quantities are formatted using imperial or metric units.
+ * Such formatting is used in many places; one example is the output of the MeasureTool.
+ * @beta
+ */
+export declare class ChangeUnitsTool extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    run(useMetric?: boolean): Promise<boolean>;
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
 //# sourceMappingURL=ChangeUnitsTool.d.ts.map

package/lib/esm/tools/ChangeUnitsTool.js

@@ -1,38 +1,39 @@
-/*---------------------------------------------------------------------------------------------
-* 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 { IModelApp, Tool } from "@itwin/core-frontend";
-import { parseToggle } from "./parseToggle";
-// CSpell: ignore fmtr
-/** Controls whether quantities are formatted using imperial or metric units.
- * Such formatting is used in many places; one example is the output of the MeasureTool.
- * @beta
- */
-export class ChangeUnitsTool extends Tool {
-    static get minArgs() { return 0; }
-    static get maxArgs() { return 1; }
-    // support boolean for backwards compatibility
-    async run(useMetric) {
-        const fmtr = IModelApp.quantityFormatter;
-        // if no arg then toggle to metric from any non-metric unit system
-        const useImperial = undefined !== useMetric ? !useMetric : fmtr.activeUnitSystem === "metric";
-        const unitSystem = useImperial ? "imperial" : "metric";
-        if (unitSystem !== fmtr.activeUnitSystem) {
-            await fmtr.setActiveUnitSystem(unitSystem);
-            await IModelApp.toolAdmin.startDefaultTool();
-        }
-        return true;
-    }
-    async parseAndRun(...args) {
-        const enable = parseToggle(args[0]);
-        if (typeof enable !== "string")
-            await this.run(enable);
-        return true;
-    }
-}
-ChangeUnitsTool.toolId = "ChangeUnits";
+/*---------------------------------------------------------------------------------------------
+* 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 { IModelApp, Tool } from "@itwin/core-frontend";
+import { parseToggle } from "./parseToggle";
+// CSpell: ignore fmtr
+/** Controls whether quantities are formatted using imperial or metric units.
+ * Such formatting is used in many places; one example is the output of the MeasureTool.
+ * @beta
+ */
+class ChangeUnitsTool extends Tool {
+    static get minArgs() { return 0; }
+    static get maxArgs() { return 1; }
+    // support boolean for backwards compatibility
+    async run(useMetric) {
+        const fmtr = IModelApp.quantityFormatter;
+        // if no arg then toggle to metric from any non-metric unit system
+        const useImperial = undefined !== useMetric ? !useMetric : fmtr.activeUnitSystem === "metric";
+        const unitSystem = useImperial ? "imperial" : "metric";
+        if (unitSystem !== fmtr.activeUnitSystem) {
+            await fmtr.setActiveUnitSystem(unitSystem);
+            await IModelApp.toolAdmin.startDefaultTool();
+        }
+        return true;
+    }
+    async parseAndRun(...args) {
+        const enable = parseToggle(args[0]);
+        if (typeof enable !== "string")
+            await this.run(enable);
+        return true;
+    }
+}
+ChangeUnitsTool.toolId = "ChangeUnits";
+export { ChangeUnitsTool };
 //# sourceMappingURL=ChangeUnitsTool.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"ChangeUnitsTool.js","sourceRoot":"","sources":["../../../src/tools/ChangeUnitsTool.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,sBAAsB;AAEtB;;;GAGG;AACH,MAAM,OAAO,eAAgB,SAAQ,IAAI;IAEhC,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAElD,8CAA8C;IAC9B,KAAK,CAAC,GAAG,CAAC,SAAmB;QAC3C,MAAM,IAAI,GAAG,SAAS,CAAC,iBAAiB,CAAC;QAEzC,kEAAkE;QAClE,MAAM,WAAW,GAAG,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,KAAK,QAAQ,CAAC;QAC9F,MAAM,UAAU,GAAG,WAAW,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC;QAEvD,IAAI,UAAU,KAAK,IAAI,CAAC,gBAAgB,EAAE;YACxC,MAAM,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;YAC3C,MAAM,SAAS,CAAC,SAAS,CAAC,gBAAgB,EAAE,CAAC;SAC9C;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAEe,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;;AA1BsB,sBAAM,GAAG,aAAa,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 { IModelApp, Tool } from \"@itwin/core-frontend\";\r\nimport { parseToggle } from \"./parseToggle\";\r\n\r\n// CSpell: ignore fmtr\r\n\r\n/** Controls whether quantities are formatted using imperial or metric units.\r\n * Such formatting is used in many places; one example is the output of the MeasureTool.\r\n * @beta\r\n */\r\nexport class ChangeUnitsTool extends Tool {\r\n  public static override toolId = \"ChangeUnits\";\r\n  public static override get minArgs() { return 0; }\r\n  public static override get maxArgs() { return 1; }\r\n\r\n  // support boolean for backwards compatibility\r\n  public override async run(useMetric?: boolean): Promise<boolean> {\r\n    const fmtr = IModelApp.quantityFormatter;\r\n\r\n    // if no arg then toggle to metric from any non-metric unit system\r\n    const useImperial = undefined !== useMetric ? !useMetric : fmtr.activeUnitSystem === \"metric\";\r\n    const unitSystem = useImperial ? \"imperial\" : \"metric\";\r\n\r\n    if (unitSystem !== fmtr.activeUnitSystem) {\r\n      await fmtr.setActiveUnitSystem(unitSystem);\r\n      await IModelApp.toolAdmin.startDefaultTool();\r\n    }\r\n\r\n    return true;\r\n  }\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"]}
+{"version":3,"file":"ChangeUnitsTool.js","sourceRoot":"","sources":["../../../src/tools/ChangeUnitsTool.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,sBAAsB;AAEtB;;;GAGG;AACH,MAAa,eAAgB,SAAQ,IAAI;IAEhC,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAElD,8CAA8C;IAC9B,KAAK,CAAC,GAAG,CAAC,SAAmB;QAC3C,MAAM,IAAI,GAAG,SAAS,CAAC,iBAAiB,CAAC;QAEzC,kEAAkE;QAClE,MAAM,WAAW,GAAG,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,KAAK,QAAQ,CAAC;QAC9F,MAAM,UAAU,GAAG,WAAW,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC;QAEvD,IAAI,UAAU,KAAK,IAAI,CAAC,gBAAgB,EAAE;YACxC,MAAM,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;YAC3C,MAAM,SAAS,CAAC,SAAS,CAAC,gBAAgB,EAAE,CAAC;SAC9C;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAEe,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;;AA1BsB,sBAAM,GAAG,aAAa,CAAC;SADnC,eAAe","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 { IModelApp, Tool } from \"@itwin/core-frontend\";\r\nimport { parseToggle } from \"./parseToggle\";\r\n\r\n// CSpell: ignore fmtr\r\n\r\n/** Controls whether quantities are formatted using imperial or metric units.\r\n * Such formatting is used in many places; one example is the output of the MeasureTool.\r\n * @beta\r\n */\r\nexport class ChangeUnitsTool extends Tool {\r\n  public static override toolId = \"ChangeUnits\";\r\n  public static override get minArgs() { return 0; }\r\n  public static override get maxArgs() { return 1; }\r\n\r\n  // support boolean for backwards compatibility\r\n  public override async run(useMetric?: boolean): Promise<boolean> {\r\n    const fmtr = IModelApp.quantityFormatter;\r\n\r\n    // if no arg then toggle to metric from any non-metric unit system\r\n    const useImperial = undefined !== useMetric ? !useMetric : fmtr.activeUnitSystem === \"metric\";\r\n    const unitSystem = useImperial ? \"imperial\" : \"metric\";\r\n\r\n    if (unitSystem !== fmtr.activeUnitSystem) {\r\n      await fmtr.setActiveUnitSystem(unitSystem);\r\n      await IModelApp.toolAdmin.startDefaultTool();\r\n    }\r\n\r\n    return true;\r\n  }\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"]}

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

@@ -1,68 +1,68 @@
-import { Tool, Viewport } from "@itwin/core-frontend";
-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 declare class ClipColorTool extends Tool {
-    static toolId: string;
-    static get minArgs(): number;
-    static get maxArgs(): number;
-    private _clearClipColors;
-    private setClipColor;
-    /** 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
-     */
-    parseAndRun(...args: string[]): Promise<boolean>;
-}
-/** Controls a view state's view details' flag for producing cut geometry for a clip style.
- * @beta
- */
-export declare class ToggleSectionCutTool extends Tool {
-    static toolId: string;
-    static get minArgs(): number;
-    static get maxArgs(): number;
-    /** 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
-     */
-    run(produceCutGeometry?: boolean): Promise<boolean>;
-    /** Executes this tool's run method with args[0] containing `produceCutGeometry`.
-     * @see [[run]]
-     */
-    parseAndRun(...args: string[]): Promise<boolean>;
-}
-/** Simple tool that toggles a hard-coded clip style overriding various aspects of the cut geometry appearance.
- * @beta
- */
-export declare class TestClipStyleTool extends DisplayStyleTool {
-    static toolId: string;
-    static get maxArgs(): number;
-    static get minArgs(): number;
-    private _useStyle;
-    protected get require3d(): boolean;
-    protected parse(args: string[]): Promise<boolean>;
-    protected execute(vp: Viewport): Promise<boolean>;
-}
+import { Tool, Viewport } from "@itwin/core-frontend";
+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 declare class ClipColorTool extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    private _clearClipColors;
+    private setClipColor;
+    /** 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
+     */
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
+/** Controls a view state's view details' flag for producing cut geometry for a clip style.
+ * @beta
+ */
+export declare class ToggleSectionCutTool extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    /** 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
+     */
+    run(produceCutGeometry?: boolean): Promise<boolean>;
+    /** Executes this tool's run method with args[0] containing `produceCutGeometry`.
+     * @see [[run]]
+     */
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
+/** Simple tool that toggles a hard-coded clip style overriding various aspects of the cut geometry appearance.
+ * @beta
+ */
+export declare class TestClipStyleTool extends DisplayStyleTool {
+    static toolId: string;
+    static get maxArgs(): number;
+    static get minArgs(): number;
+    private _useStyle;
+    protected get require3d(): boolean;
+    protected parse(args: string[]): Promise<boolean>;
+    protected execute(vp: Viewport): Promise<boolean>;
+}
 //# sourceMappingURL=ClipTools.d.ts.map

package/lib/esm/tools/ClipTools.js

@@ -1,159 +1,159 @@
-/*---------------------------------------------------------------------------------------------
-* 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() {
-        var _a;
-        const vp = IModelApp.viewManager.selectedView;
-        if (undefined !== vp) {
-            const props = (_a = vp.displayStyle.settings.clipStyle.toJSON()) !== null && _a !== void 0 ? _a : {};
-            props.insideColor = props.outsideColor = undefined;
-            vp.displayStyle.settings.clipStyle = ClipStyle.fromJSON(props);
-        }
-    }
-    setClipColor(colStr, which) {
-        var _a;
-        const vp = IModelApp.viewManager.selectedView;
-        if (vp) {
-            const props = (_a = vp.displayStyle.settings.clipStyle.toJSON()) !== null && _a !== void 0 ? _a : {};
-            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 !== null && produceCutGeometry !== void 0 ? 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) {
-        var _a;
-        this._useStyle = (_a = parseBoolean(args[0])) !== null && _a !== void 0 ? _a : 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
+ */
+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";
+export { ClipColorTool };
+/** Controls a view state's view details' flag for producing cut geometry for a clip style.
+ * @beta
+ */
+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";
+export { ToggleSectionCutTool };
+/** Simple tool that toggles a hard-coded clip style overriding various aspects of the cut geometry appearance.
+ * @beta
+ */
+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";
+export { TestClipStyleTool };
 //# sourceMappingURL=ClipTools.js.map