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

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

@@ -0,0 +1,47 @@
+import { ViewStateProps } from "@itwin/core-common";
+import { IModelConnection, Tool, ViewState } from "@itwin/core-frontend";
+/** Serialize a ViewState to JSON. The returned JSON can later be passed to [deserializeViewState] to reinstantiate the ViewState.
+ * @beta
+ */
+export declare function serializeViewState(view: ViewState): ViewStateProps;
+/** Instantiate a ViewState serialized by [serializeViewState].
+ * @beta
+ */
+export declare function deserializeViewState(props: ViewStateProps, iModel: IModelConnection): Promise<ViewState>;
+/** Copies a JSON representation of the active viewport's view to the clipboard.
+ *  * Arguments:
+ *  * `quote`: format the JSON so it can be parsed directly by [ApplyViewTool].
+ * @beta
+ */
+export declare class SaveViewTool extends Tool {
+    private _quote;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    static toolId: string;
+    parse(inputArgs: string[]): boolean;
+    parseAndRun(...args: string[]): Promise<boolean>;
+    run(): Promise<boolean>;
+}
+/** Given a string containing a JSON representation of a ViewState, applies that ViewState to the active viewport.
+ * The JSON string should be enclosed in double quotes and embedded double quote should be duplicated, example:
+ * - "{""viewDefinitionProps"":{""classFullName"":""BisCore:SpatialViewDefinition"",""id"":""0x1a""}}"
+ * @beta
+ */
+export declare class ApplyViewTool extends Tool {
+    static toolId: string;
+    static get maxArgs(): number;
+    static get minArgs(): number;
+    run(view?: ViewState): Promise<boolean>;
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
+/** Given the Id of a persistent ViewDefinition, applies that view to the active viewport.
+ * @beta
+ */
+export declare class ApplyViewByIdTool extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    parseAndRun(...args: string[]): Promise<boolean>;
+    run(viewId?: string): Promise<boolean>;
+}
+//# sourceMappingURL=SavedViews.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SavedViews.d.ts","sourceRoot":"","sources":["../../../src/tools/SavedViews.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EACmB,gBAAgB,EAA+C,IAAI,EAAE,SAAS,EACvG,MAAM,sBAAsB,CAAC;AAI9B;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,SAAS,GAAG,cAAc,CAElE;AAED;;GAEG;AACH,wBAAsB,oBAAoB,CAAC,KAAK,EAAE,cAAc,EAAE,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,SAAS,CAAC,CAW9G;AAED;;;;GAIG;AACH,qBAAa,YAAa,SAAQ,IAAI;IACpC,OAAO,CAAC,MAAM,CAAS;IACvB,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAClD,OAAuB,MAAM,SAAc;IAEpC,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE;IAWV,WAAW,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IAOhD,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC;CAmB9C;AAED;;;;GAIG;AACH,qBAAa,aAAc,SAAQ,IAAI;IACrC,OAAuB,MAAM,SAAe;IAC5C,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAE5B,GAAG,CAAC,IAAI,CAAC,EAAE,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC;IAQvC,WAAW,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAgBvE;AAED;;GAEG;AACH,qBAAa,iBAAkB,SAAQ,IAAI;IACzC,OAAuB,MAAM,SAAmB;IAChD,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAE5B,WAAW,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IAIhD,GAAG,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;CAc7D"}

package/lib/esm/tools/SavedViews.js

