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

package/lib/esm/effects/Vignette.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Vignette.js","sourceRoot":"","sources":["../../../src/effects/Vignette.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAA4B,IAAI,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAChG,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,yBAAyB,EAAE,MAAM,eAAe,CAAC;AAEzE;;;GAGG;AACH,MAAM,OAAO,cAAe,SAAQ,aAAa;IAG/C,IAAc,UAAU,KAAK,OAAO,UAAU,CAAC,CAAC,CAAC;IACjD,IAAc,wBAAwB,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IAEzD,IAAc,MAAM;QAClB,OAAO;YACL,MAAM,EAAE;;;;OAIP;YACD,QAAQ,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;OAyBT;SACF,CAAC;IACJ,CAAC;IAES,YAAY,CAAC,OAAiC;QACtD,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,WAAW,CAAC,IAAI,CAAC,CAAC;QACnD,OAAO,CAAC,UAAU,CAAC;YACjB,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,WAAW,CAAC,IAAI;YACtB,IAAI,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,aAAa,CAAC,cAAc,CAAC,IAAI,CAAC;SAC9D,CAAC,CAAC;QACH,OAAO,CAAC,UAAU,CAAC;YACjB,IAAI,EAAE,aAAa;YACnB,IAAI,EAAE,WAAW,CAAC,KAAK;YACvB,IAAI,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,cAAc,CAAC,SAAS,CAAC;SAClE,CAAC,CAAC;QACH,OAAO,CAAC,UAAU,CAAC;YACjB,IAAI,EAAE,cAAc;YACpB,IAAI,EAAE,WAAW,CAAC,KAAK;YACvB,IAAI,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,cAAc,CAAC,UAAU,CAAC;SACnE,CAAC,CAAC;IACL,CAAC;;AA1DsB,qBAAM,GAAG,gBAAgB,CAAC;AA6DnD;;GAEG;AACH,MAAM,OAAO,cAAe,SAAQ,IAAI;IAE/B,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAelC,KAAK,CAAC,GAAG,CAAC,KAAc,EAAE,MAAe,EAAE,SAAkB,EAAE,UAAmB;QAChG,MAAM,MAAM,GAAG,cAAc,CAAC;QAC9B,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACzC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC1C,MAAM,CAAC,SAAS,GAAG,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,MAAM,CAAC,SAAS,CAAC;QACjD,MAAM,CAAC,UAAU,GAAG,UAAU,aAAV,UAAU,cAAV,UAAU,GAAI,MAAM,CAAC,UAAU,CAAC;QAEpD,yBAAyB,CAAC,cAAc,CAAC,CAAC;QAC1C,OAAO,IAAI,CAAC;IACd,CAAC;IAEe,KAAK,CAAC,WAAW,CAAC,GAAG,KAAe;QAClD,MAAM,IAAI,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC;QAC9B,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;IAClG,CAAC;;AA/BsB,qBAAM,GAAG,gBAAgB,CAAC;AAIjD;;GAEG;AACoB,mBAAI,GAAG,IAAI,YAAY,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;AAE7D,iGAAiG;AACnF,wBAAS,GAAG,GAAG,CAAC;AAE9B;;GAEG;AACW,yBAAU,GAAG,GAAG,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Effects\n */\n\nimport { ScreenSpaceEffectBuilder, Tool, UniformType, VaryingType } from \"@itwin/core-frontend\";\nimport { parseArgs } from \"../tools/parseArgs\";\nimport { AddEffectTool, refreshViewportsForEffect } from \"./EffectTools\";\n\n/** Applies a [vignette](https://en.wikipedia.org/wiki/Vignetting) effect to the viewport.\n * From https://github.com/TyLindberg/glsl-vignette/blob/master/advanced.glsl.\n * @beta\n */\nexport class VignetteEffect extends AddEffectTool {\n  public static override toolId = \"VignetteEffect\";\n\n  protected get effectName() { return \"Vignette\"; }\n  protected get textureCoordFromPosition() { return true; }\n\n  protected get source() {\n    return {\n      vertex: `\n        void effectMain(vec4 pos) {\n          v_texCoord = textureCoordFromPosition(pos);\n        }\n      `,\n      fragment: `\n        float sdSquare(vec2 point, float width) {\n          vec2 d = abs(point) - width;\n          return min(max(d.x,d.y),0.0) + length(max(d,0.0));\n        }\n\n        float vignette(vec2 uv, vec2 size, float roundness, float smoothness) {\n          // Center UVs\n          uv -= 0.5;\n\n          // Shift UVs based on the larger of width or height\n          float minWidth = min(size.x, size.y);\n          uv.x = sign(uv.x) * clamp(abs(uv.x) - abs(minWidth - size.x), 0.0, 1.0);\n          uv.y = sign(uv.y) * clamp(abs(uv.y) - abs(minWidth - size.y), 0.0, 1.0);\n\n          // Signed distance calculation\n          float boxSize = minWidth * (1.0 - roundness);\n          float dist = sdSquare(uv, boxSize) - (minWidth * roundness);\n\n          return 1.0 - smoothstep(0.0, smoothness, dist);\n        }\n\n        vec4 effectMain() {\n          return TEXTURE(u_diffuse, v_texCoord) * vignette(v_texCoord, u_size, u_roundness, u_smoothness);\n        }\n      `,\n    };\n  }\n\n  protected defineEffect(builder: ScreenSpaceEffectBuilder): void {\n    builder.addVarying(\"v_texCoord\", VaryingType.Vec2);\n    builder.addUniform({\n      name: \"u_size\",\n      type: UniformType.Vec2,\n      bind: (uniform) => uniform.setUniform2fv(VignetteConfig.size),\n    });\n    builder.addUniform({\n      name: \"u_roundness\",\n      type: UniformType.Float,\n      bind: (uniform) => uniform.setUniform1f(VignetteConfig.roundness),\n    });\n    builder.addUniform({\n      name: \"u_smoothness\",\n      type: UniformType.Float,\n      bind: (uniform) => uniform.setUniform1f(VignetteConfig.smoothness),\n    });\n  }\n}\n\n/** Configures the [[VignetteEffect]].\n * @beta\n */\nexport class VignetteConfig extends Tool {\n  public static override toolId = \"VignetteConfig\";\n  public static override get minArgs() { return 0; }\n  public static override get maxArgs() { return 4; }\n\n  /** Size of the vignette in the form (width/2, height/2). e.g., to make the vignette start fading in halfway between the center and edges of\n   * UV space, use (0.25, 0.25).\n   */\n  public static readonly size = new Float32Array([0.25, 0.25]);\n\n  /** How round the vignette will be, from 0.0 (perfectly rectangular) to 1.0 (perfectly round). */\n  public static roundness = 1.0;\n\n  /** How quickly the vignette fades in. The vignette starts fading in at the edge of the values provided by `size` and will be\n   * fully faded in at (size.x + smoothness, size.y * smoothness). A value of 0.0 produces a hard edge.\n   */\n  public static smoothness = 0.5;\n\n  public override async run(width?: number, height?: number, roundness?: number, smoothness?: number): Promise<boolean> {\n    const config = VignetteConfig;\n    config.size[0] = width ?? config.size[0];\n    config.size[1] = height ?? config.size[1];\n    config.roundness = roundness ?? config.roundness;\n    config.smoothness = smoothness ?? config.smoothness;\n\n    refreshViewportsForEffect(\"fdt Vignette\");\n    return true;\n  }\n\n  public override async parseAndRun(...input: string[]): Promise<boolean> {\n    const args = parseArgs(input);\n    return this.run(args.getFloat(\"w\"), args.getFloat(\"h\"), args.getFloat(\"r\"), args.getFloat(\"s\"));\n  }\n}\n"]}

