@itwin/frontend-devtools 3.0.0-dev.72

package/lib/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"}

package/lib/tools/TileTreeBoundsDecoration.js

@@ -0,0 +1,75 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ToggleTileTreeBoundsDecorationTool = void 0;
+/** @packageDocumentation
+ * @module Tools
+ */
+const core_common_1 = require("@itwin/core-common");
+const core_frontend_1 = require("@itwin/core-frontend");
+const parseToggle_1 = require("./parseToggle");
+class TreeDecoration {
+    constructor() {
+        /** This will allow the render system to cache and reuse the decorations created by this decorator's decorate() method. */
+        this.useCachedDecorations = true;
+        this._removeMe = core_frontend_1.IModelApp.viewManager.addDecorator(this);
+    }
+    stop() {
+        if (this._removeMe) {
+            this._removeMe();
+            this._removeMe = undefined;
+        }
+    }
+    decorate(context) {
+        context.viewport.forEachTileTreeRef((ref) => this.drawBoundingBox(ref, context));
+    }
+    drawBoundingBox(ref, context) {
+        const tree = ref.treeOwner.tileTree;
+        const location = ref.getLocation();
+        if (undefined === location || undefined === tree || tree.isContentUnbounded || tree.range.isNull)
+            return;
+        const builder = context.createGraphicBuilder(core_frontend_1.GraphicType.WorldDecoration, location);
+        builder.setSymbology(core_common_1.ColorDef.green, core_common_1.ColorDef.green, 1, core_common_1.LinePixels.Solid);
+        builder.addRangeBox(tree.range);
+        if (undefined !== tree.contentRange) {
+            builder.setSymbology(core_common_1.ColorDef.red, core_common_1.ColorDef.red, 1, core_common_1.LinePixels.Solid);
+            builder.addRangeBox(tree.contentRange);
+        }
+        context.addDecorationFromBuilder(builder);
+    }
+    static toggle(enabled) {
+        const instance = TreeDecoration._instance;
+        if (undefined !== enabled && (undefined !== instance) === enabled)
+            return;
+        if (undefined === instance) {
+            TreeDecoration._instance = new TreeDecoration();
+        }
+        else {
+            instance.stop();
+            TreeDecoration._instance = undefined;
+        }
+    }
+}
+/** 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
+ */
+class ToggleTileTreeBoundsDecorationTool extends core_frontend_1.Tool {
+    static get minArgs() { return 0; }
+    static get maxArgs() { return 1; }
+    async run(enable) {
+        TreeDecoration.toggle(enable);
+        return true;
+    }
+    async parseAndRun(...args) {
+        const enable = (0, parseToggle_1.parseToggle)(args[0]);
+        if (typeof enable !== "string")
+            await this.run(enable);
+        return true;
+    }
+}
+exports.ToggleTileTreeBoundsDecorationTool = ToggleTileTreeBoundsDecorationTool;
+ToggleTileTreeBoundsDecorationTool.toolId = "ToggleTileTreeBoundsDecoration";
+//# sourceMappingURL=TileTreeBoundsDecoration.js.map