@@ -0,0 +1,129 @@
+/*---------------------------------------------------------------------------------------------
+* 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 { BentleyError } from "@itwin/core-bentley";
+import { IModelApp, NotifyMessageDetails, OutputMessagePriority, Tool, } from "@itwin/core-frontend";
+import { copyStringToClipboard } from "../ClipboardUtilities";
+import { parseArgs } from "./parseArgs";
+/** Serialize a ViewState to JSON. The returned JSON can later be passed to [deserializeViewState] to reinstantiate the ViewState.
+ * @beta
+ */
+export function serializeViewState(view) {
+    return view.toProps();
+}
+/** Instantiate a ViewState serialized by [serializeViewState].
+ * @beta
+ */
+export async function deserializeViewState(props, iModel) {
+    const ctor = await iModel.findClassFor(props.viewDefinitionProps.classFullName, undefined);
+    if (undefined === ctor)
+        throw new Error("Class not found");
+    const view = ctor.createFromProps(props, iModel);
+    if (undefined === view)
+        throw new Error("Failed to construct ViewState");
+    await view.load();
+    return view;
+}
+/** Copies a JSON representation of the active viewport's view to the clipboard.
+ *  * Arguments:
+ *  * `quote`: format the JSON so it can be parsed directly by [ApplyViewTool].
+ * @beta
+ */
+export class SaveViewTool extends Tool {
+    constructor() {
+        super(...arguments);
+        this._quote = false;
+    }
+    static get minArgs() { return 0; }
+    static get maxArgs() { return 1; }
+    parse(inputArgs) {
+        const args = parseArgs(inputArgs);
+        function getArg(name) {
+            return args.getBoolean(name) ? true : undefined;
+        }
+        this._quote = true === getArg("q");
+        return true;
+    }
+    async parseAndRun(...args) {
+        if (this.parse(args))
+            return this.run();
+        else
+            return false;
+    }
+    async run() {
+        const vp = IModelApp.viewManager.selectedView;
+        if (undefined === vp) {
+            IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Error, "No viewport"));
+            return true;
+        }
+        try {
+            let json = JSON.stringify(serializeViewState(vp.view));
+            if (this._quote)
+                json = `"${json.replace(/"/g, '""')}"`;
+            copyStringToClipboard(json);
+            IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info, "JSON copied to clipboard"));
+        }
+        catch (err) {
+            IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Error, BentleyError.getErrorMessage(err) || "An unknown error occurred."));
+        }
+        return true;
+    }
+}
+SaveViewTool.toolId = "SaveView";
+/** Given a string containing a JSON representation of a ViewState, applies that ViewState to the active viewport.
+ * The JSON string should be enclosed in double quotes and embedded double quote should be duplicated, example:
+ * - "{""viewDefinitionProps"":{""classFullName"":""BisCore:SpatialViewDefinition"",""id"":""0x1a""}}"
+ * @beta
+ */
+export class ApplyViewTool extends Tool {
+    static get maxArgs() { return 1; }
+    static get minArgs() { return 1; }
+    async run(view) {
+        const vp = IModelApp.viewManager.selectedView;
+        if (undefined !== view && undefined !== vp)
+            vp.changeView(view);
+        return true;
+    }
+    async parseAndRun(...args) {
+        const vp = IModelApp.viewManager.selectedView;
+        if (undefined === vp || 0 === args.length)
+            return true;
+        try {
+            const json = JSON.parse(args[0]);
+            const view = await deserializeViewState(json, vp.iModel);
+            await this.run(view);
+        }
+        catch (err) {
+            IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info, BentleyError.getErrorMessage(err) || "An unknown error occurred."));
+        }
+        return true;
+    }
+}
+ApplyViewTool.toolId = "ApplyView";
+/** Given the Id of a persistent ViewDefinition, applies that view to the active viewport.
+ * @beta
+ */
+export class ApplyViewByIdTool extends Tool {
+    static get minArgs() { return 1; }
+    static get maxArgs() { return 1; }
+    async parseAndRun(...args) {
+        return this.run(args[0]);
+    }
+    async run(viewId) {
+        if (typeof viewId !== "string")
+            return false;
+        const vp = IModelApp.viewManager.selectedView;
+        if (!vp)
+            return false;
+        vp.iModel.views.load(viewId).then((view) => {
+            vp.changeView(view);
+        }).catch(() => { });
+        return true;
+    }
+}
+ApplyViewByIdTool.toolId = "ApplyViewById";
+//# sourceMappingURL=SavedViews.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SavedViews.js","sourceRoot":"","sources":["../../../src/tools/SavedViews.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F;;GAEG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAEnD,OAAO,EACQ,SAAS,EAAoB,oBAAoB,EAAE,qBAAqB,EAAE,IAAI,GAC5F,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AAC9D,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC;;GAEG;AACH,MAAM,UAAU,kBAAkB,CAAC,IAAe;IAChD,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;AACxB,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CAAC,KAAqB,EAAE,MAAwB;IACxF,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,YAAY,CAAqB,KAAK,CAAC,mBAAmB,CAAC,aAAa,EAAE,SAAS,CAAiC,CAAC;IAC/I,IAAI,SAAS,KAAK,IAAI;QACpB,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAErC,MAAM,IAAI,GAAG,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACjD,IAAI,SAAS,KAAK,IAAI;QACpB,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;IAEnD,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;IAClB,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;GAIG;AACH,MAAM,OAAO,YAAa,SAAQ,IAAI;IAAtC;;QACU,WAAM,GAAG,KAAK,CAAC;IA0CzB,CAAC;IAzCQ,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAG3C,KAAK,CAAC,SAAmB;QAC9B,MAAM,IAAI,GAAG,SAAS,CAAC,SAAS,CAAC,CAAC;QAClC,SAAS,MAAM,CAAC,IAAY;YAC1B,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;QAClD,CAAC;QAED,IAAI,CAAC,MAAM,GAAG,IAAI,KAAK,MAAM,CAAC,GAAG,CAAC,CAAC;QAEnC,OAAO,IAAI,CAAC;IACd,CAAC;IAEe,KAAK,CAAC,WAAW,CAAC,GAAG,IAAc;QACjD,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;YAClB,OAAO,IAAI,CAAC,GAAG,EAAE,CAAC;;YAElB,OAAO,KAAK,CAAC;IACjB,CAAC;IAEe,KAAK,CAAC,GAAG;QACvB,MAAM,EAAE,GAAG,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC;QAC9C,IAAI,SAAS,KAAK,EAAE,EAAE;YACpB,SAAS,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,oBAAoB,CAAC,qBAAqB,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC,CAAC;YAC5G,OAAO,IAAI,CAAC;SACb;QAED,IAAI;YACF,IAAI,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;YACvD,IAAI,IAAI,CAAC,MAAM;gBACb,IAAI,GAAG,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC;YACzC,qBAAqB,CAAC,IAAI,CAAC,CAAC;YAC5B,SAAS,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,oBAAoB,CAAC,qBAAqB,CAAC,IAAI,EAAE,0BAA0B,CAAC,CAAC,CAAC;SACzH;QAAC,OAAO,GAAG,EAAE;YACZ,SAAS,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,oBAAoB,CAAC,qBAAqB,CAAC,KAAK,EAAE,YAAY,CAAC,eAAe,CAAC,GAAG,CAAC,IAAI,4BAA4B,CAAC,CAAC,CAAC;SACjK;QAED,OAAO,IAAI,CAAC;IACd,CAAC;;AAtCsB,mBAAM,GAAG,UAAU,CAAC;AAyC7C;;;;GAIG;AACH,MAAM,OAAO,aAAc,SAAQ,IAAI;IAE9B,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAElC,KAAK,CAAC,GAAG,CAAC,IAAgB;QACxC,MAAM,EAAE,GAAG,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC;QAC9C,IAAI,SAAS,KAAK,IAAI,IAAI,SAAS,KAAK,EAAE;YACxC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QAEtB,OAAO,IAAI,CAAC;IACd,CAAC;IAEe,KAAK,CAAC,WAAW,CAAC,GAAG,IAAc;QACjD,MAAM,EAAE,GAAG,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC;QAC9C,IAAI,SAAS,KAAK,EAAE,IAAI,CAAC,KAAK,IAAI,CAAC,MAAM;YACvC,OAAO,IAAI,CAAC;QAEd,IAAI;YACF,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YAEjC,MAAM,IAAI,GAAG,MAAM,oBAAoB,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC;YACzD,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;SACtB;QAAC,OAAO,GAAG,EAAE;YACZ,SAAS,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,oBAAoB,CAAC,qBAAqB,CAAC,IAAI,EAAE,YAAY,CAAC,eAAe,CAAC,GAAG,CAAC,IAAI,4BAA4B,CAAC,CAAC,CAAC;SAChK;QAED,OAAO,IAAI,CAAC;IACd,CAAC;;AA3BsB,oBAAM,GAAG,WAAW,CAAC;AA8B9C;;GAEG;AACH,MAAM,OAAO,iBAAkB,SAAQ,IAAI;IAElC,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAElC,KAAK,CAAC,WAAW,CAAC,GAAG,IAAc;QACjD,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAC3B,CAAC;IAEe,KAAK,CAAC,GAAG,CAAC,MAAe;QACvC,IAAI,OAAO,MAAM,KAAK,QAAQ;YAC5B,OAAO,KAAK,CAAC;QAEf,MAAM,EAAE,GAAG,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC;QAC9C,IAAI,CAAC,EAAE;YACL,OAAO,KAAK,CAAC;QAEf,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;YACzC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QACtB,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;QAEpB,OAAO,IAAI,CAAC;IACd,CAAC;;AArBsB,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 { BentleyError } from \"@itwin/core-bentley\";\r\nimport { ViewStateProps } from \"@itwin/core-common\";\r\nimport {\r\n  EntityState, IModelApp, IModelConnection, NotifyMessageDetails, OutputMessagePriority, Tool, ViewState,\r\n} from \"@itwin/core-frontend\";\r\nimport { copyStringToClipboard } from \"../ClipboardUtilities\";\r\nimport { parseArgs } from \"./parseArgs\";\r\n\r\n/** Serialize a ViewState to JSON. The returned JSON can later be passed to [deserializeViewState] to reinstantiate the ViewState.\r\n * @beta\r\n */\r\nexport function serializeViewState(view: ViewState): ViewStateProps {\r\n  return view.toProps();\r\n}\r\n\r\n/** Instantiate a ViewState serialized by [serializeViewState].\r\n * @beta\r\n */\r\nexport async function deserializeViewState(props: ViewStateProps, iModel: IModelConnection): Promise<ViewState> {\r\n  const ctor = await iModel.findClassFor<typeof EntityState>(props.viewDefinitionProps.classFullName, undefined) as typeof ViewState | undefined;\r\n  if (undefined === ctor)\r\n    throw new Error(\"Class not found\");\r\n\r\n  const view = ctor.createFromProps(props, iModel);\r\n  if (undefined === view)\r\n    throw new Error(\"Failed to construct ViewState\");\r\n\r\n  await view.load();\r\n  return view;\r\n}\r\n\r\n/** Copies a JSON representation of the active viewport's view to the clipboard.\r\n *  * Arguments:\r\n *  * `quote`: format the JSON so it can be parsed directly by [ApplyViewTool].\r\n * @beta\r\n */\r\nexport class SaveViewTool extends Tool {\r\n  private _quote = false;\r\n  public static override get minArgs() { return 0; }\r\n  public static override get maxArgs() { return 1; }\r\n  public static override toolId = \"SaveView\";\r\n\r\n  public parse(inputArgs: string[]) {\r\n    const args = parseArgs(inputArgs);\r\n    function getArg(name: string): true | undefined {\r\n      return args.getBoolean(name) ? true : undefined;\r\n    }\r\n\r\n    this._quote = true === getArg(\"q\");\r\n\r\n    return true;\r\n  }\r\n\r\n  public override async parseAndRun(...args: string[]): Promise<boolean> {\r\n    if (this.parse(args))\r\n      return this.run();\r\n    else\r\n      return false;\r\n  }\r\n\r\n  public override async run(): Promise<boolean> {\r\n    const vp = IModelApp.viewManager.selectedView;\r\n    if (undefined === vp) {\r\n      IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Error, \"No viewport\"));\r\n      return true;\r\n    }\r\n\r\n    try {\r\n      let json = JSON.stringify(serializeViewState(vp.view));\r\n      if (this._quote)\r\n        json = `\"${json.replace(/\"/g, '\"\"')}\"`;\r\n      copyStringToClipboard(json);\r\n      IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info, \"JSON copied to clipboard\"));\r\n    } catch (err) {\r\n      IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Error, BentleyError.getErrorMessage(err) || \"An unknown error occurred.\"));\r\n    }\r\n\r\n    return true;\r\n  }\r\n}\r\n\r\n/** Given a string containing a JSON representation of a ViewState, applies that ViewState to the active viewport.\r\n * The JSON string should be enclosed in double quotes and embedded double quote should be duplicated, example:\r\n * - \"{\"\"viewDefinitionProps\"\":{\"\"classFullName\"\":\"\"BisCore:SpatialViewDefinition\"\",\"\"id\"\":\"\"0x1a\"\"}}\"\r\n * @beta\r\n */\r\nexport class ApplyViewTool extends Tool {\r\n  public static override toolId = \"ApplyView\";\r\n  public static override get maxArgs() { return 1; }\r\n  public static override get minArgs() { return 1; }\r\n\r\n  public override async run(view?: ViewState): Promise<boolean> {\r\n    const vp = IModelApp.viewManager.selectedView;\r\n    if (undefined !== view && undefined !== vp)\r\n      vp.changeView(view);\r\n\r\n    return true;\r\n  }\r\n\r\n  public override async parseAndRun(...args: string[]): Promise<boolean> {\r\n    const vp = IModelApp.viewManager.selectedView;\r\n    if (undefined === vp || 0 === args.length)\r\n      return true;\r\n\r\n    try {\r\n      const json = JSON.parse(args[0]);\r\n\r\n      const view = await deserializeViewState(json, vp.iModel);\r\n      await this.run(view);\r\n    } catch (err) {\r\n      IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info, BentleyError.getErrorMessage(err) || \"An unknown error occurred.\"));\r\n    }\r\n\r\n    return true;\r\n  }\r\n}\r\n\r\n/** Given the Id of a persistent ViewDefinition, applies that view to the active viewport.\r\n * @beta\r\n */\r\nexport class ApplyViewByIdTool extends Tool {\r\n  public static override toolId = \"ApplyViewById\";\r\n  public static override get minArgs() { return 1; }\r\n  public static override get maxArgs() { return 1; }\r\n\r\n  public override async parseAndRun(...args: string[]): Promise<boolean> {\r\n    return this.run(args[0]);\r\n  }\r\n\r\n  public override async run(viewId?: string): Promise<boolean> {\r\n    if (typeof viewId !== \"string\")\r\n      return false;\r\n\r\n    const vp = IModelApp.viewManager.selectedView;\r\n    if (!vp)\r\n      return false;\r\n\r\n    vp.iModel.views.load(viewId).then((view) => {\r\n      vp.changeView(view);\r\n    }).catch(() => { });\r\n\r\n    return true;\r\n  }\r\n}\r\n"]}

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