package/lib/esm/frontend-devtools.d.ts

@@ -0,0 +1,82 @@
+export * from "./ClipboardUtilities";
+export * from "./FrontEndDevTools";
+export * from "./effects/Convolution";
+export * from "./effects/EffectTools";
+export * from "./effects/Explosion";
+export * from "./effects/FlipImage";
+export * from "./effects/LensDistortion";
+export * from "./effects/Random";
+export * from "./effects/Saturation";
+export * from "./effects/Snow";
+export * from "./effects/Vignette";
+export * from "./tools/AnimationIntervalTool";
+export * from "./tools/ChangeUnitsTool";
+export * from "./tools/ClipTools";
+export * from "./tools/DisplayStyleTools";
+export * from "./tools/EmphasizeElementsTool";
+export * from "./tools/FrustumDecoration";
+export * from "./tools/InspectElementTool";
+export * from "./tools/MapLayerTool";
+export * from "./tools/MeasureTileLoadTime";
+export * from "./tools/ModelAppearanceTools";
+export * from "./tools/parseArgs";
+export * from "./tools/parseBoolean";
+export * from "./tools/parseToggle";
+export * from "./tools/PlanarMaskTools";
+export * from "./tools/PlanProjectionTools";
+export * from "./tools/ProjectExtents";
+export * from "./tools/RealityModelTools";
+export * from "./tools/RealityTransitionTool";
+export * from "./tools/RenderSystemTools";
+export * from "./tools/RenderTargetTools";
+export * from "./tools/ReportWebGLCompatibilityTool";
+export * from "./tools/SavedViews";
+export * from "./tools/SelectionTools";
+export * from "./tools/SetGpuMemoryLimitTool";
+export * from "./tools/SourceAspectIdTools";
+export * from "./tools/TileRequestDecoration";
+export * from "./tools/TileTreeBoundsDecoration";
+export * from "./tools/ToolTipProvider";
+export * from "./tools/ViewportTools";
+export * from "./ui/Button";
+export * from "./ui/CheckBox";
+export * from "./ui/ColorInput";
+export * from "./ui/ComboBox";
+export * from "./ui/DataList";
+export * from "./ui/NestedMenu";
+export * from "./ui/NumericInput";
+export * from "./ui/RadioBox";
+export * from "./ui/Slider";
+export * from "./ui/TextBox";
+export * from "./widgets/DiagnosticsPanel";
+export * from "./widgets/FpsTracker";
+export * from "./widgets/GpuProfiler";
+export * from "./widgets/KeyinField";
+export * from "./widgets/MemoryTracker";
+export * from "./widgets/TileMemoryBreakdown";
+export * from "./widgets/TileStatisticsTracker";
+export * from "./widgets/ToolSettingsTracker";
+/** @docs-package-description
+ * The frontend-devtools package contains various tools and widgets for monitoring and debugging the front-end state of an iModel.js application.
+ */
+/**
+ * @docs-group-description Widgets
+ * Widgets that wrap some of the package's functionality into embeddable HTML controls.
+ */
+/**
+ * @docs-group-description Tools
+ * Interactive- and immediate-mode [tools]($docs/learning/frontend/Tools.md), most of which can be executed via key-in. All key-ins are documented in the package's README.
+ */
+/**
+ * @docs-group-description Controls
+ * Rudimentary HTML components used to build the widgets.
+ */
+/**
+ * @docs-group-description Effects
+ * Examples of screen-space effects produced by [RenderSystem.createScreenSpaceEffectBuilder]($frontend).
+ */
+/**
+ * @docs-group-description Utilities
+ * Utility functions used throughout the package.
+ */
+//# sourceMappingURL=frontend-devtools.d.ts.map

package/lib/esm/frontend-devtools.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"frontend-devtools.d.ts","sourceRoot":"","sources":["../../src/frontend-devtools.ts"],"names":[],"mappings":"AAKA,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AAEnC,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,0BAA0B,CAAC;AACzC,cAAc,kBAAkB,CAAC;AACjC,cAAc,sBAAsB,CAAC;AACrC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AAEnC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC;AAClC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,sBAAsB,CAAC;AACrC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC;AACxC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,wBAAwB,CAAC;AACvC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,sCAAsC,CAAC;AACrD,cAAc,oBAAoB,CAAC;AACnC,cAAc,wBAAwB,CAAC;AACvC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,kCAAkC,CAAC;AACjD,cAAc,yBAAyB,CAAC;AACxC,cAAc,uBAAuB,CAAC;AAEtC,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC;AAC9B,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAE7B,cAAc,4BAA4B,CAAC;AAC3C,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC;AACrC,cAAc,yBAAyB,CAAC;AACxC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,iCAAiC,CAAC;AAChD,cAAc,+BAA+B,CAAC;AAE9C;;GAEG;AAEH;;;GAGG;AAEH;;;GAGG;AAEH;;;GAGG;AAEH;;;GAGG;AAEH;;;GAGG"}

package/lib/esm/frontend-devtools.js

