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

package/lib/esm/tools/ProjectExtents.js

@@ -0,0 +1,102 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Tools
+ */
+import { ColorDef, LinePixels } from "@itwin/core-common";
+import { GraphicType, IModelApp, Tool } from "@itwin/core-frontend";
+import { parseToggle } from "./parseToggle";
+/** @beta */
+export class ProjectExtentsDecoration {
+    constructor(iModel) {
+        /** This will allow the render system to cache and reuse the decorations created by this decorator's decorate() method. */
+        this.useCachedDecorations = true;
+        this._extents = iModel.projectExtents;
+        this.updateDecorationListener(true);
+    }
+    stop() { this.updateDecorationListener(false); }
+    updateDecorationListener(add) {
+        if (this._removeDecorationListener) {
+            if (!add) {
+                this._removeDecorationListener();
+                this._removeDecorationListener = undefined;
+            }
+        }
+        else if (add) {
+            if (!this._removeDecorationListener)
+                this._removeDecorationListener = IModelApp.viewManager.addDecorator(this);
+        }
+    }
+    decorate(context) {
+        const vp = context.viewport;
+        if (!vp.view.isSpatialView())
+            return;
+        const builderAccVis = context.createGraphicBuilder(GraphicType.WorldDecoration);
+        const builderAccHid = context.createGraphicBuilder(GraphicType.WorldOverlay);
+        const colorAccVis = ColorDef.white.adjustedForContrast(context.viewport.view.backgroundColor);
+        const colorAccHid = colorAccVis.withAlpha(100);
+        builderAccVis.setSymbology(colorAccVis, ColorDef.black, 3);
+        builderAccHid.setSymbology(colorAccHid, ColorDef.black, 1, LinePixels.Code2);
+        builderAccVis.addRangeBox(this._extents);
+        builderAccHid.addRangeBox(this._extents);
+        context.addDecorationFromBuilder(builderAccVis);
+        context.addDecorationFromBuilder(builderAccHid);
+    }
+    // Returns true if extents become enabled.
+    static toggle(imodel, enabled) {
+        if (undefined !== enabled) {
+            const alreadyEnabled = undefined !== ProjectExtentsDecoration._decorator;
+            if (enabled === alreadyEnabled)
+                return alreadyEnabled;
+        }
+        if (undefined === ProjectExtentsDecoration._decorator) {
+            ProjectExtentsDecoration._decorator = new ProjectExtentsDecoration(imodel);
+            return true;
+        }
+        else {
+            ProjectExtentsDecoration._decorator.stop();
+            ProjectExtentsDecoration._decorator = undefined;
+            return false;
+        }
+    }
+}
+/** Enable or disable the project extents decoration. This decoration draws a box coinciding with the iModel's project extents.
+ * @param imodel The iModel from which to obtain the extents.
+ * @param enable If undefined, the current enabled state of the decoration will be inverted; otherwise it will be enabled if true, or disabled if false.
+ * @returns true if the extents are now ON, false if they are now OFF.
+ * @beta
+ */
+export function toggleProjectExtents(imodel, enabled) {
+    return ProjectExtentsDecoration.toggle(imodel, enabled);
+}
+/** Enable or disable project extents decoration.
+ * The key-in takes at most 1 argument (case-insensitive):
+ *  - "ON" => enable project extents
+ *  - "OFF" => disable project extents
+ *  - "TOGGLE" or omitted => toggle project extents
+ * @see [toggleProjectExtents]
+ * @beta
+ */
+export class ToggleProjectExtentsTool extends Tool {
+    static get minArgs() { return 0; }
+    static get maxArgs() { return 1; }
+    async run(enable) {
+        const vp = IModelApp.viewManager.selectedView;
+        if (undefined !== vp && vp.view.isSpatialView()) {
+            const iModel = vp.iModel;
+            if (toggleProjectExtents(iModel, enable))
+                vp.onChangeView.addOnce(() => toggleProjectExtents(iModel, false));
+        }
+        return true;
+    }
+    async parseAndRun(...args) {
+        const enable = parseToggle(args[0]);
+        if (typeof enable !== "string")
+            await this.run(enable);
+        return true;
+    }
+}
+ToggleProjectExtentsTool.toolId = "ToggleProjectExtents";
+//# sourceMappingURL=ProjectExtents.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ProjectExtents.js","sourceRoot":"","sources":["../../../src/tools/ProjectExtents.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F;;GAEG;AAEH,OAAO,EAAoB,QAAQ,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAC5E,OAAO,EAAmB,WAAW,EAAE,SAAS,EAAoB,IAAI,EAAE,MAAM,sBAAsB,CAAC;AACvG,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,YAAY;AACZ,MAAM,OAAO,wBAAwB;IAKnC,YAAmB,MAAwB;QAmB3C,0HAA0H;QAC1G,yBAAoB,GAAG,IAAI,CAAC;QAnB1C,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,cAAc,CAAC;QACtC,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC;IAES,IAAI,KAAW,IAAI,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAEtD,wBAAwB,CAAC,GAAY;QAC7C,IAAI,IAAI,CAAC,yBAAyB,EAAE;YAClC,IAAI,CAAC,GAAG,EAAE;gBACR,IAAI,CAAC,yBAAyB,EAAE,CAAC;gBACjC,IAAI,CAAC,yBAAyB,GAAG,SAAS,CAAC;aAC5C;SACF;aAAM,IAAI,GAAG,EAAE;YACd,IAAI,CAAC,IAAI,CAAC,yBAAyB;gBACjC,IAAI,CAAC,yBAAyB,GAAG,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;SAC7E;IACH,CAAC;IAKM,QAAQ,CAAC,OAAwB;QACtC,MAAM,EAAE,GAAG,OAAO,CAAC,QAAQ,CAAC;QAC5B,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,aAAa,EAAE;YAC1B,OAAO;QAET,MAAM,aAAa,GAAG,OAAO,CAAC,oBAAoB,CAAC,WAAW,CAAC,eAAe,CAAC,CAAC;QAChF,MAAM,aAAa,GAAG,OAAO,CAAC,oBAAoB,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;QAC7E,MAAM,WAAW,GAAG,QAAQ,CAAC,KAAK,CAAC,mBAAmB,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAC9F,MAAM,WAAW,GAAG,WAAW,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QAE/C,aAAa,CAAC,YAAY,CAAC,WAAW,EAAE,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QAC3D,aAAa,CAAC,YAAY,CAAC,WAAW,EAAE,QAAQ,CAAC,KAAK,EAAE,CAAC,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC;QAE7E,aAAa,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACzC,aAAa,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEzC,OAAO,CAAC,wBAAwB,CAAC,aAAa,CAAC,CAAC;QAChD,OAAO,CAAC,wBAAwB,CAAC,aAAa,CAAC,CAAC;IAClD,CAAC;IAED,0CAA0C;IACnC,MAAM,CAAC,MAAM,CAAC,MAAwB,EAAE,OAAiB;QAC9D,IAAI,SAAS,KAAK,OAAO,EAAE;YACzB,MAAM,cAAc,GAAG,SAAS,KAAK,wBAAwB,CAAC,UAAU,CAAC;YACzE,IAAI,OAAO,KAAK,cAAc;gBAC5B,OAAO,cAAc,CAAC;SACzB;QAED,IAAI,SAAS,KAAK,wBAAwB,CAAC,UAAU,EAAE;YACrD,wBAAwB,CAAC,UAAU,GAAG,IAAI,wBAAwB,CAAC,MAAM,CAAC,CAAC;YAC3E,OAAO,IAAI,CAAC;SACb;aAAM;YACL,wBAAwB,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC;YAC3C,wBAAwB,CAAC,UAAU,GAAG,SAAS,CAAC;YAChD,OAAO,KAAK,CAAC;SACd;IACH,CAAC;CACF;AAED;;;;;GAKG;AACH,MAAM,UAAU,oBAAoB,CAAC,MAAwB,EAAE,OAAiB;IAC9E,OAAO,wBAAwB,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAC1D,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,OAAO,wBAAyB,SAAQ,IAAI;IAEzC,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAElC,KAAK,CAAC,GAAG,CAAC,MAAgB;QACxC,MAAM,EAAE,GAAG,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC;QAC9C,IAAI,SAAS,KAAK,EAAE,IAAI,EAAE,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE;YAC/C,MAAM,MAAM,GAAG,EAAE,CAAC,MAAM,CAAC;YACzB,IAAI,oBAAoB,CAAC,MAAM,EAAE,MAAM,CAAC;gBACtC,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,oBAAoB,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;SACtE;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;;AArBsB,+BAAM,GAAG,sBAAsB,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 { AxisAlignedBox3d, ColorDef, LinePixels } from \"@itwin/core-common\";\r\nimport { DecorateContext, GraphicType, IModelApp, IModelConnection, Tool } from \"@itwin/core-frontend\";\r\nimport { parseToggle } from \"./parseToggle\";\r\n\r\n/** @beta */\r\nexport class ProjectExtentsDecoration {\r\n  private static _decorator?: ProjectExtentsDecoration;\r\n  protected _removeDecorationListener?: () => void;\r\n  protected _extents: AxisAlignedBox3d;\r\n\r\n  public constructor(iModel: IModelConnection) {\r\n    this._extents = iModel.projectExtents;\r\n    this.updateDecorationListener(true);\r\n  }\r\n\r\n  protected stop(): void { this.updateDecorationListener(false); }\r\n\r\n  protected updateDecorationListener(add: boolean): void {\r\n    if (this._removeDecorationListener) {\r\n      if (!add) {\r\n        this._removeDecorationListener();\r\n        this._removeDecorationListener = undefined;\r\n      }\r\n    } else if (add) {\r\n      if (!this._removeDecorationListener)\r\n        this._removeDecorationListener = IModelApp.viewManager.addDecorator(this);\r\n    }\r\n  }\r\n\r\n  /** This will allow the render system to cache and reuse the decorations created by this decorator's decorate() method. */\r\n  public readonly useCachedDecorations = true;\r\n\r\n  public decorate(context: DecorateContext): void {\r\n    const vp = context.viewport;\r\n    if (!vp.view.isSpatialView())\r\n      return;\r\n\r\n    const builderAccVis = context.createGraphicBuilder(GraphicType.WorldDecoration);\r\n    const builderAccHid = context.createGraphicBuilder(GraphicType.WorldOverlay);\r\n    const colorAccVis = ColorDef.white.adjustedForContrast(context.viewport.view.backgroundColor);\r\n    const colorAccHid = colorAccVis.withAlpha(100);\r\n\r\n    builderAccVis.setSymbology(colorAccVis, ColorDef.black, 3);\r\n    builderAccHid.setSymbology(colorAccHid, ColorDef.black, 1, LinePixels.Code2);\r\n\r\n    builderAccVis.addRangeBox(this._extents);\r\n    builderAccHid.addRangeBox(this._extents);\r\n\r\n    context.addDecorationFromBuilder(builderAccVis);\r\n    context.addDecorationFromBuilder(builderAccHid);\r\n  }\r\n\r\n  // Returns true if extents become enabled.\r\n  public static toggle(imodel: IModelConnection, enabled?: boolean): boolean {\r\n    if (undefined !== enabled) {\r\n      const alreadyEnabled = undefined !== ProjectExtentsDecoration._decorator;\r\n      if (enabled === alreadyEnabled)\r\n        return alreadyEnabled;\r\n    }\r\n\r\n    if (undefined === ProjectExtentsDecoration._decorator) {\r\n      ProjectExtentsDecoration._decorator = new ProjectExtentsDecoration(imodel);\r\n      return true;\r\n    } else {\r\n      ProjectExtentsDecoration._decorator.stop();\r\n      ProjectExtentsDecoration._decorator = undefined;\r\n      return false;\r\n    }\r\n  }\r\n}\r\n\r\n/** Enable or disable the project extents decoration. This decoration draws a box coinciding with the iModel's project extents.\r\n * @param imodel The iModel from which to obtain the extents.\r\n * @param enable If undefined, the current enabled state of the decoration will be inverted; otherwise it will be enabled if true, or disabled if false.\r\n * @returns true if the extents are now ON, false if they are now OFF.\r\n * @beta\r\n */\r\nexport function toggleProjectExtents(imodel: IModelConnection, enabled?: boolean): boolean {\r\n  return ProjectExtentsDecoration.toggle(imodel, enabled);\r\n}\r\n\r\n/** Enable or disable project extents decoration.\r\n * The key-in takes at most 1 argument (case-insensitive):\r\n *  - \"ON\" => enable project extents\r\n *  - \"OFF\" => disable project extents\r\n *  - \"TOGGLE\" or omitted => toggle project extents\r\n * @see [toggleProjectExtents]\r\n * @beta\r\n */\r\nexport class ToggleProjectExtentsTool extends Tool {\r\n  public static override toolId = \"ToggleProjectExtents\";\r\n  public static override get minArgs() { return 0; }\r\n  public static override get maxArgs() { return 1; }\r\n\r\n  public override async run(enable?: boolean): Promise<boolean> {\r\n    const vp = IModelApp.viewManager.selectedView;\r\n    if (undefined !== vp && vp.view.isSpatialView()) {\r\n      const iModel = vp.iModel;\r\n      if (toggleProjectExtents(iModel, enable))\r\n        vp.onChangeView.addOnce(() => toggleProjectExtents(iModel, false));\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/RealityModelTools.d.ts