@@ -0,0 +1,17 @@
+/** @packageDocumentation
+ * @module Tools
+ */
+import { Id64Arg } from "@itwin/core-bentley";
+import { Tool } from "@itwin/core-frontend";
+/** Replaces the contents of the selection set with the set of element Ids specified.
+ * Element Ids are separated by whitespace.
+ * @beta
+ */
+export declare class SelectElementsByIdTool extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): undefined;
+    run(ids?: Id64Arg): Promise<boolean>;
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
+//# sourceMappingURL=SelectionTools.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SelectionTools.d.ts","sourceRoot":"","sources":["../../../src/tools/SelectionTools.ts"],"names":[],"mappings":"AAKA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAa,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAEvD;;;GAGG;AACH,qBAAa,sBAAuB,SAAQ,IAAI;IAC9C,OAAuB,MAAM,SAAwB;IACrD,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,cAAwB;IAEpC,GAAG,CAAC,GAAG,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAQpC,WAAW,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAGvE"}

package/lib/esm/tools/SelectionTools.js

@@ -0,0 +1,24 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+import { IModelApp, Tool } from "@itwin/core-frontend";
+/** Replaces the contents of the selection set with the set of element Ids specified.
+ * Element Ids are separated by whitespace.
+ * @beta
+ */
+export class SelectElementsByIdTool extends Tool {
+    static get minArgs() { return 1; }
+    static get maxArgs() { return undefined; }
+    async run(ids) {
+        const vp = IModelApp.viewManager.selectedView;
+        if (undefined !== vp && undefined !== ids)
+            vp.iModel.selectionSet.replace(ids);
+        return true;
+    }
+    async parseAndRun(...args) {
+        return this.run(args);
+    }
+}
+SelectElementsByIdTool.toolId = "SelectElementsById";
+//# sourceMappingURL=SelectionTools.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SelectionTools.js","sourceRoot":"","sources":["../../../src/tools/SelectionTools.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAO/F,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAEvD;;;GAGG;AACH,MAAM,OAAO,sBAAuB,SAAQ,IAAI;IAEvC,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,SAAS,CAAC,CAAC,CAAC;IAE1C,KAAK,CAAC,GAAG,CAAC,GAAa;QACrC,MAAM,EAAE,GAAG,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC;QAC9C,IAAI,SAAS,KAAK,EAAE,IAAI,SAAS,KAAK,GAAG;YACvC,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAEtC,OAAO,IAAI,CAAC;IACd,CAAC;IAEe,KAAK,CAAC,WAAW,CAAC,GAAG,IAAc;QACjD,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC;;AAdsB,6BAAM,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 { Id64Arg } from \"@itwin/core-bentley\";\r\nimport { IModelApp, Tool } from \"@itwin/core-frontend\";\r\n\r\n/** Replaces the contents of the selection set with the set of element Ids specified.\r\n * Element Ids are separated by whitespace.\r\n * @beta\r\n */\r\nexport class SelectElementsByIdTool extends Tool {\r\n  public static override toolId = \"SelectElementsById\";\r\n  public static override get minArgs() { return 1; }\r\n  public static override get maxArgs() { return undefined; }\r\n\r\n  public override async run(ids?: Id64Arg): Promise<boolean> {\r\n    const vp = IModelApp.viewManager.selectedView;\r\n    if (undefined !== vp && undefined !== ids)\r\n      vp.iModel.selectionSet.replace(ids);\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(args);\r\n  }\r\n}\r\n"]}

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