@@ -0,0 +1,86 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+export * from "./ClipboardUtilities";
+export * from "./FrontEndDevTools";
+export * from "./effects/Convolution";
+export * from "./effects/EffectTools";
+export * from "./effects/Explosion";
+export * from "./effects/FlipImage";
+export * from "./effects/LensDistortion";
+export * from "./effects/Random";
+export * from "./effects/Saturation";
+export * from "./effects/Snow";
+export * from "./effects/Vignette";
+export * from "./tools/AnimationIntervalTool";
+export * from "./tools/ChangeUnitsTool";
+export * from "./tools/ClipTools";
+export * from "./tools/DisplayStyleTools";
+export * from "./tools/EmphasizeElementsTool";
+export * from "./tools/FrustumDecoration";
+export * from "./tools/InspectElementTool";
+export * from "./tools/MapLayerTool";
+export * from "./tools/MeasureTileLoadTime";
+export * from "./tools/ModelAppearanceTools";
+export * from "./tools/parseArgs";
+export * from "./tools/parseBoolean";
+export * from "./tools/parseToggle";
+export * from "./tools/PlanarMaskTools";
+export * from "./tools/PlanProjectionTools";
+export * from "./tools/ProjectExtents";
+export * from "./tools/RealityModelTools";
+export * from "./tools/RealityTransitionTool";
+export * from "./tools/RenderSystemTools";
+export * from "./tools/RenderTargetTools";
+export * from "./tools/ReportWebGLCompatibilityTool";
+export * from "./tools/SavedViews";
+export * from "./tools/SelectionTools";
+export * from "./tools/SetGpuMemoryLimitTool";
+export * from "./tools/SourceAspectIdTools";
+export * from "./tools/TileRequestDecoration";
+export * from "./tools/TileTreeBoundsDecoration";
+export * from "./tools/ToolTipProvider";
+export * from "./tools/ViewportTools";
+export * from "./ui/Button";
+export * from "./ui/CheckBox";
+export * from "./ui/ColorInput";
+export * from "./ui/ComboBox";
+export * from "./ui/DataList";
+export * from "./ui/NestedMenu";
+export * from "./ui/NumericInput";
+export * from "./ui/RadioBox";
+export * from "./ui/Slider";
+export * from "./ui/TextBox";
+export * from "./widgets/DiagnosticsPanel";
+export * from "./widgets/FpsTracker";
+export * from "./widgets/GpuProfiler";
+export * from "./widgets/KeyinField";
+export * from "./widgets/MemoryTracker";
+export * from "./widgets/TileMemoryBreakdown";
+export * from "./widgets/TileStatisticsTracker";
+export * from "./widgets/ToolSettingsTracker";
+/** @docs-package-description
+ * The frontend-devtools package contains various tools and widgets for monitoring and debugging the front-end state of an iModel.js application.
+ */
+/**
+ * @docs-group-description Widgets
+ * Widgets that wrap some of the package's functionality into embeddable HTML controls.
+ */
+/**
+ * @docs-group-description Tools
+ * Interactive- and immediate-mode [tools]($docs/learning/frontend/Tools.md), most of which can be executed via key-in. All key-ins are documented in the package's README.
+ */
+/**
+ * @docs-group-description Controls
+ * Rudimentary HTML components used to build the widgets.
+ */
+/**
+ * @docs-group-description Effects
+ * Examples of screen-space effects produced by [RenderSystem.createScreenSpaceEffectBuilder]($frontend).
+ */
+/**
+ * @docs-group-description Utilities
+ * Utility functions used throughout the package.
+ */
+//# sourceMappingURL=frontend-devtools.js.map

package/lib/esm/frontend-devtools.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"frontend-devtools.js","sourceRoot":"","sources":["../../src/frontend-devtools.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AAEnC,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,0BAA0B,CAAC;AACzC,cAAc,kBAAkB,CAAC;AACjC,cAAc,sBAAsB,CAAC;AACrC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AAEnC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC;AAClC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,sBAAsB,CAAC;AACrC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC;AACxC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,wBAAwB,CAAC;AACvC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,sCAAsC,CAAC;AACrD,cAAc,oBAAoB,CAAC;AACnC,cAAc,wBAAwB,CAAC;AACvC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,kCAAkC,CAAC;AACjD,cAAc,yBAAyB,CAAC;AACxC,cAAc,uBAAuB,CAAC;AAEtC,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC;AAC9B,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAE7B,cAAc,4BAA4B,CAAC;AAC3C,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC;AACrC,cAAc,yBAAyB,CAAC;AACxC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,iCAAiC,CAAC;AAChD,cAAc,+BAA+B,CAAC;AAE9C;;GAEG;AAEH;;;GAGG;AAEH;;;GAGG;AAEH;;;GAGG;AAEH;;;GAGG;AAEH;;;GAGG","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\nexport * from \"./ClipboardUtilities\";\r\nexport * from \"./FrontEndDevTools\";\r\n\r\nexport * from \"./effects/Convolution\";\r\nexport * from \"./effects/EffectTools\";\r\nexport * from \"./effects/Explosion\";\r\nexport * from \"./effects/FlipImage\";\r\nexport * from \"./effects/LensDistortion\";\r\nexport * from \"./effects/Random\";\r\nexport * from \"./effects/Saturation\";\r\nexport * from \"./effects/Snow\";\r\nexport * from \"./effects/Vignette\";\r\n\r\nexport * from \"./tools/AnimationIntervalTool\";\r\nexport * from \"./tools/ChangeUnitsTool\";\r\nexport * from \"./tools/ClipTools\";\r\nexport * from \"./tools/DisplayStyleTools\";\r\nexport * from \"./tools/EmphasizeElementsTool\";\r\nexport * from \"./tools/FrustumDecoration\";\r\nexport * from \"./tools/InspectElementTool\";\r\nexport * from \"./tools/MapLayerTool\";\r\nexport * from \"./tools/MeasureTileLoadTime\";\r\nexport * from \"./tools/ModelAppearanceTools\";\r\nexport * from \"./tools/parseArgs\";\r\nexport * from \"./tools/parseBoolean\";\r\nexport * from \"./tools/parseToggle\";\r\nexport * from \"./tools/PlanarMaskTools\";\r\nexport * from \"./tools/PlanProjectionTools\";\r\nexport * from \"./tools/ProjectExtents\";\r\nexport * from \"./tools/RealityModelTools\";\r\nexport * from \"./tools/RealityTransitionTool\";\r\nexport * from \"./tools/RenderSystemTools\";\r\nexport * from \"./tools/RenderTargetTools\";\r\nexport * from \"./tools/ReportWebGLCompatibilityTool\";\r\nexport * from \"./tools/SavedViews\";\r\nexport * from \"./tools/SelectionTools\";\r\nexport * from \"./tools/SetGpuMemoryLimitTool\";\r\nexport * from \"./tools/SourceAspectIdTools\";\r\nexport * from \"./tools/TileRequestDecoration\";\r\nexport * from \"./tools/TileTreeBoundsDecoration\";\r\nexport * from \"./tools/ToolTipProvider\";\r\nexport * from \"./tools/ViewportTools\";\r\n\r\nexport * from \"./ui/Button\";\r\nexport * from \"./ui/CheckBox\";\r\nexport * from \"./ui/ColorInput\";\r\nexport * from \"./ui/ComboBox\";\r\nexport * from \"./ui/DataList\";\r\nexport * from \"./ui/NestedMenu\";\r\nexport * from \"./ui/NumericInput\";\r\nexport * from \"./ui/RadioBox\";\r\nexport * from \"./ui/Slider\";\r\nexport * from \"./ui/TextBox\";\r\n\r\nexport * from \"./widgets/DiagnosticsPanel\";\r\nexport * from \"./widgets/FpsTracker\";\r\nexport * from \"./widgets/GpuProfiler\";\r\nexport * from \"./widgets/KeyinField\";\r\nexport * from \"./widgets/MemoryTracker\";\r\nexport * from \"./widgets/TileMemoryBreakdown\";\r\nexport * from \"./widgets/TileStatisticsTracker\";\r\nexport * from \"./widgets/ToolSettingsTracker\";\r\n\r\n/** @docs-package-description\r\n * The frontend-devtools package contains various tools and widgets for monitoring and debugging the front-end state of an iModel.js application.\r\n */\r\n\r\n/**\r\n * @docs-group-description Widgets\r\n * Widgets that wrap some of the package's functionality into embeddable HTML controls.\r\n */\r\n\r\n/**\r\n * @docs-group-description Tools\r\n * Interactive- and immediate-mode [tools]($docs/learning/frontend/Tools.md), most of which can be executed via key-in. All key-ins are documented in the package's README.\r\n */\r\n\r\n/**\r\n * @docs-group-description Controls\r\n * Rudimentary HTML components used to build the widgets.\r\n */\r\n\r\n/**\r\n * @docs-group-description Effects\r\n * Examples of screen-space effects produced by [RenderSystem.createScreenSpaceEffectBuilder]($frontend).\r\n */\r\n\r\n/**\r\n * @docs-group-description Utilities\r\n * Utility functions used throughout the package.\r\n */\r\n"]}

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