@@ -0,0 +1,117 @@
+/** @packageDocumentation
+ * @module Tools
+ */
+import { RgbColorProps } from "@itwin/core-common";
+import { Tool } from "@itwin/core-frontend";
+/** This tool attaches a specified reality model.
+ * @beta
+ */
+export declare class AttachRealityModelTool extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    /** This method runs the tool, attaching a specified reality model.
+     * @param data a [[ContextRealityModelProps]] JSON representation
+     */
+    run(data: string): Promise<boolean>;
+    /** Executes this tool's run method with args[0] containing `data`.
+     * @see [[run]]
+     */
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
+/** This tool saves a reality model's JSON representation to the system clipboard.
+ * @beta */
+export declare class SaveRealityModelTool extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    /** This method runs the tool, saving a reality model's JSON representation to the system clipboard.
+     * @param name the name of the reality model to copy; if undefined, copy the last found reality model
+     */
+    run(name: string | undefined): Promise<boolean>;
+    /** Executes this tool's run method with args[0] containing `name`.
+     * @see [[run]]
+     */
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
+/** Set reality model appearance override for transparency in display style.
+ * @beta
+ */
+export declare class SetRealityModelTransparencyTool extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    run(transparency: number, index: number): Promise<boolean>;
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
+/** Set reality model appearance override for locatable in display style.
+ * @beta
+ */
+export declare class SetRealityModelLocateTool extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    run(locate: boolean, index: number): Promise<boolean>;
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
+/** Set reality model appearance override for emphasized in display style.
+ * @beta
+ */
+export declare class SetRealityModelEmphasizedTool extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    run(emphasized: true | undefined, index: number): Promise<boolean>;
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
+/** Detach reality model from display style.
+ * @beta
+ */
+export declare class DetachRealityModelTool extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    run(index: number): Promise<boolean>;
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
+/** Set reality model appearance override for color in display style.
+ * @beta
+ */
+export declare class SetRealityModelColorTool extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    run(rgb: RgbColorProps, index: number): Promise<boolean>;
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
+/** Clear reality model appearance override in display style.
+ * @beta
+ */
+export declare class ClearRealityModelAppearanceOverrides extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    run(index: number): Promise<boolean>;
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
+/** Attach a cesium asset from the Ion ID and key.
+ * @beta
+ */
+export declare class AttachCesiumAssetTool extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    run(assetId: number, requestKey: string): Promise<boolean>;
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
+/** Turn on/off display of OpenStreetMap buildings
+ * @beta
+ */
+export declare class ToggleOSMBuildingDisplay extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    run(onOff?: boolean, transparency?: number): Promise<boolean>;
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
+//# sourceMappingURL=RealityModelTools.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"RealityModelTools.d.ts","sourceRoot":"","sources":["../../../src/tools/RealityModelTools.ts"],"names":[],"mappings":"AAKA;;GAEG;AAEH,OAAO,EAA6C,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAC9F,OAAO,EAA6E,IAAI,EAAY,MAAM,sBAAsB,CAAC;AAKjI;;GAEG;AACH,qBAAa,sBAAuB,SAAQ,IAAI;IAC9C,OAAuB,MAAM,SAA4B;IACzD,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAElD;;OAEG;IACmB,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAgBzD;;OAEG;IACmB,WAAW,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAGvE;AAED;WACW;AACX,qBAAa,oBAAqB,SAAQ,IAAI;IAC5C,OAAuB,MAAM,SAA0B;IACvD,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAElD;;OAEG;IACmB,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC;IAcrE;;OAEG;IACmB,WAAW,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAGvE;AAsBD;;GAEG;AACH,qBAAa,+BAAgC,SAAQ,IAAI;IACvD,OAAuB,MAAM,SAAqC;IAClE,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAE5B,GAAG,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAa1D,WAAW,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAGvE;AACD;;GAEG;AACH,qBAAa,yBAA0B,SAAQ,IAAI;IACjD,OAAuB,MAAM,SAA+B;IAC5D,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAE5B,GAAG,CAAC,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAcrD,WAAW,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAIvE;AAED;;GAEG;AACH,qBAAa,6BAA8B,SAAQ,IAAI;IACrD,OAAuB,MAAM,SAAmC;IAChE,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAE5B,GAAG,CAAC,UAAU,EAAE,IAAI,GAAG,SAAS,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAalE,WAAW,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAIvE;AAED;;GAEG;AACH,qBAAa,sBAAuB,SAAQ,IAAI;IAC9C,OAAuB,MAAM,SAAgC;IAC7D,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAE5B,GAAG,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAapC,WAAW,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAGvE;AAED;;GAEG;AACH,qBAAa,wBAAyB,SAAQ,IAAI;IAChD,OAAuB,MAAM,SAA8B;IAC3D,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAE5B,GAAG,CAAC,GAAG,EAAE,aAAa,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAaxD,WAAW,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAGvE;AAED;;GAEG;AACH,qBAAa,oCAAqC,SAAQ,IAAI;IAC5D,OAAuB,MAAM,SAA0C;IACvE,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAE5B,GAAG,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAapC,WAAW,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAGvE;AAED;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,IAAI;IAC7C,OAAuB,MAAM,SAA2B;IACxD,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAE5B,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAW1D,WAAW,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAIvE;AAED;;GAEG;AACH,qBAAa,wBAAyB,SAAQ,IAAI;IAChD,OAAuB,MAAM,SAAwB;IACrD,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAE5B,GAAG,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAc7D,WAAW,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAKvE"}