package/lib/tools/TileTreeBoundsDecoration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TileTreeBoundsDecoration.js","sourceRoot":"","sources":["../../src/tools/TileTreeBoundsDecoration.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F;;GAEG;AAEH,oDAA0D;AAC1D,wDAAwG;AACxG,+CAA4C;AAE5C,MAAM,cAAc;IAIlB;QAWA,0HAA0H;QAC1G,yBAAoB,GAAG,IAAI,CAAC;QAX1C,IAAI,CAAC,SAAS,GAAG,yBAAS,CAAC,WAAW,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IAC5D,CAAC;IAEO,IAAI;QACV,IAAI,IAAI,CAAC,SAAS,EAAE;YAClB,IAAI,CAAC,SAAS,EAAE,CAAC;YACjB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;SAC5B;IACH,CAAC;IAKM,QAAQ,CAAC,OAAwB;QACtC,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC;IACnF,CAAC;IAEO,eAAe,CAAC,GAAsB,EAAE,OAAwB;QACtE,MAAM,IAAI,GAAG,GAAG,CAAC,SAAS,CAAC,QAAQ,CAAC;QACpC,MAAM,QAAQ,GAAG,GAAG,CAAC,WAAW,EAAE,CAAC;QACnC,IAAI,SAAS,KAAK,QAAQ,IAAI,SAAS,KAAK,IAAI,IAAI,IAAI,CAAC,kBAAkB,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM;YAC9F,OAAO;QAET,MAAM,OAAO,GAAG,OAAO,CAAC,oBAAoB,CAAC,2BAAW,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAC;QACpF,OAAO,CAAC,YAAY,CAAC,sBAAQ,CAAC,KAAK,EAAE,sBAAQ,CAAC,KAAK,EAAE,CAAC,EAAE,wBAAU,CAAC,KAAK,CAAC,CAAC;QAC1E,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAEhC,IAAI,SAAS,KAAK,IAAI,CAAC,YAAY,EAAE;YACnC,OAAO,CAAC,YAAY,CAAC,sBAAQ,CAAC,GAAG,EAAE,sBAAQ,CAAC,GAAG,EAAE,CAAC,EAAE,wBAAU,CAAC,KAAK,CAAC,CAAC;YACtE,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;SACxC;QAED,OAAO,CAAC,wBAAwB,CAAC,OAAO,CAAC,CAAC;IAC5C,CAAC;IAEM,MAAM,CAAC,MAAM,CAAC,OAAiB;QACpC,MAAM,QAAQ,GAAG,cAAc,CAAC,SAAS,CAAC;QAC1C,IAAI,SAAS,KAAK,OAAO,IAAI,CAAC,SAAS,KAAK,QAAQ,CAAC,KAAK,OAAO;YAC/D,OAAO;QAET,IAAI,SAAS,KAAK,QAAQ,EAAE;YAC1B,cAAc,CAAC,SAAS,GAAG,IAAI,cAAc,EAAE,CAAC;SACjD;aAAM;YACL,QAAQ,CAAC,IAAI,EAAE,CAAC;YAChB,cAAc,CAAC,SAAS,GAAG,SAAS,CAAC;SACtC;IACH,CAAC;CACF;AAED;;GAEG;AACH,MAAa,kCAAmC,SAAQ,oBAAI;IAEnD,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,cAAc,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC9B,OAAO,IAAI,CAAC;IACd,CAAC;IAEe,KAAK,CAAC,WAAW,CAAC,GAAG,IAAc;QACjD,MAAM,MAAM,GAAG,IAAA,yBAAW,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QACpC,IAAI,OAAO,MAAM,KAAK,QAAQ;YAC5B,MAAM,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAEzB,OAAO,IAAI,CAAC;IACd,CAAC;;AAhBH,gFAiBC;AAhBwB,yCAAM,GAAG,gCAAgC,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, GraphicType, IModelApp, TileTreeReference, Tool } from \"@itwin/core-frontend\";\r\nimport { parseToggle } from \"./parseToggle\";\r\n\r\nclass TreeDecoration {\r\n  private static _instance?: TreeDecoration;\r\n  private _removeMe?: () => void;\r\n\r\n  private constructor() {\r\n    this._removeMe = IModelApp.viewManager.addDecorator(this);\r\n  }\r\n\r\n  private stop() {\r\n    if (this._removeMe) {\r\n      this._removeMe();\r\n      this._removeMe = 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    context.viewport.forEachTileTreeRef((ref) => this.drawBoundingBox(ref, context));\r\n  }\r\n\r\n  private drawBoundingBox(ref: TileTreeReference, context: DecorateContext): void {\r\n    const tree = ref.treeOwner.tileTree;\r\n    const location = ref.getLocation();\r\n    if (undefined === location || undefined === tree || tree.isContentUnbounded || tree.range.isNull)\r\n      return;\r\n\r\n    const builder = context.createGraphicBuilder(GraphicType.WorldDecoration, location);\r\n    builder.setSymbology(ColorDef.green, ColorDef.green, 1, LinePixels.Solid);\r\n    builder.addRangeBox(tree.range);\r\n\r\n    if (undefined !== tree.contentRange) {\r\n      builder.setSymbology(ColorDef.red, ColorDef.red, 1, LinePixels.Solid);\r\n      builder.addRangeBox(tree.contentRange);\r\n    }\r\n\r\n    context.addDecorationFromBuilder(builder);\r\n  }\r\n\r\n  public static toggle(enabled?: boolean): void {\r\n    const instance = TreeDecoration._instance;\r\n    if (undefined !== enabled && (undefined !== instance) === enabled)\r\n      return;\r\n\r\n    if (undefined === instance) {\r\n      TreeDecoration._instance = new TreeDecoration();\r\n    } else {\r\n      instance.stop();\r\n      TreeDecoration._instance = undefined;\r\n    }\r\n  }\r\n}\r\n\r\n/** 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.\r\n * @beta\r\n */\r\nexport class ToggleTileTreeBoundsDecorationTool extends Tool {\r\n  public static override toolId = \"ToggleTileTreeBoundsDecoration\";\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    TreeDecoration.toggle(enable);\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/tools/ToolTipProvider.d.ts