@@ -0,0 +1,16 @@
+/** @packageDocumentation
+ * @module Tools
+ */
+import { BeDuration } from "@itwin/core-bentley";
+import { Tool } from "@itwin/core-frontend";
+/** Changes the [IModelApp.animationInterval]($frontend). Specify the interval in integer milliseconds; or pass any string not parseable as an integer to disable the animation interval callback.
+ * @beta
+ */
+export declare class AnimationIntervalTool extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    run(interval?: BeDuration): Promise<boolean>;
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
+//# sourceMappingURL=AnimationIntervalTool.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"AnimationIntervalTool.d.ts","sourceRoot":"","sources":["../../../src/tools/AnimationIntervalTool.ts"],"names":[],"mappings":"AAKA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAa,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAEvD;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,IAAI;IAC7C,OAAuB,MAAM,SAAuB;IACpD,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAE5B,GAAG,CAAC,QAAQ,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC;IAK5C,WAAW,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAKvE"}

package/lib/esm/tools/AnimationIntervalTool.js

@@ -0,0 +1,27 @@
+/*---------------------------------------------------------------------------------------------
+* 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 { BeDuration } from "@itwin/core-bentley";
+import { IModelApp, Tool } from "@itwin/core-frontend";
+/** Changes the [IModelApp.animationInterval]($frontend). Specify the interval in integer milliseconds; or pass any string not parseable as an integer to disable the animation interval callback.
+ * @beta
+ */
+export class AnimationIntervalTool extends Tool {
+    static get minArgs() { return 1; }
+    static get maxArgs() { return 1; }
+    async run(interval) {
+        IModelApp.animationInterval = interval;
+        return true;
+    }
+    async parseAndRun(...args) {
+        const millis = Number.parseInt(args[0], 10);
+        const interval = !Number.isNaN(millis) ? BeDuration.fromMilliseconds(millis) : undefined;
+        return this.run(interval);
+    }
+}
+AnimationIntervalTool.toolId = "AnimationInterval";
+//# sourceMappingURL=AnimationIntervalTool.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"AnimationIntervalTool.js","sourceRoot":"","sources":["../../../src/tools/AnimationIntervalTool.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAEvD;;GAEG;AACH,MAAM,OAAO,qBAAsB,SAAQ,IAAI;IAEtC,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAElC,KAAK,CAAC,GAAG,CAAC,QAAqB;QAC7C,SAAS,CAAC,iBAAiB,GAAG,QAAQ,CAAC;QACvC,OAAO,IAAI,CAAC;IACd,CAAC;IAEe,KAAK,CAAC,WAAW,CAAC,GAAG,IAAc;QACjD,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QAC5C,MAAM,QAAQ,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACzF,OAAO,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC5B,CAAC;;AAbsB,4BAAM,GAAG,mBAAmB,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 { BeDuration } from \"@itwin/core-bentley\";\r\nimport { IModelApp, Tool } from \"@itwin/core-frontend\";\r\n\r\n/** Changes the [IModelApp.animationInterval]($frontend). Specify the interval in integer milliseconds; or pass any string not parseable as an integer to disable the animation interval callback.\r\n * @beta\r\n */\r\nexport class AnimationIntervalTool extends Tool {\r\n  public static override toolId = \"AnimationInterval\";\r\n  public static override get minArgs() { return 1; }\r\n  public static override get maxArgs() { return 1; }\r\n\r\n  public override async run(interval?: BeDuration): Promise<boolean> {\r\n    IModelApp.animationInterval = interval;\r\n    return true;\r\n  }\r\n\r\n  public override async parseAndRun(...args: string[]): Promise<boolean> {\r\n    const millis = Number.parseInt(args[0], 10);\r\n    const interval = !Number.isNaN(millis) ? BeDuration.fromMilliseconds(millis) : undefined;\r\n    return this.run(interval);\r\n  }\r\n}\r\n"]}

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

@@ -0,0 +1,16 @@
+/** @packageDocumentation
+ * @module Tools
+ */
+import { Tool } from "@itwin/core-frontend";
+/** Controls whether quantities are formatted using imperial or metric units.
+ * Such formatting is used in many places; one example is the output of the MeasureTool.
+ * @beta
+ */
+export declare class ChangeUnitsTool extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    run(useMetric?: boolean): Promise<boolean>;
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
+//# sourceMappingURL=ChangeUnitsTool.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ChangeUnitsTool.d.ts","sourceRoot":"","sources":["../../../src/tools/ChangeUnitsTool.ts"],"names":[],"mappings":"AAKA;;GAEG;AAEH,OAAO,EAAa,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAKvD;;;GAGG;AACH,qBAAa,eAAgB,SAAQ,IAAI;IACvC,OAAuB,MAAM,SAAiB;IAC9C,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAG5B,GAAG,CAAC,SAAS,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAe1C,WAAW,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAOvE"}