@@ -0,0 +1,16 @@
+/** @packageDocumentation
+ * @module Tools
+ */
+import { GpuMemoryLimit, Tool } from "@itwin/core-frontend";
+/** Adjust the value of [TileAdmin.gpuMemoryLimit]($frontend). This controls how much GPU memory is allowed to be consumed
+ * by tile graphics before the system starts discarding the graphics for the least recently drawn tiles.
+ * @beta
+ */
+export declare class SetGpuMemoryLimitTool extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    run(limit?: GpuMemoryLimit): Promise<boolean>;
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
+//# sourceMappingURL=SetGpuMemoryLimitTool.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SetGpuMemoryLimitTool.d.ts","sourceRoot":"","sources":["../../../src/tools/SetGpuMemoryLimitTool.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,cAAc,EAAa,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAEvE;;;GAGG;AACH,qBAAa,qBAAsB,SAAQ,IAAI;IAC7C,OAAuB,MAAM,SAAuB;IACpD,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAE5B,GAAG,CAAC,KAAK,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAS7C,WAAW,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAKvE"}

package/lib/esm/tools/SetGpuMemoryLimitTool.js

@@ -0,0 +1,30 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Tools
+ */
+import { IModelApp, Tool } from "@itwin/core-frontend";
+/** Adjust the value of [TileAdmin.gpuMemoryLimit]($frontend). This controls how much GPU memory is allowed to be consumed
+ * by tile graphics before the system starts discarding the graphics for the least recently drawn tiles.
+ * @beta
+ */
+export class SetGpuMemoryLimitTool extends Tool {
+    static get minArgs() { return 1; }
+    static get maxArgs() { return 1; }
+    async run(limit) {
+        if (undefined !== limit) {
+            IModelApp.tileAdmin.gpuMemoryLimit = limit;
+            IModelApp.requestNextAnimation();
+        }
+        return true;
+    }
+    async parseAndRun(...args) {
+        const maxBytes = Number.parseInt(args[0], 10);
+        const limit = Number.isNaN(maxBytes) ? args[0] : maxBytes;
+        return this.run(limit);
+    }
+}
+SetGpuMemoryLimitTool.toolId = "SetGpuMemoryLimit";
+//# sourceMappingURL=SetGpuMemoryLimitTool.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SetGpuMemoryLimitTool.js","sourceRoot":"","sources":["../../../src/tools/SetGpuMemoryLimitTool.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAkB,SAAS,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAEvE;;;GAGG;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,KAAsB;QAC9C,IAAI,SAAS,KAAK,KAAK,EAAE;YACvB,SAAS,CAAC,SAAS,CAAC,cAAc,GAAG,KAAK,CAAC;YAC3C,SAAS,CAAC,oBAAoB,EAAE,CAAC;SAClC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAEe,KAAK,CAAC,WAAW,CAAC,GAAG,IAAc;QACjD,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QAC9C,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAmB,CAAC,CAAC,CAAC,QAAQ,CAAC;QAC5E,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACzB,CAAC;;AAjBsB,4BAAM,GAAG,mBAAmB,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Tools\n */\n\nimport { GpuMemoryLimit, IModelApp, Tool } from \"@itwin/core-frontend\";\n\n/** Adjust the value of [TileAdmin.gpuMemoryLimit]($frontend). This controls how much GPU memory is allowed to be consumed\n * by tile graphics before the system starts discarding the graphics for the least recently drawn tiles.\n * @beta\n */\nexport class SetGpuMemoryLimitTool extends Tool {\n  public static override toolId = \"SetGpuMemoryLimit\";\n  public static override get minArgs() { return 1; }\n  public static override get maxArgs() { return 1; }\n\n  public override async run(limit?: GpuMemoryLimit): Promise<boolean> {\n    if (undefined !== limit) {\n      IModelApp.tileAdmin.gpuMemoryLimit = limit;\n      IModelApp.requestNextAnimation();\n    }\n\n    return true;\n  }\n\n  public override async parseAndRun(...args: string[]): Promise<boolean> {\n    const maxBytes = Number.parseInt(args[0], 10);\n    const limit = Number.isNaN(maxBytes) ? args[0] as GpuMemoryLimit : maxBytes;\n    return this.run(limit);\n  }\n}\n"]}

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