package/lib/esm/tools/RealityModelTools.js

@@ -0,0 +1,256 @@
+/*---------------------------------------------------------------------------------------------
+* 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 { FeatureAppearance } from "@itwin/core-common";
+import { getCesiumAssetUrl, IModelApp, NotifyMessageDetails, OutputMessagePriority, Tool } from "@itwin/core-frontend";
+import { copyStringToClipboard } from "../ClipboardUtilities";
+import { parseBoolean } from "./parseBoolean";
+import { parseToggle } from "./parseToggle";
+/** This tool attaches a specified reality model.
+ * @beta
+ */
+export class AttachRealityModelTool extends Tool {
+    static get minArgs() { return 1; }
+    static get maxArgs() { return 1; }
+    /** This method runs the tool, attaching a specified reality model.
+     * @param data a [[ContextRealityModelProps]] JSON representation
+     */
+    async run(data) {
+        const props = JSON.parse(data);
+        const vp = IModelApp.viewManager.selectedView;
+        if (vp === undefined)
+            return false;
+        if (props === undefined || props.tilesetUrl === undefined) {
+            IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Error, `Properties ${props} are not valid`));
+        }
+        vp.displayStyle.attachRealityModel(props);
+        IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info, `Reality Model ${props.tilesetUrl} attached`));
+        return true;
+    }
+    /** Executes this tool's run method with args[0] containing `data`.
+     * @see [[run]]
+     */
+    async parseAndRun(...args) {
+        return this.run(args[0]);
+    }
+}
+AttachRealityModelTool.toolId = "AttachRealityModelTool";
+/** This tool saves a reality model's JSON representation to the system clipboard.
+ * @beta */
+export class SaveRealityModelTool extends Tool {
+    static get minArgs() { return 0; }
+    static get maxArgs() { return 1; }
+    /** This method runs the tool, saving a reality model's JSON representation to the system clipboard.
+     * @param name the name of the reality model to copy; if undefined, copy the last found reality model
+     */
+    async run(name) {
+        const vp = IModelApp.viewManager.selectedView;
+        if (vp === undefined)
+            return false;
+        vp.displayStyle.forEachRealityModel((realityModel) => {
+            if (name === undefined || realityModel.name === name) {
+                copyStringToClipboard(JSON.stringify(realityModel.toJSON()));
+                IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info, `Reality Model ${realityModel.name} copied to clipboard`));
+            }
+        });
+        return true;
+    }
+    /** Executes this tool's run method with args[0] containing `name`.
+     * @see [[run]]
+     */
+    async parseAndRun(...args) {
+        return this.run(args.length > 0 ? args[0] : undefined);
+    }
+}
+SaveRealityModelTool.toolId = "SaveRealityModelTool";
+function changeRealityModelAppearanceOverrides(vp, overrides, index) {
+    if (index < 0) {
+        for (const model of vp.displayStyle.settings.contextRealityModels.models)
+            model.appearanceOverrides = model.appearanceOverrides ? model.appearanceOverrides.clone(overrides) : FeatureAppearance.fromJSON(overrides);
+        return vp.displayStyle.settings.contextRealityModels.models.length > 0;
+    }
+    else {
+        const model = vp.displayStyle.settings.contextRealityModels.models[index];
+        if (!model)
+            return false;
+        model.appearanceOverrides = model.appearanceOverrides ? model.appearanceOverrides.clone(overrides) : FeatureAppearance.fromJSON(overrides);
+        return true;
+    }
+}
+function appearanceChangedString(index) {
+    return index < 0 ? `All Reality Models` : `Reality Model at Index: ${index}`;
+}
+/** Set reality model appearance override for transparency in display style.
+ * @beta
+ */
+export class SetRealityModelTransparencyTool extends Tool {
+    static get minArgs() { return 1; }
+    static get maxArgs() { return 2; }
+    async run(transparency, index) {
+        const vp = IModelApp.viewManager.selectedView;
+        if (vp === undefined)
+            return false;
+        const changed = changeRealityModelAppearanceOverrides(vp, { transparency }, index);
+        if (changed)
+            IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info, `${appearanceChangedString(index)} set to transparency: ${transparency}`));
+        return true;
+    }
+    async parseAndRun(...args) {
+        return this.run(parseFloat(args[0]), args.length > 1 ? parseInt(args[1], 10) : -1);
+    }
+}
+SetRealityModelTransparencyTool.toolId = "SetRealityModelTransparencyTool";
+/** Set reality model appearance override for locatable in display style.
+ * @beta
+ */
+export class SetRealityModelLocateTool extends Tool {
+    static get minArgs() { return 1; }
+    static get maxArgs() { return 2; }
+    async run(locate, index) {
+        const vp = IModelApp.viewManager.selectedView;
+        if (vp === undefined)
+            return false;
+        const nonLocatable = locate ? undefined : true;
+        const changed = changeRealityModelAppearanceOverrides(vp, { nonLocatable }, index);
+        if (changed)
+            IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info, `${appearanceChangedString(index)} set to locate: ${locate}`));
+        return true;
+    }
+    async parseAndRun(...args) {
+        const locate = parseBoolean(args[0]);
+        return locate === undefined ? false : this.run(locate, args.length > 1 ? parseInt(args[1], 10) : -1);
+    }
+}
+SetRealityModelLocateTool.toolId = "SetRealityModelLocateTool";
+/** Set reality model appearance override for emphasized in display style.
+ * @beta
+ */
+export class SetRealityModelEmphasizedTool extends Tool {
+    static get minArgs() { return 1; }
+    static get maxArgs() { return 2; }
+    async run(emphasized, index) {
+        const vp = IModelApp.viewManager.selectedView;
+        if (vp === undefined)
+            return false;
+        const changed = changeRealityModelAppearanceOverrides(vp, { emphasized }, index);
+        if (changed)
+            IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info, `${appearanceChangedString(index)} set to emphasized: ${emphasized}`));
+        return true;
+    }
+    async parseAndRun(...args) {
+        const emphasized = parseBoolean(args[0]);
+        return emphasized === undefined ? false : this.run(emphasized ? true : undefined, args.length > 1 ? parseInt(args[1], 10) : -1);
+    }
+}
+SetRealityModelEmphasizedTool.toolId = "SetRealityModelEmphasizedTool";
+/** Detach reality model from display style.
+ * @beta
+ */
+export class DetachRealityModelTool extends Tool {
+    static get minArgs() { return 0; }
+    static get maxArgs() { return 1; }
+    async run(index) {
+        const vp = IModelApp.viewManager.selectedView;
+        if (vp === undefined)
+            return false;
+        const model = vp.displayStyle.settings.contextRealityModels.models[index];
+        if (!model)
+            return false;
+        vp.displayStyle.settings.contextRealityModels.delete(model);
+        return true;
+    }
+    async parseAndRun(...args) {
+        return this.run(args.length > 1 ? parseInt(args[0], 10) : -1);
+    }
+}
+DetachRealityModelTool.toolId = "ViewportDetachRealityModel";
+/** Set reality model appearance override for color in display style.
+ * @beta
+ */
+export class SetRealityModelColorTool extends Tool {
+    static get minArgs() { return 3; }
+    static get maxArgs() { return 4; }
+    async run(rgb, index) {
+        const vp = IModelApp.viewManager.selectedView;
+        if (vp === undefined)
+            return false;
+        const changed = changeRealityModelAppearanceOverrides(vp, { rgb }, index);
+        if (changed)
+            IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info, `${appearanceChangedString(index)} set to RGB color: (${rgb.r}, ${rgb.g}, ${rgb.b})`));
+        return true;
+    }
+    async parseAndRun(...args) {
+        return this.run({ r: parseFloat(args[0]), g: parseFloat(args[1]), b: parseFloat(args[2]) }, args.length > 3 ? parseInt(args[3], 10) : -1);
+    }
+}
+SetRealityModelColorTool.toolId = "SetRealityModelColorTool";
+/** Clear reality model appearance override in display style.
+ * @beta
+ */
+export class ClearRealityModelAppearanceOverrides extends Tool {
+    static get minArgs() { return 0; }
+    static get maxArgs() { return 1; }
+    async run(index) {
+        const vp = IModelApp.viewManager.selectedView;
+        if (!vp)
+            return false;
+        const model = vp.displayStyle.settings.contextRealityModels.models[index];
+        if (!model)
+            return false;
+        model.appearanceOverrides = undefined;
+        return true;
+    }
+    async parseAndRun(...args) {
+        return this.run(args[0] === undefined ? -1 : parseInt(args[0], 10));
+    }
+}
+ClearRealityModelAppearanceOverrides.toolId = "ClearRealityModelAppearanceOverrides";
+/** Attach a cesium asset from the Ion ID and key.
+ * @beta
+ */
+export class AttachCesiumAssetTool extends Tool {
+    static get minArgs() { return 1; }
+    static get maxArgs() { return 2; }
+    async run(assetId, requestKey) {
+        const vp = IModelApp.viewManager.selectedView;
+        if (vp === undefined)
+            return false;
+        const props = { tilesetUrl: getCesiumAssetUrl(assetId, requestKey) };
+        vp.displayStyle.attachRealityModel(props);
+        IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info, `Cesium Asset #${assetId} attached`));
+        return true;
+    }
+    async parseAndRun(...args) {
+        const assetId = parseInt(args[0], 10);
+        return Number.isNaN(assetId) ? false : this.run(assetId, args[1]);
+    }
+}
+AttachCesiumAssetTool.toolId = "AttachCesiumAssetTool";
+/** Turn on/off display of OpenStreetMap buildings
+ * @beta
+ */
+export class ToggleOSMBuildingDisplay extends Tool {
+    static get minArgs() { return 0; }
+    static get maxArgs() { return 2; }
+    async run(onOff, transparency) {
+        const vp = IModelApp.viewManager.selectedView;
+        if (vp === undefined)
+            return false;
+        if (onOff === undefined)
+            onOff = undefined === vp.displayStyle.getOSMBuildingRealityModel(); // Toggle current state.
+        const appearanceOverrides = (transparency !== undefined && transparency > 0 && transparency < 1) ? FeatureAppearance.fromJSON({ transparency }) : undefined;
+        vp.displayStyle.setOSMBuildingDisplay({ onOff, appearanceOverrides });
+        return true;
+    }
+    async parseAndRun(...args) {
+        const toggle = parseToggle(args[0]);
+        const transparency = args.length > 0 ? parseFloat(args[1]) : undefined;
+        return typeof toggle === "string" ? false : this.run(toggle, transparency);
+    }
+}
+ToggleOSMBuildingDisplay.toolId = "SetBuildingDisplay";
+//# sourceMappingURL=RealityModelTools.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"RealityModelTools.js","sourceRoot":"","sources":["../../../src/tools/RealityModelTools.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F;;GAEG;AAEH,OAAO,EAAE,iBAAiB,EAAyC,MAAM,oBAAoB,CAAC;AAC9F,OAAO,EAAE,iBAAiB,EAAE,SAAS,EAAE,oBAAoB,EAAE,qBAAqB,EAAE,IAAI,EAAY,MAAM,sBAAsB,CAAC;AACjI,OAAO,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AAC9D,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C;;GAEG;AACH,MAAM,OAAO,sBAAuB,SAAQ,IAAI;IAEvC,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,IAAY;QACpC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC/B,MAAM,EAAE,GAAG,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC;QAC9C,IAAI,EAAE,KAAK,SAAS;YAClB,OAAO,KAAK,CAAC;QAEf,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,CAAC,UAAU,KAAK,SAAS,EAAE;YACzD,SAAS,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,oBAAoB,CAAC,qBAAqB,CAAC,KAAK,EAAE,cAAc,KAAK,gBAAgB,CAAC,CAAC,CAAC;SACnI;QAED,EAAE,CAAC,YAAY,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;QAC1C,SAAS,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,oBAAoB,CAAC,qBAAqB,CAAC,IAAI,EAAE,iBAAiB,KAAK,CAAC,UAAU,WAAW,CAAC,CAAC,CAAC;QAE1I,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACa,KAAK,CAAC,WAAW,CAAC,GAAG,IAAc;QACjD,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAC3B,CAAC;;AA5BsB,6BAAM,GAAG,wBAAwB,CAAC;AA+B3D;WACW;AACX,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,IAAwB;QAChD,MAAM,EAAE,GAAG,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC;QAC9C,IAAI,EAAE,KAAK,SAAS;YAClB,OAAO,KAAK,CAAC;QACf,EAAE,CAAC,YAAY,CAAC,mBAAmB,CAAC,CAAC,YAAY,EAAE,EAAE;YACnD,IAAI,IAAI,KAAK,SAAS,IAAI,YAAY,CAAC,IAAI,KAAK,IAAI,EAAE;gBACpD,qBAAqB,CAAC,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;gBAC7D,SAAS,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,oBAAoB,CAAC,qBAAqB,CAAC,IAAI,EAAE,iBAAiB,YAAY,CAAC,IAAI,sBAAsB,CAAC,CAAC,CAAC;aACvJ;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACa,KAAK,CAAC,WAAW,CAAC,GAAG,IAAc;QACjD,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IACzD,CAAC;;AA1BsB,2BAAM,GAAG,sBAAsB,CAAC;AA6BzD,SAAS,qCAAqC,CAAC,EAAY,EAAE,SAAiC,EAAE,KAAa;IAC3G,IAAI,KAAK,GAAG,CAAC,EAAC;QACZ,KAAK,MAAM,KAAK,IAAI,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,oBAAoB,CAAC,MAAM;YACtE,KAAK,CAAC,mBAAmB,GAAG,KAAK,CAAC,mBAAmB,CAAC,CAAC,CAAC,KAAK,CAAC,mBAAmB,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QAE7I,OAAO,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,oBAAoB,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC;KACxE;SAAM;QACL,MAAM,KAAK,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,oBAAoB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC1E,IAAI,CAAC,KAAK;YACR,OAAO,KAAK,CAAC;QAEf,KAAK,CAAC,mBAAmB,GAAG,KAAK,CAAC,mBAAmB,CAAC,CAAC,CAAC,KAAK,CAAC,mBAAmB,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QAC3I,OAAO,IAAI,CAAC;KACb;AACH,CAAC;AAED,SAAS,uBAAuB,CAAC,KAAa;IAC5C,OAAO,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,oBAAoB,CAAC,CAAC,CAAC,2BAA2B,KAAK,EAAE,CAAC;AAC/E,CAAC;AAED;;GAEG;AACH,MAAM,OAAO,+BAAgC,SAAQ,IAAI;IAEhD,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAElC,KAAK,CAAC,GAAG,CAAC,YAAoB,EAAE,KAAa;QAC3D,MAAM,EAAE,GAAG,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC;QAC9C,IAAI,EAAE,KAAK,SAAS;YAClB,OAAO,KAAK,CAAC;QAEf,MAAM,OAAO,GAAG,qCAAqC,CAAC,EAAE,EAAE,EAAE,YAAY,EAAE,EAAE,KAAK,CAAC,CAAC;QAEnF,IAAI,OAAO;YACT,SAAS,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,oBAAoB,CAAC,qBAAqB,CAAC,IAAI,EAAC,GAAG,uBAAuB,CAAC,KAAK,CAAC,yBAAyB,YAAY,EAAE,CAAC,CAAC,CAAC;QAEvK,OAAO,IAAI,CAAC;IACd,CAAC;IAEe,KAAK,CAAC,WAAW,CAAC,GAAG,IAAc;QACjD,OAAO,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACrF,CAAC;;AAnBsB,sCAAM,GAAG,iCAAiC,CAAC;AAqBpE;;GAEG;AACH,MAAM,OAAO,yBAA0B,SAAQ,IAAI;IAE1C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAElC,KAAK,CAAC,GAAG,CAAC,MAAe,EAAE,KAAa;QACtD,MAAM,EAAE,GAAG,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC;QAC9C,IAAI,EAAE,KAAK,SAAS;YAClB,OAAO,KAAK,CAAC;QAEf,MAAM,YAAY,GAAG,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC;QAC/C,MAAM,OAAO,GAAG,qCAAqC,CAAC,EAAE,EAAE,EAAE,YAAY,EAAE,EAAE,KAAK,CAAC,CAAC;QAEnF,IAAI,OAAO;YACT,SAAS,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,oBAAoB,CAAC,qBAAqB,CAAC,IAAI,EAAC,GAAG,uBAAuB,CAAC,KAAK,CAAC,mBAAmB,MAAM,EAAE,CAAC,CAAC,CAAC;QAE3J,OAAO,IAAI,CAAC;IACd,CAAC;IAEe,KAAK,CAAC,WAAW,CAAC,GAAG,IAAc;QACjD,MAAM,MAAM,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QACrC,OAAO,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACvG,CAAC;;AArBsB,gCAAM,GAAG,2BAA2B,CAAC;AAwB9D;;GAEG;AACH,MAAM,OAAO,6BAA8B,SAAQ,IAAI;IAE9C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAElC,KAAK,CAAC,GAAG,CAAC,UAA4B,EAAE,KAAa;QACnE,MAAM,EAAE,GAAG,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC;QAC9C,IAAI,EAAE,KAAK,SAAS;YAClB,OAAO,KAAK,CAAC;QAEf,MAAM,OAAO,GAAG,qCAAqC,CAAC,EAAE,EAAE,EAAE,UAAU,EAAE,EAAE,KAAK,CAAC,CAAC;QAEjF,IAAI,OAAO;YACT,SAAS,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,oBAAoB,CAAC,qBAAqB,CAAC,IAAI,EAAC,GAAG,uBAAuB,CAAC,KAAK,CAAC,uBAAuB,UAAU,EAAE,CAAC,CAAC,CAAC;QAEnK,OAAO,IAAI,CAAC;IACd,CAAC;IAEe,KAAK,CAAC,WAAW,CAAC,GAAG,IAAc;QACjD,MAAM,UAAU,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QACzC,OAAO,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,EAAE,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAClI,CAAC;;AApBsB,oCAAM,GAAG,+BAA+B,CAAC;AAuBlE;;GAEG;AACH,MAAM,OAAO,sBAAuB,SAAQ,IAAI;IAEvC,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAElC,KAAK,CAAC,GAAG,CAAC,KAAa;QACrC,MAAM,EAAE,GAAG,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC;QAC9C,IAAI,EAAE,KAAK,SAAS;YAClB,OAAO,KAAK,CAAC;QAEf,MAAM,KAAK,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,oBAAoB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC1E,IAAI,CAAC,KAAK;YACR,OAAO,KAAK,CAAC;QAEf,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,oBAAoB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC5D,OAAO,IAAI,CAAC;IACd,CAAC;IAEe,KAAK,CAAC,WAAW,CAAC,GAAG,IAAc;QACjD,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAChE,CAAC;;AAnBsB,6BAAM,GAAG,4BAA4B,CAAC;AAsB/D;;GAEG;AACH,MAAM,OAAO,wBAAyB,SAAQ,IAAI;IAEzC,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAElC,KAAK,CAAC,GAAG,CAAC,GAAkB,EAAE,KAAa;QACzD,MAAM,EAAE,GAAG,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC;QAC9C,IAAI,EAAE,KAAK,SAAS;YAClB,OAAO,KAAK,CAAC;QAEf,MAAM,OAAO,GAAG,qCAAqC,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,EAAE,KAAK,CAAC,CAAC;QAE1E,IAAI,OAAO;YACT,SAAS,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,oBAAoB,CAAC,qBAAqB,CAAC,IAAI,EAAC,GAAG,uBAAuB,CAAC,KAAK,CAAC,uBAAuB,GAAG,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QAEnL,OAAO,IAAI,CAAC;IACd,CAAC;IAEe,KAAK,CAAC,WAAW,CAAC,GAAG,IAAc;QACjD,OAAO,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5I,CAAC;;AAnBsB,+BAAM,GAAG,0BAA0B,CAAC;AAsB7D;;GAEG;AACH,MAAM,OAAO,oCAAqC,SAAQ,IAAI;IAErD,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAElC,KAAK,CAAC,GAAG,CAAC,KAAa;QACrC,MAAM,EAAE,GAAG,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC;QAC9C,IAAI,CAAC,EAAE;YACL,OAAO,KAAK,CAAC;QAEf,MAAM,KAAK,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,oBAAoB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC1E,IAAI,CAAC,KAAK;YACR,OAAO,KAAK,CAAC;QAEf,KAAK,CAAC,mBAAmB,GAAG,SAAS,CAAC;QACtC,OAAO,IAAI,CAAC;IACd,CAAC;IAEe,KAAK,CAAC,WAAW,CAAC,GAAG,IAAc;QACjD,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;IACtE,CAAC;;AAnBsB,2CAAM,GAAG,sCAAsC,CAAC;AAsBzE;;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,OAAe,EAAE,UAAkB;QAC3D,MAAM,EAAE,GAAG,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC;QAC9C,IAAI,EAAE,KAAK,SAAS;YAClB,OAAO,KAAK,CAAC;QAEf,MAAM,KAAK,GAAG,EAAE,UAAU,EAAE,iBAAiB,CAAC,OAAO,EAAE,UAAU,CAAC,EAAE,CAAC;QACrE,EAAE,CAAC,YAAY,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;QAC1C,SAAS,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,oBAAoB,CAAC,qBAAqB,CAAC,IAAI,EAAE,iBAAiB,OAAO,WAAW,CAAC,CAAC,CAAC;QACjI,OAAO,IAAI,CAAC;IACd,CAAC;IAEe,KAAK,CAAC,WAAW,CAAC,GAAG,IAAc;QACjD,MAAM,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACtC,OAAO,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IACpE,CAAC;;AAlBsB,4BAAM,GAAG,uBAAuB,CAAC;AAqB1D;;GAEG;AACH,MAAM,OAAO,wBAAyB,SAAQ,IAAI;IAEzC,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAElC,KAAK,CAAC,GAAG,CAAC,KAAe,EAAE,YAAqB;QAC9D,MAAM,EAAE,GAAG,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC;QAC9C,IAAI,EAAE,KAAK,SAAS;YAClB,OAAO,KAAK,CAAC;QAEf,IAAI,KAAK,KAAK,SAAS;YACrB,KAAK,GAAG,SAAS,KAAK,EAAE,CAAC,YAAY,CAAC,0BAA0B,EAAE,CAAC,CAAC,wBAAwB;QAE9F,MAAM,mBAAmB,GAAG,CAAC,YAAY,KAAK,SAAS,IAAI,YAAY,GAAG,CAAC,IAAI,YAAY,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,QAAQ,CAAC,EAAE,YAAY,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAE5J,EAAE,CAAC,YAAY,CAAC,qBAAqB,CAAC,EAAE,KAAK,EAAE,mBAAmB,EAAE,CAAC,CAAC;QACtE,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,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACvE,OAAO,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IAC7E,CAAC;;AAtBsB,+BAAM,GAAG,oBAAoB,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 { FeatureAppearance, FeatureAppearanceProps, RgbColorProps } from \"@itwin/core-common\";\r\nimport { getCesiumAssetUrl, IModelApp, NotifyMessageDetails, OutputMessagePriority, Tool, Viewport } from \"@itwin/core-frontend\";\r\nimport { copyStringToClipboard } from \"../ClipboardUtilities\";\r\nimport { parseBoolean } from \"./parseBoolean\";\r\nimport { parseToggle } from \"./parseToggle\";\r\n\r\n/** This tool attaches a specified reality model.\r\n * @beta\r\n */\r\nexport class AttachRealityModelTool extends Tool {\r\n  public static override toolId = \"AttachRealityModelTool\";\r\n  public static override get minArgs() { return 1; }\r\n  public static override get maxArgs() { return 1; }\r\n\r\n  /** This method runs the tool, attaching a specified reality model.\r\n   * @param data a [[ContextRealityModelProps]] JSON representation\r\n   */\r\n  public override async run(data: string): Promise<boolean> {\r\n    const props = JSON.parse(data);\r\n    const vp = IModelApp.viewManager.selectedView;\r\n    if (vp === undefined)\r\n      return false;\r\n\r\n    if (props === undefined || props.tilesetUrl === undefined) {\r\n      IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Error, `Properties ${props} are not valid`));\r\n    }\r\n\r\n    vp.displayStyle.attachRealityModel(props);\r\n    IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info, `Reality Model ${props.tilesetUrl} attached`));\r\n\r\n    return true;\r\n  }\r\n\r\n  /** Executes this tool's run method with args[0] containing `data`.\r\n   * @see [[run]]\r\n   */\r\n  public override async parseAndRun(...args: string[]): Promise<boolean> {\r\n    return this.run(args[0]);\r\n  }\r\n}\r\n\r\n/** This tool saves a reality model's JSON representation to the system clipboard.\r\n * @beta */\r\nexport class SaveRealityModelTool extends Tool {\r\n  public static override toolId = \"SaveRealityModelTool\";\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, saving a reality model's JSON representation to the system clipboard.\r\n   * @param name the name of the reality model to copy; if undefined, copy the last found reality model\r\n   */\r\n  public override async run(name: string | undefined): Promise<boolean> {\r\n    const vp = IModelApp.viewManager.selectedView;\r\n    if (vp === undefined)\r\n      return false;\r\n    vp.displayStyle.forEachRealityModel((realityModel) => {\r\n      if (name === undefined || realityModel.name === name) {\r\n        copyStringToClipboard(JSON.stringify(realityModel.toJSON()));\r\n        IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info, `Reality Model ${realityModel.name} copied to clipboard`));\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 `name`.\r\n   * @see [[run]]\r\n   */\r\n  public override async parseAndRun(...args: string[]): Promise<boolean> {\r\n    return this.run(args.length > 0 ? args[0] : undefined);\r\n  }\r\n}\r\n\r\nfunction changeRealityModelAppearanceOverrides(vp: Viewport, overrides: FeatureAppearanceProps, index: number): boolean {\r\n  if (index < 0){\r\n    for (const model of vp.displayStyle.settings.contextRealityModels.models)\r\n      model.appearanceOverrides = model.appearanceOverrides ? model.appearanceOverrides.clone(overrides) : FeatureAppearance.fromJSON(overrides);\r\n\r\n    return vp.displayStyle.settings.contextRealityModels.models.length > 0;\r\n  } else {\r\n    const model = vp.displayStyle.settings.contextRealityModels.models[index];\r\n    if (!model)\r\n      return false;\r\n\r\n    model.appearanceOverrides = model.appearanceOverrides ? model.appearanceOverrides.clone(overrides) : FeatureAppearance.fromJSON(overrides);\r\n    return true;\r\n  }\r\n}\r\n\r\nfunction appearanceChangedString(index: number) {\r\n  return index < 0 ? `All Reality Models` : `Reality Model at Index: ${index}`;\r\n}\r\n\r\n/** Set reality model appearance override for transparency in display style.\r\n * @beta\r\n */\r\nexport class SetRealityModelTransparencyTool extends Tool {\r\n  public static override toolId = \"SetRealityModelTransparencyTool\";\r\n  public static override get minArgs() { return 1; }\r\n  public static override get maxArgs() { return 2; }\r\n\r\n  public override async run(transparency: number, index: number): Promise<boolean> {\r\n    const vp = IModelApp.viewManager.selectedView;\r\n    if (vp === undefined)\r\n      return false;\r\n\r\n    const changed = changeRealityModelAppearanceOverrides(vp, { transparency }, index);\r\n\r\n    if (changed)\r\n      IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info,`${appearanceChangedString(index)} set to transparency: ${transparency}`));\r\n\r\n    return true;\r\n  }\r\n\r\n  public override async parseAndRun(...args: string[]): Promise<boolean> {\r\n    return this.run(parseFloat(args[0]), args.length > 1 ? parseInt(args[1], 10) : -1);\r\n  }\r\n}\r\n/** Set reality model appearance override for locatable in display style.\r\n * @beta\r\n */\r\nexport class SetRealityModelLocateTool extends Tool {\r\n  public static override toolId = \"SetRealityModelLocateTool\";\r\n  public static override get minArgs() { return 1; }\r\n  public static override get maxArgs() { return 2; }\r\n\r\n  public override async run(locate: boolean, index: number): Promise<boolean> {\r\n    const vp = IModelApp.viewManager.selectedView;\r\n    if (vp === undefined)\r\n      return false;\r\n\r\n    const nonLocatable = locate ? undefined : true;\r\n    const changed = changeRealityModelAppearanceOverrides(vp, { nonLocatable }, index);\r\n\r\n    if (changed)\r\n      IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info,`${appearanceChangedString(index)} set to locate: ${locate}`));\r\n\r\n    return true;\r\n  }\r\n\r\n  public override async parseAndRun(...args: string[]): Promise<boolean> {\r\n    const locate = parseBoolean(args[0]);\r\n    return locate === undefined ? false : this.run(locate, args.length > 1 ? parseInt(args[1], 10) : -1);\r\n  }\r\n}\r\n\r\n/** Set reality model appearance override for emphasized in display style.\r\n * @beta\r\n */\r\nexport class SetRealityModelEmphasizedTool extends Tool {\r\n  public static override toolId = \"SetRealityModelEmphasizedTool\";\r\n  public static override get minArgs() { return 1; }\r\n  public static override get maxArgs() { return 2; }\r\n\r\n  public override async run(emphasized: true | undefined, index: number): Promise<boolean> {\r\n    const vp = IModelApp.viewManager.selectedView;\r\n    if (vp === undefined)\r\n      return false;\r\n\r\n    const changed = changeRealityModelAppearanceOverrides(vp, { emphasized }, index);\r\n\r\n    if (changed)\r\n      IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info,`${appearanceChangedString(index)} set to emphasized: ${emphasized}`));\r\n\r\n    return true;\r\n  }\r\n\r\n  public override async parseAndRun(...args: string[]): Promise<boolean> {\r\n    const emphasized = parseBoolean(args[0]);\r\n    return emphasized === undefined ? false : this.run(emphasized ? true : undefined, args.length > 1 ? parseInt(args[1], 10) : -1);\r\n  }\r\n}\r\n\r\n/** Detach reality model from display style.\r\n * @beta\r\n */\r\nexport class DetachRealityModelTool extends Tool {\r\n  public static override toolId = \"ViewportDetachRealityModel\";\r\n  public static override get minArgs() { return 0; }\r\n  public static override get maxArgs() { return 1; }\r\n\r\n  public override async run(index: number): Promise<boolean> {\r\n    const vp = IModelApp.viewManager.selectedView;\r\n    if (vp === undefined)\r\n      return false;\r\n\r\n    const model = vp.displayStyle.settings.contextRealityModels.models[index];\r\n    if (!model)\r\n      return false;\r\n\r\n    vp.displayStyle.settings.contextRealityModels.delete(model);\r\n    return true;\r\n  }\r\n\r\n  public override async parseAndRun(...args: string[]): Promise<boolean> {\r\n    return this.run(args.length > 1 ? parseInt(args[0], 10) : -1);\r\n  }\r\n}\r\n\r\n/** Set reality model appearance override for color in display style.\r\n * @beta\r\n */\r\nexport class SetRealityModelColorTool extends Tool {\r\n  public static override toolId = \"SetRealityModelColorTool\";\r\n  public static override get minArgs() { return 3; }\r\n  public static override get maxArgs() { return 4; }\r\n\r\n  public override async run(rgb: RgbColorProps, index: number): Promise<boolean> {\r\n    const vp = IModelApp.viewManager.selectedView;\r\n    if (vp === undefined)\r\n      return false;\r\n\r\n    const changed = changeRealityModelAppearanceOverrides(vp, { rgb }, index);\r\n\r\n    if (changed)\r\n      IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info,`${appearanceChangedString(index)} set to RGB color: (${rgb.r}, ${rgb.g}, ${rgb.b})`));\r\n\r\n    return true;\r\n  }\r\n\r\n  public override async parseAndRun(...args: string[]): Promise<boolean> {\r\n    return this.run({ r: parseFloat(args[0]), g: parseFloat(args[1]), b: parseFloat(args[2]) }, args.length > 3 ? parseInt(args[3], 10) : -1);\r\n  }\r\n}\r\n\r\n/** Clear reality model appearance override in display style.\r\n * @beta\r\n */\r\nexport class ClearRealityModelAppearanceOverrides extends Tool {\r\n  public static override toolId = \"ClearRealityModelAppearanceOverrides\";\r\n  public static override get minArgs() { return 0; }\r\n  public static override get maxArgs() { return 1; }\r\n\r\n  public override async run(index: number): Promise<boolean> {\r\n    const vp = IModelApp.viewManager.selectedView;\r\n    if (!vp)\r\n      return false;\r\n\r\n    const model = vp.displayStyle.settings.contextRealityModels.models[index];\r\n    if (!model)\r\n      return false;\r\n\r\n    model.appearanceOverrides = undefined;\r\n    return true;\r\n  }\r\n\r\n  public override async parseAndRun(...args: string[]): Promise<boolean> {\r\n    return this.run(args[0] === undefined ? -1 : parseInt(args[0], 10));\r\n  }\r\n}\r\n\r\n/** Attach a cesium asset from the Ion ID and key.\r\n * @beta\r\n */\r\nexport class AttachCesiumAssetTool extends Tool {\r\n  public static override toolId = \"AttachCesiumAssetTool\";\r\n  public static override get minArgs() { return 1; }\r\n  public static override get maxArgs() { return 2; }\r\n\r\n  public override async run(assetId: number, requestKey: string): Promise<boolean> {\r\n    const vp = IModelApp.viewManager.selectedView;\r\n    if (vp === undefined)\r\n      return false;\r\n\r\n    const props = { tilesetUrl: getCesiumAssetUrl(assetId, requestKey) };\r\n    vp.displayStyle.attachRealityModel(props);\r\n    IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info, `Cesium Asset #${assetId} attached`));\r\n    return true;\r\n  }\r\n\r\n  public override async parseAndRun(...args: string[]): Promise<boolean> {\r\n    const assetId = parseInt(args[0], 10);\r\n    return Number.isNaN(assetId) ? false : this.run(assetId, args[1]);\r\n  }\r\n}\r\n\r\n/** Turn on/off display of OpenStreetMap buildings\r\n * @beta\r\n */\r\nexport class ToggleOSMBuildingDisplay extends Tool {\r\n  public static override toolId = \"SetBuildingDisplay\";\r\n  public static override get minArgs() { return 0; }\r\n  public static override get maxArgs() { return 2; }\r\n\r\n  public override async run(onOff?: boolean, transparency?: number): Promise<boolean> {\r\n    const vp = IModelApp.viewManager.selectedView;\r\n    if (vp === undefined)\r\n      return false;\r\n\r\n    if (onOff === undefined)\r\n      onOff = undefined === vp.displayStyle.getOSMBuildingRealityModel(); // Toggle current state.\r\n\r\n    const appearanceOverrides = (transparency !== undefined && transparency > 0 && transparency < 1) ? FeatureAppearance.fromJSON({ transparency }) : undefined;\r\n\r\n    vp.displayStyle.setOSMBuildingDisplay({ onOff, appearanceOverrides });\r\n    return true;\r\n  }\r\n\r\n  public override async parseAndRun(...args: string[]): Promise<boolean> {\r\n    const toggle = parseToggle(args[0]);\r\n    const transparency = args.length > 0 ? parseFloat(args[1]) : undefined;\r\n    return typeof toggle === \"string\" ? false : this.run(toggle, transparency);\r\n  }\r\n}\r\n"]}

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