package/lib/esm/tools/ChangeUnitsTool.js

@@ -0,0 +1,38 @@
+/*---------------------------------------------------------------------------------------------
+* 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";
+// CSpell: ignore fmtr
+/** Controls whether quantities are formatted using imperial or metric units.
+ * Such formatting is used in many places; one example is the output of the MeasureTool.
+ * @beta
+ */
+export class ChangeUnitsTool extends Tool {
+    static get minArgs() { return 0; }
+    static get maxArgs() { return 1; }
+    // support boolean for backwards compatibility
+    async run(useMetric) {
+        const fmtr = IModelApp.quantityFormatter;
+        // if no arg then toggle to metric from any non-metric unit system
+        const useImperial = undefined !== useMetric ? !useMetric : fmtr.activeUnitSystem === "metric";
+        const unitSystem = useImperial ? "imperial" : "metric";
+        if (unitSystem !== fmtr.activeUnitSystem) {
+            await fmtr.setActiveUnitSystem(unitSystem);
+            await IModelApp.toolAdmin.startDefaultTool();
+        }
+        return true;
+    }
+    async parseAndRun(...args) {
+        const enable = parseToggle(args[0]);
+        if (typeof enable !== "string")
+            await this.run(enable);
+        return true;
+    }
+}
+ChangeUnitsTool.toolId = "ChangeUnits";
+//# sourceMappingURL=ChangeUnitsTool.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ChangeUnitsTool.js","sourceRoot":"","sources":["../../../src/tools/ChangeUnitsTool.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,sBAAsB;AAEtB;;;GAGG;AACH,MAAM,OAAO,eAAgB,SAAQ,IAAI;IAEhC,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAElD,8CAA8C;IAC9B,KAAK,CAAC,GAAG,CAAC,SAAmB;QAC3C,MAAM,IAAI,GAAG,SAAS,CAAC,iBAAiB,CAAC;QAEzC,kEAAkE;QAClE,MAAM,WAAW,GAAG,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,KAAK,QAAQ,CAAC;QAC9F,MAAM,UAAU,GAAG,WAAW,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC;QAEvD,IAAI,UAAU,KAAK,IAAI,CAAC,gBAAgB,EAAE;YACxC,MAAM,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;YAC3C,MAAM,SAAS,CAAC,SAAS,CAAC,gBAAgB,EAAE,CAAC;SAC9C;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAEe,KAAK,CAAC,WAAW,CAAC,GAAG,IAAc;QACjD,MAAM,MAAM,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QACpC,IAAI,OAAO,MAAM,KAAK,QAAQ;YAC5B,MAAM,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAEzB,OAAO,IAAI,CAAC;IACd,CAAC;;AA1BsB,sBAAM,GAAG,aAAa,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, Tool } from \"@itwin/core-frontend\";\r\nimport { parseToggle } from \"./parseToggle\";\r\n\r\n// CSpell: ignore fmtr\r\n\r\n/** Controls whether quantities are formatted using imperial or metric units.\r\n * Such formatting is used in many places; one example is the output of the MeasureTool.\r\n * @beta\r\n */\r\nexport class ChangeUnitsTool extends Tool {\r\n  public static override toolId = \"ChangeUnits\";\r\n  public static override get minArgs() { return 0; }\r\n  public static override get maxArgs() { return 1; }\r\n\r\n  // support boolean for backwards compatibility\r\n  public override async run(useMetric?: boolean): Promise<boolean> {\r\n    const fmtr = IModelApp.quantityFormatter;\r\n\r\n    // if no arg then toggle to metric from any non-metric unit system\r\n    const useImperial = undefined !== useMetric ? !useMetric : fmtr.activeUnitSystem === \"metric\";\r\n    const unitSystem = useImperial ? \"imperial\" : \"metric\";\r\n\r\n    if (unitSystem !== fmtr.activeUnitSystem) {\r\n      await fmtr.setActiveUnitSystem(unitSystem);\r\n      await IModelApp.toolAdmin.startDefaultTool();\r\n    }\r\n\r\n    return true;\r\n  }\r\n\r\n  public override async parseAndRun(...args: string[]): Promise<boolean> {\r\n    const enable = parseToggle(args[0]);\r\n    if (typeof enable !== \"string\")\r\n      await this.run(enable);\r\n\r\n    return true;\r\n  }\r\n}\r\n"]}

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

@@ -0,0 +1,68 @@
+import { Tool, Viewport } from "@itwin/core-frontend";
+import { DisplayStyleTool } from "./DisplayStyleTools";
+/** This tool specifies or un-specifies a clip color to use for pixels inside or outside the clip region.
+ * Arguments can be:
+ * - clear
+ * - inside   <color string> | clear
+ * - outside  <color string> | clear
+ * <color string> must be in one of the following forms:
+ * "rgb(255,0,0)"
+ * "rgba(255,0,0,255)"
+ * "rgb(100%,0%,0%)"
+ * "hsl(120,50%,50%)"
+ * "#rrbbgg"
+ * "blanchedAlmond" (see possible values from [[ColorByName]]). Case insensitive.
+ * @see [ColorDef]
+ * @beta
+ */
+export declare class ClipColorTool extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    private _clearClipColors;
+    private setClipColor;
+    /** This runs the tool using the given arguments, specifying or unspecifying a clip color to use for pixels inside or outside the clip region.
+     * Arguments can be:
+     * - clear
+     * - inside   <color string> | clear
+     * - outside  <color string> | clear
+     * <color string> must be in one of the following forms:
+     * "rgb(255,0,0)"
+     * "rgba(255,0,0,255)"
+     * "rgb(100%,0%,0%)"
+     * "hsl(120,50%,50%)"
+     * "#rrbbgg"
+     * "blanchedAlmond" (see possible values from [[ColorByName]]). Case insensitive.
+     * @beta
+     */
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
+/** Controls a view state's view details' flag for producing cut geometry for a clip style.
+ * @beta
+ */
+export declare class ToggleSectionCutTool extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    /** This method runs the tool, controlling a view state's view details' flag for producing cut geometry for a clip style.
+     * @param produceCutGeometry whether to produce cut geometry
+     */
+    run(produceCutGeometry?: boolean): Promise<boolean>;
+    /** Executes this tool's run method with args[0] containing `produceCutGeometry`.
+     * @see [[run]]
+     */
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
+/** Simple tool that toggles a hard-coded clip style overriding various aspects of the cut geometry appearance.
+ * @beta
+ */
+export declare class TestClipStyleTool extends DisplayStyleTool {
+    static toolId: string;
+    static get maxArgs(): number;
+    static get minArgs(): number;
+    private _useStyle;
+    protected get require3d(): boolean;
+    protected parse(args: string[]): boolean;
+    protected execute(vp: Viewport): boolean;
+}
+//# sourceMappingURL=ClipTools.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ClipTools.d.ts","sourceRoot":"","sources":["../../../src/tools/ClipTools.ts"],"names":[],"mappings":"AAYA,OAAO,EAAa,IAAI,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAGjE,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAEvD;;;;;;;;;;;;;;GAcG;AACH,qBAAa,aAAc,SAAQ,IAAI;IACrC,OAAuB,MAAM,SAAmB;IAChD,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAElD,OAAO,CAAC,gBAAgB;IASxB,OAAO,CAAC,YAAY;IASpB;;;;;;;;;;;;;OAaG;IACmB,WAAW,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAcvE;AAED;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,IAAI;IAC5C,OAAuB,MAAM,SAAsB;IACnD,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAElD;;OAEG;IACmB,GAAG,CAAC,kBAAkB,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAmBzE;;OAEG;IACmB,WAAW,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAOvE;AAED;;GAEG;AACH,qBAAa,iBAAkB,SAAQ,gBAAgB;IACrD,OAAuB,MAAM,SAAmB;IAChD,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAElD,OAAO,CAAC,SAAS,CAAS;IAE1B,cAAuB,SAAS,YAAmB;IAEnD,SAAS,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO;IAKxC,SAAS,CAAC,OAAO,CAAC,EAAE,EAAE,QAAQ,GAAG,OAAO;CA+BzC"}