@@ -0,0 +1,16 @@
+/** @packageDocumentation
+ * @module Tools
+ */
+import { Tool } from "@itwin/core-frontend";
+/** Replaces the default tooltips displayed when mousing over elements to instead display information useful for debugging, including
+ * element, model, subcategory, and tile Ids as well as geometry class.
+ * @beta
+ */
+export declare class ToggleToolTipsTool extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    run(enable?: boolean): Promise<boolean>;
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
+//# sourceMappingURL=ToolTipProvider.d.ts.map

package/lib/tools/ToolTipProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ToolTipProvider.d.ts","sourceRoot":"","sources":["../../src/tools/ToolTipProvider.ts"],"names":[],"mappings":"AAKA;;GAEG;AAEH,OAAO,EAAwB,IAAI,EAAmB,MAAM,sBAAsB,CAAC;AA4CnF;;;GAGG;AACH,qBAAa,kBAAmB,SAAQ,IAAI;IAC1C,OAAuB,MAAM,SAAoB;IACjD,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"}

package/lib/tools/ToolTipProvider.js

@@ -0,0 +1,67 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ToggleToolTipsTool = void 0;
+/** @packageDocumentation
+ * @module Tools
+ */
+const core_frontend_1 = require("@itwin/core-frontend");
+const parseToggle_1 = require("./parseToggle");
+/** Augments tooltips with detailed information useful for debugging.
+ * @internal
+ */
+class DebugToolTipProvider {
+    async augmentToolTip(hit, tooltipPromise) {
+        // discard and overwrite
+        await tooltipPromise;
+        const keys = ["sourceId", "modelId", "subCategoryId", "tileId", "geometryClass"];
+        let html = "";
+        for (const key of keys) {
+            const value = hit[key];
+            if (undefined === value)
+                continue;
+            html = `${html + key}: ${value.toString()}<br>`;
+        }
+        const div = document.createElement("div");
+        div.innerHTML = html;
+        return div;
+    }
+    static setEnabled(enabled) {
+        if (undefined === enabled)
+            enabled = undefined === this._instance;
+        if (enabled) {
+            if (undefined === this._instance) {
+                this._instance = new DebugToolTipProvider();
+                core_frontend_1.IModelApp.viewManager.addToolTipProvider(this._instance);
+            }
+        }
+        else if (undefined !== this._instance) {
+            core_frontend_1.IModelApp.viewManager.dropToolTipProvider(this._instance);
+            this._instance = undefined;
+        }
+    }
+}
+/** Replaces the default tooltips displayed when mousing over elements to instead display information useful for debugging, including
+ * element, model, subcategory, and tile Ids as well as geometry class.
+ * @beta
+ */
+class ToggleToolTipsTool extends core_frontend_1.Tool {
+    static get minArgs() { return 0; }
+    static get maxArgs() { return 1; }
+    async run(enable) {
+        DebugToolTipProvider.setEnabled(enable);
+        return true;
+    }
+    async parseAndRun(...args) {
+        const enable = (0, parseToggle_1.parseToggle)(args[0]);
+        if (typeof enable !== "string")
+            await this.run(enable);
+        return true;
+    }
+}
+exports.ToggleToolTipsTool = ToggleToolTipsTool;
+ToggleToolTipsTool.toolId = "ToggleToolTips";
+//# sourceMappingURL=ToolTipProvider.js.map

