@itwin/frontend-devtools 3.0.0-dev.72

package/lib/FrontEndDevTools.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FrontEndDevTools.js","sourceRoot":"","sources":["../src/FrontEndDevTools.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,wDAAiD;AACjD,uDAA+I;AAC/I,uDAAyD;AACzD,mDAAsD;AACtD,mDAAuE;AACvE,6DAAsF;AACtF,qDAA0E;AAC1E,yCAA4C;AAC5C,iDAAoE;AACpE,6DAAma;AACna,yDAAqe;AACre,yEAAsE;AACtE,6DAA0D;AAC1D,iDAA2F;AAC3F,iEAEmC;AACnC,yEAEuC;AACvC,iEAA8H;AAC9H,mEAAgE;AAChE,uDAI8B;AAC9B,qEAAsE;AACtE,uEAGsC;AACtC,qEAAgJ;AAChJ,2DAAkE;AAClE,iEAGmC;AACnC,yEAAsE;AACtE,iEAA8H;AAC9H,iEAGmC;AACnC,uFAAoF;AACpF,mDAAoF;AACpF,2DAAgE;AAChE,yEAAsE;AACtE,qEAA+G;AAC/G,yEAAgF;AAChF,+EAAsF;AACtF,6DAA6D;AAE7D;;GAEG;AACH,MAAa,gBAAgB;IAG3B;;;;;;;OAOG;IACI,MAAM,CAAC,KAAK,CAAC,UAAU;QAC5B,IAAI,IAAI,CAAC,YAAY;YACnB,OAAO;QAET,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;QAEzB,MAAM,IAAI,GAAG,yBAAS,CAAC,IAAI,CAAC,iBAAiB,CAAC,kBAAkB,CAAC,CAAC;QAClE,MAAM,KAAK,GAAG;YACZ,iCAAkB;YAClB,mCAAoB;YACpB,4CAA6B;YAC7B,yCAA0B;YAC1B,0CAA2B;YAC3B,6CAA8B;YAC9B,6CAAqB;YACrB,2CAAuB;YACvB,8BAAiB;YACjB,0BAAa;YACb,gCAAgB;YAChB,0CAA0B;YAC1B,uCAAuB;YACvB,wCAAwB;YACxB,sDAAgC;YAChC,iCAAe;YACf,uCAAmB;YACnB,8BAAgB;YAChB,mDAA2B;YAC3B,iDAAyB;YACzB,yBAAa;YACb,sCAAkB;YAClB,2CAA2B;YAC3B,kCAAmB;YACnB,oDAA8B;YAC9B,iCAAmB;YACnB,0BAAY;YACZ,qDAA+B;YAC/B,qDAA6B;YAC7B,oDAA4B;YAC5B,2BAAe;YACf,2BAAW;YACX,2BAAe;YACf,2BAAe;YACf,+BAAe;YACf,gCAAkB;YAClB,uCAAkB;YAClB,mDAA2B;YAC3B,qCAAoB;YACpB,qCAAoB;YACpB,wCAAoB;YACpB,uCAAwB;YACxB,qCAAsB;YACtB,6CAA8B;YAC9B,+BAAgB;YAChB,+BAAgB;YAChB,sCAAuB;YACvB,oCAAqB;YACrB,6CAAuB;YACvB,2CAAuB;YACvB,qDAA+B;YAC/B,6CAAqB;YACrB,+BAAgB;YAChB,2DAA4B;YAC5B,6BAAgB;YAChB,6BAAgB;YAChB,0CAAsB;YACtB,yBAAY;YACZ,uCAAsB;YACtB,oCAAgB;YAChB,sCAAsB;YACtB,2CAAuB;YACvB,6BAAc;YACd,2BAAa;YACb,6BAAe;YACf,mCAAmB;YACnB,iBAAU;YACV,qDAA+B;YAC/B,6BAAiB;YACjB,yCAAyB;YACzB,yCAAyB;YACzB,uCAAmB;YACnB,0CAAsB;YACtB,6CAAyB;YACzB,iDAA6B;YAC7B,yCAAwB;YACxB,wCAAoB;YACpB,mDAAmC;YACnC,iDAA6B;YAC7B,2CAAuB;YACvB,oCAAgB;YAChB,uDAA+B;YAC/B,6DAAkC;YAClC,oCAAkB;YAClB,kDAAkC;YAClC,kDAAkC;YAClC,yCAAyB;YACzB,sCAAkB;YAClB,2CAAuB;YACvB,4CAAwB;YACxB,4CAAwB;YACxB,2CAAuB;YACvB,gCAAoB;YACpB,gCAAiB;YACjB,6BAAe;YACf,uCAAuB;YACvB,4CAA4B;YAC5B,yBAAc;YACd,yBAAc;YACd,0CAAsB;YACtB,0CAAsB;YACtB,wCAAoB;YACpB,6CAAqB;YACrB,6CAAyB;YACzB,iDAA6B;YAC7B,mDAA+B;YAC/B,4CAAwB;YACxB,yCAAkB;YAClB,6CAAsB;YACtB,+CAAwB;YACxB,wCAAiB;YACjB,6CAAsB;YACtB,2CAAoB;YACpB,mDAA4B;YAC5B,wDAAoC;YACpC,oDAA6B;YAC7B,yCAAqB;YACrB,4CAAwB;YACxB,sDAAoC;YACpC,6CAA2B;YAC3B,6CAA2B;YAC3B,mDAAiC;YACjC,+CAA6B;YAC7B,uDAAqC;YACrC,wCAAsB;YACtB,8CAA4B;YAC5B,oDAAkC;YAClC,gDAA8B;YAC9B,wDAAsC;YACtC,+BAAa;YACb,2CAAuB;SACxB,CAAC;QAEF,KAAK,MAAM,IAAI,IAAI,KAAK;YACtB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAEtB,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;;AA5JH,4CA6JC;AA5JgB,6BAAY,GAAG,KAAK,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/** @packageDocumentation\r\n * @module Utilities\r\n */\r\n\r\nimport { IModelApp } from \"@itwin/core-frontend\";\r\nimport { EdgeDetectionEffect, EmbossEffect, GaussianBlurEffect, SharpenEffect, SharpnessEffect, UnsharpenEffect } from \"./effects/Convolution\";\r\nimport { ClearEffectsTool } from \"./effects/EffectTools\";\r\nimport { ExplosionEffect } from \"./effects/Explosion\";\r\nimport { FlipImageConfig, FlipImageEffect } from \"./effects/FlipImage\";\r\nimport { LensDistortionConfig, LensDistortionEffect } from \"./effects/LensDistortion\";\r\nimport { SaturationConfig, SaturationEffect } from \"./effects/Saturation\";\r\nimport { SnowEffect } from \"./effects/Snow\";\r\nimport { VignetteConfig, VignetteEffect } from \"./effects/Vignette\";\r\nimport { MaskBackgroundMapByElementTool, MaskBackgroundMapByExcludedElementTool, MaskBackgroundMapByModelTool, MaskBackgroundMapBySubCategoryTool, MaskRealityModelByElementTool, MaskRealityModelByExcludedElementTool, MaskRealityModelByModelTool, MaskRealityModelBySubCategoryTool, SetHigherPriorityRealityModelMasking, SetMapHigherPriorityMasking, UnmaskMapTool, UnmaskRealityModelTool } from \"./tools/PlanarMaskTools\";\r\nimport { ChangeCameraTool, ChangeEmphasisSettingsTool, ChangeFlashSettingsTool, ChangeHiliteSettingsTool, DefaultTileSizeModifierTool, FadeOutTool, FreezeSceneTool, SetAspectRatioSkewTool, ShowTileVolumesTool, Toggle3dManipulationsTool, ToggleDrawingGraphicsTool, ToggleSectionDrawingSpatialViewTool, ToggleViewAttachmentBoundariesTool, ToggleViewAttachmentClipShapesTool, ToggleViewAttachmentsTool, ViewportAddRealityModel, ViewportTileSizeModifierTool } from \"./tools/ViewportTools\";\r\nimport { AnimationIntervalTool } from \"./tools/AnimationIntervalTool\";\r\nimport { ChangeUnitsTool } from \"./tools/ChangeUnitsTool\";\r\nimport { ClipColorTool, TestClipStyleTool, ToggleSectionCutTool } from \"./tools/ClipTools\";\r\nimport {\r\n  ApplyRenderingStyleTool, ChangeViewFlagsTool, OverrideSubCategoryTool, SaveRenderingStyleTool, ToggleSkyboxTool, WoWIgnoreBackgroundTool,\r\n} from \"./tools/DisplayStyleTools\";\r\nimport {\r\n  ClearEmphasizedElementsTool, ClearIsolatedElementsTool, EmphasizeSelectedElementsTool, EmphasizeVisibleElementsTool, IsolateSelectedElementsTool,\r\n} from \"./tools/EmphasizeElementsTool\";\r\nimport { ToggleFrustumSnapshotTool, ToggleSelectedViewFrustumTool, ToggleShadowFrustumTool } from \"./tools/FrustumDecoration\";\r\nimport { InspectElementTool } from \"./tools/InspectElementTool\";\r\nimport {\r\n  AttachArcGISMapLayerByUrlTool, AttachMapLayerTool, AttachMapOverlayTool, AttachTileURLMapLayerByUrlTool, AttachWmsMapLayerByUrlTool,\r\n  AttachWmtsMapLayerByUrlTool, DetachMapLayersTool, MapBaseColorTool, MapBaseTransparencyTool, MapBaseVisibilityTool, MapLayerSubLayerVisibilityTool,\r\n  MapLayerTransparencyTool, MapLayerVisibilityTool, MapLayerZoomTool, ReorderMapLayers, SetMapBaseTool, ToggleTerrainTool,\r\n} from \"./tools/MapLayerTool\";\r\nimport { MeasureTileLoadTimeTool } from \"./tools/MeasureTileLoadTime\";\r\nimport {\r\n  ClearModelAppearanceOverrides, SetModelColorTool, SetModelEmphasizedTool, SetModelIgnoresMaterialsTool, SetModelLineCodeTool,\r\n  SetModelLineWeightTool, SetModelLocateTool, SetModelTransparencyTool,\r\n} from \"./tools/ModelAppearanceTools\";\r\nimport { ChangePlanProjectionSettingsTool, DumpPlanProjectionSettingsTool, OverrideSubCategoryPriorityTool } from \"./tools/PlanProjectionTools\";\r\nimport { ToggleProjectExtentsTool } from \"./tools/ProjectExtents\";\r\nimport {\r\n  AttachCesiumAssetTool, AttachRealityModelTool, ClearRealityModelAppearanceOverrides, DetachRealityModelTool, SaveRealityModelTool,\r\n  SetRealityModelColorTool, SetRealityModelEmphasizedTool, SetRealityModelLocateTool, SetRealityModelTransparencyTool, ToggleOSMBuildingDisplay,\r\n} from \"./tools/RealityModelTools\";\r\nimport { RealityTransitionTool } from \"./tools/RealityTransitionTool\";\r\nimport { CompileShadersTool, LoseWebGLContextTool, ToggleDPIForLODTool, ToggleWiremeshTool } from \"./tools/RenderSystemTools\";\r\nimport {\r\n  SetAASamplesTool, ToggleDrapeFrustumTool, TogglePrimitiveVisibilityTool, ToggleReadPixelsTool, ToggleRealityTileBounds, ToggleRealityTileFreeze,\r\n  ToggleRealityTileLogging, ToggleRealityTilePreload, ToggleVolClassIntersect,\r\n} from \"./tools/RenderTargetTools\";\r\nimport { ReportWebGLCompatibilityTool } from \"./tools/ReportWebGLCompatibilityTool\";\r\nimport { ApplyViewByIdTool, ApplyViewTool, SaveViewTool } from \"./tools/SavedViews\";\r\nimport { SelectElementsByIdTool } from \"./tools/SelectionTools\";\r\nimport { SetGpuMemoryLimitTool } from \"./tools/SetGpuMemoryLimitTool\";\r\nimport { ElementIdFromSourceAspectIdTool, SourceAspectIdFromElementIdTool } from \"./tools/SourceAspectIdTools\";\r\nimport { ToggleTileRequestDecorationTool } from \"./tools/TileRequestDecoration\";\r\nimport { ToggleTileTreeBoundsDecorationTool } from \"./tools/TileTreeBoundsDecoration\";\r\nimport { ToggleToolTipsTool } from \"./tools/ToolTipProvider\";\r\n\r\n/** Entry-point for the package. Before using the package you *must* call [[FrontendDevTools.initialize]].\r\n * @beta\r\n */\r\nexport class FrontendDevTools {\r\n  private static _initialized = false;\r\n\r\n  /** Call this before using the package (e.g., before instantiating any of its widgets or attempting to use any of its tools.\r\n   * To initialize when starting up your app:\r\n   * ```ts\r\n   *   IModelApp.startup();\r\n   *   await FrontendDevTools.initialize();\r\n   * ```\r\n   * @beta\r\n   */\r\n  public static async initialize(): Promise<void> {\r\n    if (this._initialized)\r\n      return;\r\n\r\n    this._initialized = true;\r\n\r\n    const i18n = IModelApp.i18n.registerNamespace(\"FrontendDevTools\");\r\n    const tools = [\r\n      AttachMapLayerTool,\r\n      AttachMapOverlayTool,\r\n      AttachArcGISMapLayerByUrlTool,\r\n      AttachWmsMapLayerByUrlTool,\r\n      AttachWmtsMapLayerByUrlTool,\r\n      AttachTileURLMapLayerByUrlTool,\r\n      AnimationIntervalTool,\r\n      ApplyRenderingStyleTool,\r\n      ApplyViewByIdTool,\r\n      ApplyViewTool,\r\n      ChangeCameraTool,\r\n      ChangeEmphasisSettingsTool,\r\n      ChangeFlashSettingsTool,\r\n      ChangeHiliteSettingsTool,\r\n      ChangePlanProjectionSettingsTool,\r\n      ChangeUnitsTool,\r\n      ChangeViewFlagsTool,\r\n      ClearEffectsTool,\r\n      ClearEmphasizedElementsTool,\r\n      ClearIsolatedElementsTool,\r\n      ClipColorTool,\r\n      CompileShadersTool,\r\n      DefaultTileSizeModifierTool,\r\n      DetachMapLayersTool,\r\n      DumpPlanProjectionSettingsTool,\r\n      EdgeDetectionEffect,\r\n      EmbossEffect,\r\n      ElementIdFromSourceAspectIdTool,\r\n      EmphasizeSelectedElementsTool,\r\n      EmphasizeVisibleElementsTool,\r\n      ExplosionEffect,\r\n      FadeOutTool,\r\n      FlipImageConfig,\r\n      FlipImageEffect,\r\n      FreezeSceneTool,\r\n      GaussianBlurEffect,\r\n      InspectElementTool,\r\n      IsolateSelectedElementsTool,\r\n      LensDistortionConfig,\r\n      LensDistortionEffect,\r\n      LoseWebGLContextTool,\r\n      MapLayerTransparencyTool,\r\n      MapLayerVisibilityTool,\r\n      MapLayerSubLayerVisibilityTool,\r\n      MapLayerZoomTool,\r\n      MapBaseColorTool,\r\n      MapBaseTransparencyTool,\r\n      MapBaseVisibilityTool,\r\n      MeasureTileLoadTimeTool,\r\n      OverrideSubCategoryTool,\r\n      OverrideSubCategoryPriorityTool,\r\n      RealityTransitionTool,\r\n      ReorderMapLayers,\r\n      ReportWebGLCompatibilityTool,\r\n      SaturationConfig,\r\n      SaturationEffect,\r\n      SaveRenderingStyleTool,\r\n      SaveViewTool,\r\n      SelectElementsByIdTool,\r\n      SetAASamplesTool,\r\n      SetAspectRatioSkewTool,\r\n      ToggleVolClassIntersect,\r\n      SetMapBaseTool,\r\n      SharpenEffect,\r\n      SharpnessEffect,\r\n      ShowTileVolumesTool,\r\n      SnowEffect,\r\n      SourceAspectIdFromElementIdTool,\r\n      TestClipStyleTool,\r\n      Toggle3dManipulationsTool,\r\n      ToggleDrawingGraphicsTool,\r\n      ToggleDPIForLODTool,\r\n      ToggleDrapeFrustumTool,\r\n      ToggleFrustumSnapshotTool,\r\n      TogglePrimitiveVisibilityTool,\r\n      ToggleProjectExtentsTool,\r\n      ToggleReadPixelsTool,\r\n      ToggleSectionDrawingSpatialViewTool,\r\n      ToggleSelectedViewFrustumTool,\r\n      ToggleShadowFrustumTool,\r\n      ToggleSkyboxTool,\r\n      ToggleTileRequestDecorationTool,\r\n      ToggleTileTreeBoundsDecorationTool,\r\n      ToggleToolTipsTool,\r\n      ToggleViewAttachmentBoundariesTool,\r\n      ToggleViewAttachmentClipShapesTool,\r\n      ToggleViewAttachmentsTool,\r\n      ToggleWiremeshTool,\r\n      ToggleRealityTileBounds,\r\n      ToggleRealityTilePreload,\r\n      ToggleRealityTileLogging,\r\n      ToggleRealityTileFreeze,\r\n      ToggleSectionCutTool,\r\n      ToggleTerrainTool,\r\n      UnsharpenEffect,\r\n      ViewportAddRealityModel,\r\n      ViewportTileSizeModifierTool,\r\n      VignetteConfig,\r\n      VignetteEffect,\r\n      AttachRealityModelTool,\r\n      DetachRealityModelTool,\r\n      SaveRealityModelTool,\r\n      SetGpuMemoryLimitTool,\r\n      SetRealityModelLocateTool,\r\n      SetRealityModelEmphasizedTool,\r\n      SetRealityModelTransparencyTool,\r\n      SetRealityModelColorTool,\r\n      SetModelLocateTool,\r\n      SetModelEmphasizedTool,\r\n      SetModelTransparencyTool,\r\n      SetModelColorTool,\r\n      SetModelLineWeightTool,\r\n      SetModelLineCodeTool,\r\n      SetModelIgnoresMaterialsTool,\r\n      ClearRealityModelAppearanceOverrides,\r\n      ClearModelAppearanceOverrides,\r\n      AttachCesiumAssetTool,\r\n      ToggleOSMBuildingDisplay,\r\n      SetHigherPriorityRealityModelMasking,\r\n      SetMapHigherPriorityMasking,\r\n      MaskRealityModelByModelTool,\r\n      MaskRealityModelBySubCategoryTool,\r\n      MaskRealityModelByElementTool,\r\n      MaskRealityModelByExcludedElementTool,\r\n      UnmaskRealityModelTool,\r\n      MaskBackgroundMapByModelTool,\r\n      MaskBackgroundMapBySubCategoryTool,\r\n      MaskBackgroundMapByElementTool,\r\n      MaskBackgroundMapByExcludedElementTool,\r\n      UnmaskMapTool,\r\n      WoWIgnoreBackgroundTool,\r\n    ];\r\n\r\n    for (const tool of tools)\r\n      tool.register(i18n);\r\n\r\n    return i18n.readFinished;\r\n  }\r\n}\r\n"]}