@@ -0,0 +1,26 @@
+import { Tool } from "@itwin/core-frontend";
+declare enum FadeMode {
+    X = 0,
+    Y = 1,
+    Z = 2,
+    Transparent = 3
+}
+/** This tool applies a transition in X, Y, Z, or transparency.
+ * @beta
+ */
+export declare class RealityTransitionTool extends Tool {
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    static toolId: string;
+    /** This method runs the tool, applying a transition in X, Y, Z, or transparency.
+     * @param fadeMode whether to apply the transition in X, Y, Z, or transparency
+     */
+    run(fadeMode?: FadeMode): Promise<boolean>;
+    /** Executes this tool's run method.
+     * @param args the first entry of this array contains either "x", "y", "z", or "transparent", indicating the type of transition to apply.
+     * @see [[run]]
+     */
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
+export {};
+//# sourceMappingURL=RealityTransitionTool.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"RealityTransitionTool.d.ts","sourceRoot":"","sources":["../../../src/tools/RealityTransitionTool.ts"],"names":[],"mappings":"AAWA,OAAO,EAAkC,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAE5E,aAAK,QAAQ;IAAG,CAAC,IAAA;IAAE,CAAC,IAAA;IAAE,CAAC,IAAA;IAAE,WAAW,IAAA;CAAE;AAEtC;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,IAAI;IAC7C,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAClD,OAAuB,MAAM,SAAuB;IACpD;;OAEG;IACmB,GAAG,CAAC,QAAQ,GAAE,QAAqB,GAAG,OAAO,CAAC,OAAO,CAAC;IAoE5E;;;OAGG;IACmB,WAAW,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAoBvE"}