@itwin/frontend-devtools 4.0.0-dev.8 → 4.0.0-dev.80

package/lib/esm/tools/RenderTargetTools.js

@@ -1,160 +1,170 @@
-/*---------------------------------------------------------------------------------------------
-* 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, PrimitiveVisibility, Tool } from "@itwin/core-frontend";
-import { parseToggle } from "./parseToggle";
-/** Executes some code against a RenderTargetDebugControl obtained from the selected viewport.
- * @beta
- */
-export class RenderTargetDebugControlTool extends Tool {
-    async run(_args) {
-        const view = IModelApp.viewManager.selectedView;
-        const control = undefined !== view ? view.target.debugControl : undefined;
-        if (undefined !== control)
-            this.execute(control, view);
-        return true;
-    }
-}
-/** Toggles some aspect of a RenderTargetDebugControl for the selected viewport.
- * @beta
- */
-export class RenderTargetDebugControlToggleTool extends RenderTargetDebugControlTool {
-    static get minArgs() { return 0; }
-    static get maxArgs() { return 1; }
-    execute(control, vp) {
-        const value = undefined !== this._enable ? this._enable : !control[this.aspect];
-        control[this.aspect] = value;
-        vp.invalidateRenderPlan();
-    }
-    async parseAndRun(...args) {
-        const enable = parseToggle(args[0]);
-        if (typeof enable !== "string") {
-            this._enable = enable;
-            await this.run([]);
-        }
-        return true;
-    }
-}
-/** Toggles between normal rendering and rendering as if drawing to an off-screen framebuffer for element locate. Useful for debugging locate issues.
- * @beta
- */
-export class ToggleReadPixelsTool extends RenderTargetDebugControlToggleTool {
-    get aspect() { return "drawForReadPixels"; }
-}
-ToggleReadPixelsTool.toolId = "ToggleReadPixels";
-/** Turn on the display of the draping frustum.
- * @beta
- */
-export class ToggleDrapeFrustumTool extends RenderTargetDebugControlToggleTool {
-    get aspect() { return "displayDrapeFrustum"; }
-}
-ToggleDrapeFrustumTool.toolId = "ToggleDrapeFrustum";
-/** Control whether all geometry renders, or only instanced or batched geometry.
- * Allowed argument: "instanced", "batched", "all". Defaults to "all" if no arguments supplied.
- * @beta
- */
-export class TogglePrimitiveVisibilityTool extends RenderTargetDebugControlTool {
-    constructor() {
-        super(...arguments);
-        this._visibility = PrimitiveVisibility.All;
-    }
-    static get minArgs() { return 0; }
-    static get maxArgs() { return 1; }
-    execute(control, vp) {
-        control.primitiveVisibility = this._visibility;
-        vp.invalidateScene();
-    }
-    async parseAndRun(...args) {
-        if (0 < args.length) {
-            switch (args[0].toLowerCase()) {
-                case "instanced":
-                    this._visibility = PrimitiveVisibility.Instanced;
-                    break;
-                case "batched":
-                    this._visibility = PrimitiveVisibility.Uninstanced;
-                    break;
-                case "all":
-                    break;
-                default:
-                    return true;
-            }
-        }
-        return this.run(args);
-    }
-}
-TogglePrimitiveVisibilityTool.toolId = "TogglePrimitiveVisibility";
-/** Turn on display of reality tile boundaries.
- * @beta
- */
-export class ToggleRealityTileBounds extends RenderTargetDebugControlToggleTool {
-    get aspect() { return "displayRealityTileRanges"; }
-}
-ToggleRealityTileBounds.toolId = "ToggleRealityTileBounds";
-/** Turn on display of reality tile preload debugging.
- * @beta
- */
-export class ToggleRealityTilePreload extends RenderTargetDebugControlToggleTool {
-    get aspect() { return "displayRealityTilePreload"; }
-}
-ToggleRealityTilePreload.toolId = "ToggleRealityTilePreload";
-/** Freeze loading of reality tiles.
- * @beta
- */
-export class ToggleRealityTileFreeze extends RenderTargetDebugControlToggleTool {
-    get aspect() { return "freezeRealityTiles"; }
-}
-ToggleRealityTileFreeze.toolId = "ToggleRealityTileFreeze";
-/** Turn on logging of console tile selection and loading (to console).
- * @beta
- */
-export class ToggleRealityTileLogging extends RenderTargetDebugControlToggleTool {
-    get aspect() { return "logRealityTiles"; }
-}
-ToggleRealityTileLogging.toolId = "ToggleRealityTileLogging";
-/** Toggles support for intersecting volume classifiers.
- * @beta
- */
-export class ToggleVolClassIntersect extends RenderTargetDebugControlToggleTool {
-    get aspect() { return "vcSupportIntersectingVolumes"; }
-}
-ToggleVolClassIntersect.toolId = "ToggleVCIntersect";
-/** Set the number of antialiasing samples to use (<=1 for no antialiasing).
- * @beta
- */
-export class SetAASamplesTool extends RenderTargetDebugControlTool {
-    constructor() {
-        super(...arguments);
-        this._aaSamples = 1;
-        this._changeAll = false;
-    }
-    static get minArgs() { return 1; }
-    static get maxArgs() { return 2; }
-    execute(_control, vp) {
-        if (this._changeAll)
-            IModelApp.viewManager.setAntialiasingAllViews(this._aaSamples);
-        else
-            vp.antialiasSamples = this._aaSamples;
-    }
-    /** Runs this tool, setting the number of antialiasing samples to use (<=1 for no antialiasing).
-     * @param args contains the arguments used by the tool's run method: args[0] contains the number of samples; optionally args[1] can contain the word "all" in order to set those number of samples for all viewports.
-     */
-    async parseAndRun(...args) {
-        if (0 < args.length)
-            this._aaSamples = parseInt(args[0], 10);
-        this._changeAll = (1 < args.length && args[1].toLowerCase() === "all");
-        return this.run(args);
-    }
-}
-SetAASamplesTool.toolId = "SetAASamples";
-/** Toggles support for normal maps.
- * @beta
- */
-export class ToggleNormalMaps extends RenderTargetDebugControlToggleTool {
-    get aspect() { return "displayNormalMaps"; }
-}
-ToggleNormalMaps.toolId = "ToggleNormalMaps";
+/*---------------------------------------------------------------------------------------------
+* 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, PrimitiveVisibility, Tool } from "@itwin/core-frontend";
+import { parseToggle } from "./parseToggle";
+/** Executes some code against a RenderTargetDebugControl obtained from the selected viewport.
+ * @beta
+ */
+export class RenderTargetDebugControlTool extends Tool {
+    async run(_args) {
+        const view = IModelApp.viewManager.selectedView;
+        const control = undefined !== view ? view.target.debugControl : undefined;
+        if (undefined !== control)
+            this.execute(control, view);
+        return true;
+    }
+}
+/** Toggles some aspect of a RenderTargetDebugControl for the selected viewport.
+ * @beta
+ */
+export class RenderTargetDebugControlToggleTool extends RenderTargetDebugControlTool {
+    static get minArgs() { return 0; }
+    static get maxArgs() { return 1; }
+    execute(control, vp) {
+        const value = undefined !== this._enable ? this._enable : !control[this.aspect];
+        control[this.aspect] = value;
+        vp.invalidateRenderPlan();
+    }
+    async parseAndRun(...args) {
+        const enable = parseToggle(args[0]);
+        if (typeof enable !== "string") {
+            this._enable = enable;
+            await this.run([]);
+        }
+        return true;
+    }
+}
+/** Toggles between normal rendering and rendering as if drawing to an off-screen framebuffer for element locate. Useful for debugging locate issues.
+ * @beta
+ */
+class ToggleReadPixelsTool extends RenderTargetDebugControlToggleTool {
+    get aspect() { return "drawForReadPixels"; }
+}
+ToggleReadPixelsTool.toolId = "ToggleReadPixels";
+export { ToggleReadPixelsTool };
+/** Turn on the display of the draping frustum.
+ * @beta
+ */
+class ToggleDrapeFrustumTool extends RenderTargetDebugControlToggleTool {
+    get aspect() { return "displayDrapeFrustum"; }
+}
+ToggleDrapeFrustumTool.toolId = "ToggleDrapeFrustum";
+export { ToggleDrapeFrustumTool };
+/** Control whether all geometry renders, or only instanced or batched geometry.
+ * Allowed argument: "instanced", "batched", "all". Defaults to "all" if no arguments supplied.
+ * @beta
+ */
+class TogglePrimitiveVisibilityTool extends RenderTargetDebugControlTool {
+    constructor() {
+        super(...arguments);
+        this._visibility = PrimitiveVisibility.All;
+    }
+    static get minArgs() { return 0; }
+    static get maxArgs() { return 1; }
+    execute(control, vp) {
+        control.primitiveVisibility = this._visibility;
+        vp.invalidateScene();
+    }
+    async parseAndRun(...args) {
+        if (0 < args.length) {
+            switch (args[0].toLowerCase()) {
+                case "instanced":
+                    this._visibility = PrimitiveVisibility.Instanced;
+                    break;
+                case "batched":
+                    this._visibility = PrimitiveVisibility.Uninstanced;
+                    break;
+                case "all":
+                    break;
+                default:
+                    return true;
+            }
+        }
+        return this.run(args);
+    }
+}
+TogglePrimitiveVisibilityTool.toolId = "TogglePrimitiveVisibility";
+export { TogglePrimitiveVisibilityTool };
+/** Turn on display of reality tile boundaries.
+ * @beta
+ */
+class ToggleRealityTileBounds extends RenderTargetDebugControlToggleTool {
+    get aspect() { return "displayRealityTileRanges"; }
+}
+ToggleRealityTileBounds.toolId = "ToggleRealityTileBounds";
+export { ToggleRealityTileBounds };
+/** Turn on display of reality tile preload debugging.
+ * @beta
+ */
+class ToggleRealityTilePreload extends RenderTargetDebugControlToggleTool {
+    get aspect() { return "displayRealityTilePreload"; }
+}
+ToggleRealityTilePreload.toolId = "ToggleRealityTilePreload";
+export { ToggleRealityTilePreload };
+/** Freeze loading of reality tiles.
+ * @beta
+ */
+class ToggleRealityTileFreeze extends RenderTargetDebugControlToggleTool {
+    get aspect() { return "freezeRealityTiles"; }
+}
+ToggleRealityTileFreeze.toolId = "ToggleRealityTileFreeze";
+export { ToggleRealityTileFreeze };
+/** Turn on logging of console tile selection and loading (to console).
+ * @beta
+ */
+class ToggleRealityTileLogging extends RenderTargetDebugControlToggleTool {
+    get aspect() { return "logRealityTiles"; }
+}
+ToggleRealityTileLogging.toolId = "ToggleRealityTileLogging";
+export { ToggleRealityTileLogging };
+/** Toggles support for intersecting volume classifiers.
+ * @beta
+ */
+class ToggleVolClassIntersect extends RenderTargetDebugControlToggleTool {
+    get aspect() { return "vcSupportIntersectingVolumes"; }
+}
+ToggleVolClassIntersect.toolId = "ToggleVCIntersect";
+export { ToggleVolClassIntersect };
+/** Set the number of antialiasing samples to use (<=1 for no antialiasing).
+ * @beta
+ */
+class SetAASamplesTool extends RenderTargetDebugControlTool {
+    constructor() {
+        super(...arguments);
+        this._aaSamples = 1;
+        this._changeAll = false;
+    }
+    static get minArgs() { return 1; }
+    static get maxArgs() { return 2; }
+    execute(_control, vp) {
+        if (this._changeAll)
+            IModelApp.viewManager.setAntialiasingAllViews(this._aaSamples);
+        else
+            vp.antialiasSamples = this._aaSamples;
+    }
+    /** Runs this tool, setting the number of antialiasing samples to use (<=1 for no antialiasing).
+     * @param args contains the arguments used by the tool's run method: args[0] contains the number of samples; optionally args[1] can contain the word "all" in order to set those number of samples for all viewports.
+     */
+    async parseAndRun(...args) {
+        if (0 < args.length)
+            this._aaSamples = parseInt(args[0], 10);
+        this._changeAll = (1 < args.length && args[1].toLowerCase() === "all");
+        return this.run(args);
+    }
+}
+SetAASamplesTool.toolId = "SetAASamples";
+export { SetAASamplesTool };
+/** Toggles support for normal maps.
+ * @beta
+ */
+class ToggleNormalMaps extends RenderTargetDebugControlToggleTool {
+    get aspect() { return "displayNormalMaps"; }
+}
+ToggleNormalMaps.toolId = "ToggleNormalMaps";
+export { ToggleNormalMaps };
 //# sourceMappingURL=RenderTargetTools.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"RenderTargetTools.js","sourceRoot":"","sources":["../../../src/tools/RenderTargetTools.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,mBAAmB,EAA4C,IAAI,EAAE,MAAM,sBAAsB,CAAC;AACtH,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C;;GAEG;AACH,MAAM,OAAgB,4BAA6B,SAAQ,IAAI;IAC7C,KAAK,CAAC,GAAG,CAAC,KAAY;QACpC,MAAM,IAAI,GAAG,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC;QAChD,MAAM,OAAO,GAAG,SAAS,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;QAC1E,IAAI,SAAS,KAAK,OAAO;YACvB,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,IAAK,CAAC,CAAC;QAE/B,OAAO,IAAI,CAAC;IACd,CAAC;CAGF;AAMD;;GAEG;AACH,MAAM,OAAgB,kCAAmC,SAAQ,4BAA4B;IACpF,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAMxC,OAAO,CAAC,OAAiC,EAAE,EAAkB;QACrE,MAAM,KAAK,GAAG,SAAS,KAAK,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAChF,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC;QAC7B,EAAE,CAAC,oBAAoB,EAAE,CAAC;IAC5B,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,EAAE;YAC9B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;YACtB,MAAM,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;SACpB;QAED,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,oBAAqB,SAAQ,kCAAkC;IAE1E,IAAW,MAAM,KAA0B,OAAO,mBAAmB,CAAC,CAAC,CAAC;;AADjD,2BAAM,GAAG,kBAAkB,CAAC;AAIrD;;GAEG;AACH,MAAM,OAAO,sBAAuB,SAAQ,kCAAkC;IAE5E,IAAW,MAAM,KAA0B,OAAO,qBAAqB,CAAC,CAAC,CAAC;;AADnD,6BAAM,GAAG,oBAAoB,CAAC;AAIvD;;;GAGG;AACH,MAAM,OAAO,6BAA8B,SAAQ,4BAA4B;IAA/E;;QAKU,gBAAW,GAAG,mBAAmB,CAAC,GAAG,CAAC;IAyBhD,CAAC;IA5BQ,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAI3C,OAAO,CAAC,OAAiC,EAAE,EAAkB;QAClE,OAAO,CAAC,mBAAmB,GAAG,IAAI,CAAC,WAAW,CAAC;QAC/C,EAAE,CAAC,eAAe,EAAE,CAAC;IACvB,CAAC;IAEe,KAAK,CAAC,WAAW,CAAC,GAAG,IAAc;QACjD,IAAI,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE;YACnB,QAAQ,IAAI,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,EAAE;gBAC7B,KAAK,WAAW;oBACd,IAAI,CAAC,WAAW,GAAG,mBAAmB,CAAC,SAAS,CAAC;oBACjD,MAAM;gBACR,KAAK,SAAS;oBACZ,IAAI,CAAC,WAAW,GAAG,mBAAmB,CAAC,WAAW,CAAC;oBACnD,MAAM;gBACR,KAAK,KAAK;oBACR,MAAM;gBACR;oBACE,OAAO,IAAI,CAAC;aACf;SACF;QAED,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC;;AA5BsB,oCAAM,GAAG,2BAA2B,CAAC;AA+B9D;;GAEG;AACH,MAAM,OAAO,uBAAwB,SAAQ,kCAAkC;IAE7E,IAAW,MAAM,KAA0B,OAAO,0BAA0B,CAAC,CAAC,CAAC;;AADxD,8BAAM,GAAG,yBAAyB,CAAC;AAI5D;;GAEG;AACH,MAAM,OAAO,wBAAyB,SAAQ,kCAAkC;IAE9E,IAAW,MAAM,KAA0B,OAAO,2BAA2B,CAAC,CAAC,CAAC;;AADzD,+BAAM,GAAG,0BAA0B,CAAC;AAG7D;;GAEG;AACH,MAAM,OAAO,uBAAwB,SAAQ,kCAAkC;IAE7E,IAAW,MAAM,KAA0B,OAAO,oBAAoB,CAAC,CAAC,CAAC;;AADlD,8BAAM,GAAG,yBAAyB,CAAC;AAI5D;;GAEG;AACH,MAAM,OAAO,wBAAyB,SAAQ,kCAAkC;IAE9E,IAAW,MAAM,KAA0B,OAAO,iBAAiB,CAAC,CAAC,CAAC;;AAD/C,+BAAM,GAAG,0BAA0B,CAAC;AAI7D;;GAEG;AACH,MAAM,OAAO,uBAAwB,SAAQ,kCAAkC;IAE7E,IAAW,MAAM,KAA0B,OAAO,8BAA8B,CAAC,CAAC,CAAC;;AAD5D,8BAAM,GAAG,mBAAmB,CAAC;AAItD;;GAEG;AACH,MAAM,OAAO,gBAAiB,SAAQ,4BAA4B;IAAlE;;QAKU,eAAU,GAAG,CAAC,CAAC;QACf,eAAU,GAAG,KAAK,CAAC;IAmB7B,CAAC;IAvBQ,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAK3C,OAAO,CAAC,QAAkC,EAAE,EAAkB;QACnE,IAAI,IAAI,CAAC,UAAU;YACjB,SAAS,CAAC,WAAW,CAAC,uBAAuB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;;YAE/D,EAAE,CAAC,gBAAgB,GAAG,IAAI,CAAC,UAAU,CAAC;IAC1C,CAAC;IAED;;OAEG;IACa,KAAK,CAAC,WAAW,CAAC,GAAG,IAAc;QACjD,IAAI,CAAC,GAAG,IAAI,CAAC,MAAM;YACjB,IAAI,CAAC,UAAU,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QAC1C,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,KAAK,KAAK,CAAC,CAAC;QAEvE,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC;;AAvBsB,uBAAM,GAAG,cAAc,CAAC;AA0BjD;;GAEG;AACH,MAAM,OAAO,gBAAiB,SAAQ,kCAAkC;IAEtE,IAAW,MAAM,KAA0B,OAAO,mBAAmB,CAAC,CAAC,CAAC;;AADjD,uBAAM,GAAG,kBAAkB,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 { IModelApp, PrimitiveVisibility, RenderTargetDebugControl, ScreenViewport, Tool } from \"@itwin/core-frontend\";\r\nimport { parseToggle } from \"./parseToggle\";\r\n\r\n/** Executes some code against a RenderTargetDebugControl obtained from the selected viewport.\r\n * @beta\r\n */\r\nexport abstract class RenderTargetDebugControlTool extends Tool {\r\n  public override async run(_args: any[]): Promise<boolean> {\r\n    const view = IModelApp.viewManager.selectedView;\r\n    const control = undefined !== view ? view.target.debugControl : undefined;\r\n    if (undefined !== control)\r\n      this.execute(control, view!);\r\n\r\n    return true;\r\n  }\r\n\r\n  protected abstract execute(_control: RenderTargetDebugControl, _vp: ScreenViewport): void;\r\n}\r\n\r\ntype DebugControlBoolean =\r\n  \"displayDrapeFrustum\" | \"drawForReadPixels\" | \"displayRealityTileRanges\" | \"displayRealityTileRanges\" |\r\n  \"displayRealityTilePreload\" | \"freezeRealityTiles\" | \"logRealityTiles\" | \"vcSupportIntersectingVolumes\" | \"displayNormalMaps\";\r\n\r\n/** Toggles some aspect of a RenderTargetDebugControl for the selected viewport.\r\n * @beta\r\n */\r\nexport abstract class RenderTargetDebugControlToggleTool extends RenderTargetDebugControlTool {\r\n  public static override get minArgs() { return 0; }\r\n  public static override get maxArgs() { return 1; }\r\n\r\n  private _enable?: boolean;\r\n\r\n  protected abstract get aspect(): DebugControlBoolean;\r\n\r\n  protected execute(control: RenderTargetDebugControl, vp: ScreenViewport): void {\r\n    const value = undefined !== this._enable ? this._enable : !control[this.aspect];\r\n    control[this.aspect] = value;\r\n    vp.invalidateRenderPlan();\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      this._enable = enable;\r\n      await this.run([]);\r\n    }\r\n\r\n    return true;\r\n  }\r\n}\r\n\r\n/** Toggles between normal rendering and rendering as if drawing to an off-screen framebuffer for element locate. Useful for debugging locate issues.\r\n * @beta\r\n */\r\nexport class ToggleReadPixelsTool extends RenderTargetDebugControlToggleTool {\r\n  public static override toolId = \"ToggleReadPixels\";\r\n  public get aspect(): DebugControlBoolean { return \"drawForReadPixels\"; }\r\n}\r\n\r\n/** Turn on the display of the draping frustum.\r\n * @beta\r\n */\r\nexport class ToggleDrapeFrustumTool extends RenderTargetDebugControlToggleTool {\r\n  public static override toolId = \"ToggleDrapeFrustum\";\r\n  public get aspect(): DebugControlBoolean { return \"displayDrapeFrustum\"; }\r\n}\r\n\r\n/** Control whether all geometry renders, or only instanced or batched geometry.\r\n * Allowed argument: \"instanced\", \"batched\", \"all\". Defaults to \"all\" if no arguments supplied.\r\n * @beta\r\n */\r\nexport class TogglePrimitiveVisibilityTool extends RenderTargetDebugControlTool {\r\n  public static override toolId = \"TogglePrimitiveVisibility\";\r\n  public static override get minArgs() { return 0; }\r\n  public static override get maxArgs() { return 1; }\r\n\r\n  private _visibility = PrimitiveVisibility.All;\r\n\r\n  public execute(control: RenderTargetDebugControl, vp: ScreenViewport): void {\r\n    control.primitiveVisibility = this._visibility;\r\n    vp.invalidateScene();\r\n  }\r\n\r\n  public override async parseAndRun(...args: string[]): Promise<boolean> {\r\n    if (0 < args.length) {\r\n      switch (args[0].toLowerCase()) {\r\n        case \"instanced\":\r\n          this._visibility = PrimitiveVisibility.Instanced;\r\n          break;\r\n        case \"batched\":\r\n          this._visibility = PrimitiveVisibility.Uninstanced;\r\n          break;\r\n        case \"all\":\r\n          break;\r\n        default:\r\n          return true;\r\n      }\r\n    }\r\n\r\n    return this.run(args);\r\n  }\r\n}\r\n\r\n/** Turn on display of reality tile boundaries.\r\n * @beta\r\n */\r\nexport class ToggleRealityTileBounds extends RenderTargetDebugControlToggleTool {\r\n  public static override toolId = \"ToggleRealityTileBounds\";\r\n  public get aspect(): DebugControlBoolean { return \"displayRealityTileRanges\"; }\r\n}\r\n\r\n/** Turn on display of reality tile preload debugging.\r\n * @beta\r\n */\r\nexport class ToggleRealityTilePreload extends RenderTargetDebugControlToggleTool {\r\n  public static override toolId = \"ToggleRealityTilePreload\";\r\n  public get aspect(): DebugControlBoolean { return \"displayRealityTilePreload\"; }\r\n}\r\n/** Freeze loading of reality tiles.\r\n * @beta\r\n */\r\nexport class ToggleRealityTileFreeze extends RenderTargetDebugControlToggleTool {\r\n  public static override toolId = \"ToggleRealityTileFreeze\";\r\n  public get aspect(): DebugControlBoolean { return \"freezeRealityTiles\"; }\r\n}\r\n\r\n/** Turn on logging of console tile selection and loading (to console).\r\n * @beta\r\n */\r\nexport class ToggleRealityTileLogging extends RenderTargetDebugControlToggleTool {\r\n  public static override toolId = \"ToggleRealityTileLogging\";\r\n  public get aspect(): DebugControlBoolean { return \"logRealityTiles\"; }\r\n}\r\n\r\n/** Toggles support for intersecting volume classifiers.\r\n * @beta\r\n */\r\nexport class ToggleVolClassIntersect extends RenderTargetDebugControlToggleTool {\r\n  public static override toolId = \"ToggleVCIntersect\";\r\n  public get aspect(): DebugControlBoolean { return \"vcSupportIntersectingVolumes\"; }\r\n}\r\n\r\n/** Set the number of antialiasing samples to use (<=1 for no antialiasing).\r\n * @beta\r\n */\r\nexport class SetAASamplesTool extends RenderTargetDebugControlTool {\r\n  public static override toolId = \"SetAASamples\";\r\n  public static override get minArgs() { return 1; }\r\n  public static override get maxArgs() { return 2; }\r\n\r\n  private _aaSamples = 1;\r\n  private _changeAll = false;\r\n\r\n  public execute(_control: RenderTargetDebugControl, vp: ScreenViewport): void {\r\n    if (this._changeAll)\r\n      IModelApp.viewManager.setAntialiasingAllViews(this._aaSamples);\r\n    else\r\n      vp.antialiasSamples = this._aaSamples;\r\n  }\r\n\r\n  /** Runs this tool, setting the number of antialiasing samples to use (<=1 for no antialiasing).\r\n   * @param args contains the arguments used by the tool's run method: args[0] contains the number of samples; optionally args[1] can contain the word \"all\" in order to set those number of samples for all viewports.\r\n   */\r\n  public override async parseAndRun(...args: string[]): Promise<boolean> {\r\n    if (0 < args.length)\r\n      this._aaSamples = parseInt(args[0], 10);\r\n    this._changeAll = (1 < args.length && args[1].toLowerCase() === \"all\");\r\n\r\n    return this.run(args);\r\n  }\r\n}\r\n\r\n/** Toggles support for normal maps.\r\n * @beta\r\n */\r\nexport class ToggleNormalMaps extends RenderTargetDebugControlToggleTool {\r\n  public static override toolId = \"ToggleNormalMaps\";\r\n  public get aspect(): DebugControlBoolean { return \"displayNormalMaps\"; }\r\n}\r\n"]}