package/lib/effects/Convolution.d.ts

@@ -0,0 +1,69 @@
+/** @packageDocumentation
+ * @module Effects
+ */
+import { ScreenSpaceEffectBuilder } from "@itwin/core-frontend";
+import { AddEffectTool } from "./EffectTools";
+/** Adds one of a collection of "convolution kernels" that alter a [Viewport]($frontend)'s image by blending neighboring pixels.
+ * Based on https://webglfundamentals.org/webgl/lessons/webgl-image-processing-continued.html
+ * @beta
+ */
+export declare abstract class ConvolutionEffect extends AddEffectTool {
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    protected abstract get matrix(): number[];
+    protected get textureCoordFromPosition(): boolean;
+    protected get source(): {
+        vertex: string;
+        fragment: string;
+    };
+    protected defineEffect(builder: ScreenSpaceEffectBuilder): void;
+}
+/** Adds a gaussian blur screen-space effect to the selected Viewport.
+ * @beta
+ */
+export declare class GaussianBlurEffect extends ConvolutionEffect {
+    static toolId: string;
+    protected get effectName(): string;
+    protected get matrix(): number[];
+}
+/** Adds a screen-space unsharpen effect to the selected Viewport.
+ * @beta
+ */
+export declare class UnsharpenEffect extends ConvolutionEffect {
+    static toolId: string;
+    protected get effectName(): string;
+    protected get matrix(): number[];
+}
+/** Adds a screen-space emboss effect to the selected Viewport.
+ * @beta
+ */
+export declare class EmbossEffect extends ConvolutionEffect {
+    static toolId: string;
+    protected get effectName(): string;
+    protected get matrix(): number[];
+}
+/** Adds a screen-space sharpen effect to the selected Viewport.
+ * @beta
+ */
+export declare class SharpenEffect extends ConvolutionEffect {
+    static toolId: string;
+    protected get effectName(): string;
+    protected get matrix(): number[];
+}
+/** Adds a screen-space sharpness effect to the selected Viewport.
+ * @beta
+ */
+export declare class SharpnessEffect extends ConvolutionEffect {
+    static toolId: string;
+    protected get effectName(): string;
+    protected get matrix(): number[];
+}
+/** Adds a screen-space edge-detection effect to the selected Viewport.
+ * @beta
+ */
+export declare class EdgeDetectionEffect extends ConvolutionEffect {
+    static toolId: string;
+    protected get effectName(): string;
+    protected get matrix(): number[];
+}
+//# sourceMappingURL=Convolution.d.ts.map

