@itwin/frontend-devtools 4.0.0-dev.51 → 4.0.0-dev.54

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

@@ -1,12 +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>;
-}
+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.js

@@ -1,71 +1,72 @@
-/*---------------------------------------------------------------------------------------------
-* 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 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 = 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(GraphicType.WorldDecoration, location);
-        builder.setSymbology(ColorDef.green, ColorDef.green, 1, LinePixels.Solid);
-        builder.addRangeBox(tree.range);
-        if (undefined !== tree.contentRange) {
-            builder.setSymbology(ColorDef.red, ColorDef.red, 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
- */
-export class ToggleTileTreeBoundsDecorationTool extends Tool {
-    static get minArgs() { return 0; }
-    static get maxArgs() { return 1; }
-    async run(enable) {
-        TreeDecoration.toggle(enable);
-        return true;
-    }
-    async parseAndRun(...args) {
-        const enable = parseToggle(args[0]);
-        if (typeof enable !== "string")
-            await this.run(enable);
-        return true;
-    }
-}
-ToggleTileTreeBoundsDecorationTool.toolId = "ToggleTileTreeBoundsDecoration";
+/*---------------------------------------------------------------------------------------------
+* 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 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 = 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(GraphicType.WorldDecoration, location);
+        builder.setSymbology(ColorDef.green, ColorDef.green, 1, LinePixels.Solid);
+        builder.addRangeBox(tree.range);
+        if (undefined !== tree.contentRange) {
+            builder.setSymbology(ColorDef.red, ColorDef.red, 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 Tool {
+    static get minArgs() { return 0; }
+    static get maxArgs() { return 1; }
+    async run(enable) {
+        TreeDecoration.toggle(enable);
+        return true;
+    }
+    async parseAndRun(...args) {
+        const enable = parseToggle(args[0]);
+        if (typeof enable !== "string")
+            await this.run(enable);
+        return true;
+    }
+}
+ToggleTileTreeBoundsDecorationTool.toolId = "ToggleTileTreeBoundsDecoration";
+export { ToggleTileTreeBoundsDecorationTool };
 //# sourceMappingURL=TileTreeBoundsDecoration.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"TileTreeBoundsDecoration.js","sourceRoot":"","sources":["../../../src/tools/TileTreeBoundsDecoration.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F;;GAEG;AAEH,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAC1D,OAAO,EAAmB,WAAW,EAAE,SAAS,EAAqB,IAAI,EAAE,MAAM,sBAAsB,CAAC;AACxG,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,MAAM,cAAc;IAIlB;QAWA,0HAA0H;QAC1G,yBAAoB,GAAG,IAAI,CAAC;QAX1C,IAAI,CAAC,SAAS,GAAG,SAAS,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,WAAW,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAC;QACpF,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,KAAK,EAAE,CAAC,EAAE,UAAU,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,QAAQ,CAAC,GAAG,EAAE,QAAQ,CAAC,GAAG,EAAE,CAAC,EAAE,UAAU,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,MAAM,OAAO,kCAAmC,SAAQ,IAAI;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,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;;AAfsB,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"]}
+{"version":3,"file":"TileTreeBoundsDecoration.js","sourceRoot":"","sources":["../../../src/tools/TileTreeBoundsDecoration.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F;;GAEG;AAEH,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAC1D,OAAO,EAAmB,WAAW,EAAE,SAAS,EAAqB,IAAI,EAAE,MAAM,sBAAsB,CAAC;AACxG,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,MAAM,cAAc;IAIlB;QAWA,0HAA0H;QAC1G,yBAAoB,GAAG,IAAI,CAAC;QAX1C,IAAI,CAAC,SAAS,GAAG,SAAS,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,WAAW,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAC;QACpF,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,KAAK,EAAE,CAAC,EAAE,UAAU,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,QAAQ,CAAC,GAAG,EAAE,QAAQ,CAAC,GAAG,EAAE,CAAC,EAAE,UAAU,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,IAAI;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,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;;AAfsB,yCAAM,GAAG,gCAAgC,CAAC;SADtD,kCAAkC","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/esm/tools/ToolTipProvider.d.ts

@@ -1,16 +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>;
-}
+/** @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/esm/tools/ToolTipProvider.js

@@ -1,63 +1,64 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Tools
- */
-import { IModelApp, Tool } from "@itwin/core-frontend";
-import { parseToggle } from "./parseToggle";
-/** 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();
-                IModelApp.viewManager.addToolTipProvider(this._instance);
-            }
-        }
-        else if (undefined !== this._instance) {
-            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
- */
-export class ToggleToolTipsTool extends Tool {
-    static get minArgs() { return 0; }
-    static get maxArgs() { return 1; }
-    async run(enable) {
-        DebugToolTipProvider.setEnabled(enable);
-        return true;
-    }
-    async parseAndRun(...args) {
-        const enable = parseToggle(args[0]);
-        if (typeof enable !== "string")
-            await this.run(enable);
-        return true;
-    }
-}
-ToggleToolTipsTool.toolId = "ToggleToolTips";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Tools
+ */
+import { IModelApp, Tool } from "@itwin/core-frontend";
+import { parseToggle } from "./parseToggle";
+/** 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();
+                IModelApp.viewManager.addToolTipProvider(this._instance);
+            }
+        }
+        else if (undefined !== this._instance) {
+            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 Tool {
+    static get minArgs() { return 0; }
+    static get maxArgs() { return 1; }
+    async run(enable) {
+        DebugToolTipProvider.setEnabled(enable);
+        return true;
+    }
+    async parseAndRun(...args) {
+        const enable = parseToggle(args[0]);
+        if (typeof enable !== "string")
+            await this.run(enable);
+        return true;
+    }
+}
+ToggleToolTipsTool.toolId = "ToggleToolTips";
+export { ToggleToolTipsTool };
 //# sourceMappingURL=ToolTipProvider.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"ToolTipProvider.js","sourceRoot":"","sources":["../../../src/tools/ToolTipProvider.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F;;GAEG;AAEH,OAAO,EAAa,SAAS,EAAE,IAAI,EAAmB,MAAM,sBAAsB,CAAC;AACnF,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;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,SAAS,CAAC,WAAW,CAAC,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;aAC1D;SACF;aAAM,IAAI,SAAS,KAAK,IAAI,CAAC,SAAS,EAAE;YACvC,SAAS,CAAC,WAAW,CAAC,mBAAmB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAC1D,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;SAC5B;IACH,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,kBAAmB,SAAQ,IAAI;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,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;;AAfsB,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"]}
+{"version":3,"file":"ToolTipProvider.js","sourceRoot":"","sources":["../../../src/tools/ToolTipProvider.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F;;GAEG;AAEH,OAAO,EAAa,SAAS,EAAE,IAAI,EAAmB,MAAM,sBAAsB,CAAC;AACnF,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;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,SAAS,CAAC,WAAW,CAAC,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;aAC1D;SACF;aAAM,IAAI,SAAS,KAAK,IAAI,CAAC,SAAS,EAAE;YACvC,SAAS,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,IAAI;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,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;;AAfsB,yBAAM,GAAG,gBAAgB,CAAC;SADtC,kBAAkB","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"]}