@itwin/frontend-devtools 4.0.0-dev.52 → 4.0.0-dev.55

package/lib/esm/effects/Snow.js

@@ -1,183 +1,185 @@
-/*---------------------------------------------------------------------------------------------
-* 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
- */
-import { dispose } from "@itwin/core-bentley";
-import { Point2d, Range1d, Range2d, Vector2d } from "@itwin/core-geometry";
-import { TextureTransparency } from "@itwin/core-common";
-import { GraphicType, imageElementFromUrl, IModelApp, ParticleCollectionBuilder, Tool, } from "@itwin/core-frontend";
-import { parseToggle } from "../tools/parseToggle";
-import { randomFloat, randomInteger } from "./Random";
-/** The default snow effect parameters used by newly-created SnowDecorators. */
-const defaultSnowParams = {
-    numParticles: 2000,
-    sizeRange: Range1d.createXX(3, 22),
-    transparencyRange: Range1d.createXX(0, 50),
-    velocityRange: new Range2d(-30, 50, 30, 130),
-    accelerationRange: new Range2d(-1, -0.25, 1, 0.25),
-    windVelocity: 0,
-};
-/** Simulates snowfall in a [Viewport]($frontend) using particle effects.
- * @see [[SnowEffect]] for a [Tool]($frontend) that toggles this decorator.
- * @see [ParticleCollectionBuilder]($frontend) for defining custom particle effects.
- * @beta
- */
-export class SnowDecorator {
-    constructor(viewport, texture) {
-        /** The list of particles being drawn. */
-        this._particles = [];
-        this._params = { ...defaultSnowParams };
-        this.viewport = viewport;
-        this._dimensions = new Point2d(viewport.viewRect.width, viewport.viewRect.height);
-        this._lastUpdateTime = Date.now();
-        this._texture = texture;
-        // Tell the viewport to re-render the decorations every frame so that the snow particles animate smoothly.
-        const removeOnRender = viewport.onRender.addListener(() => viewport.invalidateDecorations());
-        // When the viewport is resized, replace this decorator with a new one to match the new dimensions.
-        const removeOnResized = viewport.onResized.addListener(() => {
-            // Transfer ownership of the texture to the new decorator.
-            const tex = this._texture;
-            this._texture = undefined;
-            this.dispose();
-            new SnowDecorator(viewport, tex);
-        });
-        // When the viewport is destroyed, dispose of this decorator too.
-        const removeOnDispose = viewport.onDisposed.addListener(() => this.dispose());
-        const removeDecorator = IModelApp.viewManager.addDecorator(this);
-        this.dispose = () => {
-            removeDecorator();
-            removeOnRender();
-            removeOnDispose();
-            removeOnResized();
-            this._texture = dispose(this._texture);
-            SnowDecorator._decorators.delete(viewport);
-        };
-        SnowDecorator._decorators.set(viewport, this);
-        // Initialize the particles.
-        for (let i = 0; i < this._params.numParticles; i++)
-            this._particles.push(this.emit(true));
-    }
-    decorate(context) {
-        if (context.viewport !== this.viewport || !this._texture)
-            return;
-        // Update the particles.
-        const now = Date.now();
-        const deltaMillis = now - this._lastUpdateTime;
-        this._lastUpdateTime = now;
-        this.updateParticles(deltaMillis / 1000);
-        // Create particle graphics.
-        const builder = ParticleCollectionBuilder.create({
-            viewport: this.viewport,
-            isViewCoords: true,
-            texture: this._texture,
-            size: (this._params.sizeRange.high - this._params.sizeRange.low) / 2,
-        });
-        for (const particle of this._particles)
-            builder.addParticle(particle);
-        const graphic = builder.finish();
-        if (graphic)
-            context.addDecoration(GraphicType.ViewOverlay, graphic);
-    }
-    /** Change some of the parameters affecting this decorator. */
-    configure(params) {
-        for (const key of Object.keys(params)) {
-            const val = params[key];
-            if (undefined !== val)
-                this._params[key] = val;
-        }
-    }
-    /** Emit a new particle with randomized properties. */
-    emit(randomizeHeight) {
-        return {
-            x: randomInteger(0, this._dimensions.x),
-            y: randomizeHeight ? randomInteger(0, this._dimensions.y) : 0,
-            z: 0,
-            size: randomInteger(this._params.sizeRange.low, this._params.sizeRange.high),
-            transparency: randomInteger(this._params.transparencyRange.low, this._params.transparencyRange.high),
-            velocity: new Vector2d(randomFloat(this._params.velocityRange.low.x, this._params.velocityRange.high.x), randomFloat(this._params.velocityRange.low.y, this._params.velocityRange.high.y)),
-        };
-    }
-    // Update the positions and velocities of all the particles based on the amount of time that has passed since the last update.
-    updateParticles(elapsedSeconds) {
-        // Determine if someone changed the desired number of particles.
-        const particleDiscrepancy = this._params.numParticles - this._particles.length;
-        if (particleDiscrepancy > 0) {
-            // Birth new particles up to the new maximum.
-            for (let i = 0; i < particleDiscrepancy; i++)
-                this._particles.push(this.emit(true));
-        }
-        else {
-            // Destroy extra particles.
-            this._particles.length = this._params.numParticles;
-        }
-        const acceleration = new Vector2d();
-        const velocity = new Vector2d();
-        for (let i = 0; i < this._particles.length; i++) {
-            // Apply some acceleration to produce random drift.
-            const particle = this._particles[i];
-            acceleration.set(randomFloat(this._params.accelerationRange.low.x, this._params.accelerationRange.high.x), randomFloat(this._params.accelerationRange.low.y, this._params.accelerationRange.high.y));
-            acceleration.scale(elapsedSeconds, acceleration);
-            particle.velocity.plus(acceleration, particle.velocity);
-            // Apply velocity.
-            particle.velocity.clone(velocity);
-            velocity.scale(elapsedSeconds, velocity);
-            particle.x += velocity.x;
-            particle.y += velocity.y;
-            // Apply wind
-            particle.x += this._params.windVelocity * elapsedSeconds;
-            // Particles that travel beyond the viewport's left or right edges wrap around to the other side.
-            if (particle.x < 0)
-                particle.x = this._dimensions.x - 1;
-            else if (particle.x >= this._dimensions.x)
-                particle.x = 0;
-            // Particles that travel beyond the viewport's bottom or top edges are replaced by newborn particles.
-            if (particle.y < 0 || particle.y >= this._dimensions.y)
-                this._particles[i] = this.emit(false);
-        }
-    }
-    /** Toggle this decorator for the specified viewport.
-     * @param viewport The viewport to which the effect should be applied or removed.
-     * @param enable `true` to enable the effect, `false` to disable it, or `undefined` to toggle the current state.
-     */
-    static async toggle(viewport, enable) {
-        const decorator = this._decorators.get(viewport);
-        if (undefined === enable)
-            enable = undefined === decorator;
-        if (undefined !== decorator && !enable)
-            decorator.dispose();
-        else if (undefined === decorator && enable) {
-            // Create a texture to use for the particles.
-            // Note: the decorator takes ownership of the texture, and disposes of it when the decorator is disposed.
-            const image = await imageElementFromUrl(`${IModelApp.publicPath}sprites/particle_snow.png`);
-            const texture = IModelApp.renderSystem.createTexture({
-                ownership: "external",
-                image: { source: image, transparency: TextureTransparency.Mixed },
-            });
-            new SnowDecorator(viewport, texture);
-        }
-    }
-}
-SnowDecorator._decorators = new Map();
-/** Toggles a decorator that simulates snow using particle effects.
- * @see [[SnowDecorator]] for the implementation of the decorator.
- * @beta
- */
-export class SnowEffect extends Tool {
-    async run(enable) {
-        const vp = IModelApp.viewManager.selectedView;
-        if (vp)
-            await SnowDecorator.toggle(vp, enable);
-        return true;
-    }
-    async parseAndRun(...args) {
-        const enable = parseToggle(args[0]);
-        if (typeof enable !== "string")
-            await this.run(enable);
-        return true;
-    }
-}
-SnowEffect.toolId = "SnowEffect";
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+import { dispose } from "@itwin/core-bentley";
+import { Point2d, Range1d, Range2d, Vector2d } from "@itwin/core-geometry";
+import { TextureTransparency } from "@itwin/core-common";
+import { GraphicType, imageElementFromUrl, IModelApp, ParticleCollectionBuilder, Tool, } from "@itwin/core-frontend";
+import { parseToggle } from "../tools/parseToggle";
+import { randomFloat, randomInteger } from "./Random";
+/** The default snow effect parameters used by newly-created SnowDecorators. */
+const defaultSnowParams = {
+    numParticles: 2000,
+    sizeRange: Range1d.createXX(3, 22),
+    transparencyRange: Range1d.createXX(0, 50),
+    velocityRange: new Range2d(-30, 50, 30, 130),
+    accelerationRange: new Range2d(-1, -0.25, 1, 0.25),
+    windVelocity: 0,
+};
+/** Simulates snowfall in a [Viewport]($frontend) using particle effects.
+ * @see [[SnowEffect]] for a [Tool]($frontend) that toggles this decorator.
+ * @see [ParticleCollectionBuilder]($frontend) for defining custom particle effects.
+ * @beta
+ */
+class SnowDecorator {
+    constructor(viewport, texture) {
+        /** The list of particles being drawn. */
+        this._particles = [];
+        this._params = { ...defaultSnowParams };
+        this.viewport = viewport;
+        this._dimensions = new Point2d(viewport.viewRect.width, viewport.viewRect.height);
+        this._lastUpdateTime = Date.now();
+        this._texture = texture;
+        // Tell the viewport to re-render the decorations every frame so that the snow particles animate smoothly.
+        const removeOnRender = viewport.onRender.addListener(() => viewport.invalidateDecorations());
+        // When the viewport is resized, replace this decorator with a new one to match the new dimensions.
+        const removeOnResized = viewport.onResized.addListener(() => {
+            // Transfer ownership of the texture to the new decorator.
+            const tex = this._texture;
+            this._texture = undefined;
+            this.dispose();
+            new SnowDecorator(viewport, tex);
+        });
+        // When the viewport is destroyed, dispose of this decorator too.
+        const removeOnDispose = viewport.onDisposed.addListener(() => this.dispose());
+        const removeDecorator = IModelApp.viewManager.addDecorator(this);
+        this.dispose = () => {
+            removeDecorator();
+            removeOnRender();
+            removeOnDispose();
+            removeOnResized();
+            this._texture = dispose(this._texture);
+            SnowDecorator._decorators.delete(viewport);
+        };
+        SnowDecorator._decorators.set(viewport, this);
+        // Initialize the particles.
+        for (let i = 0; i < this._params.numParticles; i++)
+            this._particles.push(this.emit(true));
+    }
+    decorate(context) {
+        if (context.viewport !== this.viewport || !this._texture)
+            return;
+        // Update the particles.
+        const now = Date.now();
+        const deltaMillis = now - this._lastUpdateTime;
+        this._lastUpdateTime = now;
+        this.updateParticles(deltaMillis / 1000);
+        // Create particle graphics.
+        const builder = ParticleCollectionBuilder.create({
+            viewport: this.viewport,
+            isViewCoords: true,
+            texture: this._texture,
+            size: (this._params.sizeRange.high - this._params.sizeRange.low) / 2,
+        });
+        for (const particle of this._particles)
+            builder.addParticle(particle);
+        const graphic = builder.finish();
+        if (graphic)
+            context.addDecoration(GraphicType.ViewOverlay, graphic);
+    }
+    /** Change some of the parameters affecting this decorator. */
+    configure(params) {
+        for (const key of Object.keys(params)) {
+            const val = params[key];
+            if (undefined !== val)
+                this._params[key] = val;
+        }
+    }
+    /** Emit a new particle with randomized properties. */
+    emit(randomizeHeight) {
+        return {
+            x: randomInteger(0, this._dimensions.x),
+            y: randomizeHeight ? randomInteger(0, this._dimensions.y) : 0,
+            z: 0,
+            size: randomInteger(this._params.sizeRange.low, this._params.sizeRange.high),
+            transparency: randomInteger(this._params.transparencyRange.low, this._params.transparencyRange.high),
+            velocity: new Vector2d(randomFloat(this._params.velocityRange.low.x, this._params.velocityRange.high.x), randomFloat(this._params.velocityRange.low.y, this._params.velocityRange.high.y)),
+        };
+    }
+    // Update the positions and velocities of all the particles based on the amount of time that has passed since the last update.
+    updateParticles(elapsedSeconds) {
+        // Determine if someone changed the desired number of particles.
+        const particleDiscrepancy = this._params.numParticles - this._particles.length;
+        if (particleDiscrepancy > 0) {
+            // Birth new particles up to the new maximum.
+            for (let i = 0; i < particleDiscrepancy; i++)
+                this._particles.push(this.emit(true));
+        }
+        else {
+            // Destroy extra particles.
+            this._particles.length = this._params.numParticles;
+        }
+        const acceleration = new Vector2d();
+        const velocity = new Vector2d();
+        for (let i = 0; i < this._particles.length; i++) {
+            // Apply some acceleration to produce random drift.
+            const particle = this._particles[i];
+            acceleration.set(randomFloat(this._params.accelerationRange.low.x, this._params.accelerationRange.high.x), randomFloat(this._params.accelerationRange.low.y, this._params.accelerationRange.high.y));
+            acceleration.scale(elapsedSeconds, acceleration);
+            particle.velocity.plus(acceleration, particle.velocity);
+            // Apply velocity.
+            particle.velocity.clone(velocity);
+            velocity.scale(elapsedSeconds, velocity);
+            particle.x += velocity.x;
+            particle.y += velocity.y;
+            // Apply wind
+            particle.x += this._params.windVelocity * elapsedSeconds;
+            // Particles that travel beyond the viewport's left or right edges wrap around to the other side.
+            if (particle.x < 0)
+                particle.x = this._dimensions.x - 1;
+            else if (particle.x >= this._dimensions.x)
+                particle.x = 0;
+            // Particles that travel beyond the viewport's bottom or top edges are replaced by newborn particles.
+            if (particle.y < 0 || particle.y >= this._dimensions.y)
+                this._particles[i] = this.emit(false);
+        }
+    }
+    /** Toggle this decorator for the specified viewport.
+     * @param viewport The viewport to which the effect should be applied or removed.
+     * @param enable `true` to enable the effect, `false` to disable it, or `undefined` to toggle the current state.
+     */
+    static async toggle(viewport, enable) {
+        const decorator = this._decorators.get(viewport);
+        if (undefined === enable)
+            enable = undefined === decorator;
+        if (undefined !== decorator && !enable)
+            decorator.dispose();
+        else if (undefined === decorator && enable) {
+            // Create a texture to use for the particles.
+            // Note: the decorator takes ownership of the texture, and disposes of it when the decorator is disposed.
+            const image = await imageElementFromUrl(`${IModelApp.publicPath}sprites/particle_snow.png`);
+            const texture = IModelApp.renderSystem.createTexture({
+                ownership: "external",
+                image: { source: image, transparency: TextureTransparency.Mixed },
+            });
+            new SnowDecorator(viewport, texture);
+        }
+    }
+}
+SnowDecorator._decorators = new Map();
+export { SnowDecorator };
+/** Toggles a decorator that simulates snow using particle effects.
+ * @see [[SnowDecorator]] for the implementation of the decorator.
+ * @beta
+ */
+class SnowEffect extends Tool {
+    async run(enable) {
+        const vp = IModelApp.viewManager.selectedView;
+        if (vp)
+            await SnowDecorator.toggle(vp, enable);
+        return true;
+    }
+    async parseAndRun(...args) {
+        const enable = parseToggle(args[0]);
+        if (typeof enable !== "string")
+            await this.run(enable);
+        return true;
+    }
+}
+SnowEffect.toolId = "SnowEffect";
+export { SnowEffect };
 //# sourceMappingURL=Snow.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"Snow.js","sourceRoot":"","sources":["../../../src/effects/Snow.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAC3E,OAAO,EAAiB,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AACxE,OAAO,EACuB,WAAW,EAAE,mBAAmB,EAAE,SAAS,EAAE,yBAAyB,EAAiB,IAAI,GACxH,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAkCtD,+EAA+E;AAC/E,MAAM,iBAAiB,GAAe;IACpC,YAAY,EAAE,IAAI;IAClB,SAAS,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,EAAE,EAAE,CAAC;IAClC,iBAAiB,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,EAAE,EAAE,CAAC;IAC1C,aAAa,EAAE,IAAI,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,GAAG,CAAC;IAC5C,iBAAiB,EAAE,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI,CAAC;IAClD,YAAY,EAAE,CAAC;CAChB,CAAC;AAEF;;;;GAIG;AACH,MAAM,OAAO,aAAa;IAexB,YAAoB,QAAkB,EAAE,OAAkC;QAR1E,yCAAyC;QACxB,eAAU,GAAmB,EAAE,CAAC;QAQ/C,IAAI,CAAC,OAAO,GAAG,EAAE,GAAG,iBAAiB,EAAE,CAAC;QACxC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,WAAW,GAAG,IAAI,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAClF,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAClC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QAExB,0GAA0G;QAC1G,MAAM,cAAc,GAAG,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,qBAAqB,EAAE,CAAC,CAAC;QAE7F,mGAAmG;QACnG,MAAM,eAAe,GAAG,QAAQ,CAAC,SAAS,CAAC,WAAW,CAAC,GAAG,EAAE;YAC1D,0DAA0D;YAC1D,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC;YAC1B,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;YAC1B,IAAI,CAAC,OAAO,EAAE,CAAC;YACf,IAAI,aAAa,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;QAEH,iEAAiE;QACjE,MAAM,eAAe,GAAG,QAAQ,CAAC,UAAU,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;QAC9E,MAAM,eAAe,GAAG,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAEjE,IAAI,CAAC,OAAO,GAAG,GAAG,EAAE;YAClB,eAAe,EAAE,CAAC;YAClB,cAAc,EAAE,CAAC;YACjB,eAAe,EAAE,CAAC;YAClB,eAAe,EAAE,CAAC;YAClB,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACvC,aAAa,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC7C,CAAC,CAAC;QAEF,aAAa,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAE9C,4BAA4B;QAC5B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC,EAAE;YAChD,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC1C,CAAC;IAEM,QAAQ,CAAC,OAAwB;QACtC,IAAI,OAAO,CAAC,QAAQ,KAAK,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAI,CAAC,QAAQ;YACtD,OAAO;QAET,wBAAwB;QACxB,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACvB,MAAM,WAAW,GAAG,GAAG,GAAG,IAAI,CAAC,eAAe,CAAC;QAC/C,IAAI,CAAC,eAAe,GAAG,GAAG,CAAC;QAC3B,IAAI,CAAC,eAAe,CAAC,WAAW,GAAG,IAAI,CAAC,CAAC;QAEzC,4BAA4B;QAC5B,MAAM,OAAO,GAAG,yBAAyB,CAAC,MAAM,CAAC;YAC/C,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,YAAY,EAAE,IAAI;YAClB,OAAO,EAAE,IAAI,CAAC,QAAQ;YACtB,IAAI,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC;SACrE,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;YACT,OAAO,CAAC,aAAa,CAAC,WAAW,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED,8DAA8D;IACvD,SAAS,CAAC,MAA2B;QAC1C,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;YACrC,MAAM,GAAG,GAAI,MAAc,CAAC,GAAG,CAAC,CAAC;YACjC,IAAI,SAAS,KAAK,GAAG;gBAClB,IAAI,CAAC,OAAe,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;SACpC;IACH,CAAC;IAED,sDAAsD;IAC9C,IAAI,CAAC,eAAwB;QACnC,OAAO;YACL,CAAC,EAAE,aAAa,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;YACvC,CAAC,EAAE,eAAe,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAC7D,CAAC,EAAE,CAAC;YACJ,IAAI,EAAE,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC;YAC5E,YAAY,EAAE,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC;YACpG,QAAQ,EAAE,IAAI,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,EACrG,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;SACpF,CAAC;IACJ,CAAC;IAED,8HAA8H;IACtH,eAAe,CAAC,cAAsB;QAC5C,gEAAgE;QAChE,MAAM,mBAAmB,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;QAC/E,IAAI,mBAAmB,GAAG,CAAC,EAAE;YAC3B,6CAA6C;YAC7C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,mBAAmB,EAAE,CAAC,EAAE;gBAC1C,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;SACzC;aAAM;YACL,2BAA2B;YAC3B,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC;SACpD;QAED,MAAM,YAAY,GAAG,IAAI,QAAQ,EAAE,CAAC;QACpC,MAAM,QAAQ,GAAG,IAAI,QAAQ,EAAE,CAAC;QAChC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YAC/C,mDAAmD;YACnD,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;YACpC,YAAY,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,EACvG,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YAE5F,YAAY,CAAC,KAAK,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC;YACjD,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC;YAExD,kBAAkB;YAClB,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;YAClC,QAAQ,CAAC,KAAK,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC;YACzC,QAAQ,CAAC,CAAC,IAAI,QAAQ,CAAC,CAAC,CAAC;YACzB,QAAQ,CAAC,CAAC,IAAI,QAAQ,CAAC,CAAC,CAAC;YAEzB,aAAa;YACb,QAAQ,CAAC,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,YAAY,GAAG,cAAc,CAAC;YAEzD,iGAAiG;YACjG,IAAI,QAAQ,CAAC,CAAC,GAAG,CAAC;gBAChB,QAAQ,CAAC,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,CAAC;iBACjC,IAAI,QAAQ,CAAC,CAAC,IAAI,IAAI,CAAC,WAAW,CAAC,CAAC;gBACvC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC;YAEjB,qGAAqG;YACrG,IAAI,QAAQ,CAAC,CAAC,GAAG,CAAC,IAAI,QAAQ,CAAC,CAAC,IAAI,IAAI,CAAC,WAAW,CAAC,CAAC;gBACpD,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;SACzC;IACH,CAAC;IAID;;;OAGG;IACI,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,QAAkB,EAAE,MAAgB;QAC7D,MAAM,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACjD,IAAI,SAAS,KAAK,MAAM;YACtB,MAAM,GAAG,SAAS,KAAK,SAAS,CAAC;QAEnC,IAAI,SAAS,KAAK,SAAS,IAAI,CAAC,MAAM;YACpC,SAAS,CAAC,OAAO,EAAE,CAAC;aACjB,IAAI,SAAS,KAAK,SAAS,IAAI,MAAM,EAAE;YAC1C,6CAA6C;YAC7C,yGAAyG;YACzG,MAAM,KAAK,GAAG,MAAM,mBAAmB,CAAC,GAAG,SAAS,CAAC,UAAU,2BAA2B,CAAC,CAAC;YAC5F,MAAM,OAAO,GAAG,SAAS,CAAC,YAAY,CAAC,aAAa,CAAC;gBACnD,SAAS,EAAE,UAAU;gBACrB,KAAK,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,mBAAmB,CAAC,KAAK,EAAE;aAClE,CAAC,CAAC;YAEH,IAAI,aAAa,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;SACtC;IACH,CAAC;;AAxBuB,yBAAW,GAAG,IAAI,GAAG,EAA2B,CAAC;AA2B3E;;;GAGG;AACH,MAAM,OAAO,UAAW,SAAQ,IAAI;IAGlB,KAAK,CAAC,GAAG,CAAC,MAAgB;QACxC,MAAM,EAAE,GAAG,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC;QAC9C,IAAI,EAAE;YACJ,MAAM,aAAa,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;QAEzC,OAAO,IAAI,CAAC;IACd,CAAC;IAEe,KAAK,CAAC,WAAW,CAAC,GAAG,IAAc;QACjD,MAAM,MAAM,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QACpC,IAAI,OAAO,MAAM,KAAK,QAAQ;YAC5B,MAAM,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAEzB,OAAO,IAAI,CAAC;IACd,CAAC;;AAhBsB,iBAAM,GAAG,YAAY,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 { dispose } from \"@itwin/core-bentley\";\r\nimport { Point2d, Range1d, Range2d, Vector2d } from \"@itwin/core-geometry\";\r\nimport { RenderTexture, TextureTransparency } from \"@itwin/core-common\";\r\nimport {\r\n  DecorateContext, Decorator, GraphicType, imageElementFromUrl, IModelApp, ParticleCollectionBuilder, ParticleProps, Tool, Viewport,\r\n} from \"@itwin/core-frontend\";\r\nimport { parseToggle } from \"../tools/parseToggle\";\r\nimport { randomFloat, randomInteger } from \"./Random\";\r\n\r\n/** Represents one particle displayed by a [[SnowDecorator]].\r\n * Particle positions are in [CoordSystem.View]($frontend).\r\n * @beta\r\n */\r\nexport interface SnowParticle extends ParticleProps {\r\n  /** Make x, y, and z from ParticleProps writable. */\r\n  x: number;\r\n  y: number;\r\n  z: number;\r\n\r\n  /** Current velocity, in pixels per second. */\r\n  velocity: Vector2d;\r\n}\r\n\r\n/** Parameters controlling how a [[SnowDecorator]] works.\r\n * @beta\r\n */\r\nexport interface SnowParams {\r\n  /** The number of snow particles to produce. This could alternatively be expressed as a density so that small viewports would not be more crowded than larger ones. */\r\n  numParticles: number;\r\n  /** Range from which to randomly select each particle's size, in pixels. */\r\n  sizeRange: Range1d;\r\n  /** Range from which to randomly select each particle's transparency. */\r\n  transparencyRange: Range1d;\r\n  /** Range from which to randomly select each particle's initial velocity, in pixels per second. */\r\n  velocityRange: Range2d;\r\n  /** Range from which to randomly select an acceleration to apply to each particle's velocity each frame, in pixels per second squared, to simulate wind. */\r\n  accelerationRange: Range2d;\r\n  /** Wind velocity in pixels per second in X. */\r\n  windVelocity: number;\r\n}\r\n\r\n/** The default snow effect parameters used by newly-created SnowDecorators. */\r\nconst defaultSnowParams: SnowParams = {\r\n  numParticles: 2000,\r\n  sizeRange: Range1d.createXX(3, 22),\r\n  transparencyRange: Range1d.createXX(0, 50),\r\n  velocityRange: new Range2d(-30, 50, 30, 130),\r\n  accelerationRange: new Range2d(-1, -0.25, 1, 0.25),\r\n  windVelocity: 0,\r\n};\r\n\r\n/** Simulates snowfall in a [Viewport]($frontend) using particle effects.\r\n * @see [[SnowEffect]] for a [Tool]($frontend) that toggles this decorator.\r\n * @see [ParticleCollectionBuilder]($frontend) for defining custom particle effects.\r\n * @beta\r\n */\r\nexport class SnowDecorator implements Decorator {\r\n  /** The viewport being decorated. */\r\n  public readonly viewport: Viewport;\r\n  /** Invoked when this decorator is to be destroyed. */\r\n  public readonly dispose: VoidFunction;\r\n  /** The initial width and height of the viewport, from which we randomly select each particle's initial position. */\r\n  private readonly _dimensions: Point2d;\r\n  /** The list of particles being drawn. */\r\n  private readonly _particles: SnowParticle[] = [];\r\n  /** The image to display for each particle. */\r\n  private _texture?: RenderTexture;\r\n  /** The last time `updateParticles()` was invoked, in milliseconds. */\r\n  private _lastUpdateTime: number;\r\n  private readonly _params: SnowParams;\r\n\r\n  private constructor(viewport: Viewport, texture: RenderTexture | undefined) {\r\n    this._params = { ...defaultSnowParams };\r\n    this.viewport = viewport;\r\n    this._dimensions = new Point2d(viewport.viewRect.width, viewport.viewRect.height);\r\n    this._lastUpdateTime = Date.now();\r\n    this._texture = texture;\r\n\r\n    // Tell the viewport to re-render the decorations every frame so that the snow particles animate smoothly.\r\n    const removeOnRender = viewport.onRender.addListener(() => viewport.invalidateDecorations());\r\n\r\n    // When the viewport is resized, replace this decorator with a new one to match the new dimensions.\r\n    const removeOnResized = viewport.onResized.addListener(() => {\r\n      // Transfer ownership of the texture to the new decorator.\r\n      const tex = this._texture;\r\n      this._texture = undefined;\r\n      this.dispose();\r\n      new SnowDecorator(viewport, tex);\r\n    });\r\n\r\n    // When the viewport is destroyed, dispose of this decorator too.\r\n    const removeOnDispose = viewport.onDisposed.addListener(() => this.dispose());\r\n    const removeDecorator = IModelApp.viewManager.addDecorator(this);\r\n\r\n    this.dispose = () => {\r\n      removeDecorator();\r\n      removeOnRender();\r\n      removeOnDispose();\r\n      removeOnResized();\r\n      this._texture = dispose(this._texture);\r\n      SnowDecorator._decorators.delete(viewport);\r\n    };\r\n\r\n    SnowDecorator._decorators.set(viewport, this);\r\n\r\n    // Initialize the particles.\r\n    for (let i = 0; i < this._params.numParticles; i++)\r\n      this._particles.push(this.emit(true));\r\n  }\r\n\r\n  public decorate(context: DecorateContext): void {\r\n    if (context.viewport !== this.viewport || !this._texture)\r\n      return;\r\n\r\n    // Update the particles.\r\n    const now = Date.now();\r\n    const deltaMillis = now - this._lastUpdateTime;\r\n    this._lastUpdateTime = now;\r\n    this.updateParticles(deltaMillis / 1000);\r\n\r\n    // Create particle graphics.\r\n    const builder = ParticleCollectionBuilder.create({\r\n      viewport: this.viewport,\r\n      isViewCoords: true,\r\n      texture: this._texture,\r\n      size: (this._params.sizeRange.high - this._params.sizeRange.low) / 2,\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.ViewOverlay, graphic);\r\n  }\r\n\r\n  /** Change some of the parameters affecting this decorator. */\r\n  public configure(params: Partial<SnowParams>): void {\r\n    for (const key of Object.keys(params)) {\r\n      const val = (params as any)[key];\r\n      if (undefined !== val)\r\n        (this._params as any)[key] = val;\r\n    }\r\n  }\r\n\r\n  /** Emit a new particle with randomized properties. */\r\n  private emit(randomizeHeight: boolean): SnowParticle {\r\n    return {\r\n      x: randomInteger(0, this._dimensions.x),\r\n      y: randomizeHeight ? randomInteger(0, this._dimensions.y) : 0,\r\n      z: 0,\r\n      size: randomInteger(this._params.sizeRange.low, this._params.sizeRange.high),\r\n      transparency: randomInteger(this._params.transparencyRange.low, this._params.transparencyRange.high),\r\n      velocity: new Vector2d(randomFloat(this._params.velocityRange.low.x, this._params.velocityRange.high.x),\r\n        randomFloat(this._params.velocityRange.low.y, this._params.velocityRange.high.y)),\r\n    };\r\n  }\r\n\r\n  // Update the positions and velocities of all the particles based on the amount of time that has passed since the last update.\r\n  private updateParticles(elapsedSeconds: number): void {\r\n    // Determine if someone changed the desired number of particles.\r\n    const particleDiscrepancy = this._params.numParticles - this._particles.length;\r\n    if (particleDiscrepancy > 0) {\r\n      // Birth new particles up to the new maximum.\r\n      for (let i = 0; i < particleDiscrepancy; i++)\r\n        this._particles.push(this.emit(true));\r\n    } else {\r\n      // Destroy extra particles.\r\n      this._particles.length = this._params.numParticles;\r\n    }\r\n\r\n    const acceleration = new Vector2d();\r\n    const velocity = new Vector2d();\r\n    for (let i = 0; i < this._particles.length; i++) {\r\n      // Apply some acceleration to produce random drift.\r\n      const particle = this._particles[i];\r\n      acceleration.set(randomFloat(this._params.accelerationRange.low.x, this._params.accelerationRange.high.x),\r\n        randomFloat(this._params.accelerationRange.low.y, this._params.accelerationRange.high.y));\r\n\r\n      acceleration.scale(elapsedSeconds, acceleration);\r\n      particle.velocity.plus(acceleration, particle.velocity);\r\n\r\n      // Apply velocity.\r\n      particle.velocity.clone(velocity);\r\n      velocity.scale(elapsedSeconds, velocity);\r\n      particle.x += velocity.x;\r\n      particle.y += velocity.y;\r\n\r\n      // Apply wind\r\n      particle.x += this._params.windVelocity * elapsedSeconds;\r\n\r\n      // Particles that travel beyond the viewport's left or right edges wrap around to the other side.\r\n      if (particle.x < 0)\r\n        particle.x = this._dimensions.x - 1;\r\n      else if (particle.x >= this._dimensions.x)\r\n        particle.x = 0;\r\n\r\n      // Particles that travel beyond the viewport's bottom or top edges are replaced by newborn particles.\r\n      if (particle.y < 0 || particle.y >= this._dimensions.y)\r\n        this._particles[i] = this.emit(false);\r\n    }\r\n  }\r\n\r\n  private static readonly _decorators = new Map<Viewport, SnowDecorator>();\r\n\r\n  /** Toggle this decorator for the specified viewport.\r\n   * @param viewport The viewport to which the effect should be applied or removed.\r\n   * @param enable `true` to enable the effect, `false` to disable it, or `undefined` to toggle the current state.\r\n   */\r\n  public static async toggle(viewport: Viewport, enable?: boolean): Promise<void> {\r\n    const decorator = this._decorators.get(viewport);\r\n    if (undefined === enable)\r\n      enable = undefined === decorator;\r\n\r\n    if (undefined !== decorator && !enable)\r\n      decorator.dispose();\r\n    else if (undefined === decorator && enable) {\r\n      // Create a texture to use for the particles.\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_snow.png`);\r\n      const texture = IModelApp.renderSystem.createTexture({\r\n        ownership: \"external\",\r\n        image: { source: image, transparency: TextureTransparency.Mixed },\r\n      });\r\n\r\n      new SnowDecorator(viewport, texture);\r\n    }\r\n  }\r\n}\r\n\r\n/** Toggles a decorator that simulates snow using particle effects.\r\n * @see [[SnowDecorator]] for the implementation of the decorator.\r\n * @beta\r\n */\r\nexport class SnowEffect extends Tool {\r\n  public static override toolId = \"SnowEffect\";\r\n\r\n  public override async run(enable?: boolean): Promise<boolean> {\r\n    const vp = IModelApp.viewManager.selectedView;\r\n    if (vp)\r\n      await SnowDecorator.toggle(vp, enable);\r\n\r\n    return true;\r\n  }\r\n\r\n  public override async parseAndRun(...args: string[]): Promise<boolean> {\r\n    const enable = parseToggle(args[0]);\r\n    if (typeof enable !== \"string\")\r\n      await this.run(enable);\r\n\r\n    return true;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"Snow.js","sourceRoot":"","sources":["../../../src/effects/Snow.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAC3E,OAAO,EAAiB,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AACxE,OAAO,EACuB,WAAW,EAAE,mBAAmB,EAAE,SAAS,EAAE,yBAAyB,EAAiB,IAAI,GACxH,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAkCtD,+EAA+E;AAC/E,MAAM,iBAAiB,GAAe;IACpC,YAAY,EAAE,IAAI;IAClB,SAAS,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,EAAE,EAAE,CAAC;IAClC,iBAAiB,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,EAAE,EAAE,CAAC;IAC1C,aAAa,EAAE,IAAI,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,GAAG,CAAC;IAC5C,iBAAiB,EAAE,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI,CAAC;IAClD,YAAY,EAAE,CAAC;CAChB,CAAC;AAEF;;;;GAIG;AACH,MAAa,aAAa;IAexB,YAAoB,QAAkB,EAAE,OAAkC;QAR1E,yCAAyC;QACxB,eAAU,GAAmB,EAAE,CAAC;QAQ/C,IAAI,CAAC,OAAO,GAAG,EAAE,GAAG,iBAAiB,EAAE,CAAC;QACxC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,WAAW,GAAG,IAAI,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAClF,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAClC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QAExB,0GAA0G;QAC1G,MAAM,cAAc,GAAG,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,qBAAqB,EAAE,CAAC,CAAC;QAE7F,mGAAmG;QACnG,MAAM,eAAe,GAAG,QAAQ,CAAC,SAAS,CAAC,WAAW,CAAC,GAAG,EAAE;YAC1D,0DAA0D;YAC1D,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC;YAC1B,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;YAC1B,IAAI,CAAC,OAAO,EAAE,CAAC;YACf,IAAI,aAAa,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;QAEH,iEAAiE;QACjE,MAAM,eAAe,GAAG,QAAQ,CAAC,UAAU,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;QAC9E,MAAM,eAAe,GAAG,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAEjE,IAAI,CAAC,OAAO,GAAG,GAAG,EAAE;YAClB,eAAe,EAAE,CAAC;YAClB,cAAc,EAAE,CAAC;YACjB,eAAe,EAAE,CAAC;YAClB,eAAe,EAAE,CAAC;YAClB,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACvC,aAAa,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC7C,CAAC,CAAC;QAEF,aAAa,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAE9C,4BAA4B;QAC5B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC,EAAE;YAChD,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC1C,CAAC;IAEM,QAAQ,CAAC,OAAwB;QACtC,IAAI,OAAO,CAAC,QAAQ,KAAK,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAI,CAAC,QAAQ;YACtD,OAAO;QAET,wBAAwB;QACxB,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACvB,MAAM,WAAW,GAAG,GAAG,GAAG,IAAI,CAAC,eAAe,CAAC;QAC/C,IAAI,CAAC,eAAe,GAAG,GAAG,CAAC;QAC3B,IAAI,CAAC,eAAe,CAAC,WAAW,GAAG,IAAI,CAAC,CAAC;QAEzC,4BAA4B;QAC5B,MAAM,OAAO,GAAG,yBAAyB,CAAC,MAAM,CAAC;YAC/C,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,YAAY,EAAE,IAAI;YAClB,OAAO,EAAE,IAAI,CAAC,QAAQ;YACtB,IAAI,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC;SACrE,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;YACT,OAAO,CAAC,aAAa,CAAC,WAAW,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED,8DAA8D;IACvD,SAAS,CAAC,MAA2B;QAC1C,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;YACrC,MAAM,GAAG,GAAI,MAAc,CAAC,GAAG,CAAC,CAAC;YACjC,IAAI,SAAS,KAAK,GAAG;gBAClB,IAAI,CAAC,OAAe,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;SACpC;IACH,CAAC;IAED,sDAAsD;IAC9C,IAAI,CAAC,eAAwB;QACnC,OAAO;YACL,CAAC,EAAE,aAAa,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;YACvC,CAAC,EAAE,eAAe,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAC7D,CAAC,EAAE,CAAC;YACJ,IAAI,EAAE,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC;YAC5E,YAAY,EAAE,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC;YACpG,QAAQ,EAAE,IAAI,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,EACrG,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;SACpF,CAAC;IACJ,CAAC;IAED,8HAA8H;IACtH,eAAe,CAAC,cAAsB;QAC5C,gEAAgE;QAChE,MAAM,mBAAmB,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;QAC/E,IAAI,mBAAmB,GAAG,CAAC,EAAE;YAC3B,6CAA6C;YAC7C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,mBAAmB,EAAE,CAAC,EAAE;gBAC1C,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;SACzC;aAAM;YACL,2BAA2B;YAC3B,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC;SACpD;QAED,MAAM,YAAY,GAAG,IAAI,QAAQ,EAAE,CAAC;QACpC,MAAM,QAAQ,GAAG,IAAI,QAAQ,EAAE,CAAC;QAChC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YAC/C,mDAAmD;YACnD,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;YACpC,YAAY,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,EACvG,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YAE5F,YAAY,CAAC,KAAK,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC;YACjD,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC;YAExD,kBAAkB;YAClB,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;YAClC,QAAQ,CAAC,KAAK,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC;YACzC,QAAQ,CAAC,CAAC,IAAI,QAAQ,CAAC,CAAC,CAAC;YACzB,QAAQ,CAAC,CAAC,IAAI,QAAQ,CAAC,CAAC,CAAC;YAEzB,aAAa;YACb,QAAQ,CAAC,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,YAAY,GAAG,cAAc,CAAC;YAEzD,iGAAiG;YACjG,IAAI,QAAQ,CAAC,CAAC,GAAG,CAAC;gBAChB,QAAQ,CAAC,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,CAAC;iBACjC,IAAI,QAAQ,CAAC,CAAC,IAAI,IAAI,CAAC,WAAW,CAAC,CAAC;gBACvC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC;YAEjB,qGAAqG;YACrG,IAAI,QAAQ,CAAC,CAAC,GAAG,CAAC,IAAI,QAAQ,CAAC,CAAC,IAAI,IAAI,CAAC,WAAW,CAAC,CAAC;gBACpD,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;SACzC;IACH,CAAC;IAID;;;OAGG;IACI,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,QAAkB,EAAE,MAAgB;QAC7D,MAAM,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACjD,IAAI,SAAS,KAAK,MAAM;YACtB,MAAM,GAAG,SAAS,KAAK,SAAS,CAAC;QAEnC,IAAI,SAAS,KAAK,SAAS,IAAI,CAAC,MAAM;YACpC,SAAS,CAAC,OAAO,EAAE,CAAC;aACjB,IAAI,SAAS,KAAK,SAAS,IAAI,MAAM,EAAE;YAC1C,6CAA6C;YAC7C,yGAAyG;YACzG,MAAM,KAAK,GAAG,MAAM,mBAAmB,CAAC,GAAG,SAAS,CAAC,UAAU,2BAA2B,CAAC,CAAC;YAC5F,MAAM,OAAO,GAAG,SAAS,CAAC,YAAY,CAAC,aAAa,CAAC;gBACnD,SAAS,EAAE,UAAU;gBACrB,KAAK,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,mBAAmB,CAAC,KAAK,EAAE;aAClE,CAAC,CAAC;YAEH,IAAI,aAAa,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;SACtC;IACH,CAAC;;AAxBuB,yBAAW,GAAG,IAAI,GAAG,EAA2B,AAArC,CAAsC;SAnJ9D,aAAa;AA8K1B;;;GAGG;AACH,MAAa,UAAW,SAAQ,IAAI;IAGlB,KAAK,CAAC,GAAG,CAAC,MAAgB;QACxC,MAAM,EAAE,GAAG,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC;QAC9C,IAAI,EAAE;YACJ,MAAM,aAAa,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;QAEzC,OAAO,IAAI,CAAC;IACd,CAAC;IAEe,KAAK,CAAC,WAAW,CAAC,GAAG,IAAc;QACjD,MAAM,MAAM,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QACpC,IAAI,OAAO,MAAM,KAAK,QAAQ;YAC5B,MAAM,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAEzB,OAAO,IAAI,CAAC;IACd,CAAC;;AAhBsB,iBAAM,GAAG,YAAY,CAAC;SADlC,UAAU","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 { dispose } from \"@itwin/core-bentley\";\r\nimport { Point2d, Range1d, Range2d, Vector2d } from \"@itwin/core-geometry\";\r\nimport { RenderTexture, TextureTransparency } from \"@itwin/core-common\";\r\nimport {\r\n  DecorateContext, Decorator, GraphicType, imageElementFromUrl, IModelApp, ParticleCollectionBuilder, ParticleProps, Tool, Viewport,\r\n} from \"@itwin/core-frontend\";\r\nimport { parseToggle } from \"../tools/parseToggle\";\r\nimport { randomFloat, randomInteger } from \"./Random\";\r\n\r\n/** Represents one particle displayed by a [[SnowDecorator]].\r\n * Particle positions are in [CoordSystem.View]($frontend).\r\n * @beta\r\n */\r\nexport interface SnowParticle extends ParticleProps {\r\n  /** Make x, y, and z from ParticleProps writable. */\r\n  x: number;\r\n  y: number;\r\n  z: number;\r\n\r\n  /** Current velocity, in pixels per second. */\r\n  velocity: Vector2d;\r\n}\r\n\r\n/** Parameters controlling how a [[SnowDecorator]] works.\r\n * @beta\r\n */\r\nexport interface SnowParams {\r\n  /** The number of snow particles to produce. This could alternatively be expressed as a density so that small viewports would not be more crowded than larger ones. */\r\n  numParticles: number;\r\n  /** Range from which to randomly select each particle's size, in pixels. */\r\n  sizeRange: Range1d;\r\n  /** Range from which to randomly select each particle's transparency. */\r\n  transparencyRange: Range1d;\r\n  /** Range from which to randomly select each particle's initial velocity, in pixels per second. */\r\n  velocityRange: Range2d;\r\n  /** Range from which to randomly select an acceleration to apply to each particle's velocity each frame, in pixels per second squared, to simulate wind. */\r\n  accelerationRange: Range2d;\r\n  /** Wind velocity in pixels per second in X. */\r\n  windVelocity: number;\r\n}\r\n\r\n/** The default snow effect parameters used by newly-created SnowDecorators. */\r\nconst defaultSnowParams: SnowParams = {\r\n  numParticles: 2000,\r\n  sizeRange: Range1d.createXX(3, 22),\r\n  transparencyRange: Range1d.createXX(0, 50),\r\n  velocityRange: new Range2d(-30, 50, 30, 130),\r\n  accelerationRange: new Range2d(-1, -0.25, 1, 0.25),\r\n  windVelocity: 0,\r\n};\r\n\r\n/** Simulates snowfall in a [Viewport]($frontend) using particle effects.\r\n * @see [[SnowEffect]] for a [Tool]($frontend) that toggles this decorator.\r\n * @see [ParticleCollectionBuilder]($frontend) for defining custom particle effects.\r\n * @beta\r\n */\r\nexport class SnowDecorator implements Decorator {\r\n  /** The viewport being decorated. */\r\n  public readonly viewport: Viewport;\r\n  /** Invoked when this decorator is to be destroyed. */\r\n  public readonly dispose: VoidFunction;\r\n  /** The initial width and height of the viewport, from which we randomly select each particle's initial position. */\r\n  private readonly _dimensions: Point2d;\r\n  /** The list of particles being drawn. */\r\n  private readonly _particles: SnowParticle[] = [];\r\n  /** The image to display for each particle. */\r\n  private _texture?: RenderTexture;\r\n  /** The last time `updateParticles()` was invoked, in milliseconds. */\r\n  private _lastUpdateTime: number;\r\n  private readonly _params: SnowParams;\r\n\r\n  private constructor(viewport: Viewport, texture: RenderTexture | undefined) {\r\n    this._params = { ...defaultSnowParams };\r\n    this.viewport = viewport;\r\n    this._dimensions = new Point2d(viewport.viewRect.width, viewport.viewRect.height);\r\n    this._lastUpdateTime = Date.now();\r\n    this._texture = texture;\r\n\r\n    // Tell the viewport to re-render the decorations every frame so that the snow particles animate smoothly.\r\n    const removeOnRender = viewport.onRender.addListener(() => viewport.invalidateDecorations());\r\n\r\n    // When the viewport is resized, replace this decorator with a new one to match the new dimensions.\r\n    const removeOnResized = viewport.onResized.addListener(() => {\r\n      // Transfer ownership of the texture to the new decorator.\r\n      const tex = this._texture;\r\n      this._texture = undefined;\r\n      this.dispose();\r\n      new SnowDecorator(viewport, tex);\r\n    });\r\n\r\n    // When the viewport is destroyed, dispose of this decorator too.\r\n    const removeOnDispose = viewport.onDisposed.addListener(() => this.dispose());\r\n    const removeDecorator = IModelApp.viewManager.addDecorator(this);\r\n\r\n    this.dispose = () => {\r\n      removeDecorator();\r\n      removeOnRender();\r\n      removeOnDispose();\r\n      removeOnResized();\r\n      this._texture = dispose(this._texture);\r\n      SnowDecorator._decorators.delete(viewport);\r\n    };\r\n\r\n    SnowDecorator._decorators.set(viewport, this);\r\n\r\n    // Initialize the particles.\r\n    for (let i = 0; i < this._params.numParticles; i++)\r\n      this._particles.push(this.emit(true));\r\n  }\r\n\r\n  public decorate(context: DecorateContext): void {\r\n    if (context.viewport !== this.viewport || !this._texture)\r\n      return;\r\n\r\n    // Update the particles.\r\n    const now = Date.now();\r\n    const deltaMillis = now - this._lastUpdateTime;\r\n    this._lastUpdateTime = now;\r\n    this.updateParticles(deltaMillis / 1000);\r\n\r\n    // Create particle graphics.\r\n    const builder = ParticleCollectionBuilder.create({\r\n      viewport: this.viewport,\r\n      isViewCoords: true,\r\n      texture: this._texture,\r\n      size: (this._params.sizeRange.high - this._params.sizeRange.low) / 2,\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.ViewOverlay, graphic);\r\n  }\r\n\r\n  /** Change some of the parameters affecting this decorator. */\r\n  public configure(params: Partial<SnowParams>): void {\r\n    for (const key of Object.keys(params)) {\r\n      const val = (params as any)[key];\r\n      if (undefined !== val)\r\n        (this._params as any)[key] = val;\r\n    }\r\n  }\r\n\r\n  /** Emit a new particle with randomized properties. */\r\n  private emit(randomizeHeight: boolean): SnowParticle {\r\n    return {\r\n      x: randomInteger(0, this._dimensions.x),\r\n      y: randomizeHeight ? randomInteger(0, this._dimensions.y) : 0,\r\n      z: 0,\r\n      size: randomInteger(this._params.sizeRange.low, this._params.sizeRange.high),\r\n      transparency: randomInteger(this._params.transparencyRange.low, this._params.transparencyRange.high),\r\n      velocity: new Vector2d(randomFloat(this._params.velocityRange.low.x, this._params.velocityRange.high.x),\r\n        randomFloat(this._params.velocityRange.low.y, this._params.velocityRange.high.y)),\r\n    };\r\n  }\r\n\r\n  // Update the positions and velocities of all the particles based on the amount of time that has passed since the last update.\r\n  private updateParticles(elapsedSeconds: number): void {\r\n    // Determine if someone changed the desired number of particles.\r\n    const particleDiscrepancy = this._params.numParticles - this._particles.length;\r\n    if (particleDiscrepancy > 0) {\r\n      // Birth new particles up to the new maximum.\r\n      for (let i = 0; i < particleDiscrepancy; i++)\r\n        this._particles.push(this.emit(true));\r\n    } else {\r\n      // Destroy extra particles.\r\n      this._particles.length = this._params.numParticles;\r\n    }\r\n\r\n    const acceleration = new Vector2d();\r\n    const velocity = new Vector2d();\r\n    for (let i = 0; i < this._particles.length; i++) {\r\n      // Apply some acceleration to produce random drift.\r\n      const particle = this._particles[i];\r\n      acceleration.set(randomFloat(this._params.accelerationRange.low.x, this._params.accelerationRange.high.x),\r\n        randomFloat(this._params.accelerationRange.low.y, this._params.accelerationRange.high.y));\r\n\r\n      acceleration.scale(elapsedSeconds, acceleration);\r\n      particle.velocity.plus(acceleration, particle.velocity);\r\n\r\n      // Apply velocity.\r\n      particle.velocity.clone(velocity);\r\n      velocity.scale(elapsedSeconds, velocity);\r\n      particle.x += velocity.x;\r\n      particle.y += velocity.y;\r\n\r\n      // Apply wind\r\n      particle.x += this._params.windVelocity * elapsedSeconds;\r\n\r\n      // Particles that travel beyond the viewport's left or right edges wrap around to the other side.\r\n      if (particle.x < 0)\r\n        particle.x = this._dimensions.x - 1;\r\n      else if (particle.x >= this._dimensions.x)\r\n        particle.x = 0;\r\n\r\n      // Particles that travel beyond the viewport's bottom or top edges are replaced by newborn particles.\r\n      if (particle.y < 0 || particle.y >= this._dimensions.y)\r\n        this._particles[i] = this.emit(false);\r\n    }\r\n  }\r\n\r\n  private static readonly _decorators = new Map<Viewport, SnowDecorator>();\r\n\r\n  /** Toggle this decorator for the specified viewport.\r\n   * @param viewport The viewport to which the effect should be applied or removed.\r\n   * @param enable `true` to enable the effect, `false` to disable it, or `undefined` to toggle the current state.\r\n   */\r\n  public static async toggle(viewport: Viewport, enable?: boolean): Promise<void> {\r\n    const decorator = this._decorators.get(viewport);\r\n    if (undefined === enable)\r\n      enable = undefined === decorator;\r\n\r\n    if (undefined !== decorator && !enable)\r\n      decorator.dispose();\r\n    else if (undefined === decorator && enable) {\r\n      // Create a texture to use for the particles.\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_snow.png`);\r\n      const texture = IModelApp.renderSystem.createTexture({\r\n        ownership: \"external\",\r\n        image: { source: image, transparency: TextureTransparency.Mixed },\r\n      });\r\n\r\n      new SnowDecorator(viewport, texture);\r\n    }\r\n  }\r\n}\r\n\r\n/** Toggles a decorator that simulates snow using particle effects.\r\n * @see [[SnowDecorator]] for the implementation of the decorator.\r\n * @beta\r\n */\r\nexport class SnowEffect extends Tool {\r\n  public static override toolId = \"SnowEffect\";\r\n\r\n  public override async run(enable?: boolean): Promise<boolean> {\r\n    const vp = IModelApp.viewManager.selectedView;\r\n    if (vp)\r\n      await SnowDecorator.toggle(vp, enable);\r\n\r\n    return true;\r\n  }\r\n\r\n  public override async parseAndRun(...args: string[]): Promise<boolean> {\r\n    const enable = parseToggle(args[0]);\r\n    if (typeof enable !== \"string\")\r\n      await this.run(enable);\r\n\r\n    return true;\r\n  }\r\n}\r\n"]}