package/lib/effects/Convolution.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Convolution.d.ts","sourceRoot":"","sources":["../../src/effects/Convolution.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,wBAAwB,EAA4B,MAAM,sBAAsB,CAAC;AAC1F,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAE9C;;;GAGG;AACH,8BAAsB,iBAAkB,SAAQ,aAAa;IAC3D,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAElD,SAAS,CAAC,QAAQ,KAAK,MAAM,IAAI,MAAM,EAAE,CAAC;IAE1C,SAAS,KAAK,wBAAwB,YAAmB;IAEzD,SAAS,KAAK,MAAM;;;MAwBnB;IAED,SAAS,CAAC,YAAY,CAAC,OAAO,EAAE,wBAAwB,GAAG,IAAI;CA+BhE;AAED;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,iBAAiB;IACvD,OAAuB,MAAM,SAAwB;IACrD,SAAS,KAAK,UAAU,WAAqB;IAC7C,SAAS,KAAK,MAAM,aAMnB;CACF;AAED;;GAEG;AACH,qBAAa,eAAgB,SAAQ,iBAAiB;IACpD,OAAuB,MAAM,SAAqB;IAClD,SAAS,KAAK,UAAU,WAA0B;IAClD,SAAS,KAAK,MAAM,aAMnB;CACF;AAED;;GAEG;AACH,qBAAa,YAAa,SAAQ,iBAAiB;IACjD,OAAuB,MAAM,SAAkB;IAC/C,SAAS,KAAK,UAAU,WAAuB;IAC/C,SAAS,KAAK,MAAM,aAMnB;CACF;AAED;;GAEG;AACH,qBAAa,aAAc,SAAQ,iBAAiB;IAClD,OAAuB,MAAM,SAAmB;IAChD,SAAS,KAAK,UAAU,WAAwB;IAChD,SAAS,KAAK,MAAM,aAMnB;CACF;AAED;;GAEG;AACH,qBAAa,eAAgB,SAAQ,iBAAiB;IACpD,OAAuB,MAAM,SAAqB;IAClD,SAAS,KAAK,UAAU,WAA0B;IAClD,SAAS,KAAK,MAAM,aAMnB;CACF;AAED;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,iBAAiB;IACxD,OAAuB,MAAM,SAAyB;IACtD,SAAS,KAAK,UAAU,WAA2B;IACnD,SAAS,KAAK,MAAM,aAMnB;CACF"}

package/lib/effects/Convolution.js

@@ -0,0 +1,166 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Effects
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EdgeDetectionEffect = exports.SharpnessEffect = exports.SharpenEffect = exports.EmbossEffect = exports.UnsharpenEffect = exports.GaussianBlurEffect = exports.ConvolutionEffect = void 0;
+const core_frontend_1 = require("@itwin/core-frontend");
+const EffectTools_1 = require("./EffectTools");
+/** Adds one of a collection of "convolution kernels" that alter a [Viewport]($frontend)'s image by blending neighboring pixels.
+ * Based on https://webglfundamentals.org/webgl/lessons/webgl-image-processing-continued.html
+ * @beta
+ */
+class ConvolutionEffect extends EffectTools_1.AddEffectTool {
+    static get minArgs() { return 0; }
+    static get maxArgs() { return 0; }
+    get textureCoordFromPosition() { return true; }
+    get source() {
+        return {
+            // The vertex shader simply computes the texture coordinate for use in the fragment shader.
+            vertex: `
+        void effectMain(vec4 pos) {
+          v_texCoord = textureCoordFromPosition(pos);
+        }`,
+            // The fragment shader samples the pixel and its neighbors and applies the kernel.
+            fragment: `
+        vec4 effectMain() {
+          vec2 onePixel = vec2(1.0, 1.0) / u_textureSize;
+          vec4 colorSum =
+            TEXTURE(u_diffuse, v_texCoord + onePixel * vec2(-1, -1)) * u_kernel[0] +
+            TEXTURE(u_diffuse, v_texCoord + onePixel * vec2( 0, -1)) * u_kernel[1] +
+            TEXTURE(u_diffuse, v_texCoord + onePixel * vec2( 1, -1)) * u_kernel[2] +
+            TEXTURE(u_diffuse, v_texCoord + onePixel * vec2(-1,  0)) * u_kernel[3] +
+            TEXTURE(u_diffuse, v_texCoord + onePixel * vec2( 0,  0)) * u_kernel[4] +
+            TEXTURE(u_diffuse, v_texCoord + onePixel * vec2( 1,  0)) * u_kernel[5] +
+            TEXTURE(u_diffuse, v_texCoord + onePixel * vec2(-1,  1)) * u_kernel[6] +
+            TEXTURE(u_diffuse, v_texCoord + onePixel * vec2( 0,  1)) * u_kernel[7] +
+            TEXTURE(u_diffuse, v_texCoord + onePixel * vec2( 1,  1)) * u_kernel[8] ;
+          return vec4((colorSum / u_kernelWeight).rgb, 1);
+        }`,
+        };
+    }
+    defineEffect(builder) {
+        // Define the varying for the texture coordinate.
+        builder.addVarying("v_texCoord", core_frontend_1.VaryingType.Vec2);
+        // Hook up the uniforms.
+        const matrix = this.matrix;
+        builder.addUniform({
+            name: "u_textureSize",
+            type: core_frontend_1.UniformType.Vec2,
+            bind: (uniform, context) => {
+                const rect = context.viewport.viewRect;
+                uniform.setUniform2fv([rect.width, rect.height]);
+            },
+        });
+        builder.addUniformArray({
+            name: "u_kernel",
+            type: core_frontend_1.UniformType.Float,
+            length: matrix.length,
+            bind: (uniform) => uniform.setUniform1fv(matrix),
+        });
+        let weight = matrix.reduce((prev, curr) => prev + curr);
+        if (weight <= 0)
+            weight = 1;
+        builder.addUniform({
+            name: "u_kernelWeight",
+            type: core_frontend_1.UniformType.Float,
+            bind: (uniform) => uniform.setUniform1f(weight),
+        });
+    }
+}
+exports.ConvolutionEffect = ConvolutionEffect;
+/** Adds a gaussian blur screen-space effect to the selected Viewport.
+ * @beta
+ */
+class GaussianBlurEffect extends ConvolutionEffect {
+    get effectName() { return "blur"; }
+    get matrix() {
+        return [
+            0.045, 0.122, 0.045,
+            0.122, 0.332, 0.122,
+            0.045, 0.122, 0.045,
+        ];
+    }
+}
+exports.GaussianBlurEffect = GaussianBlurEffect;
+GaussianBlurEffect.toolId = "GaussianBlurEffect";
+/** Adds a screen-space unsharpen effect to the selected Viewport.
+ * @beta
+ */
+class UnsharpenEffect extends ConvolutionEffect {
+    get effectName() { return "unsharpen"; }
+    get matrix() {
+        return [
+            -1, -1, -1,
+            -1, 9, -1,
+            -1, -1, -1,
+        ];
+    }
+}
+exports.UnsharpenEffect = UnsharpenEffect;
+UnsharpenEffect.toolId = "UnsharpenEffect";
+/** Adds a screen-space emboss effect to the selected Viewport.
+ * @beta
+ */
+class EmbossEffect extends ConvolutionEffect {
+    get effectName() { return "emboss"; }
+    get matrix() {
+        return [
+            -2, -1, 0,
+            -1, 1, 1,
+            0, 1, 2,
+        ];
+    }
+}
+exports.EmbossEffect = EmbossEffect;
+EmbossEffect.toolId = "EmbossEffect";
+/** Adds a screen-space sharpen effect to the selected Viewport.
+ * @beta
+ */
+class SharpenEffect extends ConvolutionEffect {
+    get effectName() { return "sharpen"; }
+    get matrix() {
+        return [
+            0, -1, 0,
+            -1, 5, -1,
+            0, -1, 0,
+        ];
+    }
+}
+exports.SharpenEffect = SharpenEffect;
+SharpenEffect.toolId = "SharpenEffect";
+/** Adds a screen-space sharpness effect to the selected Viewport.
+ * @beta
+ */
+class SharpnessEffect extends ConvolutionEffect {
+    get effectName() { return "sharpness"; }
+    get matrix() {
+        return [
+            0, -1, 0,
+            -1, 5, -1,
+            0, -1, 0,
+        ];
+    }
+}
+exports.SharpnessEffect = SharpnessEffect;
+SharpnessEffect.toolId = "SharpnessEffect";
+/** Adds a screen-space edge-detection effect to the selected Viewport.
+ * @beta
+ */
+class EdgeDetectionEffect extends ConvolutionEffect {
+    get effectName() { return "edgedetect"; }
+    get matrix() {
+        return [
+            -5, 0, 0,
+            0, 0, 0,
+            0, 0, 5,
+        ];
+    }
+}
+exports.EdgeDetectionEffect = EdgeDetectionEffect;
+EdgeDetectionEffect.toolId = "EdgeDetectionEffect";
+//# sourceMappingURL=Convolution.js.map