@@ -0,0 +1,41 @@
+import { Tool } from "@itwin/core-frontend";
+/** Base class for a tool that can convert between source aspect Ids and element Ids.
+ * A "source aspect Id" is a string that identifies an object (such as an element) in the source document from which the iModel originated.
+ * For example, if the iModel was produced by the MicroStation bridge, the source aspect Id is usually a V8 element Id.
+ * @beta
+ */
+export declare abstract class SourceAspectIdTool extends Tool {
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    protected abstract getECSql(queryId: string): string;
+    run(idToQuery?: string, copyToClipboard?: boolean): Promise<boolean>;
+    parseAndRun(...keyinArgs: string[]): Promise<boolean>;
+    private doQuery;
+}
+/** Given a source aspect Id, output the Id of the corresponding element in the iModel.
+ * A "source aspect Id" is a string that identifies an object (such as an element) in the source document from which the iModel originated.
+ * For example, if the iModel was produced by the MicroStation bridge, the source aspect Id is usually a V8 element Id.
+ * Arguments:
+ *  - `id=elementId` where `elementId` is the numeric Id of the element of interest (e.g., `0x13a6c`; decimal notation is also permitted).
+ *  - `copy=0|1` where `1` indicates the source aspect Id should be copied to the clipboard.
+ * The command outputs to the IModelApp.notifications the corresponding source aspect Id, or "NOT FOUND".
+ * @beta
+ */
+export declare class SourceAspectIdFromElementIdTool extends SourceAspectIdTool {
+    static toolId: string;
+    protected getECSql(queryId: string): string;
+}
+/** Given the Id of an element in the iModel, output the source aspect Id of the object in the source document from which the element originated.
+ * A "source aspect Id" is a string that identifies an object (such as an element) in the source document from which the iModel originated.
+ * For example, if the iModel was produced by the MicroStation bridge, the source aspect Id is usually a V8 element Id.
+ * Arguments:
+ *  - `id=sourceAspectId` where `sourceAspectId` is the string identifier of the object of interest.
+ *  - `copy=0|1` where `1` indicates the element Id should be copied to the clipboard.
+ * The command outputs to the IModelApp.notifications the corresponding element Id, or "NOT FOUND".
+ * @beta
+ */
+export declare class ElementIdFromSourceAspectIdTool extends SourceAspectIdTool {
+    static toolId: string;
+    protected getECSql(queryId: string): string;
+}
+//# sourceMappingURL=SourceAspectIdTools.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SourceAspectIdTools.d.ts","sourceRoot":"","sources":["../../../src/tools/SourceAspectIdTools.ts"],"names":[],"mappings":"AAWA,OAAO,EAA0D,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAIpG;;;;GAIG;AACH,8BAAsB,kBAAmB,SAAQ,IAAI;IACnD,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAElD,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;IAE9B,GAAG,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,eAAe,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAOpE,WAAW,CAAC,GAAG,SAAS,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;YAK7D,OAAO;CAsBtB;AAED;;;;;;;;GAQG;AACH,qBAAa,+BAAgC,SAAQ,kBAAkB;IACrE,OAAuB,MAAM,SAAiC;IAE9D,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;CAG5C;AAED;;;;;;;;GAQG;AACH,qBAAa,+BAAgC,SAAQ,kBAAkB;IACrE,OAAuB,MAAM,SAAiC;IAE9D,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;CAG5C"}

package/lib/esm/tools/SourceAspectIdTools.js