+{"version":3,"file":"RenderTargetTools.js","sourceRoot":"","sources":["../../../src/tools/RenderTargetTools.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,mBAAmB,EAA4C,IAAI,EAAE,MAAM,sBAAsB,CAAC;AACtH,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C;;GAEG;AACH,MAAM,OAAgB,4BAA6B,SAAQ,IAAI;IAC7C,KAAK,CAAC,GAAG,CAAC,KAAY;QACpC,MAAM,IAAI,GAAG,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC;QAChD,MAAM,OAAO,GAAG,SAAS,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;QAC1E,IAAI,SAAS,KAAK,OAAO;YACvB,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,IAAK,CAAC,CAAC;QAE/B,OAAO,IAAI,CAAC;IACd,CAAC;CAGF;AAMD;;GAEG;AACH,MAAM,OAAgB,kCAAmC,SAAQ,4BAA4B;IACpF,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAMxC,OAAO,CAAC,OAAiC,EAAE,EAAkB;QACrE,MAAM,KAAK,GAAG,SAAS,KAAK,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAChF,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC;QAC7B,EAAE,CAAC,oBAAoB,EAAE,CAAC;IAC5B,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,EAAE;YAC9B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;YACtB,MAAM,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;SACpB;QAED,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAED;;GAEG;AACH,MAAa,oBAAqB,SAAQ,kCAAkC;IAE1E,IAAW,MAAM,KAA0B,OAAO,mBAAmB,CAAC,CAAC,CAAC;;AADjD,2BAAM,GAAG,kBAAkB,CAAC;SADxC,oBAAoB;AAKjC;;GAEG;AACH,MAAa,sBAAuB,SAAQ,kCAAkC;IAE5E,IAAW,MAAM,KAA0B,OAAO,qBAAqB,CAAC,CAAC,CAAC;;AADnD,6BAAM,GAAG,oBAAoB,CAAC;SAD1C,sBAAsB;AAKnC;;;GAGG;AACH,MAAa,6BAA8B,SAAQ,4BAA4B;IAA/E;;QAKU,gBAAW,GAAG,mBAAmB,CAAC,GAAG,CAAC;IAyBhD,CAAC;IA5BQ,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAI3C,OAAO,CAAC,OAAiC,EAAE,EAAkB;QAClE,OAAO,CAAC,mBAAmB,GAAG,IAAI,CAAC,WAAW,CAAC;QAC/C,EAAE,CAAC,eAAe,EAAE,CAAC;IACvB,CAAC;IAEe,KAAK,CAAC,WAAW,CAAC,GAAG,IAAc;QACjD,IAAI,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE;YACnB,QAAQ,IAAI,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,EAAE;gBAC7B,KAAK,WAAW;oBACd,IAAI,CAAC,WAAW,GAAG,mBAAmB,CAAC,SAAS,CAAC;oBACjD,MAAM;gBACR,KAAK,SAAS;oBACZ,IAAI,CAAC,WAAW,GAAG,mBAAmB,CAAC,WAAW,CAAC;oBACnD,MAAM;gBACR,KAAK,KAAK;oBACR,MAAM;gBACR;oBACE,OAAO,IAAI,CAAC;aACf;SACF;QAED,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC;;AA5BsB,oCAAM,GAAG,2BAA2B,AAA9B,CAA+B;SADjD,6BAA6B;AAgC1C;;GAEG;AACH,MAAa,uBAAwB,SAAQ,kCAAkC;IAE7E,IAAW,MAAM,KAA0B,OAAO,0BAA0B,CAAC,CAAC,CAAC;;AADxD,8BAAM,GAAG,yBAAyB,CAAC;SAD/C,uBAAuB;AAKpC;;GAEG;AACH,MAAa,wBAAyB,SAAQ,kCAAkC;IAE9E,IAAW,MAAM,KAA0B,OAAO,2BAA2B,CAAC,CAAC,CAAC;;AADzD,+BAAM,GAAG,0BAA0B,CAAC;SADhD,wBAAwB;AAIrC;;GAEG;AACH,MAAa,uBAAwB,SAAQ,kCAAkC;IAE7E,IAAW,MAAM,KAA0B,OAAO,oBAAoB,CAAC,CAAC,CAAC;;AADlD,8BAAM,GAAG,yBAAyB,CAAC;SAD/C,uBAAuB;AAKpC;;GAEG;AACH,MAAa,wBAAyB,SAAQ,kCAAkC;IAE9E,IAAW,MAAM,KAA0B,OAAO,iBAAiB,CAAC,CAAC,CAAC;;AAD/C,+BAAM,GAAG,0BAA0B,CAAC;SADhD,wBAAwB;AAKrC;;GAEG;AACH,MAAa,uBAAwB,SAAQ,kCAAkC;IAE7E,IAAW,MAAM,KAA0B,OAAO,8BAA8B,CAAC,CAAC,CAAC;;AAD5D,8BAAM,GAAG,mBAAmB,CAAC;SADzC,uBAAuB;AAKpC;;GAEG;AACH,MAAa,gBAAiB,SAAQ,4BAA4B;IAAlE;;QAKU,eAAU,GAAG,CAAC,CAAC;QACf,eAAU,GAAG,KAAK,CAAC;IAmB7B,CAAC;IAvBQ,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAK3C,OAAO,CAAC,QAAkC,EAAE,EAAkB;QACnE,IAAI,IAAI,CAAC,UAAU;YACjB,SAAS,CAAC,WAAW,CAAC,uBAAuB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;;YAE/D,EAAE,CAAC,gBAAgB,GAAG,IAAI,CAAC,UAAU,CAAC;IAC1C,CAAC;IAED;;OAEG;IACa,KAAK,CAAC,WAAW,CAAC,GAAG,IAAc;QACjD,IAAI,CAAC,GAAG,IAAI,CAAC,MAAM;YACjB,IAAI,CAAC,UAAU,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QAC1C,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,KAAK,KAAK,CAAC,CAAC;QAEvE,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC;;AAvBsB,uBAAM,GAAG,cAAc,AAAjB,CAAkB;SADpC,gBAAgB;AA2B7B;;GAEG;AACH,MAAa,gBAAiB,SAAQ,kCAAkC;IAEtE,IAAW,MAAM,KAA0B,OAAO,mBAAmB,CAAC,CAAC,CAAC;;AADjD,uBAAM,GAAG,kBAAkB,CAAC;SADxC,gBAAgB","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 { IModelApp, PrimitiveVisibility, RenderTargetDebugControl, ScreenViewport, Tool } from \"@itwin/core-frontend\";\r\nimport { parseToggle } from \"./parseToggle\";\r\n\r\n/** Executes some code against a RenderTargetDebugControl obtained from the selected viewport.\r\n * @beta\r\n */\r\nexport abstract class RenderTargetDebugControlTool extends Tool {\r\n  public override async run(_args: any[]): Promise<boolean> {\r\n    const view = IModelApp.viewManager.selectedView;\r\n    const control = undefined !== view ? view.target.debugControl : undefined;\r\n    if (undefined !== control)\r\n      this.execute(control, view!);\r\n\r\n    return true;\r\n  }\r\n\r\n  protected abstract execute(_control: RenderTargetDebugControl, _vp: ScreenViewport): void;\r\n}\r\n\r\ntype DebugControlBoolean =\r\n  \"displayDrapeFrustum\" | \"drawForReadPixels\" | \"displayRealityTileRanges\" | \"displayRealityTileRanges\" |\r\n  \"displayRealityTilePreload\" | \"freezeRealityTiles\" | \"logRealityTiles\" | \"vcSupportIntersectingVolumes\" | \"displayNormalMaps\";\r\n\r\n/** Toggles some aspect of a RenderTargetDebugControl for the selected viewport.\r\n * @beta\r\n */\r\nexport abstract class RenderTargetDebugControlToggleTool extends RenderTargetDebugControlTool {\r\n  public static override get minArgs() { return 0; }\r\n  public static override get maxArgs() { return 1; }\r\n\r\n  private _enable?: boolean;\r\n\r\n  protected abstract get aspect(): DebugControlBoolean;\r\n\r\n  protected execute(control: RenderTargetDebugControl, vp: ScreenViewport): void {\r\n    const value = undefined !== this._enable ? this._enable : !control[this.aspect];\r\n    control[this.aspect] = value;\r\n    vp.invalidateRenderPlan();\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      this._enable = enable;\r\n      await this.run([]);\r\n    }\r\n\r\n    return true;\r\n  }\r\n}\r\n\r\n/** Toggles between normal rendering and rendering as if drawing to an off-screen framebuffer for element locate. Useful for debugging locate issues.\r\n * @beta\r\n */\r\nexport class ToggleReadPixelsTool extends RenderTargetDebugControlToggleTool {\r\n  public static override toolId = \"ToggleReadPixels\";\r\n  public get aspect(): DebugControlBoolean { return \"drawForReadPixels\"; }\r\n}\r\n\r\n/** Turn on the display of the draping frustum.\r\n * @beta\r\n */\r\nexport class ToggleDrapeFrustumTool extends RenderTargetDebugControlToggleTool {\r\n  public static override toolId = \"ToggleDrapeFrustum\";\r\n  public get aspect(): DebugControlBoolean { return \"displayDrapeFrustum\"; }\r\n}\r\n\r\n/** Control whether all geometry renders, or only instanced or batched geometry.\r\n * Allowed argument: \"instanced\", \"batched\", \"all\". Defaults to \"all\" if no arguments supplied.\r\n * @beta\r\n */\r\nexport class TogglePrimitiveVisibilityTool extends RenderTargetDebugControlTool {\r\n  public static override toolId = \"TogglePrimitiveVisibility\";\r\n  public static override get minArgs() { return 0; }\r\n  public static override get maxArgs() { return 1; }\r\n\r\n  private _visibility = PrimitiveVisibility.All;\r\n\r\n  public execute(control: RenderTargetDebugControl, vp: ScreenViewport): void {\r\n    control.primitiveVisibility = this._visibility;\r\n    vp.invalidateScene();\r\n  }\r\n\r\n  public override async parseAndRun(...args: string[]): Promise<boolean> {\r\n    if (0 < args.length) {\r\n      switch (args[0].toLowerCase()) {\r\n        case \"instanced\":\r\n          this._visibility = PrimitiveVisibility.Instanced;\r\n          break;\r\n        case \"batched\":\r\n          this._visibility = PrimitiveVisibility.Uninstanced;\r\n          break;\r\n        case \"all\":\r\n          break;\r\n        default:\r\n          return true;\r\n      }\r\n    }\r\n\r\n    return this.run(args);\r\n  }\r\n}\r\n\r\n/** Turn on display of reality tile boundaries.\r\n * @beta\r\n */\r\nexport class ToggleRealityTileBounds extends RenderTargetDebugControlToggleTool {\r\n  public static override toolId = \"ToggleRealityTileBounds\";\r\n  public get aspect(): DebugControlBoolean { return \"displayRealityTileRanges\"; }\r\n}\r\n\r\n/** Turn on display of reality tile preload debugging.\r\n * @beta\r\n */\r\nexport class ToggleRealityTilePreload extends RenderTargetDebugControlToggleTool {\r\n  public static override toolId = \"ToggleRealityTilePreload\";\r\n  public get aspect(): DebugControlBoolean { return \"displayRealityTilePreload\"; }\r\n}\r\n/** Freeze loading of reality tiles.\r\n * @beta\r\n */\r\nexport class ToggleRealityTileFreeze extends RenderTargetDebugControlToggleTool {\r\n  public static override toolId = \"ToggleRealityTileFreeze\";\r\n  public get aspect(): DebugControlBoolean { return \"freezeRealityTiles\"; }\r\n}\r\n\r\n/** Turn on logging of console tile selection and loading (to console).\r\n * @beta\r\n */\r\nexport class ToggleRealityTileLogging extends RenderTargetDebugControlToggleTool {\r\n  public static override toolId = \"ToggleRealityTileLogging\";\r\n  public get aspect(): DebugControlBoolean { return \"logRealityTiles\"; }\r\n}\r\n\r\n/** Toggles support for intersecting volume classifiers.\r\n * @beta\r\n */\r\nexport class ToggleVolClassIntersect extends RenderTargetDebugControlToggleTool {\r\n  public static override toolId = \"ToggleVCIntersect\";\r\n  public get aspect(): DebugControlBoolean { return \"vcSupportIntersectingVolumes\"; }\r\n}\r\n\r\n/** Set the number of antialiasing samples to use (<=1 for no antialiasing).\r\n * @beta\r\n */\r\nexport class SetAASamplesTool extends RenderTargetDebugControlTool {\r\n  public static override toolId = \"SetAASamples\";\r\n  public static override get minArgs() { return 1; }\r\n  public static override get maxArgs() { return 2; }\r\n\r\n  private _aaSamples = 1;\r\n  private _changeAll = false;\r\n\r\n  public execute(_control: RenderTargetDebugControl, vp: ScreenViewport): void {\r\n    if (this._changeAll)\r\n      IModelApp.viewManager.setAntialiasingAllViews(this._aaSamples);\r\n    else\r\n      vp.antialiasSamples = this._aaSamples;\r\n  }\r\n\r\n  /** Runs this tool, setting the number of antialiasing samples to use (<=1 for no antialiasing).\r\n   * @param args contains the arguments used by the tool's run method: args[0] contains the number of samples; optionally args[1] can contain the word \"all\" in order to set those number of samples for all viewports.\r\n   */\r\n  public override async parseAndRun(...args: string[]): Promise<boolean> {\r\n    if (0 < args.length)\r\n      this._aaSamples = parseInt(args[0], 10);\r\n    this._changeAll = (1 < args.length && args[1].toLowerCase() === \"all\");\r\n\r\n    return this.run(args);\r\n  }\r\n}\r\n\r\n/** Toggles support for normal maps.\r\n * @beta\r\n */\r\nexport class ToggleNormalMaps extends RenderTargetDebugControlToggleTool {\r\n  public static override toolId = \"ToggleNormalMaps\";\r\n  public get aspect(): DebugControlBoolean { return \"displayNormalMaps\"; }\r\n}\r\n"]}

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