package/lib/effects/Convolution.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Convolution.js","sourceRoot":"","sources":["../../src/effects/Convolution.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,wDAA0F;AAC1F,+CAA8C;AAE9C;;;GAGG;AACH,MAAsB,iBAAkB,SAAQ,2BAAa;IACpD,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAIlD,IAAc,wBAAwB,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IAEzD,IAAc,MAAM;QAClB,OAAO;YACL,2FAA2F;YAC3F,MAAM,EAAE;;;UAGJ;YACJ,kFAAkF;YAClF,QAAQ,EAAE;;;;;;;;;;;;;;UAcN;SACL,CAAC;IACJ,CAAC;IAES,YAAY,CAAC,OAAiC;QACtD,iDAAiD;QACjD,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,2BAAW,CAAC,IAAI,CAAC,CAAC;QAEnD,wBAAwB;QACxB,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,OAAO,CAAC,UAAU,CAAC;YACjB,IAAI,EAAE,eAAe;YACrB,IAAI,EAAE,2BAAW,CAAC,IAAI;YACtB,IAAI,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE;gBACzB,MAAM,IAAI,GAAG,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC;gBACvC,OAAO,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;YACnD,CAAC;SACF,CAAC,CAAC;QACH,OAAO,CAAC,eAAe,CAAC;YACtB,IAAI,EAAE,UAAU;YAChB,IAAI,EAAE,2BAAW,CAAC,KAAK;YACvB,MAAM,EAAE,MAAM,CAAC,MAAM;YACrB,IAAI,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC;SACjD,CAAC,CAAC;QAEH,IAAI,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,GAAG,IAAI,CAAC,CAAC;QACxD,IAAI,MAAM,IAAI,CAAC;YACb,MAAM,GAAG,CAAC,CAAC;QAEb,OAAO,CAAC,UAAU,CAAC;YACjB,IAAI,EAAE,gBAAgB;YACtB,IAAI,EAAE,2BAAW,CAAC,KAAK;YACvB,IAAI,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC;SAChD,CAAC,CAAC;IACL,CAAC;CACF;AAjED,8CAiEC;AAED;;GAEG;AACH,MAAa,kBAAmB,SAAQ,iBAAiB;IAEvD,IAAc,UAAU,KAAK,OAAO,MAAM,CAAC,CAAC,CAAC;IAC7C,IAAc,MAAM;QAClB,OAAO;YACL,KAAK,EAAE,KAAK,EAAE,KAAK;YACnB,KAAK,EAAE,KAAK,EAAE,KAAK;YACnB,KAAK,EAAE,KAAK,EAAE,KAAK;SACpB,CAAC;IACJ,CAAC;;AATH,gDAUC;AATwB,yBAAM,GAAG,oBAAoB,CAAC;AAWvD;;GAEG;AACH,MAAa,eAAgB,SAAQ,iBAAiB;IAEpD,IAAc,UAAU,KAAK,OAAO,WAAW,CAAC,CAAC,CAAC;IAClD,IAAc,MAAM;QAClB,OAAO;YACL,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;YACV,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;YACT,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;SACX,CAAC;IACJ,CAAC;;AATH,0CAUC;AATwB,sBAAM,GAAG,iBAAiB,CAAC;AAWpD;;GAEG;AACH,MAAa,YAAa,SAAQ,iBAAiB;IAEjD,IAAc,UAAU,KAAK,OAAO,QAAQ,CAAC,CAAC,CAAC;IAC/C,IAAc,MAAM;QAClB,OAAO;YACL,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;YACT,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC;YACR,CAAC,EAAE,CAAC,EAAE,CAAC;SACR,CAAC;IACJ,CAAC;;AATH,oCAUC;AATwB,mBAAM,GAAG,cAAc,CAAC;AAWjD;;GAEG;AACH,MAAa,aAAc,SAAQ,iBAAiB;IAElD,IAAc,UAAU,KAAK,OAAO,SAAS,CAAC,CAAC,CAAC;IAChD,IAAc,MAAM;QAClB,OAAO;YACL,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;YACR,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;YACT,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;SACT,CAAC;IACJ,CAAC;;AATH,sCAUC;AATwB,oBAAM,GAAG,eAAe,CAAC;AAWlD;;GAEG;AACH,MAAa,eAAgB,SAAQ,iBAAiB;IAEpD,IAAc,UAAU,KAAK,OAAO,WAAW,CAAC,CAAC,CAAC;IAClD,IAAc,MAAM;QAClB,OAAO;YACL,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;YACR,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;YACT,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;SACT,CAAC;IACJ,CAAC;;AATH,0CAUC;AATwB,sBAAM,GAAG,iBAAiB,CAAC;AAWpD;;GAEG;AACH,MAAa,mBAAoB,SAAQ,iBAAiB;IAExD,IAAc,UAAU,KAAK,OAAO,YAAY,CAAC,CAAC,CAAC;IACnD,IAAc,MAAM;QAClB,OAAO;YACL,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC;YACR,CAAC,EAAE,CAAC,EAAE,CAAC;YACP,CAAC,EAAE,CAAC,EAAE,CAAC;SACR,CAAC;IACJ,CAAC;;AATH,kDAUC;AATwB,0BAAM,GAAG,qBAAqB,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, UniformType, VaryingType } from \"@itwin/core-frontend\";\nimport { AddEffectTool } from \"./EffectTools\";\n\n/** Adds one of a collection of \"convolution kernels\" that alter a [Viewport]($frontend)'s image by blending neighboring pixels.\n * Based on https://webglfundamentals.org/webgl/lessons/webgl-image-processing-continued.html\n * @beta\n */\nexport abstract class ConvolutionEffect extends AddEffectTool {\n  public static override get minArgs() { return 0; }\n  public static override get maxArgs() { return 0; }\n\n  protected abstract get matrix(): number[];\n\n  protected get textureCoordFromPosition() { return true; }\n\n  protected get source() {\n    return {\n      // The vertex shader simply computes the texture coordinate for use in the fragment shader.\n      vertex: `\n        void effectMain(vec4 pos) {\n          v_texCoord = textureCoordFromPosition(pos);\n        }`,\n      // The fragment shader samples the pixel and its neighbors and applies the kernel.\n      fragment: `\n        vec4 effectMain() {\n          vec2 onePixel = vec2(1.0, 1.0) / u_textureSize;\n          vec4 colorSum =\n            TEXTURE(u_diffuse, v_texCoord + onePixel * vec2(-1, -1)) * u_kernel[0] +\n            TEXTURE(u_diffuse, v_texCoord + onePixel * vec2( 0, -1)) * u_kernel[1] +\n            TEXTURE(u_diffuse, v_texCoord + onePixel * vec2( 1, -1)) * u_kernel[2] +\n            TEXTURE(u_diffuse, v_texCoord + onePixel * vec2(-1,  0)) * u_kernel[3] +\n            TEXTURE(u_diffuse, v_texCoord + onePixel * vec2( 0,  0)) * u_kernel[4] +\n            TEXTURE(u_diffuse, v_texCoord + onePixel * vec2( 1,  0)) * u_kernel[5] +\n            TEXTURE(u_diffuse, v_texCoord + onePixel * vec2(-1,  1)) * u_kernel[6] +\n            TEXTURE(u_diffuse, v_texCoord + onePixel * vec2( 0,  1)) * u_kernel[7] +\n            TEXTURE(u_diffuse, v_texCoord + onePixel * vec2( 1,  1)) * u_kernel[8] ;\n          return vec4((colorSum / u_kernelWeight).rgb, 1);\n        }`,\n    };\n  }\n\n  protected defineEffect(builder: ScreenSpaceEffectBuilder): void {\n    // Define the varying for the texture coordinate.\n    builder.addVarying(\"v_texCoord\", VaryingType.Vec2);\n\n    // Hook up the uniforms.\n    const matrix = this.matrix;\n    builder.addUniform({\n      name: \"u_textureSize\",\n      type: UniformType.Vec2,\n      bind: (uniform, context) => {\n        const rect = context.viewport.viewRect;\n        uniform.setUniform2fv([rect.width, rect.height]);\n      },\n    });\n    builder.addUniformArray({\n      name: \"u_kernel\",\n      type: UniformType.Float,\n      length: matrix.length,\n      bind: (uniform) => uniform.setUniform1fv(matrix),\n    });\n\n    let weight = matrix.reduce((prev, curr) => prev + curr);\n    if (weight <= 0)\n      weight = 1;\n\n    builder.addUniform({\n      name: \"u_kernelWeight\",\n      type: UniformType.Float,\n      bind: (uniform) => uniform.setUniform1f(weight),\n    });\n  }\n}\n\n/** Adds a gaussian blur screen-space effect to the selected Viewport.\n * @beta\n */\nexport class GaussianBlurEffect extends ConvolutionEffect {\n  public static override toolId = \"GaussianBlurEffect\";\n  protected get effectName() { return \"blur\"; }\n  protected get matrix() {\n    return [\n      0.045, 0.122, 0.045,\n      0.122, 0.332, 0.122,\n      0.045, 0.122, 0.045,\n    ];\n  }\n}\n\n/** Adds a screen-space unsharpen effect to the selected Viewport.\n * @beta\n */\nexport class UnsharpenEffect extends ConvolutionEffect {\n  public static override toolId = \"UnsharpenEffect\";\n  protected get effectName() { return \"unsharpen\"; }\n  protected get matrix() {\n    return [\n      -1, -1, -1,\n      -1, 9, -1,\n      -1, -1, -1,\n    ];\n  }\n}\n\n/** Adds a screen-space emboss effect to the selected Viewport.\n * @beta\n */\nexport class EmbossEffect extends ConvolutionEffect {\n  public static override toolId = \"EmbossEffect\";\n  protected get effectName() { return \"emboss\"; }\n  protected get matrix() {\n    return [\n      -2, -1, 0,\n      -1, 1, 1,\n      0, 1, 2,\n    ];\n  }\n}\n\n/** Adds a screen-space sharpen effect to the selected Viewport.\n * @beta\n */\nexport class SharpenEffect extends ConvolutionEffect {\n  public static override toolId = \"SharpenEffect\";\n  protected get effectName() { return \"sharpen\"; }\n  protected get matrix() {\n    return [\n      0, -1, 0,\n      -1, 5, -1,\n      0, -1, 0,\n    ];\n  }\n}\n\n/** Adds a screen-space sharpness effect to the selected Viewport.\n * @beta\n */\nexport class SharpnessEffect extends ConvolutionEffect {\n  public static override toolId = \"SharpnessEffect\";\n  protected get effectName() { return \"sharpness\"; }\n  protected get matrix() {\n    return [\n      0, -1, 0,\n      -1, 5, -1,\n      0, -1, 0,\n    ];\n  }\n}\n\n/** Adds a screen-space edge-detection effect to the selected Viewport.\n * @beta\n */\nexport class EdgeDetectionEffect extends ConvolutionEffect {\n  public static override toolId = \"EdgeDetectionEffect\";\n  protected get effectName() { return \"edgedetect\"; }\n  protected get matrix() {\n    return [\n      -5, 0, 0,\n      0, 0, 0,\n      0, 0, 5,\n    ];\n  }\n}\n"]}