@@ -0,0 +1,81 @@
+/*---------------------------------------------------------------------------------------------
+* 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 { BentleyError } from "@itwin/core-bentley";
+import { QueryRowFormat } from "@itwin/core-common";
+import { IModelApp, NotifyMessageDetails, OutputMessagePriority, Tool } from "@itwin/core-frontend";
+import { copyStringToClipboard } from "../ClipboardUtilities";
+import { parseArgs } from "./parseArgs";
+/** Base class for a tool that can convert between source aspect Ids and element Ids.
+ * A "source aspect Id" is a string that identifies an object (such as an element) in the source document from which the iModel originated.
+ * For example, if the iModel was produced by the MicroStation bridge, the source aspect Id is usually a V8 element Id.
+ * @beta
+ */
+export class SourceAspectIdTool extends Tool {
+    static get minArgs() { return 1; }
+    static get maxArgs() { return 2; }
+    async run(idToQuery, copyToClipboard) {
+        if (typeof idToQuery === "string")
+            await this.doQuery(idToQuery, true === copyToClipboard);
+        return true;
+    }
+    async parseAndRun(...keyinArgs) {
+        const args = parseArgs(keyinArgs);
+        return this.run(args.get("i"), args.getBoolean("c"));
+    }
+    async doQuery(queryId, copyToClipboard) {
+        var _a;
+        const imodel = (_a = IModelApp.viewManager.selectedView) === null || _a === void 0 ? void 0 : _a.iModel;
+        if (undefined === imodel)
+            return;
+        let resultId;
+        try {
+            for await (const row of imodel.query(this.getECSql(queryId), undefined, QueryRowFormat.UseJsPropertyNames, { limit: { count: 1 } }))
+                resultId = row.resultId;
+        }
+        catch (ex) {
+            resultId = BentleyError.getErrorMessage(ex);
+        }
+        if (typeof resultId !== "string")
+            resultId = "NOT FOUND";
+        if (copyToClipboard)
+            copyStringToClipboard(resultId);
+        const message = `${queryId} => ${resultId}`;
+        IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info, message));
+    }
+}
+/** Given a source aspect Id, output the Id of the corresponding element in the iModel.
+ * A "source aspect Id" is a string that identifies an object (such as an element) in the source document from which the iModel originated.
+ * For example, if the iModel was produced by the MicroStation bridge, the source aspect Id is usually a V8 element Id.
+ * Arguments:
+ *  - `id=elementId` where `elementId` is the numeric Id of the element of interest (e.g., `0x13a6c`; decimal notation is also permitted).
+ *  - `copy=0|1` where `1` indicates the source aspect Id should be copied to the clipboard.
+ * The command outputs to the IModelApp.notifications the corresponding source aspect Id, or "NOT FOUND".
+ * @beta
+ */
+export class SourceAspectIdFromElementIdTool extends SourceAspectIdTool {
+    getECSql(queryId) {
+        return `SELECT Identifier as resultId FROM BisCore.ExternalSourceAspect WHERE Element.Id=${queryId} AND [Kind]='Element'`;
+    }
+}
+SourceAspectIdFromElementIdTool.toolId = "SourceAspectIdFromElementId";
+/** Given the Id of an element in the iModel, output the source aspect Id of the object in the source document from which the element originated.
+ * A "source aspect Id" is a string that identifies an object (such as an element) in the source document from which the iModel originated.
+ * For example, if the iModel was produced by the MicroStation bridge, the source aspect Id is usually a V8 element Id.
+ * Arguments:
+ *  - `id=sourceAspectId` where `sourceAspectId` is the string identifier of the object of interest.
+ *  - `copy=0|1` where `1` indicates the element Id should be copied to the clipboard.
+ * The command outputs to the IModelApp.notifications the corresponding element Id, or "NOT FOUND".
+ * @beta
+ */
+export class ElementIdFromSourceAspectIdTool extends SourceAspectIdTool {
+    getECSql(queryId) {
+        return `SELECT Element.Id as resultId FROM BisCore.ExternalSourceAspect WHERE Identifier='${queryId}' AND [Kind]='Element'`;
+    }
+}
+ElementIdFromSourceAspectIdTool.toolId = "ElementIdFromSourceAspectId";
+//# sourceMappingURL=SourceAspectIdTools.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SourceAspectIdTools.js","sourceRoot":"","sources":["../../../src/tools/SourceAspectIdTools.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F;;GAEG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAE,SAAS,EAAE,oBAAoB,EAAE,qBAAqB,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AACpG,OAAO,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AAC9D,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC;;;;GAIG;AACH,MAAM,OAAgB,kBAAmB,SAAQ,IAAI;IAC5C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAIlC,KAAK,CAAC,GAAG,CAAC,SAAkB,EAAE,eAAyB;QACrE,IAAI,OAAO,SAAS,KAAK,QAAQ;YAC/B,MAAM,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,IAAI,KAAK,eAAe,CAAC,CAAC;QAE1D,OAAO,IAAI,CAAC;IACd,CAAC;IAEe,KAAK,CAAC,WAAW,CAAC,GAAG,SAAmB;QACtD,MAAM,IAAI,GAAG,SAAS,CAAC,SAAS,CAAC,CAAC;QAClC,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;IACvD,CAAC;IAEO,KAAK,CAAC,OAAO,CAAC,OAAe,EAAE,eAAwB;;QAC7D,MAAM,MAAM,GAAG,MAAA,SAAS,CAAC,WAAW,CAAC,YAAY,0CAAE,MAAM,CAAC;QAC1D,IAAI,SAAS,KAAK,MAAM;YACtB,OAAO;QAET,IAAI,QAAQ,CAAC;QACb,IAAI;YACF,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,EAAE,cAAc,CAAC,kBAAkB,EAAE,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC;gBACjI,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;SAC3B;QAAC,OAAO,EAAE,EAAE;YACX,QAAQ,GAAG,YAAY,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC;SAC7C;QAED,IAAI,OAAO,QAAQ,KAAK,QAAQ;YAC9B,QAAQ,GAAG,WAAW,CAAC;QAEzB,IAAI,eAAe;YACjB,qBAAqB,CAAC,QAAQ,CAAC,CAAC;QAElC,MAAM,OAAO,GAAG,GAAG,OAAO,OAAO,QAAQ,EAAE,CAAC;QAC5C,SAAS,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,oBAAoB,CAAC,qBAAqB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;IACvG,CAAC;CACF;AAED;;;;;;;;GAQG;AACH,MAAM,OAAO,+BAAgC,SAAQ,kBAAkB;IAG3D,QAAQ,CAAC,OAAe;QAChC,OAAO,oFAAoF,OAAO,uBAAuB,CAAC;IAC5H,CAAC;;AAJsB,sCAAM,GAAG,6BAA6B,CAAC;AAOhE;;;;;;;;GAQG;AACH,MAAM,OAAO,+BAAgC,SAAQ,kBAAkB;IAG3D,QAAQ,CAAC,OAAe;QAChC,OAAO,qFAAqF,OAAO,wBAAwB,CAAC;IAC9H,CAAC;;AAJsB,sCAAM,GAAG,6BAA6B,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 { BentleyError } from \"@itwin/core-bentley\";\r\nimport { QueryRowFormat } from \"@itwin/core-common\";\r\nimport { IModelApp, NotifyMessageDetails, OutputMessagePriority, Tool } from \"@itwin/core-frontend\";\r\nimport { copyStringToClipboard } from \"../ClipboardUtilities\";\r\nimport { parseArgs } from \"./parseArgs\";\r\n\r\n/** Base class for a tool that can convert between source aspect Ids and element Ids.\r\n * A \"source aspect Id\" is a string that identifies an object (such as an element) in the source document from which the iModel originated.\r\n * For example, if the iModel was produced by the MicroStation bridge, the source aspect Id is usually a V8 element Id.\r\n * @beta\r\n */\r\nexport abstract class SourceAspectIdTool extends Tool {\r\n  public static override get minArgs() { return 1; }\r\n  public static override get maxArgs() { return 2; }\r\n\r\n  protected abstract getECSql(queryId: string): string;\r\n\r\n  public override async run(idToQuery?: string, copyToClipboard?: boolean): Promise<boolean> {\r\n    if (typeof idToQuery === \"string\")\r\n      await this.doQuery(idToQuery, true === copyToClipboard);\r\n\r\n    return true;\r\n  }\r\n\r\n  public override async parseAndRun(...keyinArgs: string[]): Promise<boolean> {\r\n    const args = parseArgs(keyinArgs);\r\n    return this.run(args.get(\"i\"), args.getBoolean(\"c\"));\r\n  }\r\n\r\n  private async doQuery(queryId: string, copyToClipboard: boolean): Promise<void> {\r\n    const imodel = IModelApp.viewManager.selectedView?.iModel;\r\n    if (undefined === imodel)\r\n      return;\r\n\r\n    let resultId;\r\n    try {\r\n      for await (const row of imodel.query(this.getECSql(queryId), undefined, QueryRowFormat.UseJsPropertyNames, { limit: { count: 1 } }))\r\n        resultId = row.resultId;\r\n    } catch (ex) {\r\n      resultId = BentleyError.getErrorMessage(ex);\r\n    }\r\n\r\n    if (typeof resultId !== \"string\")\r\n      resultId = \"NOT FOUND\";\r\n\r\n    if (copyToClipboard)\r\n      copyStringToClipboard(resultId);\r\n\r\n    const message = `${queryId} => ${resultId}`;\r\n    IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info, message));\r\n  }\r\n}\r\n\r\n/** Given a source aspect Id, output the Id of the corresponding element in the iModel.\r\n * A \"source aspect Id\" is a string that identifies an object (such as an element) in the source document from which the iModel originated.\r\n * For example, if the iModel was produced by the MicroStation bridge, the source aspect Id is usually a V8 element Id.\r\n * Arguments:\r\n *  - `id=elementId` where `elementId` is the numeric Id of the element of interest (e.g., `0x13a6c`; decimal notation is also permitted).\r\n *  - `copy=0|1` where `1` indicates the source aspect Id should be copied to the clipboard.\r\n * The command outputs to the IModelApp.notifications the corresponding source aspect Id, or \"NOT FOUND\".\r\n * @beta\r\n */\r\nexport class SourceAspectIdFromElementIdTool extends SourceAspectIdTool {\r\n  public static override toolId = \"SourceAspectIdFromElementId\";\r\n\r\n  protected getECSql(queryId: string): string {\r\n    return `SELECT Identifier as resultId FROM BisCore.ExternalSourceAspect WHERE Element.Id=${queryId} AND [Kind]='Element'`;\r\n  }\r\n}\r\n\r\n/** Given the Id of an element in the iModel, output the source aspect Id of the object in the source document from which the element originated.\r\n * A \"source aspect Id\" is a string that identifies an object (such as an element) in the source document from which the iModel originated.\r\n * For example, if the iModel was produced by the MicroStation bridge, the source aspect Id is usually a V8 element Id.\r\n * Arguments:\r\n *  - `id=sourceAspectId` where `sourceAspectId` is the string identifier of the object of interest.\r\n *  - `copy=0|1` where `1` indicates the element Id should be copied to the clipboard.\r\n * The command outputs to the IModelApp.notifications the corresponding element Id, or \"NOT FOUND\".\r\n * @beta\r\n */\r\nexport class ElementIdFromSourceAspectIdTool extends SourceAspectIdTool {\r\n  public static override toolId = \"ElementIdFromSourceAspectId\";\r\n\r\n  protected getECSql(queryId: string): string {\r\n    return `SELECT Element.Id as resultId FROM BisCore.ExternalSourceAspect WHERE Identifier='${queryId}' AND [Kind]='Element'`;\r\n  }\r\n}\r\n"]}

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

