@itwin/frontend-devtools 3.0.0-extension.1 → 3.1.0-dev.0

package/lib/cjs/tools/ClipTools.js

@@ -125,12 +125,12 @@ class TestClipStyleTool extends DisplayStyleTools_1.DisplayStyleTool {
     static get maxArgs() { return 1; }
     static get minArgs() { return 1; }
     get require3d() { return true; }
-    parse(args) {
+    async parse(args) {
         var _a;
         this._useStyle = (_a = (0, parseBoolean_1.parseBoolean)(args[0])) !== null && _a !== void 0 ? _a : false;
         return true;
     }
-    execute(vp) {
+    async execute(vp) {
         const props = { produceCutGeometry: true };
         if (this._useStyle) {
             props.cutStyle = {

package/lib/cjs/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,oDAE4B;AAC5B,wDAAiE;AACjE,+CAA4C;AAC5C,iDAA8C;AAC9C,2DAAuD;AAEvD;;;;;;;;;;;;;;GAcG;AACH,MAAa,aAAc,SAAQ,oBAAI;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,yBAAS,CAAC,WAAW,CAAC,YAAY,CAAC;QAC9C,IAAI,SAAS,KAAK,EAAE,EAAE;YACpB,MAAM,KAAK,GAAG,MAAA,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,SAAS,CAAC,MAAM,EAAE,mCAAI,EAAE,CAAC;YAChE,KAAK,CAAC,WAAW,GAAG,KAAK,CAAC,YAAY,GAAG,SAAS,CAAC;YACnD,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,SAAS,GAAG,uBAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;SAChE;IACH,CAAC;IAEO,YAAY,CAAC,MAAc,EAAE,KAAqC;;QACxE,MAAM,EAAE,GAAG,yBAAS,CAAC,WAAW,CAAC,YAAY,CAAC;QAC9C,IAAI,EAAE,EAAE;YACN,MAAM,KAAK,GAAG,MAAA,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,SAAS,CAAC,MAAM,EAAE,mCAAI,EAAE,CAAC;YAChE,KAAK,CAAC,KAAK,CAAC,GAAG,MAAM,KAAK,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,sBAAQ,CAAC,YAAY,CAAC,sBAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;YACnG,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,SAAS,GAAG,uBAAS,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;;AAlDH,sCAmDC;AAlDwB,oBAAM,GAAG,eAAe,CAAC;AAoDlD;;GAEG;AACH,MAAa,oBAAqB,SAAQ,oBAAI;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,yBAAS,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,aAAlB,kBAAkB,cAAlB,kBAAkB,GAAI,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,uBAAS,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,IAAA,yBAAW,EAAC,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;;AApCH,oDAqCC;AApCwB,2BAAM,GAAG,kBAAkB,CAAC;AAsCrD;;GAEG;AACH,MAAa,iBAAkB,SAAQ,oCAAgB;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,IAAc;;QAC5B,IAAI,CAAC,SAAS,GAAG,MAAA,IAAA,2BAAY,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,mCAAI,KAAK,CAAC;QAChD,OAAO,IAAI,CAAC;IACd,CAAC;IAES,OAAO,CAAC,EAAY;QAC5B,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,wBAAU,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,yBAAW,CAAC,IAAI;wBACvB,OAAO,EAAE,wBAAU,CAAC,KAAK;wBACzB,KAAK,EAAE,CAAC;qBACT;iBACF;aACF,CAAC;SACH;QAED,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,SAAS,GAAG,uBAAS,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;;AA5CH,8CA6CC;AA5CwB,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 parse(args: string[]): boolean {\r\n    this._useStyle = parseBoolean(args[0]) ?? false;\r\n    return true;\r\n  }\r\n\r\n  protected execute(vp: Viewport): boolean {\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"]}
+{"version":3,"file":"ClipTools.js","sourceRoot":"","sources":["../../../src/tools/ClipTools.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F;;GAEG;AAEH,oDAE4B;AAC5B,wDAAiE;AACjE,+CAA4C;AAC5C,iDAA8C;AAC9C,2DAAuD;AAEvD;;;;;;;;;;;;;;GAcG;AACH,MAAa,aAAc,SAAQ,oBAAI;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,yBAAS,CAAC,WAAW,CAAC,YAAY,CAAC;QAC9C,IAAI,SAAS,KAAK,EAAE,EAAE;YACpB,MAAM,KAAK,GAAG,MAAA,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,SAAS,CAAC,MAAM,EAAE,mCAAI,EAAE,CAAC;YAChE,KAAK,CAAC,WAAW,GAAG,KAAK,CAAC,YAAY,GAAG,SAAS,CAAC;YACnD,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,SAAS,GAAG,uBAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;SAChE;IACH,CAAC;IAEO,YAAY,CAAC,MAAc,EAAE,KAAqC;;QACxE,MAAM,EAAE,GAAG,yBAAS,CAAC,WAAW,CAAC,YAAY,CAAC;QAC9C,IAAI,EAAE,EAAE;YACN,MAAM,KAAK,GAAG,MAAA,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,SAAS,CAAC,MAAM,EAAE,mCAAI,EAAE,CAAC;YAChE,KAAK,CAAC,KAAK,CAAC,GAAG,MAAM,KAAK,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,sBAAQ,CAAC,YAAY,CAAC,sBAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;YACnG,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,SAAS,GAAG,uBAAS,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;;AAlDH,sCAmDC;AAlDwB,oBAAM,GAAG,eAAe,CAAC;AAoDlD;;GAEG;AACH,MAAa,oBAAqB,SAAQ,oBAAI;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,yBAAS,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,aAAlB,kBAAkB,cAAlB,kBAAkB,GAAI,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,uBAAS,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,IAAA,yBAAW,EAAC,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;;AApCH,oDAqCC;AApCwB,2BAAM,GAAG,kBAAkB,CAAC;AAsCrD;;GAEG;AACH,MAAa,iBAAkB,SAAQ,oCAAgB;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,MAAA,IAAA,2BAAY,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,mCAAI,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,wBAAU,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,yBAAW,CAAC,IAAI;wBACvB,OAAO,EAAE,wBAAU,CAAC,KAAK;wBACzB,KAAK,EAAE,CAAC;qBACT;iBACF;aACF,CAAC;SACH;QAED,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,SAAS,GAAG,uBAAS,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;;AA5CH,8CA6CC;AA5CwB,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/cjs/tools/DisplayStyleTools.d.ts

@@ -1,6 +1,3 @@
-/** @packageDocumentation
- * @module Tools
- */
 import { ViewFlags } from "@itwin/core-common";
 import { Tool, Viewport } from "@itwin/core-frontend";
 /** Modifies the selected viewport's DisplayStyleState.
@@ -8,8 +5,8 @@ import { Tool, Viewport } from "@itwin/core-frontend";
  */
 export declare abstract class DisplayStyleTool extends Tool {
     protected get require3d(): boolean;
-    protected abstract execute(vp: Viewport): boolean;
-    protected abstract parse(args: string[]): 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>;
 }
@@ -34,8 +31,32 @@ export declare class ChangeViewFlagsTool extends Tool {
 export declare class ToggleSkyboxTool extends DisplayStyleTool {
     static toolId: string;
     get require3d(): boolean;
-    parse(_args: string[]): boolean;
-    execute(vp: Viewport): 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.
@@ -47,7 +68,7 @@ export declare class ToggleSkyboxTool extends DisplayStyleTool {
  *  * `project`: include iTwin-specific (formerly known as project) settings.
  *  * `map`: include background map settings.
  *  * `drawingaids`: include drawing aid decoration settings.
- *  * `copy`: copy result to system clipboarad.
+ *  * `copy`: copy result to system clipboard.
  *  * `quote`: format the JSON so it can be parsed directly by [ApplyRenderingStyleTool].
  * @beta
  */
@@ -58,8 +79,8 @@ export declare class SaveRenderingStyleTool extends DisplayStyleTool {
     static toolId: string;
     static get minArgs(): number;
     static get maxArgs(): number;
-    parse(inputArgs: string[]): boolean;
-    execute(vp: Viewport): boolean;
+    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.
@@ -70,8 +91,8 @@ export declare class ApplyRenderingStyleTool extends DisplayStyleTool {
     static toolId: string;
     static get minArgs(): number;
     static get maxArgs(): number;
-    parse(args: string[]): boolean;
-    execute(vp: Viewport): boolean;
+    parse(args: string[]): Promise<boolean>;
+    execute(vp: Viewport): Promise<boolean>;
 }
 /** Apply appearance overrides to one or more subcategories in the active viewport.
  * @beta
@@ -82,8 +103,23 @@ export declare class OverrideSubCategoryTool extends DisplayStyleTool {
     static toolId: string;
     static get minArgs(): number;
     static get maxArgs(): number;
-    parse(inArgs: string[]): boolean;
-    execute(vp: Viewport): boolean;
+    parse(inArgs: string[]): Promise<boolean>;
+    execute(vp: Viewport): Promise<boolean>;
+}
+/** Query the schedule script JSON from an element.
+ * @beta
+ */
+export declare class QueryScheduleScriptTool extends DisplayStyleTool {
+    private _sourceId?;
+    private _action;
+    private _includeElementIds;
+    private _countElementIds;
+    private _expandElementIds;
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    parse(input: string[], vp: Viewport): Promise<boolean>;
+    execute(vp: Viewport): Promise<boolean>;
 }
 /** Set whether background color is ignored when applying white-on-white reversal.
  * @beta
@@ -93,7 +129,30 @@ export declare class WoWIgnoreBackgroundTool extends DisplayStyleTool {
     static toolId: string;
     static get minArgs(): number;
     static get maxArgs(): number;
-    parse(args: string[]): boolean;
-    execute(vp: Viewport): boolean;
+    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

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

@@ -1 +1 @@
-{"version":3,"file":"DisplayStyleTools.d.ts","sourceRoot":"","sources":["../../../src/tools/DisplayStyleTools.ts"],"names":[],"mappings":"AAKA;;GAEG;AAEH,OAAO,EAC8G,SAAS,EAE7H,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACqF,IAAI,EAAE,QAAQ,EACzG,MAAM,sBAAsB,CAAC;AAiB9B;;GAEG;AACH,8BAAsB,gBAAiB,SAAQ,IAAI;IACjD,SAAS,KAAK,SAAS,YAAoB;IAE3C,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,EAAE,QAAQ,GAAG,OAAO;IAEjD,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO;IAE3B,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC;IAQvB,WAAW,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAOvE;AAED;;;;;;;GAOG;AACH,qBAAa,mBAAoB,SAAQ,IAAI;IAC3C,OAAuB,MAAM,SAAqB;IAClD,WAA2B,OAAO,cAAwB;IAC1D,WAA2B,OAAO,WAAgB;IAE5B,GAAG,CAAC,EAAE,EAAE,SAAS,EAAE,EAAE,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IAOnD,WAAW,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CA2CvE;AAED;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,gBAAgB;IACpD,OAAuB,MAAM,SAAkB;IAE/C,IAAoB,SAAS,YAAmB;IAEzC,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE;IAErB,OAAO,CAAC,EAAE,EAAE,QAAQ,GAAG,OAAO;CAKtC;AAED;;;;;;;;;;;;;GAaG;AACH,qBAAa,sBAAuB,SAAQ,gBAAgB;IAC1D,OAAO,CAAC,QAAQ,CAAoC;IACpD,OAAO,CAAC,gBAAgB,CAAS;IACjC,OAAO,CAAC,MAAM,CAAS;IAEvB,OAAuB,MAAM,SAAwB;IAErD,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAE3C,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE;IAiBzB,OAAO,CAAC,EAAE,EAAE,QAAQ,GAAG,OAAO;CAWtC;AAED;;;GAGG;AACH,qBAAa,uBAAwB,SAAQ,gBAAgB;IAC3D,OAAO,CAAC,UAAU,CAAC,CAA8B;IAEjD,OAAuB,MAAM,SAAyB;IAEtD,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAE3C,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE;IAUpB,OAAO,CAAC,EAAE,EAAE,QAAQ,GAAG,OAAO;CAMtC;AAED;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,gBAAgB;IAC3D,OAAO,CAAC,cAAc,CAAmC;IACzD,OAAO,CAAC,eAAe,CAAgB;IAEvC,OAAuB,MAAM,SAAyB;IACtD,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAE3C,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO;IAkBhC,OAAO,CAAC,EAAE,EAAE,QAAQ,GAAG,OAAO;CAOtC;AAED;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,gBAAgB;IAC3D,OAAO,CAAC,OAAO,CAAC,CAAU;IAE1B,OAAuB,MAAM,SAAyB;IACtD,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAE3C,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO;IAS9B,OAAO,CAAC,EAAE,EAAE,QAAQ,GAAG,OAAO;CAKtC"}
+{"version":3,"file":"DisplayStyleTools.d.ts","sourceRoot":"","sources":["../../../src/tools/DisplayStyleTools.ts"],"names":[],"mappings":"AAUA,OAAO,EAEuC,SAAS,EACtD,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACwE,IAAI,EAAE,QAAQ,EAC5F,MAAM,sBAAsB,CAAC;AAmB9B;;GAEG;AACH,8BAAsB,gBAAiB,SAAQ,IAAI;IACjD,SAAS,KAAK,SAAS,YAAoB;IAE3C,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IAE1D,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IAElD,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC;IAQvB,WAAW,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAOvE;AAED;;;;;;;GAOG;AACH,qBAAa,mBAAoB,SAAQ,IAAI;IAC3C,OAAuB,MAAM,SAAqB;IAClD,WAA2B,OAAO,cAAwB;IAC1D,WAA2B,OAAO,WAAgB;IAE5B,GAAG,CAAC,EAAE,EAAE,SAAS,EAAE,EAAE,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IAOnD,WAAW,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CA2CvE;AAED;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,gBAAgB;IACpD,OAAuB,MAAM,SAAkB;IAE/C,IAAoB,SAAS,YAAmB;IAEnC,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IAExC,OAAO,CAAC,EAAE,EAAE,QAAQ;CAKlC;AAED;;GAEG;AACH,qBAAa,aAAc,SAAQ,gBAAgB;IACjD,OAAO,CAAC,MAAM,CAAC,CAAS;IAExB,OAAuB,MAAM,SAAkB;IAC/C,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAElD,IAAoB,SAAS,YAAmB;IAEnC,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE;IAKpB,OAAO,CAAC,EAAE,EAAE,QAAQ;CAUlC;AAED;;GAEG;AACH,qBAAa,WAAY,SAAQ,gBAAgB;IAC/C,OAAO,CAAC,OAAO,CAAgB;IAE/B,OAAuB,MAAM,SAAgB;IAC7C,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAElD,IAAoB,SAAS,YAAmB;IAEnC,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE;IAKpB,OAAO,CAAC,EAAE,EAAE,QAAQ;CAiDlC;AAED;;;;;;;;;;;;;GAaG;AACH,qBAAa,sBAAuB,SAAQ,gBAAgB;IAC1D,OAAO,CAAC,QAAQ,CAAoC;IACpD,OAAO,CAAC,gBAAgB,CAAS;IACjC,OAAO,CAAC,MAAM,CAAS;IAEvB,OAAuB,MAAM,SAAwB;IAErD,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAErC,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE;IAiBzB,OAAO,CAAC,EAAE,EAAE,QAAQ;CAWlC;AAED;;;GAGG;AACH,qBAAa,uBAAwB,SAAQ,gBAAgB;IAC3D,OAAO,CAAC,UAAU,CAAC,CAA8B;IAEjD,OAAuB,MAAM,SAAyB;IAEtD,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAErC,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE;IAUpB,OAAO,CAAC,EAAE,EAAE,QAAQ;CAMlC;AAED;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,gBAAgB;IAC3D,OAAO,CAAC,cAAc,CAAmC;IACzD,OAAO,CAAC,eAAe,CAAgB;IAEvC,OAAuB,MAAM,SAAyB;IACtD,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAErC,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE;IAkBtB,OAAO,CAAC,EAAE,EAAE,QAAQ;CAOlC;AAED;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,gBAAgB;IAC3D,OAAO,CAAC,SAAS,CAAC,CAAS;IAC3B,OAAO,CAAC,OAAO,CAA4B;IAC3C,OAAO,CAAC,kBAAkB,CAAS;IACnC,OAAO,CAAC,gBAAgB,CAAS;IACjC,OAAO,CAAC,iBAAiB,CAAS;IAElC,OAAuB,MAAM,SAAyB;IACtD,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAErC,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,QAAQ;IA4BnC,OAAO,CAAC,EAAE,EAAE,QAAQ;CAsClC;AAED;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,gBAAgB;IAC3D,OAAO,CAAC,OAAO,CAAC,CAAU;IAE1B,OAAuB,MAAM,SAAyB;IACtD,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAErC,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE;IASpB,OAAO,CAAC,EAAE,EAAE,QAAQ;CAKlC;AAED;;;GAGG;AACH,qBAAa,kBAAmB,SAAQ,gBAAgB;IACtD,OAAO,CAAC,OAAO,CAAC,CAAU;IAE1B,OAAuB,MAAM,SAAoB;IACjD,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAErC,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE;IASpB,OAAO,CAAC,EAAE,EAAE,QAAQ;CAIlC;AAED;;GAEG;AACH,qBAAa,yBAA0B,SAAQ,gBAAgB;IAC7D,OAAO,CAAC,MAAM,CAAC,CAAW;IAE1B,OAAuB,MAAM,SAA2B;IACxD,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAErC,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE;IAKpB,OAAO,CAAC,EAAE,EAAE,QAAQ;CAOlC"}

package/lib/cjs/tools/DisplayStyleTools.js

@@ -4,10 +4,11 @@
 * See LICENSE.md in the project root for license terms and full copyright notice.
 *--------------------------------------------------------------------------------------------*/
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.WoWIgnoreBackgroundTool = exports.OverrideSubCategoryTool = exports.ApplyRenderingStyleTool = exports.SaveRenderingStyleTool = exports.ToggleSkyboxTool = exports.ChangeViewFlagsTool = exports.DisplayStyleTool = void 0;
+exports.ChangeBackgroundColorTool = exports.ToggleWiremeshTool = exports.WoWIgnoreBackgroundTool = exports.QueryScheduleScriptTool = exports.OverrideSubCategoryTool = exports.ApplyRenderingStyleTool = exports.SaveRenderingStyleTool = exports.SkyCubeTool = exports.SkySphereTool = exports.ToggleSkyboxTool = exports.ChangeViewFlagsTool = exports.DisplayStyleTool = void 0;
 /** @packageDocumentation
  * @module Tools
  */
+const core_bentley_1 = require("@itwin/core-bentley");
 const core_common_1 = require("@itwin/core-common");
 const core_frontend_1 = require("@itwin/core-frontend");
 const ClipboardUtilities_1 = require("../ClipboardUtilities");
@@ -17,6 +18,7 @@ const parseToggle_1 = require("./parseToggle");
 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.
@@ -26,13 +28,13 @@ class DisplayStyleTool extends core_frontend_1.Tool {
     get require3d() { return false; }
     async run() {
         const vp = core_frontend_1.IModelApp.viewManager.selectedView;
-        if (undefined !== vp && (!this.require3d || vp.view.is3d()) && this.execute(vp))
+        if (undefined !== vp && (!this.require3d || vp.view.is3d()) && await this.execute(vp))
             vp.displayStyle = vp.view.displayStyle;
         return true;
     }
     async parseAndRun(...args) {
         const vp = core_frontend_1.IModelApp.viewManager.selectedView;
-        if (undefined !== vp && (!this.require3d || vp.view.is3d()) && this.parse(args))
+        if (undefined !== vp && (!this.require3d || vp.view.is3d()) && await this.parse(args, vp))
             return this.run();
         else
             return false;
@@ -99,15 +101,102 @@ ChangeViewFlagsTool.toolId = "ChangeViewFlags";
  */
 class ToggleSkyboxTool extends DisplayStyleTool {
     get require3d() { return true; }
-    parse(_args) { return true; } // no arguments
-    execute(vp) {
+    async parse(_args) { return true; } // no arguments
+    async execute(vp) {
         const style = vp.view.displayStyle;
-        style.environment = new core_frontend_1.Environment({ sky: { display: !style.environment.sky.display } });
+        style.environment = style.environment.withDisplay({ sky: !style.environment.displaySky });
         return true;
     }
 }
 exports.ToggleSkyboxTool = ToggleSkyboxTool;
 ToggleSkyboxTool.toolId = "ToggleSkybox";
+/** Defines a [SkySphere]($common) to apply to the current view.
+ * @beta
+ */
+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 core_common_1.SkySphere(this._image),
+            });
+        }
+        return true;
+    }
+}
+exports.SkySphereTool = SkySphereTool;
+SkySphereTool.toolId = "SetSkySphere";
+/** Defines a [SkyCube]($common) to apply to the current view.
+ * @beta
+ */
+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 core_common_1.SkyCube({ top, bottom, left, right, front, back }),
+        });
+        return true;
+    }
+}
+exports.SkyCubeTool = SkyCubeTool;
+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.
@@ -118,7 +207,7 @@ ToggleSkyboxTool.toolId = "ToggleSkybox";
  *  * `project`: include iTwin-specific (formerly known as project) settings.
  *  * `map`: include background map settings.
  *  * `drawingaids`: include drawing aid decoration settings.
- *  * `copy`: copy result to system clipboarad.
+ *  * `copy`: copy result to system clipboard.
  *  * `quote`: format the JSON so it can be parsed directly by [ApplyRenderingStyleTool].
  * @beta
  */
@@ -131,7 +220,7 @@ class SaveRenderingStyleTool extends DisplayStyleTool {
     }
     static get minArgs() { return 0; }
     static get maxArgs() { return 7; }
-    parse(inputArgs) {
+    async parse(inputArgs) {
         const args = (0, parseArgs_1.parseArgs)(inputArgs);
         function getArg(name) {
             return args.getBoolean(name) ? true : undefined;
@@ -145,7 +234,7 @@ class SaveRenderingStyleTool extends DisplayStyleTool {
         this._quote = true === getArg("q");
         return true;
     }
-    execute(vp) {
+    async execute(vp) {
         let json = JSON.stringify(vp.displayStyle.settings.toOverrides(this._options));
         if (this._quote)
             json = `"${json.replace(/"/g, '""')}"`;
@@ -164,7 +253,7 @@ SaveRenderingStyleTool.toolId = "SaveRenderingStyle";
 class ApplyRenderingStyleTool extends DisplayStyleTool {
     static get minArgs() { return 1; }
     static get maxArgs() { return 1; }
-    parse(args) {
+    async parse(args) {
         try {
             this._overrides = JSON.parse(args[0]);
             return true;
@@ -174,7 +263,7 @@ class ApplyRenderingStyleTool extends DisplayStyleTool {
             return false;
         }
     }
-    execute(vp) {
+    async execute(vp) {
         if (this._overrides)
             vp.overrideDisplayStyle(this._overrides);
         return false;
@@ -193,7 +282,7 @@ class OverrideSubCategoryTool extends DisplayStyleTool {
     }
     static get minArgs() { return 1; }
     static get maxArgs() { return 7; }
-    parse(inArgs) {
+    async parse(inArgs) {
         const args = (0, parseArgs_1.parseArgs)(inArgs);
         const ids = args.get("i");
         if (ids)
@@ -208,7 +297,7 @@ class OverrideSubCategoryTool extends DisplayStyleTool {
         props.invisible = typeof visible === "boolean" ? !visible : undefined;
         return true;
     }
-    execute(vp) {
+    async execute(vp) {
         const ovr = core_common_1.SubCategoryOverride.fromJSON(this._overrideProps);
         for (const id of this._subcategoryIds)
             vp.displayStyle.overrideSubCategory(id, ovr);
@@ -217,20 +306,94 @@ class OverrideSubCategoryTool extends DisplayStyleTool {
 }
 exports.OverrideSubCategoryTool = OverrideSubCategoryTool;
 OverrideSubCategoryTool.toolId = "OverrideSubCategory";
+/** Query the schedule script JSON from an element.
+ * @beta
+ */
+class QueryScheduleScriptTool extends DisplayStyleTool {
+    constructor() {
+        super(...arguments);
+        this._action = "copy";
+        this._includeElementIds = false;
+        this._countElementIds = false;
+        this._expandElementIds = false;
+    }
+    static get minArgs() { return 0; }
+    static get maxArgs() { return 3; }
+    async parse(input, vp) {
+        var _a, _b, _c;
+        const args = (0, parseArgs_1.parseArgs)(input);
+        this._sourceId = (_a = args.get("i")) !== null && _a !== void 0 ? _a : (_b = vp.displayStyle.scheduleScriptReference) === null || _b === void 0 ? void 0 : _b.sourceId;
+        if (!this._sourceId)
+            return false;
+        const action = (_c = args.get("a")) !== null && _c !== void 0 ? _c : "";
+        this._action = action.length > 0 && "b" === action[0].toLowerCase() ? "break" : "copy";
+        this._includeElementIds = this._countElementIds = this._expandElementIds = false;
+        const ids = args.get("e");
+        if (ids && ids.length > 0) {
+            switch (ids[0].toLowerCase()) {
+                case "i":
+                    this._includeElementIds = true;
+                    break;
+                case "c":
+                    this._includeElementIds = this._countElementIds = true;
+                    break;
+                case "e":
+                    this._includeElementIds = this._expandElementIds = true;
+                    break;
+            }
+        }
+        return true;
+    }
+    async execute(vp) {
+        var _a, _b;
+        if (!this._sourceId || !this._action)
+            return false;
+        const opts = {
+            displayStyle: { omitScheduleScriptElementIds: !this._includeElementIds },
+            renderTimeline: { omitScriptElementIds: !this._includeElementIds },
+        };
+        let script;
+        const props = await vp.iModel.elements.loadProps(this._sourceId, opts);
+        if (props.script)
+            script = JSON.parse(props.script.script);
+        else if ((_b = (_a = props.jsonProperties) === null || _a === void 0 ? void 0 : _a.styles) === null || _b === void 0 ? void 0 : _b.scheduleScript)
+            script = props.jsonProperties.styles.scheduleScript;
+        if (!script)
+            return false;
+        if (this._countElementIds || this._expandElementIds) {
+            for (const model of script) {
+                for (const elem of model.elementTimelines) {
+                    const elemIds = typeof elem.elementIds === "string" ? core_bentley_1.CompressedId64Set.decompressArray(elem.elementIds) : elem.elementIds;
+                    if (this._countElementIds)
+                        elem.elementIds = elemIds.length;
+                    else
+                        elem.elementIds = elemIds;
+                }
+            }
+        }
+        if (this._action === "break")
+            debugger; // eslint-disable-line no-debugger
+        else
+            (0, ClipboardUtilities_1.copyStringToClipboard)(JSON.stringify(script, null, 2));
+        return true;
+    }
+}
+exports.QueryScheduleScriptTool = QueryScheduleScriptTool;
+QueryScheduleScriptTool.toolId = "QueryScheduleScript";
 /** Set whether background color is ignored when applying white-on-white reversal.
  * @beta
  */
 class WoWIgnoreBackgroundTool extends DisplayStyleTool {
     static get minArgs() { return 0; }
     static get maxArgs() { return 1; }
-    parse(args) {
+    async parse(args) {
         const ignore = (0, parseToggle_1.parseToggle)(args[0]);
         if (typeof ignore === "string")
             return false;
         this._ignore = ignore;
         return true;
     }
-    execute(vp) {
+    async execute(vp) {
         var _a;
         const ignoreBackgroundColor = (_a = this._ignore) !== null && _a !== void 0 ? _a : !vp.displayStyle.settings.whiteOnWhiteReversal.ignoreBackgroundColor;
         vp.displayStyle.settings.whiteOnWhiteReversal = core_common_1.WhiteOnWhiteReversalSettings.fromJSON({ ignoreBackgroundColor });
@@ -239,4 +402,45 @@ class WoWIgnoreBackgroundTool extends DisplayStyleTool {
 }
 exports.WoWIgnoreBackgroundTool = WoWIgnoreBackgroundTool;
 WoWIgnoreBackgroundTool.toolId = "WoWIgnoreBackground";
+/** Toggle whether surfaces display with overlaid wiremesh in the active viewport.
+ * @see [ViewFlags.wiremesh]($common).
+ * @beta
+ */
+class ToggleWiremeshTool extends DisplayStyleTool {
+    static get minArgs() { return 0; }
+    static get maxArgs() { return 1; }
+    async parse(args) {
+        const enable = (0, parseToggle_1.parseToggle)(args[0]);
+        if (typeof enable === "string")
+            return false;
+        this._enable = enable;
+        return true;
+    }
+    async execute(vp) {
+        var _a;
+        vp.viewFlags = vp.viewFlags.with("wiremesh", (_a = this._enable) !== null && _a !== void 0 ? _a : !vp.viewFlags.wiremesh);
+        return true;
+    }
+}
+exports.ToggleWiremeshTool = ToggleWiremeshTool;
+ToggleWiremeshTool.toolId = "ToggleWiremesh";
+/** Change the background color of the active viewport and optionally its transparency.
+ * @beta
+ */
+class ChangeBackgroundColorTool extends DisplayStyleTool {
+    static get minArgs() { return 1; }
+    static get maxArgs() { return 1; }
+    async parse(args) {
+        this._color = core_common_1.ColorDef.fromString(args[0]);
+        return true;
+    }
+    async execute(vp) {
+        if (!this._color)
+            return false;
+        vp.displayStyle.backgroundColor = this._color;
+        return true;
+    }
+}
+exports.ChangeBackgroundColorTool = ChangeBackgroundColorTool;
+ChangeBackgroundColorTool.toolId = "ChangeBackgroundColor";
 //# sourceMappingURL=DisplayStyleTools.js.map