package/lib/effects/EffectTools.d.ts

@@ -0,0 +1,34 @@
+/** @packageDocumentation
+ * @module Effects
+ */
+import { ScreenSpaceEffectBuilder, ScreenSpaceEffectSource, Tool } from "@itwin/core-frontend";
+/** Adds a screen-space effect to the selected viewport.
+ * @beta
+ */
+export declare abstract class AddEffectTool extends Tool {
+    private static readonly _registeredEffects;
+    /** Name of effect as used in keyins like `fdt effect add`. Ideally one word. */
+    protected abstract get effectName(): string;
+    /** vertex, fragment, and optional sampleSourcePixel GLSL snippets. */
+    protected abstract get source(): ScreenSpaceEffectSource;
+    /** Whether the fragment shader should include built-in `textureCoordFromPosition` function. */
+    protected abstract get textureCoordFromPosition(): boolean;
+    /** Add uniforms, varyings, etc. */
+    protected abstract defineEffect(builder: ScreenSpaceEffectBuilder): void;
+    run(): Promise<boolean>;
+}
+/** Removes all screen-space effects from the selected viewport.
+ * @beta
+ */
+export declare class ClearEffectsTool extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    run(): Promise<boolean>;
+}
+/** Requests that any viewport to which the specified effect has been applied redraw its contents.
+ * Used by tools like [[VignetteConfig]] to update the view after the effect parameters are modified.
+ * @beta
+ */
+export declare function refreshViewportsForEffect(effectName: string): void;
+//# sourceMappingURL=EffectTools.d.ts.map

package/lib/effects/EffectTools.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EffectTools.d.ts","sourceRoot":"","sources":["../../src/effects/EffectTools.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EACM,wBAAwB,EAAE,uBAAuB,EAAE,IAAI,EACnE,MAAM,sBAAsB,CAAC;AAE9B;;GAEG;AACH,8BAAsB,aAAc,SAAQ,IAAI;IAC9C,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,kBAAkB,CAAqB;IAE/D,gFAAgF;IAChF,SAAS,CAAC,QAAQ,KAAK,UAAU,IAAI,MAAM,CAAC;IAC5C,sEAAsE;IACtE,SAAS,CAAC,QAAQ,KAAK,MAAM,IAAI,uBAAuB,CAAC;IACzD,+FAA+F;IAC/F,SAAS,CAAC,QAAQ,KAAK,wBAAwB,IAAI,OAAO,CAAC;IAC3D,mCAAmC;IACnC,SAAS,CAAC,QAAQ,CAAC,YAAY,CAAC,OAAO,EAAE,wBAAwB,GAAG,IAAI;IAElD,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC;CAwB9C;AAED;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,IAAI;IACxC,OAAuB,MAAM,SAAkB;IAC/C,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAE5B,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC;CAI9C;AAED;;;GAGG;AACH,wBAAgB,yBAAyB,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CASlE"}

package/lib/effects/EffectTools.js

@@ -0,0 +1,69 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Effects
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.refreshViewportsForEffect = exports.ClearEffectsTool = exports.AddEffectTool = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+const core_frontend_1 = require("@itwin/core-frontend");
+/** Adds a screen-space effect to the selected viewport.
+ * @beta
+ */
+class AddEffectTool extends core_frontend_1.Tool {
+    async run() {
+        // Avoid conflicts with the names of other registered screen-space effects.
+        const name = `fdt ${this.effectName}`;
+        if (!AddEffectTool._registeredEffects.has(name)) {
+            // Register the effect.
+            const builder = core_frontend_1.IModelApp.renderSystem.createScreenSpaceEffectBuilder({
+                name,
+                textureCoordFromPosition: this.textureCoordFromPosition,
+                source: this.source,
+            });
+            (0, core_bentley_1.assert)(undefined !== builder);
+            this.defineEffect(builder);
+            builder.finish();
+            AddEffectTool._registeredEffects.add(name);
+        }
+        const vp = core_frontend_1.IModelApp.viewManager.selectedView;
+        if (vp)
+            vp.addScreenSpaceEffect(name);
+        return true;
+    }
+}
+exports.AddEffectTool = AddEffectTool;
+AddEffectTool._registeredEffects = new Set();
+/** Removes all screen-space effects from the selected viewport.
+ * @beta
+ */
+class ClearEffectsTool extends core_frontend_1.Tool {
+    static get minArgs() { return 0; }
+    static get maxArgs() { return 0; }
+    async run() {
+        var _a;
+        (_a = core_frontend_1.IModelApp.viewManager.selectedView) === null || _a === void 0 ? void 0 : _a.removeScreenSpaceEffects();
+        return true;
+    }
+}
+exports.ClearEffectsTool = ClearEffectsTool;
+ClearEffectsTool.toolId = "ClearEffects";
+/** Requests that any viewport to which the specified effect has been applied redraw its contents.
+ * Used by tools like [[VignetteConfig]] to update the view after the effect parameters are modified.
+ * @beta
+ */
+function refreshViewportsForEffect(effectName) {
+    for (const vp of core_frontend_1.IModelApp.viewManager) {
+        for (const vpEffectName of vp.screenSpaceEffects) {
+            if (vpEffectName === effectName) {
+                vp.requestRedraw();
+                break;
+            }
+        }
+    }
+}
+exports.refreshViewportsForEffect = refreshViewportsForEffect;
+//# sourceMappingURL=EffectTools.js.map