@@ -0,0 +1,13 @@
+import { Tool } from "@itwin/core-frontend";
+/** Display in every viewport a range graphic for every tile currently being requested for the viewport that was initially selected when the decorator was installed.
+ * Green indicates queued (http request not yet sent), red indicates active (http request sent). White indicates unexpected state.
+ * @beta
+ */
+export declare class ToggleTileRequestDecorationTool extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    run(enable?: boolean): Promise<boolean>;
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
+//# sourceMappingURL=TileRequestDecoration.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"TileRequestDecoration.d.ts","sourceRoot":"","sources":["../../../src/tools/TileRequestDecoration.ts"],"names":[],"mappings":"AAUA,OAAO,EAAqE,IAAI,EAAY,MAAM,sBAAsB,CAAC;AAgEzH;;;GAGG;AACH,qBAAa,+BAAgC,SAAQ,IAAI;IACvD,OAAuB,MAAM,SAAiC;IAC9D,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAE5B,GAAG,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAQvC,WAAW,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAOvE"}

package/lib/esm/tools/TileRequestDecoration.js

@@ -0,0 +1,80 @@
+/*---------------------------------------------------------------------------------------------
+* 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";
+class TileRequestDecoration {
+    constructor(vp) {
+        /** This will allow the render system to cache and reuse the decorations created by this decorator's decorate() method. */
+        this.useCachedDecorations = true;
+        this._targetVp = vp;
+        this._removeDecorator = IModelApp.viewManager.addDecorator(this);
+    }
+    stop() {
+        if (this._removeDecorator) {
+            this._removeDecorator();
+            this._removeDecorator = undefined;
+        }
+    }
+    decorate(context) {
+        const tiles = IModelApp.tileAdmin.getRequestsForViewport(this._targetVp);
+        if (undefined === tiles)
+            return;
+        const map = new Map();
+        for (const tile of tiles) {
+            let builder = map.get(tile.tree);
+            if (undefined === builder) {
+                builder = context.createGraphicBuilder(GraphicType.WorldDecoration, tile.tree.iModelTransform);
+                map.set(tile.tree, builder);
+            }
+            let color = ColorDef.white;
+            if (undefined !== tile.request)
+                color = tile.request.isQueued ? ColorDef.green : ColorDef.red;
+            builder.setSymbology(color, color, 1, LinePixels.Solid);
+            builder.addRangeBox(tile.range);
+        }
+        for (const builder of map.values())
+            context.addDecorationFromBuilder(builder);
+    }
+    static toggle(vp, enabled) {
+        const instance = TileRequestDecoration._instance;
+        if (undefined !== enabled) {
+            if ((undefined !== instance) === enabled)
+                return;
+        }
+        if (undefined === instance) {
+            TileRequestDecoration._instance = new TileRequestDecoration(vp);
+        }
+        else {
+            instance.stop();
+            TileRequestDecoration._instance = undefined;
+        }
+    }
+}
+/** Display in every viewport a range graphic for every tile currently being requested for the viewport that was initially selected when the decorator was installed.
+ * Green indicates queued (http request not yet sent), red indicates active (http request sent). White indicates unexpected state.
+ * @beta
+ */
+export class ToggleTileRequestDecorationTool extends Tool {
+    static get minArgs() { return 0; }
+    static get maxArgs() { return 1; }
+    async run(enable) {
+        const vp = IModelApp.viewManager.selectedView;
+        if (undefined !== vp)
+            TileRequestDecoration.toggle(vp, enable);
+        return true;
+    }
+    async parseAndRun(...args) {
+        const enable = parseToggle(args[0]);
+        if (typeof enable !== "string")
+            await this.run(enable);
+        return true;
+    }
+}
+ToggleTileRequestDecorationTool.toolId = "ToggleTileRequestDecoration";
+//# sourceMappingURL=TileRequestDecoration.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"TileRequestDecoration.js","sourceRoot":"","sources":["../../../src/tools/TileRequestDecoration.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F;;GAEG;AAEH,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAC1D,OAAO,EAAmC,WAAW,EAAE,SAAS,EAAY,IAAI,EAAY,MAAM,sBAAsB,CAAC;AACzH,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,MAAM,qBAAqB;IAKzB,YAAoB,EAAY;QAYhC,0HAA0H;QAC1G,yBAAoB,GAAG,IAAI,CAAC;QAZ1C,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QACpB,IAAI,CAAC,gBAAgB,GAAG,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IACnE,CAAC;IAEO,IAAI;QACV,IAAI,IAAI,CAAC,gBAAgB,EAAE;YACzB,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACxB,IAAI,CAAC,gBAAgB,GAAG,SAAS,CAAC;SACnC;IACH,CAAC;IAKM,QAAQ,CAAC,OAAwB;QACtC,MAAM,KAAK,GAAG,SAAS,CAAC,SAAS,CAAC,sBAAsB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACzE,IAAI,SAAS,KAAK,KAAK;YACrB,OAAO;QAET,MAAM,GAAG,GAAG,IAAI,GAAG,EAA4B,CAAC;QAChD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACxB,IAAI,OAAO,GAAG,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACjC,IAAI,SAAS,KAAK,OAAO,EAAE;gBACzB,OAAO,GAAG,OAAO,CAAC,oBAAoB,CAAC,WAAW,CAAC,eAAe,EAAE,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;gBAC/F,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;aAC7B;YAED,IAAI,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC;YAC3B,IAAI,SAAS,KAAK,IAAI,CAAC,OAAO;gBAC5B,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC;YAEhE,OAAO,CAAC,YAAY,CAAC,KAAK,EAAE,KAAK,EAAE,CAAC,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC;YACxD,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;SACjC;QAED,KAAK,MAAM,OAAO,IAAI,GAAG,CAAC,MAAM,EAAE;YAChC,OAAO,CAAC,wBAAwB,CAAC,OAAO,CAAC,CAAC;IAC9C,CAAC;IAEM,MAAM,CAAC,MAAM,CAAC,EAAY,EAAE,OAAiB;QAClD,MAAM,QAAQ,GAAG,qBAAqB,CAAC,SAAS,CAAC;QACjD,IAAI,SAAS,KAAK,OAAO,EAAE;YACzB,IAAI,CAAC,SAAS,KAAK,QAAQ,CAAC,KAAK,OAAO;gBACtC,OAAO;SACV;QAED,IAAI,SAAS,KAAK,QAAQ,EAAE;YAC1B,qBAAqB,CAAC,SAAS,GAAG,IAAI,qBAAqB,CAAC,EAAE,CAAC,CAAC;SACjE;aAAM;YACL,QAAQ,CAAC,IAAI,EAAE,CAAC;YAChB,qBAAqB,CAAC,SAAS,GAAG,SAAS,CAAC;SAC7C;IACH,CAAC;CACF;AAED;;;GAGG;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,MAAgB;QACxC,MAAM,EAAE,GAAG,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC;QAC9C,IAAI,SAAS,KAAK,EAAE;YAClB,qBAAqB,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;QAE3C,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;;AAlBsB,sCAAM,GAAG,6BAA6B,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 { ColorDef, LinePixels } from \"@itwin/core-common\";\r\nimport { DecorateContext, GraphicBuilder, GraphicType, IModelApp, TileTree, Tool, Viewport } from \"@itwin/core-frontend\";\r\nimport { parseToggle } from \"./parseToggle\";\r\n\r\nclass TileRequestDecoration {\r\n  private static _instance?: TileRequestDecoration;\r\n  private _removeDecorator?: () => void;\r\n  private readonly _targetVp: Viewport;\r\n\r\n  private constructor(vp: Viewport) {\r\n    this._targetVp = vp;\r\n    this._removeDecorator = IModelApp.viewManager.addDecorator(this);\r\n  }\r\n\r\n  private stop(): void {\r\n    if (this._removeDecorator) {\r\n      this._removeDecorator();\r\n      this._removeDecorator = undefined;\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 tiles = IModelApp.tileAdmin.getRequestsForViewport(this._targetVp);\r\n    if (undefined === tiles)\r\n      return;\r\n\r\n    const map = new Map<TileTree, GraphicBuilder>();\r\n    for (const tile of tiles) {\r\n      let builder = map.get(tile.tree);\r\n      if (undefined === builder) {\r\n        builder = context.createGraphicBuilder(GraphicType.WorldDecoration, tile.tree.iModelTransform);\r\n        map.set(tile.tree, builder);\r\n      }\r\n\r\n      let color = ColorDef.white;\r\n      if (undefined !== tile.request)\r\n        color = tile.request.isQueued ? ColorDef.green : ColorDef.red;\r\n\r\n      builder.setSymbology(color, color, 1, LinePixels.Solid);\r\n      builder.addRangeBox(tile.range);\r\n    }\r\n\r\n    for (const builder of map.values())\r\n      context.addDecorationFromBuilder(builder);\r\n  }\r\n\r\n  public static toggle(vp: Viewport, enabled?: boolean): void {\r\n    const instance = TileRequestDecoration._instance;\r\n    if (undefined !== enabled) {\r\n      if ((undefined !== instance) === enabled)\r\n        return;\r\n    }\r\n\r\n    if (undefined === instance) {\r\n      TileRequestDecoration._instance = new TileRequestDecoration(vp);\r\n    } else {\r\n      instance.stop();\r\n      TileRequestDecoration._instance = undefined;\r\n    }\r\n  }\r\n}\r\n\r\n/** Display in every viewport a range graphic for every tile currently being requested for the viewport that was initially selected when the decorator was installed.\r\n * Green indicates queued (http request not yet sent), red indicates active (http request sent). White indicates unexpected state.\r\n * @beta\r\n */\r\nexport class ToggleTileRequestDecorationTool extends Tool {\r\n  public static override toolId = \"ToggleTileRequestDecoration\";\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)\r\n      TileRequestDecoration.toggle(vp, enable);\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/TileTreeBoundsDecoration.d.ts

@@ -0,0 +1,12 @@
+import { Tool } from "@itwin/core-frontend";
+/** Display in every viewport a green range graphic for each displayed tile tree, plus a red range graphic for each tile tree's content range if defined.
+ * @beta
+ */
+export declare class ToggleTileTreeBoundsDecorationTool extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    run(enable?: boolean): Promise<boolean>;
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
+//# sourceMappingURL=TileTreeBoundsDecoration.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"TileTreeBoundsDecoration.d.ts","sourceRoot":"","sources":["../../../src/tools/TileTreeBoundsDecoration.ts"],"names":[],"mappings":"AAUA,OAAO,EAA8D,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAyDxG;;GAEG;AACH,qBAAa,kCAAmC,SAAQ,IAAI;IAC1D,OAAuB,MAAM,SAAoC;IACjE,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAE5B,GAAG,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAKvC,WAAW,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAOvE"}