package/lib/tools/ToolTipProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ToolTipProvider.js","sourceRoot":"","sources":["../../src/tools/ToolTipProvider.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F;;GAEG;AAEH,wDAAmF;AACnF,+CAA4C;AAE5C;;GAEG;AACH,MAAM,oBAAoB;IAGjB,KAAK,CAAC,cAAc,CAAC,GAAc,EAAE,cAA6C;QACvF,wBAAwB;QACxB,MAAM,cAAc,CAAC;QAErB,MAAM,IAAI,GAA2B,CAAC,UAAU,EAAE,SAAS,EAAE,eAAe,EAAE,QAAQ,EAAE,eAAe,CAAC,CAAC;QACzG,IAAI,IAAI,GAAG,EAAE,CAAC;QACd,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;YACtB,MAAM,KAAK,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;YACvB,IAAI,SAAS,KAAK,KAAK;gBACrB,SAAS;YAEX,IAAI,GAAG,GAAG,IAAI,GAAG,GAAG,KAAK,KAAK,CAAC,QAAQ,EAAE,MAAM,CAAC;SACjD;QAED,MAAM,GAAG,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAC1C,GAAG,CAAC,SAAS,GAAG,IAAI,CAAC;QACrB,OAAO,GAAG,CAAC;IACb,CAAC;IAEM,MAAM,CAAC,UAAU,CAAC,OAA4B;QACnD,IAAI,SAAS,KAAK,OAAO;YACvB,OAAO,GAAG,SAAS,KAAK,IAAI,CAAC,SAAS,CAAC;QAEzC,IAAI,OAAO,EAAE;YACX,IAAI,SAAS,KAAK,IAAI,CAAC,SAAS,EAAE;gBAChC,IAAI,CAAC,SAAS,GAAG,IAAI,oBAAoB,EAAE,CAAC;gBAC5C,yBAAS,CAAC,WAAW,CAAC,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;aAC1D;SACF;aAAM,IAAI,SAAS,KAAK,IAAI,CAAC,SAAS,EAAE;YACvC,yBAAS,CAAC,WAAW,CAAC,mBAAmB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAC1D,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;SAC5B;IACH,CAAC;CACF;AAED;;;GAGG;AACH,MAAa,kBAAmB,SAAQ,oBAAI;IAEnC,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,oBAAoB,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC;IACd,CAAC;IAEe,KAAK,CAAC,WAAW,CAAC,GAAG,IAAc;QACjD,MAAM,MAAM,GAAG,IAAA,yBAAW,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QACpC,IAAI,OAAO,MAAM,KAAK,QAAQ;YAC5B,MAAM,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAEzB,OAAO,IAAI,CAAC;IACd,CAAC;;AAhBH,gDAiBC;AAhBwB,yBAAM,GAAG,gBAAgB,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 { HitDetail, IModelApp, Tool, ToolTipProvider } from \"@itwin/core-frontend\";\r\nimport { parseToggle } from \"./parseToggle\";\r\n\r\n/** Augments tooltips with detailed information useful for debugging.\r\n * @internal\r\n */\r\nclass DebugToolTipProvider implements ToolTipProvider {\r\n  private static _instance?: DebugToolTipProvider;\r\n\r\n  public async augmentToolTip(hit: HitDetail, tooltipPromise: Promise<HTMLElement | string>): Promise<HTMLElement | string> {\r\n    // discard and overwrite\r\n    await tooltipPromise;\r\n\r\n    const keys: Array<keyof HitDetail> = [\"sourceId\", \"modelId\", \"subCategoryId\", \"tileId\", \"geometryClass\"];\r\n    let html = \"\";\r\n    for (const key of keys) {\r\n      const value = hit[key];\r\n      if (undefined === value)\r\n        continue;\r\n\r\n      html = `${html + key}: ${value.toString()}<br>`;\r\n    }\r\n\r\n    const div = document.createElement(\"div\");\r\n    div.innerHTML = html;\r\n    return div;\r\n  }\r\n\r\n  public static setEnabled(enabled: boolean | undefined): void {\r\n    if (undefined === enabled)\r\n      enabled = undefined === this._instance;\r\n\r\n    if (enabled) {\r\n      if (undefined === this._instance) {\r\n        this._instance = new DebugToolTipProvider();\r\n        IModelApp.viewManager.addToolTipProvider(this._instance);\r\n      }\r\n    } else if (undefined !== this._instance) {\r\n      IModelApp.viewManager.dropToolTipProvider(this._instance);\r\n      this._instance = undefined;\r\n    }\r\n  }\r\n}\r\n\r\n/** Replaces the default tooltips displayed when mousing over elements to instead display information useful for debugging, including\r\n * element, model, subcategory, and tile Ids as well as geometry class.\r\n * @beta\r\n */\r\nexport class ToggleToolTipsTool extends Tool {\r\n  public static override toolId = \"ToggleToolTips\";\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    DebugToolTipProvider.setEnabled(enable);\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/tools/ViewportTools.d.ts