package/lib/effects/EffectTools.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EffectTools.js","sourceRoot":"","sources":["../../src/effects/EffectTools.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA6C;AAC7C,wDAE8B;AAE9B;;GAEG;AACH,MAAsB,aAAc,SAAQ,oBAAI;IAY9B,KAAK,CAAC,GAAG;QACvB,2EAA2E;QAC3E,MAAM,IAAI,GAAG,OAAO,IAAI,CAAC,UAAU,EAAE,CAAC;QACtC,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;YAC/C,uBAAuB;YACvB,MAAM,OAAO,GAAG,yBAAS,CAAC,YAAY,CAAC,8BAA8B,CAAC;gBACpE,IAAI;gBACJ,wBAAwB,EAAE,IAAI,CAAC,wBAAwB;gBACvD,MAAM,EAAE,IAAI,CAAC,MAAM;aACpB,CAAC,CAAC;YAEH,IAAA,qBAAM,EAAC,SAAS,KAAK,OAAO,CAAC,CAAC;YAC9B,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;YAC3B,OAAO,CAAC,MAAM,EAAE,CAAC;YAEjB,aAAa,CAAC,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;SAC5C;QAED,MAAM,EAAE,GAAG,yBAAS,CAAC,WAAW,CAAC,YAAY,CAAC;QAC9C,IAAI,EAAE;YACJ,EAAE,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;QAEhC,OAAO,IAAI,CAAC;IACd,CAAC;;AAnCH,sCAoCC;AAnCyB,gCAAkB,GAAG,IAAI,GAAG,EAAU,CAAC;AAqCjE;;GAEG;AACH,MAAa,gBAAiB,SAAQ,oBAAI;IAEjC,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAElC,KAAK,CAAC,GAAG;;QACvB,MAAA,yBAAS,CAAC,WAAW,CAAC,YAAY,0CAAE,wBAAwB,EAAE,CAAC;QAC/D,OAAO,IAAI,CAAC;IACd,CAAC;;AARH,4CASC;AARwB,uBAAM,GAAG,cAAc,CAAC;AAUjD;;;GAGG;AACH,SAAgB,yBAAyB,CAAC,UAAkB;IAC1D,KAAK,MAAM,EAAE,IAAI,yBAAS,CAAC,WAAW,EAAE;QACtC,KAAK,MAAM,YAAY,IAAI,EAAE,CAAC,kBAAkB,EAAE;YAChD,IAAI,YAAY,KAAK,UAAU,EAAE;gBAC/B,EAAE,CAAC,aAAa,EAAE,CAAC;gBACnB,MAAM;aACP;SACF;KACF;AACH,CAAC;AATD,8DASC","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 { assert } from \"@itwin/core-bentley\";\nimport {\n  IModelApp, ScreenSpaceEffectBuilder, ScreenSpaceEffectSource, Tool,\n} from \"@itwin/core-frontend\";\n\n/** Adds a screen-space effect to the selected viewport.\n * @beta\n */\nexport abstract class AddEffectTool extends Tool {\n  private static readonly _registeredEffects = new Set<string>();\n\n  /** Name of effect as used in keyins like `fdt effect add`. Ideally one word. */\n  protected abstract get effectName(): string;\n  /** vertex, fragment, and optional sampleSourcePixel GLSL snippets. */\n  protected abstract get source(): ScreenSpaceEffectSource;\n  /** Whether the fragment shader should include built-in `textureCoordFromPosition` function. */\n  protected abstract get textureCoordFromPosition(): boolean;\n  /** Add uniforms, varyings, etc. */\n  protected abstract defineEffect(builder: ScreenSpaceEffectBuilder): void;\n\n  public override async run(): Promise<boolean> {\n    // Avoid conflicts with the names of other registered screen-space effects.\n    const name = `fdt ${this.effectName}`;\n    if (!AddEffectTool._registeredEffects.has(name)) {\n      // Register the effect.\n      const builder = IModelApp.renderSystem.createScreenSpaceEffectBuilder({\n        name,\n        textureCoordFromPosition: this.textureCoordFromPosition,\n        source: this.source,\n      });\n\n      assert(undefined !== builder);\n      this.defineEffect(builder);\n      builder.finish();\n\n      AddEffectTool._registeredEffects.add(name);\n    }\n\n    const vp = IModelApp.viewManager.selectedView;\n    if (vp)\n      vp.addScreenSpaceEffect(name);\n\n    return true;\n  }\n}\n\n/** Removes all screen-space effects from the selected viewport.\n * @beta\n */\nexport class ClearEffectsTool extends Tool {\n  public static override toolId = \"ClearEffects\";\n  public static override get minArgs() { return 0; }\n  public static override get maxArgs() { return 0; }\n\n  public override async run(): Promise<boolean> {\n    IModelApp.viewManager.selectedView?.removeScreenSpaceEffects();\n    return true;\n  }\n}\n\n/** Requests that any viewport to which the specified effect has been applied redraw its contents.\n * Used by tools like [[VignetteConfig]] to update the view after the effect parameters are modified.\n * @beta\n */\nexport function refreshViewportsForEffect(effectName: string): void {\n  for (const vp of IModelApp.viewManager) {\n    for (const vpEffectName of vp.screenSpaceEffects) {\n      if (vpEffectName === effectName) {\n        vp.requestRedraw();\n        break;\n      }\n    }\n  }\n}\n"]}

package/lib/effects/Explosion.d.ts

@@ -0,0 +1,13 @@
+/** @packageDocumentation
+ * @module Effects
+ */
+import { Tool } from "@itwin/core-frontend";
+/** This tool applies an explosion particle effect used for testing [ParticleCollectionBuilder]($frontend).
+ * @beta
+ */
+export declare class ExplosionEffect extends Tool {
+    static toolId: string;
+    /** This method runs the tool, applying an explosion particle effect. */
+    run(): Promise<boolean>;
+}
+//# sourceMappingURL=Explosion.d.ts.map

package/lib/effects/Explosion.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Explosion.d.ts","sourceRoot":"","sources":["../../src/effects/Explosion.ts"],"names":[],"mappings":"AAIA;;GAEG;AAKH,OAAO,EACgI,IAAI,EAC1I,MAAM,sBAAsB,CAAC;AAwL9B;;GAEG;AACH,qBAAa,eAAgB,SAAQ,IAAI;IACvC,OAAuB,MAAM,SAAqB;IAElD,wEAAwE;IAClD,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC;CAO9C"}

package/lib/effects/Explosion.js

@@ -0,0 +1,168 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Effects
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExplosionEffect = void 0;
+const core_geometry_1 = require("@itwin/core-geometry");
+const core_common_1 = require("@itwin/core-common");
+const core_frontend_1 = require("@itwin/core-frontend");
+const Random_1 = require("./Random");
+/** Represents one particle in the system. */
+class Particle {
+    constructor(position, velocity, lifetime, size) {
+        /** Current age in seconds, incremented each frame. */
+        this.age = 0;
+        /** Particle transparency in [0..255]. */
+        this.transparency = 0;
+        this.position = position;
+        this.velocity = velocity;
+        this.lifetime = lifetime;
+        this.size = size;
+    }
+    get x() { return this.position.x; }
+    get y() { return this.position.y; }
+    get z() { return this.position.z; }
+    get isExpired() { return this.age >= this.lifetime; }
+}
+/** Emits particles in a sphere with its center at the origin.
+ * Each particle is emitted from the center of the sphere with random velocity toward the surface of the sphere.
+ */
+class ParticleEmitter {
+    constructor() {
+        /** Range from which each particle's initial speed in meters per second will be selected. */
+        this.speedRange = core_geometry_1.Range1d.createXX(1, 2);
+        /** Range from which each particle's lifetime in seconds will be selected. */
+        this.lifetimeRange = core_geometry_1.Range1d.createXX(5, 10);
+        /** Range from which each particle's size in meters will be selected. */
+        this.sizeRange = core_geometry_1.Range1d.createXX(0.2, 1.0);
+        /** Range from which the number of particles emitted will be selected. */
+        this.numParticlesRange = core_geometry_1.Range1d.createXX(1600, 2200);
+    }
+    /** Emit an explosion of particles from the center of the sphere. */
+    emit() {
+        const particles = [];
+        const numParticles = (0, Random_1.randomIntegerInRange)(this.numParticlesRange);
+        for (let i = 0; i < numParticles; i++) {
+            const velocity = new core_geometry_1.Vector3d((0, Random_1.randomFloat)(-1.0, 1.0), (0, Random_1.randomFloat)(-1.0, 1.0), (0, Random_1.randomFloat)(-1.0, 1.0));
+            velocity.normalizeInPlace();
+            velocity.scaleInPlace((0, Random_1.randomFloatInRange)(this.speedRange));
+            const lifetime = (0, Random_1.randomFloatInRange)(this.lifetimeRange);
+            const size = (0, Random_1.randomFloatInRange)(this.sizeRange);
+            particles.push(new Particle(new core_geometry_1.Point3d(0, 0, 0), velocity, lifetime, size));
+        }
+        return particles;
+    }
+}
+class ParticleSystem {
+    constructor(texture, iModel, numEmissions) {
+        this._emitter = new ParticleEmitter();
+        this._particles = [];
+        this._scratchVector3d = new core_geometry_1.Vector3d();
+        /** Acceleration in Z applied to particles, in meters per second squared. */
+        this.gravity = -3;
+        this._texture = texture;
+        this._pickableId = iModel.transientIds.next;
+        this._numEmissions = numEmissions;
+        this._lastUpdateTime = Date.now();
+        this._origin = (0, Random_1.randomPositionInRange)(iModel.projectExtents);
+        this._dispose = iModel.onClose.addListener(() => this.dispose());
+    }
+    dispose() {
+        if (this._dispose) {
+            this._dispose();
+            this._dispose = undefined;
+        }
+        core_frontend_1.IModelApp.viewManager.dropDecorator(this);
+        this._texture.dispose();
+    }
+    update() {
+        const now = Date.now();
+        let deltaMillis = now - this._lastUpdateTime;
+        deltaMillis = Math.min(100, deltaMillis);
+        this._lastUpdateTime = now;
+        let numParticles = this._particles.length;
+        if (numParticles === 0) {
+            this._numEmissions--;
+            if (this._numEmissions < 0)
+                this.dispose();
+            else
+                this._particles = this._emitter.emit();
+            return;
+        }
+        const elapsedSeconds = deltaMillis / 1000;
+        for (let i = 0; i < numParticles; i++) {
+            const particle = this._particles[i];
+            this.updateParticle(particle, elapsedSeconds);
+            if (particle.isExpired) {
+                this._particles[i] = this._particles[numParticles - 1];
+                --i;
+                --numParticles;
+            }
+        }
+        this._particles.length = numParticles;
+    }
+    updateParticle(particle, elapsedSeconds) {
+        const velocity = particle.velocity.clone(this._scratchVector3d);
+        velocity.scale(elapsedSeconds, velocity);
+        velocity.z += elapsedSeconds * this.gravity;
+        particle.position.addInPlace(velocity);
+        particle.transparency = 255 * (particle.age / particle.lifetime);
+        particle.age += elapsedSeconds;
+    }
+    decorate(context) {
+        if (!context.viewport.view.isSpatialView())
+            return;
+        this.update();
+        const builder = core_frontend_1.ParticleCollectionBuilder.create({
+            viewport: context.viewport,
+            texture: this._texture,
+            size: (this._emitter.sizeRange.high - this._emitter.sizeRange.low) / 2,
+            transparency: 0,
+            origin: this._origin,
+            pickableId: this._pickableId,
+        });
+        for (const particle of this._particles)
+            builder.addParticle(particle);
+        const graphic = builder.finish();
+        if (graphic) {
+            context.addDecoration(core_frontend_1.GraphicType.WorldDecoration, graphic);
+            context.viewport.onRender.addOnce((vp) => vp.invalidateDecorations());
+        }
+    }
+    testDecorationHit(id) {
+        return id === this._pickableId;
+    }
+    async getDecorationToolTip(_hit) {
+        return "Explosion effect";
+    }
+    static async addDecorator(iModel) {
+        // Note: The decorator takes ownership of the texture, and disposes of it when the decorator is disposed.
+        const isOwned = true;
+        const params = new core_common_1.RenderTexture.Params(undefined, undefined, isOwned);
+        const image = await (0, core_frontend_1.imageElementFromUrl)("./sprites/particle_explosion.png");
+        const texture = core_frontend_1.IModelApp.renderSystem.createTextureFromImage(image, true, undefined, params);
+        if (texture)
+            core_frontend_1.IModelApp.viewManager.addDecorator(new ParticleSystem(texture, iModel, (0, Random_1.randomIntegerInRange)(this.numEmissionsRange)));
+    }
+}
+ParticleSystem.numEmissionsRange = core_geometry_1.Range1d.createXX(1, 5);
+/** This tool applies an explosion particle effect used for testing [ParticleCollectionBuilder]($frontend).
+ * @beta
+ */
+class ExplosionEffect extends core_frontend_1.Tool {
+    /** This method runs the tool, applying an explosion particle effect. */
+    async run() {
+        const vp = core_frontend_1.IModelApp.viewManager.selectedView;
+        if (vp)
+            await ParticleSystem.addDecorator(vp.iModel);
+        return true;
+    }
+}
+exports.ExplosionEffect = ExplosionEffect;
+ExplosionEffect.toolId = "ExplosionEffect";
+//# sourceMappingURL=Explosion.js.map