@@ -1,12 +1,12 @@
-/** @packageDocumentation
- * @module Tools
- */
-import { Tool } from "@itwin/core-frontend";
-/** Queries the client's level of compatibility with the rendering system and outputs it to NotificationManager.
- * @beta
- */
-export declare class ReportWebGLCompatibilityTool extends Tool {
-    static toolId: string;
-    run(_args: any[]): Promise<boolean>;
-}
+/** @packageDocumentation
+ * @module Tools
+ */
+import { Tool } from "@itwin/core-frontend";
+/** Queries the client's level of compatibility with the rendering system and outputs it to NotificationManager.
+ * @beta
+ */
+export declare class ReportWebGLCompatibilityTool extends Tool {
+    static toolId: string;
+    run(_args: any[]): Promise<boolean>;
+}
 //# sourceMappingURL=ReportWebGLCompatibilityTool.d.ts.map

package/lib/esm/tools/ReportWebGLCompatibilityTool.js

@@ -1,27 +1,28 @@
-/*---------------------------------------------------------------------------------------------
-* 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, MessageBoxIconType, MessageBoxType, Tool } from "@itwin/core-frontend";
-/** Queries the client's level of compatibility with the rendering system and outputs it to NotificationManager.
- * @beta
- */
-export class ReportWebGLCompatibilityTool extends Tool {
-    async run(_args) {
-        const info = IModelApp.queryRenderCompatibility();
-        const statuses = ["OK", "Missing Optional Features", "Major Performance Caveat", "Missing Required Features", "Failed to Create Context"];
-        const status = info.status < statuses.length ? statuses[info.status] : "UNKNOWN";
-        const json = JSON.stringify(info, null, 2); // prettify JSON output
-        const msg = `Compatibility: ${status}\n${json}`;
-        const html = document.createElement("div");
-        html.style.whiteSpace = "pre-wrap";
-        html.appendChild(document.createTextNode(msg));
-        await IModelApp.notifications.openMessageBox(MessageBoxType.Ok, html, MessageBoxIconType.Information);
-        return true;
-    }
-}
-ReportWebGLCompatibilityTool.toolId = "ReportWebGLCompatibility";
+/*---------------------------------------------------------------------------------------------
+* 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, MessageBoxIconType, MessageBoxType, Tool } from "@itwin/core-frontend";
+/** Queries the client's level of compatibility with the rendering system and outputs it to NotificationManager.
+ * @beta
+ */
+class ReportWebGLCompatibilityTool extends Tool {
+    async run(_args) {
+        const info = IModelApp.queryRenderCompatibility();
+        const statuses = ["OK", "Missing Optional Features", "Major Performance Caveat", "Missing Required Features", "Failed to Create Context"];
+        const status = info.status < statuses.length ? statuses[info.status] : "UNKNOWN";
+        const json = JSON.stringify(info, null, 2); // prettify JSON output
+        const msg = `Compatibility: ${status}\n${json}`;
+        const html = document.createElement("div");
+        html.style.whiteSpace = "pre-wrap";
+        html.appendChild(document.createTextNode(msg));
+        await IModelApp.notifications.openMessageBox(MessageBoxType.Ok, html, MessageBoxIconType.Information);
+        return true;
+    }
+}
+ReportWebGLCompatibilityTool.toolId = "ReportWebGLCompatibility";
+export { ReportWebGLCompatibilityTool };
 //# sourceMappingURL=ReportWebGLCompatibilityTool.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"ReportWebGLCompatibilityTool.js","sourceRoot":"","sources":["../../../src/tools/ReportWebGLCompatibilityTool.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,kBAAkB,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAE3F;;GAEG;AACH,MAAM,OAAO,4BAA6B,SAAQ,IAAI;IAEpC,KAAK,CAAC,GAAG,CAAC,KAAY;QACpC,MAAM,IAAI,GAAG,SAAS,CAAC,wBAAwB,EAAE,CAAC;QAClD,MAAM,QAAQ,GAAG,CAAC,IAAI,EAAE,2BAA2B,EAAE,0BAA0B,EAAE,2BAA2B,EAAE,0BAA0B,CAAC,CAAC;QAC1I,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACjF,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,uBAAuB;QAEnE,MAAM,GAAG,GAAG,kBAAkB,MAAM,KAAK,IAAI,EAAE,CAAC;QAChD,MAAM,IAAI,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAC3C,IAAI,CAAC,KAAK,CAAC,UAAU,GAAG,UAAU,CAAC;QACnC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC;QAE/C,MAAM,SAAS,CAAC,aAAa,CAAC,cAAc,CAAC,cAAc,CAAC,EAAE,EAAE,IAAI,EAAE,kBAAkB,CAAC,WAAW,CAAC,CAAC;QACtG,OAAO,IAAI,CAAC;IACd,CAAC;;AAdsB,mCAAM,GAAG,0BAA0B,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 { IModelApp, MessageBoxIconType, MessageBoxType, Tool } from \"@itwin/core-frontend\";\r\n\r\n/** Queries the client's level of compatibility with the rendering system and outputs it to NotificationManager.\r\n * @beta\r\n */\r\nexport class ReportWebGLCompatibilityTool extends Tool {\r\n  public static override toolId = \"ReportWebGLCompatibility\";\r\n  public override async run(_args: any[]): Promise<boolean> {\r\n    const info = IModelApp.queryRenderCompatibility();\r\n    const statuses = [\"OK\", \"Missing Optional Features\", \"Major Performance Caveat\", \"Missing Required Features\", \"Failed to Create Context\"];\r\n    const status = info.status < statuses.length ? statuses[info.status] : \"UNKNOWN\";\r\n    const json = JSON.stringify(info, null, 2); // prettify JSON output\r\n\r\n    const msg = `Compatibility: ${status}\\n${json}`;\r\n    const html = document.createElement(\"div\");\r\n    html.style.whiteSpace = \"pre-wrap\";\r\n    html.appendChild(document.createTextNode(msg));\r\n\r\n    await IModelApp.notifications.openMessageBox(MessageBoxType.Ok, html, MessageBoxIconType.Information);\r\n    return true;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"ReportWebGLCompatibilityTool.js","sourceRoot":"","sources":["../../../src/tools/ReportWebGLCompatibilityTool.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,kBAAkB,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAE3F;;GAEG;AACH,MAAa,4BAA6B,SAAQ,IAAI;IAEpC,KAAK,CAAC,GAAG,CAAC,KAAY;QACpC,MAAM,IAAI,GAAG,SAAS,CAAC,wBAAwB,EAAE,CAAC;QAClD,MAAM,QAAQ,GAAG,CAAC,IAAI,EAAE,2BAA2B,EAAE,0BAA0B,EAAE,2BAA2B,EAAE,0BAA0B,CAAC,CAAC;QAC1I,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACjF,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,uBAAuB;QAEnE,MAAM,GAAG,GAAG,kBAAkB,MAAM,KAAK,IAAI,EAAE,CAAC;QAChD,MAAM,IAAI,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAC3C,IAAI,CAAC,KAAK,CAAC,UAAU,GAAG,UAAU,CAAC;QACnC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC;QAE/C,MAAM,SAAS,CAAC,aAAa,CAAC,cAAc,CAAC,cAAc,CAAC,EAAE,EAAE,IAAI,EAAE,kBAAkB,CAAC,WAAW,CAAC,CAAC;QACtG,OAAO,IAAI,CAAC;IACd,CAAC;;AAdsB,mCAAM,GAAG,0BAA0B,CAAC;SADhD,4BAA4B","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 { IModelApp, MessageBoxIconType, MessageBoxType, Tool } from \"@itwin/core-frontend\";\r\n\r\n/** Queries the client's level of compatibility with the rendering system and outputs it to NotificationManager.\r\n * @beta\r\n */\r\nexport class ReportWebGLCompatibilityTool extends Tool {\r\n  public static override toolId = \"ReportWebGLCompatibility\";\r\n  public override async run(_args: any[]): Promise<boolean> {\r\n    const info = IModelApp.queryRenderCompatibility();\r\n    const statuses = [\"OK\", \"Missing Optional Features\", \"Major Performance Caveat\", \"Missing Required Features\", \"Failed to Create Context\"];\r\n    const status = info.status < statuses.length ? statuses[info.status] : \"UNKNOWN\";\r\n    const json = JSON.stringify(info, null, 2); // prettify JSON output\r\n\r\n    const msg = `Compatibility: ${status}\\n${json}`;\r\n    const html = document.createElement(\"div\");\r\n    html.style.whiteSpace = \"pre-wrap\";\r\n    html.appendChild(document.createTextNode(msg));\r\n\r\n    await IModelApp.notifications.openMessageBox(MessageBoxType.Ok, html, MessageBoxIconType.Information);\r\n    return true;\r\n  }\r\n}\r\n"]}

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

@@ -1,47 +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>;
-}
+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