@@ -0,0 +1,194 @@
+import { Camera, Hilite } from "@itwin/core-common";
+import { FlashSettings, TileBoundingBoxes, Tool, Viewport } from "@itwin/core-frontend";
+/** Base class for a tool that toggles some aspect of a Viewport.
+ * @beta
+ */
+export declare abstract class ViewportToggleTool extends Tool {
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    protected abstract toggle(vp: Viewport, enable?: boolean): Promise<void>;
+    run(enable?: boolean): Promise<boolean>;
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
+/** Freeze or unfreeze the scene for the selected viewport. While the scene is frozen, no new tiles will be selected for drawing within the viewport.
+ * @beta
+ */
+export declare class FreezeSceneTool extends ViewportToggleTool {
+    static toolId: string;
+    protected toggle(vp: Viewport, enable?: boolean): Promise<void>;
+}
+/** Set the tile bounding volume decorations to display in the selected viewport.
+ * Omitting the argument turns on Volume bounding boxes if bounding boxes are currently off; otherwise, toggles them off.
+ * Allowed inputs are "none", "volume", "content", "both" (volume and content), "children", and "sphere".
+ * @beta
+ */
+export declare class ShowTileVolumesTool extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    run(boxes?: TileBoundingBoxes): Promise<boolean>;
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
+/** This tool sets the aspect ratio skew for the selected viewport.
+ * @beta
+ */
+export declare class SetAspectRatioSkewTool extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    /** This method runs the tool, setting the aspect ratio skew for the selected viewport.
+     * @param skew the aspect ratio (x/y) skew value; 1.0 or undefined removes any skew
+     */
+    run(skew?: number): Promise<boolean>;
+    /** Executes this tool's run method.
+     * @param args the first entry of this array contains the `skew` argument
+     * @see [[run]]
+     */
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
+/** Changes the selected viewport's hilite or emphasis settings.
+ * @beta
+ */
+export declare abstract class ChangeHiliteTool extends Tool {
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    run(settings?: Hilite.Settings): Promise<boolean>;
+    protected abstract apply(vp: Viewport, settings: Hilite.Settings | undefined): void;
+    protected abstract getCurrentSettings(vp: Viewport): Hilite.Settings;
+    parseAndRun(...inputArgs: string[]): Promise<boolean>;
+}
+/** Changes the selected viewport's hilite settings, or resets to defaults.
+ * @beta
+ */
+export declare class ChangeHiliteSettingsTool extends ChangeHiliteTool {
+    static toolId: string;
+    protected getCurrentSettings(vp: Viewport): Hilite.Settings;
+    protected apply(vp: Viewport, settings?: Hilite.Settings): void;
+}
+/** Changes the selected viewport's emphasis settings.
+ * @beta
+ */
+export declare class ChangeEmphasisSettingsTool extends ChangeHiliteTool {
+    static toolId: string;
+    protected getCurrentSettings(vp: Viewport): Hilite.Settings;
+    protected apply(vp: Viewport, settings?: Hilite.Settings): void;
+}
+/** Changes the [FlashSettings]($frontend) for the selected [Viewport]($frontend).
+ * @beta
+ */
+export declare class ChangeFlashSettingsTool extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    run(settings?: FlashSettings): Promise<boolean>;
+    parseAndRun(...inputArgs: string[]): Promise<boolean>;
+}
+/** Enables or disables fade-out transparency mode for the selected viewport.
+ * @beta
+ */
+export declare class FadeOutTool extends ViewportToggleTool {
+    static toolId: string;
+    protected toggle(vp: Viewport, enable?: boolean): Promise<void>;
+}
+/** Sets the default tile size modifier used for all viewports that don't explicitly override it.
+ * @beta
+ */
+export declare class DefaultTileSizeModifierTool extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    /** This method runs the tool, setting the default tile size modifier used for all viewports that don't explicitly override it.
+     * @param modifier the tile size modifier to use; if undefined, do not set modifier
+     */
+    run(modifier?: number): Promise<boolean>;
+    /** Executes this tool's run method with args[0] containing `modifier`.
+     * @see [[run]]
+     */
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
+/** Sets or clears the tile size modifier override for the selected viewport.
+ * @beta
+ */
+export declare class ViewportTileSizeModifierTool extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    /** This method runs the tool, setting the tile size modifier used for the selected viewport.
+     * @param modifier the tile size modifier to use; if undefined, reset the modifier
+     */
+    run(modifier?: number): Promise<boolean>;
+    /** Executes this tool's run method with args[0] containing the `modifier` argument or the string "reset" in order to reset the modifier.
+     * @see [[run]]
+     */
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
+/** This tool adds a reality model to the viewport.
+ * @beta
+ */
+export declare class ViewportAddRealityModel extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    /** This method runs the tool, adding a reality model to the viewport
+     * @param url the URL which points to the reality model tileset
+     */
+    run(url: string): Promise<boolean>;
+    /** Executes this tool's run method with args[0] containing the `url` argument.
+     * @see [[run]]
+     */
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
+/** Changes the `allow3dManipulations` flag for the selected viewport if the viewport is displaying a `ViewState3d`.
+ * @beta
+ */
+export declare class Toggle3dManipulationsTool extends ViewportToggleTool {
+    static toolId: string;
+    protected toggle(vp: Viewport, allow?: boolean): Promise<void>;
+}
+/** Toggles display of view attachments in sheet views.
+ * @beta
+ */
+export declare class ToggleViewAttachmentsTool extends ViewportToggleTool {
+    static toolId: string;
+    protected toggle(vp: Viewport, enable?: boolean): Promise<void>;
+}
+/** Toggle display of view attachment boundaries in sheet views.
+ * @beta
+ */
+export declare class ToggleViewAttachmentBoundariesTool extends ViewportToggleTool {
+    static toolId: string;
+    protected toggle(vp: Viewport, enable?: boolean): Promise<void>;
+}
+/** Toggle display of view attachment clip shapes in sheet views.
+ * @beta
+ */
+export declare class ToggleViewAttachmentClipShapesTool extends ViewportToggleTool {
+    static toolId: string;
+    protected toggle(vp: Viewport, enable?: boolean): Promise<void>;
+}
+/** Toggles display of 2d graphics in a [DrawingViewState]($frontend). This setting affects all drawing views until it is reset.
+ * @beta
+ */
+export declare class ToggleDrawingGraphicsTool extends ViewportToggleTool {
+    static toolId: string;
+    protected toggle(vp: Viewport, enable?: boolean): Promise<void>;
+}
+/** Toggles whether a [SectionDrawing]($backend)'s spatial view is always displayed along with the 2d graphics by a [DrawingViewState]($frontend), even
+ * if it otherwise would not be. This setting affects all section drawing views until it is reset.
+ * @beta
+ */
+export declare class ToggleSectionDrawingSpatialViewTool extends ViewportToggleTool {
+    static toolId: string;
+    protected toggle(vp: Viewport, enable?: boolean): Promise<void>;
+}
+/** Change the camera settings of the selected viewport.
+ * @beta
+ */
+export declare class ChangeCameraTool extends Tool {
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    static toolId: string;
+    run(camera?: Camera): Promise<boolean>;
+    parseAndRun(...inArgs: string[]): Promise<boolean>;
+}
+//# sourceMappingURL=ViewportTools.d.ts.map