package/lib/effects/Explosion.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Explosion.js","sourceRoot":"","sources":["../../src/effects/Explosion.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAGH,wDAAkE;AAClE,oDAAmD;AACnD,wDAE8B;AAC9B,qCAAwG;AAExG,6CAA6C;AAC7C,MAAM,QAAQ;IAkBZ,YAAmB,QAAiB,EAAE,QAAkB,EAAE,QAAgB,EAAE,IAAY;QAbxF,sDAAsD;QAC/C,QAAG,GAAG,CAAC,CAAC;QAKf,yCAAyC;QAClC,iBAAY,GAAG,CAAC,CAAC;QAOtB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IATD,IAAW,CAAC,KAAK,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1C,IAAW,CAAC,KAAK,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1C,IAAW,CAAC,KAAK,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IAS1C,IAAW,SAAS,KAAK,OAAO,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;CAC7D;AAED;;GAEG;AACH,MAAM,eAAe;IAArB;QACE,4FAA4F;QAC5E,eAAU,GAAG,uBAAO,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QACpD,6EAA6E;QAC7D,kBAAa,GAAG,uBAAO,CAAC,QAAQ,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACxD,wEAAwE;QACxD,cAAS,GAAG,uBAAO,CAAC,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACvD,yEAAyE;QAClE,sBAAiB,GAAG,uBAAO,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAkB1D,CAAC;IAhBC,oEAAoE;IAC7D,IAAI;QACT,MAAM,SAAS,GAAG,EAAE,CAAC;QACrB,MAAM,YAAY,GAAG,IAAA,6BAAoB,EAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAClE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,YAAY,EAAE,CAAC,EAAE,EAAE;YACrC,MAAM,QAAQ,GAAG,IAAI,wBAAQ,CAAC,IAAA,oBAAW,EAAC,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,IAAA,oBAAW,EAAC,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,IAAA,oBAAW,EAAC,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;YACtG,QAAQ,CAAC,gBAAgB,EAAE,CAAC;YAC5B,QAAQ,CAAC,YAAY,CAAC,IAAA,2BAAkB,EAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;YAE3D,MAAM,QAAQ,GAAG,IAAA,2BAAkB,EAAC,IAAI,CAAC,aAAa,CAAC,CAAC;YACxD,MAAM,IAAI,GAAG,IAAA,2BAAkB,EAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAChD,SAAS,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC,IAAI,uBAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC;SAC9E;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;CACF;AAED,MAAM,cAAc;IAelB,YAAmB,OAAsB,EAAE,MAAwB,EAAE,YAAoB;QAZxE,aAAQ,GAAG,IAAI,eAAe,EAAE,CAAC;QAI1C,eAAU,GAAe,EAAE,CAAC;QACnB,qBAAgB,GAAG,IAAI,wBAAQ,EAAE,CAAC;QAEnD,4EAA4E;QACrE,YAAO,GAAG,CAAC,CAAC,CAAC;QAKlB,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC;QAC5C,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC;QAClC,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAElC,IAAI,CAAC,OAAO,GAAG,IAAA,8BAAqB,EAAC,MAAM,CAAC,cAAc,CAAC,CAAC;QAE5D,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;IAEM,OAAO;QACZ,IAAI,IAAI,CAAC,QAAQ,EAAE;YACjB,IAAI,CAAC,QAAQ,EAAE,CAAC;YAChB,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;SAC3B;QAED,yBAAS,CAAC,WAAW,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QAC1C,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;IAC1B,CAAC;IAEM,MAAM;QACX,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACvB,IAAI,WAAW,GAAG,GAAG,GAAG,IAAI,CAAC,eAAe,CAAC;QAC7C,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;QACzC,IAAI,CAAC,eAAe,GAAG,GAAG,CAAC;QAE3B,IAAI,YAAY,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;QAC1C,IAAI,YAAY,KAAK,CAAC,EAAE;YACtB,IAAI,CAAC,aAAa,EAAE,CAAC;YACrB,IAAI,IAAI,CAAC,aAAa,GAAG,CAAC;gBACxB,IAAI,CAAC,OAAO,EAAE,CAAC;;gBAEf,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;YAEzC,OAAO;SACR;QAED,MAAM,cAAc,GAAG,WAAW,GAAG,IAAI,CAAC;QAC1C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,YAAY,EAAE,CAAC,EAAE,EAAE;YACrC,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;YACpC,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;YAC9C,IAAI,QAAQ,CAAC,SAAS,EAAE;gBACtB,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC;gBACvD,EAAE,CAAC,CAAC;gBACJ,EAAE,YAAY,CAAC;aAChB;SACF;QAED,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,YAAY,CAAC;IACxC,CAAC;IAEO,cAAc,CAAC,QAAkB,EAAE,cAAsB;QAC/D,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAChE,QAAQ,CAAC,KAAK,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC;QACzC,QAAQ,CAAC,CAAC,IAAI,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC;QAC5C,QAAQ,CAAC,QAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QACvC,QAAQ,CAAC,YAAY,GAAG,GAAG,GAAG,CAAC,QAAQ,CAAC,GAAG,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAEjE,QAAQ,CAAC,GAAG,IAAI,cAAc,CAAC;IACjC,CAAC;IAEM,QAAQ,CAAC,OAAwB;QACtC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,EAAE;YACxC,OAAO;QAET,IAAI,CAAC,MAAM,EAAE,CAAC;QAEd,MAAM,OAAO,GAAG,yCAAyB,CAAC,MAAM,CAAC;YAC/C,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,OAAO,EAAE,IAAI,CAAC,QAAQ;YACtB,IAAI,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC;YACtE,YAAY,EAAE,CAAC;YACf,MAAM,EAAE,IAAI,CAAC,OAAO;YACpB,UAAU,EAAE,IAAI,CAAC,WAAW;SAC7B,CAAC,CAAC;QAEH,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,UAAU;YACpC,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QAEhC,MAAM,OAAO,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;QACjC,IAAI,OAAO,EAAE;YACX,OAAO,CAAC,aAAa,CAAC,2BAAW,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;YAC5D,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,qBAAqB,EAAE,CAAC,CAAC;SACvE;IACH,CAAC;IAEM,iBAAiB,CAAC,EAAc;QACrC,OAAO,EAAE,KAAK,IAAI,CAAC,WAAW,CAAC;IACjC,CAAC;IAEM,KAAK,CAAC,oBAAoB,CAAC,IAAe;QAC/C,OAAO,kBAAkB,CAAC;IAC5B,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,MAAwB;QACvD,yGAAyG;QACzG,MAAM,OAAO,GAAG,IAAI,CAAC;QACrB,MAAM,MAAM,GAAG,IAAI,2BAAa,CAAC,MAAM,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;QACvE,MAAM,KAAK,GAAG,MAAM,IAAA,mCAAmB,EAAC,kCAAkC,CAAC,CAAC;QAC5E,MAAM,OAAO,GAAG,yBAAS,CAAC,YAAY,CAAC,sBAAsB,CAAC,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;QAC9F,IAAI,OAAO;YACT,yBAAS,CAAC,WAAW,CAAC,YAAY,CAAC,IAAI,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,IAAA,6BAAoB,EAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC;IAC1H,CAAC;;AAzGa,gCAAiB,GAAG,uBAAO,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AA4G3D;;GAEG;AACH,MAAa,eAAgB,SAAQ,oBAAI;IAGvC,wEAAwE;IACxD,KAAK,CAAC,GAAG;QACvB,MAAM,EAAE,GAAG,yBAAS,CAAC,WAAW,CAAC,YAAY,CAAC;QAC9C,IAAI,EAAE;YACJ,MAAM,cAAc,CAAC,YAAY,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC;QAE/C,OAAO,IAAI,CAAC;IACd,CAAC;;AAVH,0CAWC;AAVwB,sBAAM,GAAG,iBAAiB,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 { Id64String } from \"@itwin/core-bentley\";\nimport { Point3d, Range1d, Vector3d } from \"@itwin/core-geometry\";\nimport { RenderTexture } from \"@itwin/core-common\";\nimport {\n  DecorateContext, GraphicType, HitDetail, imageElementFromUrl, IModelApp, IModelConnection, ParticleCollectionBuilder, ParticleProps, Tool,\n} from \"@itwin/core-frontend\";\nimport { randomFloat, randomFloatInRange, randomIntegerInRange, randomPositionInRange } from \"./Random\";\n\n/** Represents one particle in the system. */\nclass Particle implements ParticleProps {\n  /** Current position in the particle system's local coordinate space. */\n  public readonly position: Point3d;\n  /** Current velocity in meters per second. */\n  public readonly velocity: Vector3d;\n  /** Current age in seconds, incremented each frame. */\n  public age = 0;\n  /** Maximum age in seconds. When `this.age` exceeds `this.lifetime`, the particle expires. */\n  public readonly lifetime: number;\n  /** Particle size in meters. */\n  public size: number;\n  /** Particle transparency in [0..255]. */\n  public transparency = 0;\n\n  public get x() { return this.position.x; }\n  public get y() { return this.position.y; }\n  public get z() { return this.position.z; }\n\n  public constructor(position: Point3d, velocity: Vector3d, lifetime: number, size: number) {\n    this.position = position;\n    this.velocity = velocity;\n    this.lifetime = lifetime;\n    this.size = size;\n  }\n\n  public get isExpired() { return this.age >= this.lifetime; }\n}\n\n/** Emits particles in a sphere with its center at the origin.\n * Each particle is emitted from the center of the sphere with random velocity toward the surface of the sphere.\n */\nclass ParticleEmitter {\n  /** Range from which each particle's initial speed in meters per second will be selected. */\n  public readonly speedRange = Range1d.createXX(1, 2);\n  /** Range from which each particle's lifetime in seconds will be selected. */\n  public readonly lifetimeRange = Range1d.createXX(5, 10);\n  /** Range from which each particle's size in meters will be selected. */\n  public readonly sizeRange = Range1d.createXX(0.2, 1.0);\n  /** Range from which the number of particles emitted will be selected. */\n  public numParticlesRange = Range1d.createXX(1600, 2200);\n\n  /** Emit an explosion of particles from the center of the sphere. */\n  public emit(): Particle[] {\n    const particles = [];\n    const numParticles = randomIntegerInRange(this.numParticlesRange);\n    for (let i = 0; i < numParticles; i++) {\n      const velocity = new Vector3d(randomFloat(-1.0, 1.0), randomFloat(-1.0, 1.0), randomFloat(-1.0, 1.0));\n      velocity.normalizeInPlace();\n      velocity.scaleInPlace(randomFloatInRange(this.speedRange));\n\n      const lifetime = randomFloatInRange(this.lifetimeRange);\n      const size = randomFloatInRange(this.sizeRange);\n      particles.push(new Particle(new Point3d(0, 0, 0), velocity, lifetime, size));\n    }\n\n    return particles;\n  }\n}\n\nclass ParticleSystem {\n  private readonly _origin: Point3d;\n  private readonly _pickableId: Id64String;\n  private readonly _emitter = new ParticleEmitter();\n  private _numEmissions: number;\n  private readonly _texture: RenderTexture;\n  private _lastUpdateTime: number;\n  private _particles: Particle[] = [];\n  private readonly _scratchVector3d = new Vector3d();\n  private _dispose?: VoidFunction;\n  /** Acceleration in Z applied to particles, in meters per second squared. */\n  public gravity = -3;\n\n  public static numEmissionsRange = Range1d.createXX(1, 5);\n\n  public constructor(texture: RenderTexture, iModel: IModelConnection, numEmissions: number) {\n    this._texture = texture;\n    this._pickableId = iModel.transientIds.next;\n    this._numEmissions = numEmissions;\n    this._lastUpdateTime = Date.now();\n\n    this._origin = randomPositionInRange(iModel.projectExtents);\n\n    this._dispose = iModel.onClose.addListener(() => this.dispose());\n  }\n\n  public dispose(): void {\n    if (this._dispose) {\n      this._dispose();\n      this._dispose = undefined;\n    }\n\n    IModelApp.viewManager.dropDecorator(this);\n    this._texture.dispose();\n  }\n\n  public update(): void {\n    const now = Date.now();\n    let deltaMillis = now - this._lastUpdateTime;\n    deltaMillis = Math.min(100, deltaMillis);\n    this._lastUpdateTime = now;\n\n    let numParticles = this._particles.length;\n    if (numParticles === 0) {\n      this._numEmissions--;\n      if (this._numEmissions < 0)\n        this.dispose();\n      else\n        this._particles = this._emitter.emit();\n\n      return;\n    }\n\n    const elapsedSeconds = deltaMillis / 1000;\n    for (let i = 0; i < numParticles; i++) {\n      const particle = this._particles[i];\n      this.updateParticle(particle, elapsedSeconds);\n      if (particle.isExpired) {\n        this._particles[i] = this._particles[numParticles - 1];\n        --i;\n        --numParticles;\n      }\n    }\n\n    this._particles.length = numParticles;\n  }\n\n  private updateParticle(particle: Particle, elapsedSeconds: number): void {\n    const velocity = particle.velocity.clone(this._scratchVector3d);\n    velocity.scale(elapsedSeconds, velocity);\n    velocity.z += elapsedSeconds * this.gravity;\n    particle.position.addInPlace(velocity);\n    particle.transparency = 255 * (particle.age / particle.lifetime);\n\n    particle.age += elapsedSeconds;\n  }\n\n  public decorate(context: DecorateContext): void {\n    if (!context.viewport.view.isSpatialView())\n      return;\n\n    this.update();\n\n    const builder = ParticleCollectionBuilder.create({\n      viewport: context.viewport,\n      texture: this._texture,\n      size: (this._emitter.sizeRange.high - this._emitter.sizeRange.low) / 2,\n      transparency: 0,\n      origin: this._origin,\n      pickableId: this._pickableId,\n    });\n\n    for (const particle of this._particles)\n      builder.addParticle(particle);\n\n    const graphic = builder.finish();\n    if (graphic) {\n      context.addDecoration(GraphicType.WorldDecoration, graphic);\n      context.viewport.onRender.addOnce((vp) => vp.invalidateDecorations());\n    }\n  }\n\n  public testDecorationHit(id: Id64String): boolean {\n    return id === this._pickableId;\n  }\n\n  public async getDecorationToolTip(_hit: HitDetail): Promise<HTMLElement | string> {\n    return \"Explosion effect\";\n  }\n\n  public static async addDecorator(iModel: IModelConnection): Promise<void> {\n    // Note: The decorator takes ownership of the texture, and disposes of it when the decorator is disposed.\n    const isOwned = true;\n    const params = new RenderTexture.Params(undefined, undefined, isOwned);\n    const image = await imageElementFromUrl(\"./sprites/particle_explosion.png\");\n    const texture = IModelApp.renderSystem.createTextureFromImage(image, true, undefined, params);\n    if (texture)\n      IModelApp.viewManager.addDecorator(new ParticleSystem(texture, iModel, randomIntegerInRange(this.numEmissionsRange)));\n  }\n}\n\n/** This tool applies an explosion particle effect used for testing [ParticleCollectionBuilder]($frontend).\n * @beta\n */\nexport class ExplosionEffect extends Tool {\n  public static override toolId = \"ExplosionEffect\";\n\n  /** This method runs the tool, applying an explosion particle effect. */\n  public override async run(): Promise<boolean> {\n    const vp = IModelApp.viewManager.selectedView;\n    if (vp)\n      await ParticleSystem.addDecorator(vp.iModel);\n\n    return true;\n  }\n}\n"]}