package/lib/esm/tools/ClipTools.js

@@ -0,0 +1,159 @@
+/*---------------------------------------------------------------------------------------------
+* 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 { ClipStyle, ColorByName, ColorDef, LinePixels, RenderMode, RgbColor, } from "@itwin/core-common";
+import { IModelApp, Tool } from "@itwin/core-frontend";
+import { parseToggle } from "./parseToggle";
+import { parseBoolean } from "./parseBoolean";
+import { DisplayStyleTool } from "./DisplayStyleTools";
+/** This tool specifies or un-specifies a clip color to use for pixels inside or outside the clip region.
+ * Arguments can be:
+ * - clear
+ * - inside   <color string> | clear
+ * - outside  <color string> | clear
+ * <color string> must be in one of the following forms:
+ * "rgb(255,0,0)"
+ * "rgba(255,0,0,255)"
+ * "rgb(100%,0%,0%)"
+ * "hsl(120,50%,50%)"
+ * "#rrbbgg"
+ * "blanchedAlmond" (see possible values from [[ColorByName]]). Case insensitive.
+ * @see [ColorDef]
+ * @beta
+ */
+export class ClipColorTool extends Tool {
+    static get minArgs() { return 1; }
+    static get maxArgs() { return 2; }
+    _clearClipColors() {
+        var _a;
+        const vp = IModelApp.viewManager.selectedView;
+        if (undefined !== vp) {
+            const props = (_a = vp.displayStyle.settings.clipStyle.toJSON()) !== null && _a !== void 0 ? _a : {};
+            props.insideColor = props.outsideColor = undefined;
+            vp.displayStyle.settings.clipStyle = ClipStyle.fromJSON(props);
+        }
+    }
+    setClipColor(colStr, which) {
+        var _a;
+        const vp = IModelApp.viewManager.selectedView;
+        if (vp) {
+            const props = (_a = vp.displayStyle.settings.clipStyle.toJSON()) !== null && _a !== void 0 ? _a : {};
+            props[which] = colStr === "clear" ? undefined : RgbColor.fromColorDef(ColorDef.fromString(colStr));
+            vp.displayStyle.settings.clipStyle = ClipStyle.fromJSON(props);
+        }
+    }
+    /** This runs the tool using the given arguments, specifying or unspecifying a clip color to use for pixels inside or outside the clip region.
+     * Arguments can be:
+     * - clear
+     * - inside   <color string> | clear
+     * - outside  <color string> | clear
+     * <color string> must be in one of the following forms:
+     * "rgb(255,0,0)"
+     * "rgba(255,0,0,255)"
+     * "rgb(100%,0%,0%)"
+     * "hsl(120,50%,50%)"
+     * "#rrbbgg"
+     * "blanchedAlmond" (see possible values from [[ColorByName]]). Case insensitive.
+     * @beta
+     */
+    async parseAndRun(...args) {
+        if (1 === args.length) {
+            if (args[0] === "clear")
+                this._clearClipColors();
+            return true;
+        }
+        const which = args[0];
+        if (which === "inside" || which === "outside")
+            this.setClipColor(args[1], "inside" === which ? "insideColor" : "outsideColor");
+        return true;
+    }
+}
+ClipColorTool.toolId = "ClipColorTool";
+/** Controls a view state's view details' flag for producing cut geometry for a clip style.
+ * @beta
+ */
+export class ToggleSectionCutTool extends Tool {
+    static get minArgs() { return 0; }
+    static get maxArgs() { return 1; }
+    /** This method runs the tool, controlling a view state's view details' flag for producing cut geometry for a clip style.
+     * @param produceCutGeometry whether to produce cut geometry
+     */
+    async run(produceCutGeometry) {
+        const vp = IModelApp.viewManager.selectedView;
+        if (vp) {
+            const style = vp.view.displayStyle.settings.clipStyle;
+            produceCutGeometry = produceCutGeometry !== null && produceCutGeometry !== void 0 ? produceCutGeometry : !style.produceCutGeometry;
+            if (produceCutGeometry !== style.produceCutGeometry) {
+                const json = {
+                    ...vp.view.displayStyle.settings.clipStyle.toJSON(),
+                    produceCutGeometry,
+                };
+                vp.view.displayStyle.settings.clipStyle = ClipStyle.fromJSON(json);
+                vp.invalidateScene();
+            }
+        }
+        return true;
+    }
+    /** Executes this tool's run method with args[0] containing `produceCutGeometry`.
+     * @see [[run]]
+     */
+    async parseAndRun(...args) {
+        const enable = parseToggle(args[0]);
+        if (typeof enable !== "string")
+            await this.run(enable);
+        return true;
+    }
+}
+ToggleSectionCutTool.toolId = "ToggleSectionCut";
+/** Simple tool that toggles a hard-coded clip style overriding various aspects of the cut geometry appearance.
+ * @beta
+ */
+export class TestClipStyleTool extends DisplayStyleTool {
+    constructor() {
+        super(...arguments);
+        this._useStyle = false;
+    }
+    static get maxArgs() { return 1; }
+    static get minArgs() { return 1; }
+    get require3d() { return true; }
+    parse(args) {
+        var _a;
+        this._useStyle = (_a = parseBoolean(args[0])) !== null && _a !== void 0 ? _a : false;
+        return true;
+    }
+    execute(vp) {
+        const props = { produceCutGeometry: true };
+        if (this._useStyle) {
+            props.cutStyle = {
+                viewflags: {
+                    renderMode: RenderMode.SmoothShade,
+                    visibleEdges: true,
+                    hiddenEdges: false,
+                },
+                appearance: {
+                    rgb: { r: 0xff, g: 0x7f, b: 0 },
+                    transparency: 0.5,
+                    nonLocatable: true,
+                },
+                hiddenLine: {
+                    visible: {
+                        ovrColor: true,
+                        color: ColorByName.blue,
+                        pattern: LinePixels.Solid,
+                        width: 3,
+                    },
+                },
+            };
+        }
+        vp.displayStyle.settings.clipStyle = ClipStyle.fromJSON(props);
+        vp.invalidateRenderPlan();
+        vp.setFeatureOverrideProviderChanged();
+        return true;
+    }
+}
+TestClipStyleTool.toolId = "TestClipStyle";
+//# sourceMappingURL=ClipTools.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ClipTools.js","sourceRoot":"","sources":["../../../src/tools/ClipTools.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F;;GAEG;AAEH,OAAO,EACL,SAAS,EAAkB,WAAW,EAAE,QAAQ,EAAE,UAAU,EAAE,UAAU,EAAE,QAAQ,GACnF,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAE,IAAI,EAAY,MAAM,sBAAsB,CAAC;AACjE,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAEvD;;;;;;;;;;;;;;GAcG;AACH,MAAM,OAAO,aAAc,SAAQ,IAAI;IAE9B,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAE1C,gBAAgB;;QACtB,MAAM,EAAE,GAAG,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC;QAC9C,IAAI,SAAS,KAAK,EAAE,EAAE;YACpB,MAAM,KAAK,GAAG,MAAA,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,SAAS,CAAC,MAAM,EAAE,mCAAI,EAAE,CAAC;YAChE,KAAK,CAAC,WAAW,GAAG,KAAK,CAAC,YAAY,GAAG,SAAS,CAAC;YACnD,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,SAAS,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;SAChE;IACH,CAAC;IAEO,YAAY,CAAC,MAAc,EAAE,KAAqC;;QACxE,MAAM,EAAE,GAAG,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC;QAC9C,IAAI,EAAE,EAAE;YACN,MAAM,KAAK,GAAG,MAAA,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,SAAS,CAAC,MAAM,EAAE,mCAAI,EAAE,CAAC;YAChE,KAAK,CAAC,KAAK,CAAC,GAAG,MAAM,KAAK,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;YACnG,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,SAAS,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;SAChE;IACH,CAAC;IAED;;;;;;;;;;;;;OAaG;IACa,KAAK,CAAC,WAAW,CAAC,GAAG,IAAc;QACjD,IAAI,CAAC,KAAK,IAAI,CAAC,MAAM,EAAE;YACrB,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,OAAO;gBACrB,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAE1B,OAAO,IAAI,CAAC;SACb;QAED,MAAM,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QACtB,IAAI,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,SAAS;YAC3C,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,QAAQ,KAAK,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC;QAElF,OAAO,IAAI,CAAC;IACd,CAAC;;AAjDsB,oBAAM,GAAG,eAAe,CAAC;AAoDlD;;GAEG;AACH,MAAM,OAAO,oBAAqB,SAAQ,IAAI;IAErC,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAElD;;OAEG;IACa,KAAK,CAAC,GAAG,CAAC,kBAA4B;QACpD,MAAM,EAAE,GAAG,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC;QAC9C,IAAI,EAAE,EAAE;YACN,MAAM,KAAK,GAAG,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,SAAS,CAAC;YACtD,kBAAkB,GAAG,kBAAkB,aAAlB,kBAAkB,cAAlB,kBAAkB,GAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC;YACrE,IAAI,kBAAkB,KAAK,KAAK,CAAC,kBAAkB,EAAE;gBACnD,MAAM,IAAI,GAAG;oBACX,GAAG,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,SAAS,CAAC,MAAM,EAAE;oBACnD,kBAAkB;iBACnB,CAAC;gBAEF,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,SAAS,GAAG,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;gBACnE,EAAE,CAAC,eAAe,EAAE,CAAC;aACtB;SACF;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACa,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;;AAnCsB,2BAAM,GAAG,kBAAkB,CAAC;AAsCrD;;GAEG;AACH,MAAM,OAAO,iBAAkB,SAAQ,gBAAgB;IAAvD;;QAKU,cAAS,GAAG,KAAK,CAAC;IAwC5B,CAAC;IA3CQ,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAIlD,IAAuB,SAAS,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IAEzC,KAAK,CAAC,IAAc;;QAC5B,IAAI,CAAC,SAAS,GAAG,MAAA,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,mCAAI,KAAK,CAAC;QAChD,OAAO,IAAI,CAAC;IACd,CAAC;IAES,OAAO,CAAC,EAAY;QAC5B,MAAM,KAAK,GAAmB,EAAE,kBAAkB,EAAE,IAAI,EAAE,CAAC;QAC3D,IAAI,IAAI,CAAC,SAAS,EAAE;YAClB,KAAK,CAAC,QAAQ,GAAG;gBACf,SAAS,EAAE;oBACT,UAAU,EAAE,UAAU,CAAC,WAAW;oBAClC,YAAY,EAAE,IAAI;oBAClB,WAAW,EAAE,KAAK;iBACnB;gBACD,UAAU,EAAE;oBACV,GAAG,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,EAAE;oBAC/B,YAAY,EAAE,GAAG;oBACjB,YAAY,EAAE,IAAI;iBACnB;gBACD,UAAU,EAAE;oBACV,OAAO,EAAE;wBACP,QAAQ,EAAE,IAAI;wBACd,KAAK,EAAE,WAAW,CAAC,IAAI;wBACvB,OAAO,EAAE,UAAU,CAAC,KAAK;wBACzB,KAAK,EAAE,CAAC;qBACT;iBACF;aACF,CAAC;SACH;QAED,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,SAAS,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAC/D,EAAE,CAAC,oBAAoB,EAAE,CAAC;QAC1B,EAAE,CAAC,iCAAiC,EAAE,CAAC;QAEvC,OAAO,IAAI,CAAC;IACd,CAAC;;AA3CsB,wBAAM,GAAG,eAAe,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n\r\n/** @packageDocumentation\r\n * @module Tools\r\n */\r\n\r\nimport {\r\n  ClipStyle, ClipStyleProps, ColorByName, ColorDef, LinePixels, RenderMode, RgbColor,\r\n} from \"@itwin/core-common\";\r\nimport { IModelApp, Tool, Viewport } from \"@itwin/core-frontend\";\r\nimport { parseToggle } from \"./parseToggle\";\r\nimport { parseBoolean } from \"./parseBoolean\";\r\nimport { DisplayStyleTool } from \"./DisplayStyleTools\";\r\n\r\n/** This tool specifies or un-specifies a clip color to use for pixels inside or outside the clip region.\r\n * Arguments can be:\r\n * - clear\r\n * - inside   <color string> | clear\r\n * - outside  <color string> | clear\r\n * <color string> must be in one of the following forms:\r\n * \"rgb(255,0,0)\"\r\n * \"rgba(255,0,0,255)\"\r\n * \"rgb(100%,0%,0%)\"\r\n * \"hsl(120,50%,50%)\"\r\n * \"#rrbbgg\"\r\n * \"blanchedAlmond\" (see possible values from [[ColorByName]]). Case insensitive.\r\n * @see [ColorDef]\r\n * @beta\r\n */\r\nexport class ClipColorTool extends Tool {\r\n  public static override toolId = \"ClipColorTool\";\r\n  public static override get minArgs() { return 1; }\r\n  public static override get maxArgs() { return 2; }\r\n\r\n  private _clearClipColors() {\r\n    const vp = IModelApp.viewManager.selectedView;\r\n    if (undefined !== vp) {\r\n      const props = vp.displayStyle.settings.clipStyle.toJSON() ?? {};\r\n      props.insideColor = props.outsideColor = undefined;\r\n      vp.displayStyle.settings.clipStyle = ClipStyle.fromJSON(props);\r\n    }\r\n  }\r\n\r\n  private setClipColor(colStr: string, which: \"insideColor\" | \"outsideColor\") {\r\n    const vp = IModelApp.viewManager.selectedView;\r\n    if (vp) {\r\n      const props = vp.displayStyle.settings.clipStyle.toJSON() ?? {};\r\n      props[which] = colStr === \"clear\" ? undefined : RgbColor.fromColorDef(ColorDef.fromString(colStr));\r\n      vp.displayStyle.settings.clipStyle = ClipStyle.fromJSON(props);\r\n    }\r\n  }\r\n\r\n  /** This runs the tool using the given arguments, specifying or unspecifying a clip color to use for pixels inside or outside the clip region.\r\n   * Arguments can be:\r\n   * - clear\r\n   * - inside   <color string> | clear\r\n   * - outside  <color string> | clear\r\n   * <color string> must be in one of the following forms:\r\n   * \"rgb(255,0,0)\"\r\n   * \"rgba(255,0,0,255)\"\r\n   * \"rgb(100%,0%,0%)\"\r\n   * \"hsl(120,50%,50%)\"\r\n   * \"#rrbbgg\"\r\n   * \"blanchedAlmond\" (see possible values from [[ColorByName]]). Case insensitive.\r\n   * @beta\r\n   */\r\n  public override async parseAndRun(...args: string[]): Promise<boolean> {\r\n    if (1 === args.length) {\r\n      if (args[0] === \"clear\")\r\n        this._clearClipColors();\r\n\r\n      return true;\r\n    }\r\n\r\n    const which = args[0];\r\n    if (which === \"inside\" || which === \"outside\")\r\n      this.setClipColor(args[1], \"inside\" === which ? \"insideColor\" : \"outsideColor\");\r\n\r\n    return true;\r\n  }\r\n}\r\n\r\n/** Controls a view state's view details' flag for producing cut geometry for a clip style.\r\n * @beta\r\n */\r\nexport class ToggleSectionCutTool extends Tool {\r\n  public static override toolId = \"ToggleSectionCut\";\r\n  public static override get minArgs() { return 0; }\r\n  public static override get maxArgs() { return 1; }\r\n\r\n  /** This method runs the tool, controlling a view state's view details' flag for producing cut geometry for a clip style.\r\n   * @param produceCutGeometry whether to produce cut geometry\r\n   */\r\n  public override async run(produceCutGeometry?: boolean): Promise<boolean> {\r\n    const vp = IModelApp.viewManager.selectedView;\r\n    if (vp) {\r\n      const style = vp.view.displayStyle.settings.clipStyle;\r\n      produceCutGeometry = produceCutGeometry ?? !style.produceCutGeometry;\r\n      if (produceCutGeometry !== style.produceCutGeometry) {\r\n        const json = {\r\n          ...vp.view.displayStyle.settings.clipStyle.toJSON(),\r\n          produceCutGeometry,\r\n        };\r\n\r\n        vp.view.displayStyle.settings.clipStyle = ClipStyle.fromJSON(json);\r\n        vp.invalidateScene();\r\n      }\r\n    }\r\n\r\n    return true;\r\n  }\r\n\r\n  /** Executes this tool's run method with args[0] containing `produceCutGeometry`.\r\n   * @see [[run]]\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\r\n/** Simple tool that toggles a hard-coded clip style overriding various aspects of the cut geometry appearance.\r\n * @beta\r\n */\r\nexport class TestClipStyleTool extends DisplayStyleTool {\r\n  public static override toolId = \"TestClipStyle\";\r\n  public static override get maxArgs() { return 1; }\r\n  public static override get minArgs() { return 1; }\r\n\r\n  private _useStyle = false;\r\n\r\n  protected override get require3d() { return true; }\r\n\r\n  protected parse(args: string[]): boolean {\r\n    this._useStyle = parseBoolean(args[0]) ?? false;\r\n    return true;\r\n  }\r\n\r\n  protected execute(vp: Viewport): boolean {\r\n    const props: ClipStyleProps = { produceCutGeometry: true };\r\n    if (this._useStyle) {\r\n      props.cutStyle = {\r\n        viewflags: {\r\n          renderMode: RenderMode.SmoothShade,\r\n          visibleEdges: true,\r\n          hiddenEdges: false,\r\n        },\r\n        appearance: {\r\n          rgb: { r: 0xff, g: 0x7f, b: 0 },\r\n          transparency: 0.5,\r\n          nonLocatable: true,\r\n        },\r\n        hiddenLine: {\r\n          visible: {\r\n            ovrColor: true,\r\n            color: ColorByName.blue,\r\n            pattern: LinePixels.Solid,\r\n            width: 3,\r\n          },\r\n        },\r\n      };\r\n    }\r\n\r\n    vp.displayStyle.settings.clipStyle = ClipStyle.fromJSON(props);\r\n    vp.invalidateRenderPlan();\r\n    vp.setFeatureOverrideProviderChanged();\r\n\r\n    return true;\r\n  }\r\n}\r\n"]}