package/lib/tools/ViewportTools.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ViewportTools.d.ts","sourceRoot":"","sources":["../../src/tools/ViewportTools.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,MAAM,EAAY,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC9D,OAAO,EACwB,aAAa,EAAmC,iBAAiB,EAAE,IAAI,EAAE,QAAQ,EAC/G,MAAM,sBAAsB,CAAC;AAI9B;;GAEG;AACH,8BAAsB,kBAAmB,SAAQ,IAAI;IACnD,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAElD,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,EAAE,QAAQ,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAElD,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;AAED;;GAEG;AACH,qBAAa,eAAgB,SAAQ,kBAAkB;IACrD,OAAuB,MAAM,SAAiB;cAErB,MAAM,CAAC,EAAE,EAAE,QAAQ,EAAE,MAAM,CAAC,EAAE,OAAO;CAM/D;AAWD;;;;GAIG;AACH,qBAAa,mBAAoB,SAAQ,IAAI;IAC3C,OAAuB,MAAM,SAAqB;IAClD,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAE5B,GAAG,CAAC,KAAK,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,OAAO,CAAC;IAYhD,WAAW,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAiBvE;AAED;;GAEG;AACH,qBAAa,sBAAuB,SAAQ,IAAI;IAC9C,OAAuB,MAAM,SAAwB;IACrD,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAElD;;OAEG;IACmB,GAAG,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAa1D;;;OAGG;IACmB,WAAW,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAIvE;AAED;;GAEG;AACH,8BAAsB,gBAAiB,SAAQ,IAAI;IACjD,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAE5B,GAAG,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IAQvE,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,CAAC,QAAQ,GAAG,SAAS,GAAG,IAAI;IACnF,SAAS,CAAC,QAAQ,CAAC,kBAAkB,CAAC,EAAE,EAAE,QAAQ,GAAG,MAAM,CAAC,QAAQ;IAE9C,WAAW,CAAC,GAAG,SAAS,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAuD5E;AAED;;GAEG;AACH,qBAAa,wBAAyB,SAAQ,gBAAgB;IAC5D,OAAuB,MAAM,SAA0B;IAEvD,SAAS,CAAC,kBAAkB,CAAC,EAAE,EAAE,QAAQ;IACzC,SAAS,CAAC,KAAK,CAAC,EAAE,EAAE,QAAQ,EAAE,QAAQ,CAAC,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI;CAGhE;AAED;;GAEG;AACH,qBAAa,0BAA2B,SAAQ,gBAAgB;IAC9D,OAAuB,MAAM,SAA4B;IAEzD,SAAS,CAAC,kBAAkB,CAAC,EAAE,EAAE,QAAQ;IACzC,SAAS,CAAC,KAAK,CAAC,EAAE,EAAE,QAAQ,EAAE,QAAQ,CAAC,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI;CAIhE;AAED;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,IAAI;IAC/C,OAAuB,MAAM,SAAyB;IACtD,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAE5B,GAAG,CAAC,QAAQ,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC;IAQ/C,WAAW,CAAC,GAAG,SAAS,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAmC5E;AAED;;GAEG;AACH,qBAAa,WAAY,SAAQ,kBAAkB;IACjD,OAAuB,MAAM,SAAa;cAEjB,MAAM,CAAC,EAAE,EAAE,QAAQ,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;CAM/E;AAED;;GAEG;AACH,qBAAa,2BAA4B,SAAQ,IAAI;IACnD,OAAuB,MAAM,SAAwB;IACrD,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAElD;;OAEG;IACmB,GAAG,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAO9D;;OAEG;IACmB,WAAW,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAGvE;AAED;;GAEG;AACH,qBAAa,4BAA6B,SAAQ,IAAI;IACpD,OAAuB,MAAM,SAAyB;IACtD,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAElD;;OAEG;IACmB,GAAG,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAQ9D;;OAEG;IACmB,WAAW,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAKvE;AAED;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,IAAI;IAC/C,OAAuB,MAAM,SAA6B;IAC1D,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAElD;;OAEG;IACmB,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAQxD;;OAEG;IACmB,WAAW,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAGvE;AAED;;GAEG;AACH,qBAAa,yBAA0B,SAAQ,kBAAkB;IAC/D,OAAuB,MAAM,SAA2B;cAE/B,MAAM,CAAC,EAAE,EAAE,QAAQ,EAAE,KAAK,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;CAe9E;AAED;;GAEG;AACH,qBAAa,yBAA0B,SAAQ,kBAAkB;IAC/D,OAAuB,MAAM,SAA2B;cAE/B,MAAM,CAAC,EAAE,EAAE,QAAQ,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;CAM/E;AAED;;GAEG;AACH,qBAAa,kCAAmC,SAAQ,kBAAkB;IACxE,OAAuB,MAAM,SAAoC;cAExC,MAAM,CAAC,EAAE,EAAE,QAAQ,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;CAM/E;AAED;;GAEG;AACH,qBAAa,kCAAmC,SAAQ,kBAAkB;IACxE,OAAuB,MAAM,SAAoC;cAExC,MAAM,CAAC,EAAE,EAAE,QAAQ,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;CAM/E;AAED;;GAEG;AACH,qBAAa,yBAA0B,SAAQ,kBAAkB;IAC/D,OAAuB,MAAM,SAA2B;cAE/B,MAAM,CAAC,EAAE,EAAE,QAAQ,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;CAQ/E;AAED;;;GAGG;AACH,qBAAa,mCAAoC,SAAQ,kBAAkB;IACzE,OAAuB,MAAM,SAAqC;cAElD,MAAM,CAAC,EAAE,EAAE,QAAQ,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;CAYtE;AAED;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,IAAI;IACxC,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAClD,OAAuB,MAAM,SAAkB;IAEzB,GAAG,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAWtC,WAAW,CAAC,GAAG,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAiBzE"}