package/lib/esm/effects/Vignette.d.ts

@@ -1,40 +1,40 @@
-/** @packageDocumentation
- * @module Effects
- */
-import { ScreenSpaceEffectBuilder, Tool } from "@itwin/core-frontend";
-import { AddEffectTool } from "./EffectTools";
-/** Applies a [vignette](https://en.wikipedia.org/wiki/Vignetting) effect to the viewport.
- * From https://github.com/TyLindberg/glsl-vignette/blob/master/advanced.glsl.
- * @beta
- */
-export declare class VignetteEffect extends AddEffectTool {
-    static toolId: string;
-    protected get effectName(): string;
-    protected get textureCoordFromPosition(): boolean;
-    protected get source(): {
-        vertex: string;
-        fragment: string;
-    };
-    protected defineEffect(builder: ScreenSpaceEffectBuilder): void;
-}
-/** Configures the [[VignetteEffect]].
- * @beta
- */
-export declare class VignetteConfig extends Tool {
-    static toolId: string;
-    static get minArgs(): number;
-    static get maxArgs(): number;
-    /** Size of the vignette in the form (width/2, height/2). e.g., to make the vignette start fading in halfway between the center and edges of
-     * UV space, use (0.25, 0.25).
-     */
-    static readonly size: Float32Array;
-    /** How round the vignette will be, from 0.0 (perfectly rectangular) to 1.0 (perfectly round). */
-    static roundness: number;
-    /** How quickly the vignette fades in. The vignette starts fading in at the edge of the values provided by `size` and will be
-     * fully faded in at (size.x + smoothness, size.y * smoothness). A value of 0.0 produces a hard edge.
-     */
-    static smoothness: number;
-    run(width?: number, height?: number, roundness?: number, smoothness?: number): Promise<boolean>;
-    parseAndRun(...input: string[]): Promise<boolean>;
-}
+/** @packageDocumentation
+ * @module Effects
+ */
+import { ScreenSpaceEffectBuilder, Tool } from "@itwin/core-frontend";
+import { AddEffectTool } from "./EffectTools";
+/** Applies a [vignette](https://en.wikipedia.org/wiki/Vignetting) effect to the viewport.
+ * From https://github.com/TyLindberg/glsl-vignette/blob/master/advanced.glsl.
+ * @beta
+ */
+export declare class VignetteEffect extends AddEffectTool {
+    static toolId: string;
+    protected get effectName(): string;
+    protected get textureCoordFromPosition(): boolean;
+    protected get source(): {
+        vertex: string;
+        fragment: string;
+    };
+    protected defineEffect(builder: ScreenSpaceEffectBuilder): void;
+}
+/** Configures the [[VignetteEffect]].
+ * @beta
+ */
+export declare class VignetteConfig extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    /** Size of the vignette in the form (width/2, height/2). e.g., to make the vignette start fading in halfway between the center and edges of
+     * UV space, use (0.25, 0.25).
+     */
+    static readonly size: Float32Array;
+    /** How round the vignette will be, from 0.0 (perfectly rectangular) to 1.0 (perfectly round). */
+    static roundness: number;
+    /** How quickly the vignette fades in. The vignette starts fading in at the edge of the values provided by `size` and will be
+     * fully faded in at (size.x + smoothness, size.y * smoothness). A value of 0.0 produces a hard edge.
+     */
+    static smoothness: number;
+    run(width?: number, height?: number, roundness?: number, smoothness?: number): Promise<boolean>;
+    parseAndRun(...input: string[]): Promise<boolean>;
+}
 //# sourceMappingURL=Vignette.d.ts.map