@itwin/frontend-devtools 4.0.0-dev.24 → 4.0.0-dev.28

package/lib/cjs/effects/Explosion.js.map

@@ -1 +1 @@
-{"version":3,"file":"Explosion.js","sourceRoot":"","sources":["../../../src/effects/Explosion.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAGH,wDAAkE;AAClE,oDAAwE;AACxE,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,OAAO,EAAE,CAAC;QACjD,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,KAAK,GAAG,MAAM,IAAA,mCAAmB,EAAC,GAAG,yBAAS,CAAC,UAAU,gCAAgC,CAAC,CAAC;QACjG,MAAM,OAAO,GAAG,yBAAS,CAAC,YAAY,CAAC,aAAa,CAAC;YACnD,SAAS,EAAE,UAAU;YACrB,KAAK,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,iCAAmB,CAAC,KAAK,EAAE;SAClE,CAAC,CAAC;QACH,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;;AA1Ga,gCAAiB,GAAG,uBAAO,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AA6G3D;;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":["/*---------------------------------------------------------------------------------------------\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 Effects\r\n */\r\n\r\nimport { Id64String } from \"@itwin/core-bentley\";\r\nimport { Point3d, Range1d, Vector3d } from \"@itwin/core-geometry\";\r\nimport { RenderTexture, TextureTransparency } from \"@itwin/core-common\";\r\nimport {\r\n  DecorateContext, GraphicType, HitDetail, imageElementFromUrl, IModelApp, IModelConnection, ParticleCollectionBuilder, ParticleProps, Tool,\r\n} from \"@itwin/core-frontend\";\r\nimport { randomFloat, randomFloatInRange, randomIntegerInRange, randomPositionInRange } from \"./Random\";\r\n\r\n/** Represents one particle in the system. */\r\nclass Particle implements ParticleProps {\r\n  /** Current position in the particle system's local coordinate space. */\r\n  public readonly position: Point3d;\r\n  /** Current velocity in meters per second. */\r\n  public readonly velocity: Vector3d;\r\n  /** Current age in seconds, incremented each frame. */\r\n  public age = 0;\r\n  /** Maximum age in seconds. When `this.age` exceeds `this.lifetime`, the particle expires. */\r\n  public readonly lifetime: number;\r\n  /** Particle size in meters. */\r\n  public size: number;\r\n  /** Particle transparency in [0..255]. */\r\n  public transparency = 0;\r\n\r\n  public get x() { return this.position.x; }\r\n  public get y() { return this.position.y; }\r\n  public get z() { return this.position.z; }\r\n\r\n  public constructor(position: Point3d, velocity: Vector3d, lifetime: number, size: number) {\r\n    this.position = position;\r\n    this.velocity = velocity;\r\n    this.lifetime = lifetime;\r\n    this.size = size;\r\n  }\r\n\r\n  public get isExpired() { return this.age >= this.lifetime; }\r\n}\r\n\r\n/** Emits particles in a sphere with its center at the origin.\r\n * Each particle is emitted from the center of the sphere with random velocity toward the surface of the sphere.\r\n */\r\nclass ParticleEmitter {\r\n  /** Range from which each particle's initial speed in meters per second will be selected. */\r\n  public readonly speedRange = Range1d.createXX(1, 2);\r\n  /** Range from which each particle's lifetime in seconds will be selected. */\r\n  public readonly lifetimeRange = Range1d.createXX(5, 10);\r\n  /** Range from which each particle's size in meters will be selected. */\r\n  public readonly sizeRange = Range1d.createXX(0.2, 1.0);\r\n  /** Range from which the number of particles emitted will be selected. */\r\n  public numParticlesRange = Range1d.createXX(1600, 2200);\r\n\r\n  /** Emit an explosion of particles from the center of the sphere. */\r\n  public emit(): Particle[] {\r\n    const particles = [];\r\n    const numParticles = randomIntegerInRange(this.numParticlesRange);\r\n    for (let i = 0; i < numParticles; i++) {\r\n      const velocity = new Vector3d(randomFloat(-1.0, 1.0), randomFloat(-1.0, 1.0), randomFloat(-1.0, 1.0));\r\n      velocity.normalizeInPlace();\r\n      velocity.scaleInPlace(randomFloatInRange(this.speedRange));\r\n\r\n      const lifetime = randomFloatInRange(this.lifetimeRange);\r\n      const size = randomFloatInRange(this.sizeRange);\r\n      particles.push(new Particle(new Point3d(0, 0, 0), velocity, lifetime, size));\r\n    }\r\n\r\n    return particles;\r\n  }\r\n}\r\n\r\nclass ParticleSystem {\r\n  private readonly _origin: Point3d;\r\n  private readonly _pickableId: Id64String;\r\n  private readonly _emitter = new ParticleEmitter();\r\n  private _numEmissions: number;\r\n  private readonly _texture: RenderTexture;\r\n  private _lastUpdateTime: number;\r\n  private _particles: Particle[] = [];\r\n  private readonly _scratchVector3d = new Vector3d();\r\n  private _dispose?: VoidFunction;\r\n  /** Acceleration in Z applied to particles, in meters per second squared. */\r\n  public gravity = -3;\r\n\r\n  public static numEmissionsRange = Range1d.createXX(1, 5);\r\n\r\n  public constructor(texture: RenderTexture, iModel: IModelConnection, numEmissions: number) {\r\n    this._texture = texture;\r\n    this._pickableId = iModel.transientIds.getNext();\r\n    this._numEmissions = numEmissions;\r\n    this._lastUpdateTime = Date.now();\r\n\r\n    this._origin = randomPositionInRange(iModel.projectExtents);\r\n\r\n    this._dispose = iModel.onClose.addListener(() => this.dispose());\r\n  }\r\n\r\n  public dispose(): void {\r\n    if (this._dispose) {\r\n      this._dispose();\r\n      this._dispose = undefined;\r\n    }\r\n\r\n    IModelApp.viewManager.dropDecorator(this);\r\n    this._texture.dispose();\r\n  }\r\n\r\n  public update(): void {\r\n    const now = Date.now();\r\n    let deltaMillis = now - this._lastUpdateTime;\r\n    deltaMillis = Math.min(100, deltaMillis);\r\n    this._lastUpdateTime = now;\r\n\r\n    let numParticles = this._particles.length;\r\n    if (numParticles === 0) {\r\n      this._numEmissions--;\r\n      if (this._numEmissions < 0)\r\n        this.dispose();\r\n      else\r\n        this._particles = this._emitter.emit();\r\n\r\n      return;\r\n    }\r\n\r\n    const elapsedSeconds = deltaMillis / 1000;\r\n    for (let i = 0; i < numParticles; i++) {\r\n      const particle = this._particles[i];\r\n      this.updateParticle(particle, elapsedSeconds);\r\n      if (particle.isExpired) {\r\n        this._particles[i] = this._particles[numParticles - 1];\r\n        --i;\r\n        --numParticles;\r\n      }\r\n    }\r\n\r\n    this._particles.length = numParticles;\r\n  }\r\n\r\n  private updateParticle(particle: Particle, elapsedSeconds: number): void {\r\n    const velocity = particle.velocity.clone(this._scratchVector3d);\r\n    velocity.scale(elapsedSeconds, velocity);\r\n    velocity.z += elapsedSeconds * this.gravity;\r\n    particle.position.addInPlace(velocity);\r\n    particle.transparency = 255 * (particle.age / particle.lifetime);\r\n\r\n    particle.age += elapsedSeconds;\r\n  }\r\n\r\n  public decorate(context: DecorateContext): void {\r\n    if (!context.viewport.view.isSpatialView())\r\n      return;\r\n\r\n    this.update();\r\n\r\n    const builder = ParticleCollectionBuilder.create({\r\n      viewport: context.viewport,\r\n      texture: this._texture,\r\n      size: (this._emitter.sizeRange.high - this._emitter.sizeRange.low) / 2,\r\n      transparency: 0,\r\n      origin: this._origin,\r\n      pickableId: this._pickableId,\r\n    });\r\n\r\n    for (const particle of this._particles)\r\n      builder.addParticle(particle);\r\n\r\n    const graphic = builder.finish();\r\n    if (graphic) {\r\n      context.addDecoration(GraphicType.WorldDecoration, graphic);\r\n      context.viewport.onRender.addOnce((vp) => vp.invalidateDecorations());\r\n    }\r\n  }\r\n\r\n  public testDecorationHit(id: Id64String): boolean {\r\n    return id === this._pickableId;\r\n  }\r\n\r\n  public async getDecorationToolTip(_hit: HitDetail): Promise<HTMLElement | string> {\r\n    return \"Explosion effect\";\r\n  }\r\n\r\n  public static async addDecorator(iModel: IModelConnection): Promise<void> {\r\n    // Note: The decorator takes ownership of the texture, and disposes of it when the decorator is disposed.\r\n    const image = await imageElementFromUrl(`${IModelApp.publicPath}sprites/particle_explosion.png`);\r\n    const texture = IModelApp.renderSystem.createTexture({\r\n      ownership: \"external\",\r\n      image: { source: image, transparency: TextureTransparency.Mixed },\r\n    });\r\n    if (texture)\r\n      IModelApp.viewManager.addDecorator(new ParticleSystem(texture, iModel, randomIntegerInRange(this.numEmissionsRange)));\r\n  }\r\n}\r\n\r\n/** This tool applies an explosion particle effect used for testing [ParticleCollectionBuilder]($frontend).\r\n * @beta\r\n */\r\nexport class ExplosionEffect extends Tool {\r\n  public static override toolId = \"ExplosionEffect\";\r\n\r\n  /** This method runs the tool, applying an explosion particle effect. */\r\n  public override async run(): Promise<boolean> {\r\n    const vp = IModelApp.viewManager.selectedView;\r\n    if (vp)\r\n      await ParticleSystem.addDecorator(vp.iModel);\r\n\r\n    return true;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"Explosion.js","sourceRoot":"","sources":["../../../src/effects/Explosion.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAGH,wDAAkE;AAClE,oDAAwE;AACxE,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,OAAO,EAAE,CAAC;QACjD,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,KAAK,GAAG,MAAM,IAAA,mCAAmB,EAAC,GAAG,yBAAS,CAAC,UAAU,gCAAgC,CAAC,CAAC;QACjG,MAAM,OAAO,GAAG,yBAAS,CAAC,YAAY,CAAC,aAAa,CAAC;YACnD,SAAS,EAAE,UAAU;YACrB,KAAK,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,iCAAmB,CAAC,KAAK,EAAE;SAClE,CAAC,CAAC;QACH,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;;AA1Ga,gCAAiB,GAAG,uBAAO,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AA6G3D;;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, TextureTransparency } 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.getNext();\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 image = await imageElementFromUrl(`${IModelApp.publicPath}sprites/particle_explosion.png`);\n    const texture = IModelApp.renderSystem.createTexture({\n      ownership: \"external\",\n      image: { source: image, transparency: TextureTransparency.Mixed },\n    });\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"]}

package/lib/cjs/effects/FlipImage.d.ts

@@ -1,31 +1,31 @@
-/** @packageDocumentation
- * @module Effects
- */
-import { ScreenSpaceEffectBuilder, Tool } from "@itwin/core-frontend";
-import { AddEffectTool } from "./EffectTools";
-/** An extremely simple and mostly useless effect intended to demonstrate the basics of creating a screen-space effect.
- * It flips the Viewport's image on the x and/or y axis, and/or inverts the color of each pixel.
- * @beta
- */
-export declare class FlipImageEffect extends AddEffectTool {
-    static toolId: string;
-    protected get effectName(): string;
-    protected get textureCoordFromPosition(): boolean;
-    protected get source(): {
-        vertex: string;
-        fragment: string;
-        sampleSourcePixel: string;
-    };
-    protected defineEffect(builder: ScreenSpaceEffectBuilder): void;
-}
-/** Configure the [[FlipImageEffect]].
- * @beta
- */
-export declare class FlipImageConfig extends Tool {
-    static toolId: string;
-    static get minArgs(): number;
-    static get maxArgs(): number;
-    run(horizontal?: boolean, vertical?: boolean, color?: boolean): Promise<boolean>;
-    parseAndRun(...input: string[]): Promise<boolean>;
-}
+/** @packageDocumentation
+ * @module Effects
+ */
+import { ScreenSpaceEffectBuilder, Tool } from "@itwin/core-frontend";
+import { AddEffectTool } from "./EffectTools";
+/** An extremely simple and mostly useless effect intended to demonstrate the basics of creating a screen-space effect.
+ * It flips the Viewport's image on the x and/or y axis, and/or inverts the color of each pixel.
+ * @beta
+ */
+export declare class FlipImageEffect extends AddEffectTool {
+    static toolId: string;
+    protected get effectName(): string;
+    protected get textureCoordFromPosition(): boolean;
+    protected get source(): {
+        vertex: string;
+        fragment: string;
+        sampleSourcePixel: string;
+    };
+    protected defineEffect(builder: ScreenSpaceEffectBuilder): void;
+}
+/** Configure the [[FlipImageEffect]].
+ * @beta
+ */
+export declare class FlipImageConfig extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    run(horizontal?: boolean, vertical?: boolean, color?: boolean): Promise<boolean>;
+    parseAndRun(...input: string[]): Promise<boolean>;
+}
 //# sourceMappingURL=FlipImage.d.ts.map

package/lib/cjs/effects/FlipImage.js

@@ -1,100 +1,100 @@
-"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.FlipImageConfig = exports.FlipImageEffect = void 0;
-const core_frontend_1 = require("@itwin/core-frontend");
-const parseArgs_1 = require("../tools/parseArgs");
-const EffectTools_1 = require("./EffectTools");
-let flipHorizontal = false;
-let flipVertical = false;
-let flipColor = false;
-/** An extremely simple and mostly useless effect intended to demonstrate the basics of creating a screen-space effect.
- * It flips the Viewport's image on the x and/or y axis, and/or inverts the color of each pixel.
- * @beta
- */
-class FlipImageEffect extends EffectTools_1.AddEffectTool {
-    get effectName() { return "flip"; }
-    get textureCoordFromPosition() { return true; }
-    get source() {
-        return {
-            // Compute texture coordinate for use in fragment shader.
-            vertex: `
-        void effectMain(vec4 pos) {
-          vec2 uv = textureCoordFromPosition(pos);
-          if (u_flipHorizontal)
-            uv.x = 1.0 - uv.x;
-
-          if (u_flipVertical)
-            uv.y = 1.0 - uv.y;
-
-          v_uv = uv;
-        }`,
-            // Sample the original image to flip on x and/or y axis, then invert its color.
-            fragment: `
-        vec4 effectMain() {
-          vec4 color = sampleSourcePixel();
-          if (u_flipColor) {
-            color.r = 1.0 - color.r;
-            color.g = 1.0 - color.g;
-            color.b = 1.0 - color.b;
-          }
-
-          return color;
-        }`,
-            // Because we're moving pixels around, we must tell the render system where the source pixel was originally located - otherwise
-            // element locate will not work correctly.
-            sampleSourcePixel: "return TEXTURE(u_diffuse, v_uv);",
-        };
-    }
-    defineEffect(builder) {
-        // Don't bother applying the effect if nothing is to be flipped.
-        builder.shouldApply = (_context) => flipHorizontal || flipVertical || flipColor;
-        // Define the varying for the texture coordinate.
-        builder.addVarying("v_uv", core_frontend_1.VaryingType.Vec2);
-        // Hook up the uniforms.
-        builder.addUniform({
-            name: "u_flipHorizontal",
-            type: core_frontend_1.UniformType.Bool,
-            bind: (uniform, _context) => uniform.setUniform1i(flipHorizontal ? 1 : 0),
-        });
-        builder.addUniform({
-            name: "u_flipVertical",
-            type: core_frontend_1.UniformType.Bool,
-            bind: (uniform, _context) => uniform.setUniform1i(flipVertical ? 1 : 0),
-        });
-        builder.addUniform({
-            name: "u_flipColor",
-            type: core_frontend_1.UniformType.Bool,
-            bind: (uniform, _context) => uniform.setUniform1i(flipColor ? 1 : 0),
-        });
-    }
-}
-exports.FlipImageEffect = FlipImageEffect;
-FlipImageEffect.toolId = "FlipImageEffect";
-/** Configure the [[FlipImageEffect]].
- * @beta
- */
-class FlipImageConfig extends core_frontend_1.Tool {
-    static get minArgs() { return 0; }
-    static get maxArgs() { return 3; }
-    async run(horizontal, vertical, color) {
-        flipHorizontal = !!horizontal;
-        flipVertical = !!vertical;
-        flipColor = !!color;
-        (0, EffectTools_1.refreshViewportsForEffect)("fdt flip");
-        return true;
-    }
-    async parseAndRun(...input) {
-        const args = (0, parseArgs_1.parseArgs)(input);
-        return this.run(args.getBoolean("h"), args.getBoolean("v"), args.getBoolean("c"));
-    }
-}
-exports.FlipImageConfig = FlipImageConfig;
-FlipImageConfig.toolId = "FlipImageConfig";
+"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.FlipImageConfig = exports.FlipImageEffect = void 0;
+const core_frontend_1 = require("@itwin/core-frontend");
+const parseArgs_1 = require("../tools/parseArgs");
+const EffectTools_1 = require("./EffectTools");
+let flipHorizontal = false;
+let flipVertical = false;
+let flipColor = false;
+/** An extremely simple and mostly useless effect intended to demonstrate the basics of creating a screen-space effect.
+ * It flips the Viewport's image on the x and/or y axis, and/or inverts the color of each pixel.
+ * @beta
+ */
+class FlipImageEffect extends EffectTools_1.AddEffectTool {
+    get effectName() { return "flip"; }
+    get textureCoordFromPosition() { return true; }
+    get source() {
+        return {
+            // Compute texture coordinate for use in fragment shader.
+            vertex: `
+        void effectMain(vec4 pos) {
+          vec2 uv = textureCoordFromPosition(pos);
+          if (u_flipHorizontal)
+            uv.x = 1.0 - uv.x;
+
+          if (u_flipVertical)
+            uv.y = 1.0 - uv.y;
+
+          v_uv = uv;
+        }`,
+            // Sample the original image to flip on x and/or y axis, then invert its color.
+            fragment: `
+        vec4 effectMain() {
+          vec4 color = sampleSourcePixel();
+          if (u_flipColor) {
+            color.r = 1.0 - color.r;
+            color.g = 1.0 - color.g;
+            color.b = 1.0 - color.b;
+          }
+
+          return color;
+        }`,
+            // Because we're moving pixels around, we must tell the render system where the source pixel was originally located - otherwise
+            // element locate will not work correctly.
+            sampleSourcePixel: "return TEXTURE(u_diffuse, v_uv);",
+        };
+    }
+    defineEffect(builder) {
+        // Don't bother applying the effect if nothing is to be flipped.
+        builder.shouldApply = (_context) => flipHorizontal || flipVertical || flipColor;
+        // Define the varying for the texture coordinate.
+        builder.addVarying("v_uv", core_frontend_1.VaryingType.Vec2);
+        // Hook up the uniforms.
+        builder.addUniform({
+            name: "u_flipHorizontal",
+            type: core_frontend_1.UniformType.Bool,
+            bind: (uniform, _context) => uniform.setUniform1i(flipHorizontal ? 1 : 0),
+        });
+        builder.addUniform({
+            name: "u_flipVertical",
+            type: core_frontend_1.UniformType.Bool,
+            bind: (uniform, _context) => uniform.setUniform1i(flipVertical ? 1 : 0),
+        });
+        builder.addUniform({
+            name: "u_flipColor",
+            type: core_frontend_1.UniformType.Bool,
+            bind: (uniform, _context) => uniform.setUniform1i(flipColor ? 1 : 0),
+        });
+    }
+}
+exports.FlipImageEffect = FlipImageEffect;
+FlipImageEffect.toolId = "FlipImageEffect";
+/** Configure the [[FlipImageEffect]].
+ * @beta
+ */
+class FlipImageConfig extends core_frontend_1.Tool {
+    static get minArgs() { return 0; }
+    static get maxArgs() { return 3; }
+    async run(horizontal, vertical, color) {
+        flipHorizontal = !!horizontal;
+        flipVertical = !!vertical;
+        flipColor = !!color;
+        (0, EffectTools_1.refreshViewportsForEffect)("fdt flip");
+        return true;
+    }
+    async parseAndRun(...input) {
+        const args = (0, parseArgs_1.parseArgs)(input);
+        return this.run(args.getBoolean("h"), args.getBoolean("v"), args.getBoolean("c"));
+    }
+}
+exports.FlipImageConfig = FlipImageConfig;
+FlipImageConfig.toolId = "FlipImageConfig";
 //# sourceMappingURL=FlipImage.js.map

package/lib/cjs/effects/FlipImage.js.map

@@ -1 +1 @@
-{"version":3,"file":"FlipImage.js","sourceRoot":"","sources":["../../../src/effects/FlipImage.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,wDAAgG;AAChG,kDAA+C;AAC/C,+CAAyE;AAEzE,IAAI,cAAc,GAAG,KAAK,CAAC;AAC3B,IAAI,YAAY,GAAG,KAAK,CAAC;AACzB,IAAI,SAAS,GAAG,KAAK,CAAC;AAEtB;;;GAGG;AACH,MAAa,eAAgB,SAAQ,2BAAa;IAGhD,IAAc,UAAU,KAAK,OAAO,MAAM,CAAC,CAAC,CAAC;IAC7C,IAAc,wBAAwB,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IAEzD,IAAc,MAAM;QAClB,OAAO;YACL,yDAAyD;YACzD,MAAM,EAAE;;;;;;;;;;UAUJ;YACJ,+EAA+E;YAC/E,QAAQ,EAAE;;;;;;;;;;UAUN;YACJ,+HAA+H;YAC/H,0CAA0C;YAC1C,iBAAiB,EAAE,kCAAkC;SACtD,CAAC;IACJ,CAAC;IAES,YAAY,CAAC,OAAiC;QACtD,gEAAgE;QAChE,OAAO,CAAC,WAAW,GAAG,CAAC,QAAQ,EAAE,EAAE,CAAC,cAAc,IAAI,YAAY,IAAI,SAAS,CAAC;QAEhF,iDAAiD;QACjD,OAAO,CAAC,UAAU,CAAC,MAAM,EAAE,2BAAW,CAAC,IAAI,CAAC,CAAC;QAE7C,wBAAwB;QACxB,OAAO,CAAC,UAAU,CAAC;YACjB,IAAI,EAAE,kBAAkB;YACxB,IAAI,EAAE,2BAAW,CAAC,IAAI;YACtB,IAAI,EAAE,CAAC,OAAO,EAAE,QAAQ,EAAE,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;SAC1E,CAAC,CAAC;QACH,OAAO,CAAC,UAAU,CAAC;YACjB,IAAI,EAAE,gBAAgB;YACtB,IAAI,EAAE,2BAAW,CAAC,IAAI;YACtB,IAAI,EAAE,CAAC,OAAO,EAAE,QAAQ,EAAE,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;SACxE,CAAC,CAAC;QACH,OAAO,CAAC,UAAU,CAAC;YACjB,IAAI,EAAE,aAAa;YACnB,IAAI,EAAE,2BAAW,CAAC,IAAI;YACtB,IAAI,EAAE,CAAC,OAAO,EAAE,QAAQ,EAAE,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;SACrE,CAAC,CAAC;IACL,CAAC;;AA7DH,0CA8DC;AA7DwB,sBAAM,GAAG,iBAAiB,CAAC;AA+DpD;;GAEG;AACH,MAAa,eAAgB,SAAQ,oBAAI;IAEhC,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAElC,KAAK,CAAC,GAAG,CAAC,UAAoB,EAAE,QAAkB,EAAE,KAAe;QACjF,cAAc,GAAG,CAAC,CAAC,UAAU,CAAC;QAC9B,YAAY,GAAG,CAAC,CAAC,QAAQ,CAAC;QAC1B,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC;QAEpB,IAAA,uCAAyB,EAAC,UAAU,CAAC,CAAC;QACtC,OAAO,IAAI,CAAC;IACd,CAAC;IAEe,KAAK,CAAC,WAAW,CAAC,GAAG,KAAe;QAClD,MAAM,IAAI,GAAG,IAAA,qBAAS,EAAC,KAAK,CAAC,CAAC;QAC9B,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;IACpF,CAAC;;AAjBH,0CAkBC;AAjBwB,sBAAM,GAAG,iBAAiB,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 Effects\r\n */\r\n\r\nimport { ScreenSpaceEffectBuilder, Tool, UniformType, VaryingType } from \"@itwin/core-frontend\";\r\nimport { parseArgs } from \"../tools/parseArgs\";\r\nimport { AddEffectTool, refreshViewportsForEffect } from \"./EffectTools\";\r\n\r\nlet flipHorizontal = false;\r\nlet flipVertical = false;\r\nlet flipColor = false;\r\n\r\n/** An extremely simple and mostly useless effect intended to demonstrate the basics of creating a screen-space effect.\r\n * It flips the Viewport's image on the x and/or y axis, and/or inverts the color of each pixel.\r\n * @beta\r\n */\r\nexport class FlipImageEffect extends AddEffectTool {\r\n  public static override toolId = \"FlipImageEffect\";\r\n\r\n  protected get effectName() { return \"flip\"; }\r\n  protected get textureCoordFromPosition() { return true; }\r\n\r\n  protected get source() {\r\n    return {\r\n      // Compute texture coordinate for use in fragment shader.\r\n      vertex: `\r\n        void effectMain(vec4 pos) {\r\n          vec2 uv = textureCoordFromPosition(pos);\r\n          if (u_flipHorizontal)\r\n            uv.x = 1.0 - uv.x;\r\n\r\n          if (u_flipVertical)\r\n            uv.y = 1.0 - uv.y;\r\n\r\n          v_uv = uv;\r\n        }`,\r\n      // Sample the original image to flip on x and/or y axis, then invert its color.\r\n      fragment: `\r\n        vec4 effectMain() {\r\n          vec4 color = sampleSourcePixel();\r\n          if (u_flipColor) {\r\n            color.r = 1.0 - color.r;\r\n            color.g = 1.0 - color.g;\r\n            color.b = 1.0 - color.b;\r\n          }\r\n\r\n          return color;\r\n        }`,\r\n      // Because we're moving pixels around, we must tell the render system where the source pixel was originally located - otherwise\r\n      // element locate will not work correctly.\r\n      sampleSourcePixel: \"return TEXTURE(u_diffuse, v_uv);\",\r\n    };\r\n  }\r\n\r\n  protected defineEffect(builder: ScreenSpaceEffectBuilder): void {\r\n    // Don't bother applying the effect if nothing is to be flipped.\r\n    builder.shouldApply = (_context) => flipHorizontal || flipVertical || flipColor;\r\n\r\n    // Define the varying for the texture coordinate.\r\n    builder.addVarying(\"v_uv\", VaryingType.Vec2);\r\n\r\n    // Hook up the uniforms.\r\n    builder.addUniform({\r\n      name: \"u_flipHorizontal\",\r\n      type: UniformType.Bool,\r\n      bind: (uniform, _context) => uniform.setUniform1i(flipHorizontal ? 1 : 0),\r\n    });\r\n    builder.addUniform({\r\n      name: \"u_flipVertical\",\r\n      type: UniformType.Bool,\r\n      bind: (uniform, _context) => uniform.setUniform1i(flipVertical ? 1 : 0),\r\n    });\r\n    builder.addUniform({\r\n      name: \"u_flipColor\",\r\n      type: UniformType.Bool,\r\n      bind: (uniform, _context) => uniform.setUniform1i(flipColor ? 1 : 0),\r\n    });\r\n  }\r\n}\r\n\r\n/** Configure the [[FlipImageEffect]].\r\n * @beta\r\n */\r\nexport class FlipImageConfig extends Tool {\r\n  public static override toolId = \"FlipImageConfig\";\r\n  public static override get minArgs() { return 0; }\r\n  public static override get maxArgs() { return 3; }\r\n\r\n  public override async run(horizontal?: boolean, vertical?: boolean, color?: boolean): Promise<boolean> {\r\n    flipHorizontal = !!horizontal;\r\n    flipVertical = !!vertical;\r\n    flipColor = !!color;\r\n\r\n    refreshViewportsForEffect(\"fdt flip\");\r\n    return true;\r\n  }\r\n\r\n  public override async parseAndRun(...input: string[]): Promise<boolean> {\r\n    const args = parseArgs(input);\r\n    return this.run(args.getBoolean(\"h\"), args.getBoolean(\"v\"), args.getBoolean(\"c\"));\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"FlipImage.js","sourceRoot":"","sources":["../../../src/effects/FlipImage.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,wDAAgG;AAChG,kDAA+C;AAC/C,+CAAyE;AAEzE,IAAI,cAAc,GAAG,KAAK,CAAC;AAC3B,IAAI,YAAY,GAAG,KAAK,CAAC;AACzB,IAAI,SAAS,GAAG,KAAK,CAAC;AAEtB;;;GAGG;AACH,MAAa,eAAgB,SAAQ,2BAAa;IAGhD,IAAc,UAAU,KAAK,OAAO,MAAM,CAAC,CAAC,CAAC;IAC7C,IAAc,wBAAwB,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IAEzD,IAAc,MAAM;QAClB,OAAO;YACL,yDAAyD;YACzD,MAAM,EAAE;;;;;;;;;;UAUJ;YACJ,+EAA+E;YAC/E,QAAQ,EAAE;;;;;;;;;;UAUN;YACJ,+HAA+H;YAC/H,0CAA0C;YAC1C,iBAAiB,EAAE,kCAAkC;SACtD,CAAC;IACJ,CAAC;IAES,YAAY,CAAC,OAAiC;QACtD,gEAAgE;QAChE,OAAO,CAAC,WAAW,GAAG,CAAC,QAAQ,EAAE,EAAE,CAAC,cAAc,IAAI,YAAY,IAAI,SAAS,CAAC;QAEhF,iDAAiD;QACjD,OAAO,CAAC,UAAU,CAAC,MAAM,EAAE,2BAAW,CAAC,IAAI,CAAC,CAAC;QAE7C,wBAAwB;QACxB,OAAO,CAAC,UAAU,CAAC;YACjB,IAAI,EAAE,kBAAkB;YACxB,IAAI,EAAE,2BAAW,CAAC,IAAI;YACtB,IAAI,EAAE,CAAC,OAAO,EAAE,QAAQ,EAAE,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;SAC1E,CAAC,CAAC;QACH,OAAO,CAAC,UAAU,CAAC;YACjB,IAAI,EAAE,gBAAgB;YACtB,IAAI,EAAE,2BAAW,CAAC,IAAI;YACtB,IAAI,EAAE,CAAC,OAAO,EAAE,QAAQ,EAAE,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;SACxE,CAAC,CAAC;QACH,OAAO,CAAC,UAAU,CAAC;YACjB,IAAI,EAAE,aAAa;YACnB,IAAI,EAAE,2BAAW,CAAC,IAAI;YACtB,IAAI,EAAE,CAAC,OAAO,EAAE,QAAQ,EAAE,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;SACrE,CAAC,CAAC;IACL,CAAC;;AA7DH,0CA8DC;AA7DwB,sBAAM,GAAG,iBAAiB,CAAC;AA+DpD;;GAEG;AACH,MAAa,eAAgB,SAAQ,oBAAI;IAEhC,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAElC,KAAK,CAAC,GAAG,CAAC,UAAoB,EAAE,QAAkB,EAAE,KAAe;QACjF,cAAc,GAAG,CAAC,CAAC,UAAU,CAAC;QAC9B,YAAY,GAAG,CAAC,CAAC,QAAQ,CAAC;QAC1B,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC;QAEpB,IAAA,uCAAyB,EAAC,UAAU,CAAC,CAAC;QACtC,OAAO,IAAI,CAAC;IACd,CAAC;IAEe,KAAK,CAAC,WAAW,CAAC,GAAG,KAAe;QAClD,MAAM,IAAI,GAAG,IAAA,qBAAS,EAAC,KAAK,CAAC,CAAC;QAC9B,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;IACpF,CAAC;;AAjBH,0CAkBC;AAjBwB,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 { ScreenSpaceEffectBuilder, Tool, UniformType, VaryingType } from \"@itwin/core-frontend\";\nimport { parseArgs } from \"../tools/parseArgs\";\nimport { AddEffectTool, refreshViewportsForEffect } from \"./EffectTools\";\n\nlet flipHorizontal = false;\nlet flipVertical = false;\nlet flipColor = false;\n\n/** An extremely simple and mostly useless effect intended to demonstrate the basics of creating a screen-space effect.\n * It flips the Viewport's image on the x and/or y axis, and/or inverts the color of each pixel.\n * @beta\n */\nexport class FlipImageEffect extends AddEffectTool {\n  public static override toolId = \"FlipImageEffect\";\n\n  protected get effectName() { return \"flip\"; }\n  protected get textureCoordFromPosition() { return true; }\n\n  protected get source() {\n    return {\n      // Compute texture coordinate for use in fragment shader.\n      vertex: `\n        void effectMain(vec4 pos) {\n          vec2 uv = textureCoordFromPosition(pos);\n          if (u_flipHorizontal)\n            uv.x = 1.0 - uv.x;\n\n          if (u_flipVertical)\n            uv.y = 1.0 - uv.y;\n\n          v_uv = uv;\n        }`,\n      // Sample the original image to flip on x and/or y axis, then invert its color.\n      fragment: `\n        vec4 effectMain() {\n          vec4 color = sampleSourcePixel();\n          if (u_flipColor) {\n            color.r = 1.0 - color.r;\n            color.g = 1.0 - color.g;\n            color.b = 1.0 - color.b;\n          }\n\n          return color;\n        }`,\n      // Because we're moving pixels around, we must tell the render system where the source pixel was originally located - otherwise\n      // element locate will not work correctly.\n      sampleSourcePixel: \"return TEXTURE(u_diffuse, v_uv);\",\n    };\n  }\n\n  protected defineEffect(builder: ScreenSpaceEffectBuilder): void {\n    // Don't bother applying the effect if nothing is to be flipped.\n    builder.shouldApply = (_context) => flipHorizontal || flipVertical || flipColor;\n\n    // Define the varying for the texture coordinate.\n    builder.addVarying(\"v_uv\", VaryingType.Vec2);\n\n    // Hook up the uniforms.\n    builder.addUniform({\n      name: \"u_flipHorizontal\",\n      type: UniformType.Bool,\n      bind: (uniform, _context) => uniform.setUniform1i(flipHorizontal ? 1 : 0),\n    });\n    builder.addUniform({\n      name: \"u_flipVertical\",\n      type: UniformType.Bool,\n      bind: (uniform, _context) => uniform.setUniform1i(flipVertical ? 1 : 0),\n    });\n    builder.addUniform({\n      name: \"u_flipColor\",\n      type: UniformType.Bool,\n      bind: (uniform, _context) => uniform.setUniform1i(flipColor ? 1 : 0),\n    });\n  }\n}\n\n/** Configure the [[FlipImageEffect]].\n * @beta\n */\nexport class FlipImageConfig extends Tool {\n  public static override toolId = \"FlipImageConfig\";\n  public static override get minArgs() { return 0; }\n  public static override get maxArgs() { return 3; }\n\n  public override async run(horizontal?: boolean, vertical?: boolean, color?: boolean): Promise<boolean> {\n    flipHorizontal = !!horizontal;\n    flipVertical = !!vertical;\n    flipColor = !!color;\n\n    refreshViewportsForEffect(\"fdt flip\");\n    return true;\n  }\n\n  public override async parseAndRun(...input: string[]): Promise<boolean> {\n    const args = parseArgs(input);\n    return this.run(args.getBoolean(\"h\"), args.getBoolean(\"v\"), args.getBoolean(\"c\"));\n  }\n}\n"]}

package/lib/cjs/effects/LensDistortion.d.ts

@@ -1,35 +1,35 @@
-/** @packageDocumentation
- * @module Effects
- */
-import { ScreenSpaceEffectBuilder, Tool } from "@itwin/core-frontend";
-import { AddEffectTool } from "./EffectTools";
-/** Adds a screen-space effect to the selected [[Viewport]] to simulate the lens distortion produced by real-world cameras with very wide fields of view.
- * Based on https://www.decarpentier.nl/lens-distortion
- * The effect is improved considerably by enabling anti-aliasing (e.g., via [RenderSystem.Options.antialiasSamples]($frontend) at startup, or using the `fdt aasamples` key-in`).
- * @note Because this effect applies a non-linear transform to each pixel, operations like snapping to geometry will not work properly. Element locate will work however - @see [ScreenSpaceEffectSource.sampleSourcePixel]($frontend).
- * @beta
- */
-export declare class LensDistortionEffect extends AddEffectTool {
-    static toolId: string;
-    protected get effectName(): string;
-    protected get textureCoordFromPosition(): boolean;
-    protected get source(): {
-        vertex: string;
-        fragment: string;
-        sampleSourcePixel: string;
-    };
-    protected defineEffect(builder: ScreenSpaceEffectBuilder): void;
-}
-/** Configures the [[LensDistortionEffect]].
- * @beta
- */
-export declare class LensDistortionConfig extends Tool {
-    static toolId: string;
-    static get minArgs(): number;
-    static get maxArgs(): number;
-    static strength: number;
-    static cylindricalRatio: number;
-    run(strength?: number, ratio?: number): Promise<boolean>;
-    parseAndRun(...input: string[]): Promise<boolean>;
-}
+/** @packageDocumentation
+ * @module Effects
+ */
+import { ScreenSpaceEffectBuilder, Tool } from "@itwin/core-frontend";
+import { AddEffectTool } from "./EffectTools";
+/** Adds a screen-space effect to the selected [[Viewport]] to simulate the lens distortion produced by real-world cameras with very wide fields of view.
+ * Based on https://www.decarpentier.nl/lens-distortion
+ * The effect is improved considerably by enabling anti-aliasing (e.g., via [RenderSystem.Options.antialiasSamples]($frontend) at startup, or using the `fdt aasamples` key-in`).
+ * @note Because this effect applies a non-linear transform to each pixel, operations like snapping to geometry will not work properly. Element locate will work however - @see [ScreenSpaceEffectSource.sampleSourcePixel]($frontend).
+ * @beta
+ */
+export declare class LensDistortionEffect extends AddEffectTool {
+    static toolId: string;
+    protected get effectName(): string;
+    protected get textureCoordFromPosition(): boolean;
+    protected get source(): {
+        vertex: string;
+        fragment: string;
+        sampleSourcePixel: string;
+    };
+    protected defineEffect(builder: ScreenSpaceEffectBuilder): void;
+}
+/** Configures the [[LensDistortionEffect]].
+ * @beta
+ */
+export declare class LensDistortionConfig extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    static strength: number;
+    static cylindricalRatio: number;
+    run(strength?: number, ratio?: number): Promise<boolean>;
+    parseAndRun(...input: string[]): Promise<boolean>;
+}
 //# sourceMappingURL=LensDistortion.d.ts.map