@tsparticles/plugin-emitters 3.0.0-alpha.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Matteo Bruni
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,70 @@
+[![banner](https://particles.js.org/images/banner2.png)](https://particles.js.org)
+
+# tsParticles Emitters Plugin
+
+[![jsDelivr](https://data.jsdelivr.com/v1/package/npm/tsparticles-plugin-emitters/badge)](https://www.jsdelivr.com/package/npm/tsparticles-plugin-emitters)
+[![npmjs](https://badge.fury.io/js/tsparticles-plugin-emitters.svg)](https://www.npmjs.com/package/tsparticles-plugin-emitters)
+[![npmjs](https://img.shields.io/npm/dt/tsparticles-plugin-emitters)](https://www.npmjs.com/package/tsparticles-plugin-emitters) [![GitHub Sponsors](https://img.shields.io/github/sponsors/matteobruni)](https://github.com/sponsors/matteobruni)
+
+[tsParticles](https://github.com/matteobruni/tsparticles) plugin for particles emitters.
+
+## How to use it
+
+### CDN / Vanilla JS / jQuery
+
+The CDN/Vanilla version JS has one required file in vanilla configuration:
+
+Including the `tsparticles.plugin.emitters.min.js` file will export the function to load the plugin:
+
+```javascript
+loadEmittersPlugin;
+```
+
+### Usage
+
+Once the scripts are loaded you can set up `tsParticles` and the plugin like this:
+
+```javascript
+(async () => {
+  await loadEmittersPlugin(tsParticles);
+
+  await tsParticles.load({
+    id: "tsparticles",
+    options: {
+      /* options */
+    },
+  });
+})();
+```
+
+### ESM / CommonJS
+
+This package is compatible also with ES or CommonJS modules, firstly this needs to be installed, like this:
+
+```shell
+$ npm install tsparticles-plugin-emitters
+```
+
+or
+
+```shell
+$ yarn add tsparticles-plugin-emitters
+```
+
+Then you need to import it in the app, like this:
+
+```javascript
+const { tsParticles } = require("tsparticles-engine");
+const { loadEmittersPlugin } = require("tsparticles-plugin-emitters");
+
+loadEmittersPlugin(tsParticles);
+```
+
+or
+
+```javascript
+import { tsParticles } from "tsparticles-engine";
+import { loadEmittersPlugin } from "tsparticles-plugin-emitters";
+
+loadEmittersPlugin(tsParticles);
+```

package/browser/EmitterContainer.js

@@ -0,0 +1 @@
+export {};

package/browser/EmitterInstance.js

@@ -0,0 +1,257 @@
+import { Vector, calcPositionOrRandomFromSizeRanged, deepExtend, getRangeValue, isPointInside, itemFromSingleOrMultiple, randomInRange, rangeColorToHsl, } from "@tsparticles/engine";
+import { Emitter } from "./Options/Classes/Emitter";
+import { EmitterSize } from "./Options/Classes/EmitterSize";
+export class EmitterInstance {
+    constructor(engine, emitters, container, options, position) {
+        var _a, _b, _c, _d, _e, _f, _g;
+        var _h;
+        this.emitters = emitters;
+        this.container = container;
+        this._engine = engine;
+        this._currentDuration = 0;
+        this._currentEmitDelay = 0;
+        this._currentSpawnDelay = 0;
+        this._initialPosition = position;
+        if (options instanceof Emitter) {
+            this.options = options;
+        }
+        else {
+            this.options = new Emitter();
+            this.options.load(options);
+        }
+        this._spawnDelay = (((_a = this.options.life.delay) !== null && _a !== void 0 ? _a : 0) * 1000) / this.container.retina.reduceFactor;
+        this.position = (_b = this._initialPosition) !== null && _b !== void 0 ? _b : this.calcPosition();
+        this.name = this.options.name;
+        this._shape = (_c = this._engine.emitterShapeManager) === null || _c === void 0 ? void 0 : _c.getShape(this.options.shape);
+        this.fill = this.options.fill;
+        this._firstSpawn = !this.options.life.wait;
+        this._startParticlesAdded = false;
+        let particlesOptions = deepExtend({}, this.options.particles);
+        particlesOptions !== null && particlesOptions !== void 0 ? particlesOptions : (particlesOptions = {});
+        (_d = particlesOptions.move) !== null && _d !== void 0 ? _d : (particlesOptions.move = {});
+        (_e = (_h = particlesOptions.move).direction) !== null && _e !== void 0 ? _e : (_h.direction = this.options.direction);
+        if (this.options.spawnColor) {
+            this.spawnColor = rangeColorToHsl(this.options.spawnColor);
+        }
+        this._paused = !this.options.autoPlay;
+        this._particlesOptions = particlesOptions;
+        this.size =
+            (_f = this.options.size) !== null && _f !== void 0 ? _f : (() => {
+                const size = new EmitterSize();
+                size.load({
+                    height: 0,
+                    mode: "percent",
+                    width: 0,
+                });
+                return size;
+            })();
+        this._lifeCount = (_g = this.options.life.count) !== null && _g !== void 0 ? _g : -1;
+        this._immortal = this._lifeCount <= 0;
+        this._engine.dispatchEvent("emitterCreated", {
+            container,
+            data: {
+                emitter: this,
+            },
+        });
+        this.play();
+    }
+    externalPause() {
+        this._paused = true;
+        this.pause();
+    }
+    externalPlay() {
+        this._paused = false;
+        this.play();
+    }
+    getPosition() {
+        if (this.options.domId) {
+            const container = this.container, element = document.getElementById(this.options.domId);
+            if (element) {
+                const elRect = element.getBoundingClientRect();
+                return {
+                    x: (elRect.x + elRect.width / 2) * container.retina.pixelRatio,
+                    y: (elRect.y + elRect.height / 2) * container.retina.pixelRatio,
+                };
+            }
+        }
+        return this.position;
+    }
+    getSize() {
+        const container = this.container;
+        if (this.options.domId) {
+            const element = document.getElementById(this.options.domId);
+            if (element) {
+                const elRect = element.getBoundingClientRect();
+                return {
+                    width: elRect.width * container.retina.pixelRatio,
+                    height: elRect.height * container.retina.pixelRatio,
+                };
+            }
+        }
+        return {
+            width: this.size.mode === "percent"
+                ? (container.canvas.size.width * this.size.width) / 100
+                : this.size.width,
+            height: this.size.mode === "percent"
+                ? (container.canvas.size.height * this.size.height) / 100
+                : this.size.height,
+        };
+    }
+    pause() {
+        if (this._paused) {
+            return;
+        }
+        delete this._emitDelay;
+    }
+    play() {
+        var _a;
+        if (this._paused) {
+            return;
+        }
+        if (!(this.container.retina.reduceFactor &&
+            (this._lifeCount > 0 || this._immortal || !this.options.life.count) &&
+            (this._firstSpawn || this._currentSpawnDelay >= ((_a = this._spawnDelay) !== null && _a !== void 0 ? _a : 0)))) {
+            return;
+        }
+        if (this._emitDelay === undefined) {
+            const delay = getRangeValue(this.options.rate.delay);
+            this._emitDelay = (1000 * delay) / this.container.retina.reduceFactor;
+        }
+        if (this._lifeCount > 0 || this._immortal) {
+            this.prepareToDie();
+        }
+    }
+    resize() {
+        const initialPosition = this._initialPosition;
+        this.position =
+            initialPosition && isPointInside(initialPosition, this.container.canvas.size, Vector.origin)
+                ? initialPosition
+                : this.calcPosition();
+    }
+    update(delta) {
+        var _a, _b, _c;
+        if (this._paused) {
+            return;
+        }
+        if (this._firstSpawn) {
+            this._firstSpawn = false;
+            this._currentSpawnDelay = (_a = this._spawnDelay) !== null && _a !== void 0 ? _a : 0;
+            this._currentEmitDelay = (_b = this._emitDelay) !== null && _b !== void 0 ? _b : 0;
+        }
+        if (!this._startParticlesAdded) {
+            this._startParticlesAdded = true;
+            this.emitParticles(this.options.startCount);
+        }
+        if (this._duration !== undefined) {
+            this._currentDuration += delta.value;
+            if (this._currentDuration >= this._duration) {
+                this.pause();
+                if (this._spawnDelay !== undefined) {
+                    delete this._spawnDelay;
+                }
+                if (!this._immortal) {
+                    this._lifeCount--;
+                }
+                if (this._lifeCount > 0 || this._immortal) {
+                    this.position = this.calcPosition();
+                    this._spawnDelay = (((_c = this.options.life.delay) !== null && _c !== void 0 ? _c : 0) * 1000) / this.container.retina.reduceFactor;
+                }
+                else {
+                    this.destroy();
+                }
+                this._currentDuration -= this._duration;
+                delete this._duration;
+            }
+        }
+        if (this._spawnDelay !== undefined) {
+            this._currentSpawnDelay += delta.value;
+            if (this._currentSpawnDelay >= this._spawnDelay) {
+                this._engine.dispatchEvent("emitterPlay", {
+                    container: this.container,
+                });
+                this.play();
+                this._currentSpawnDelay -= this._currentSpawnDelay;
+                delete this._spawnDelay;
+            }
+        }
+        if (this._emitDelay !== undefined) {
+            this._currentEmitDelay += delta.value;
+            if (this._currentEmitDelay >= this._emitDelay) {
+                this.emit();
+                this._currentEmitDelay -= this._emitDelay;
+            }
+        }
+    }
+    calcPosition() {
+        return calcPositionOrRandomFromSizeRanged({
+            size: this.container.canvas.size,
+            position: this.options.position,
+        });
+    }
+    destroy() {
+        this.emitters.removeEmitter(this);
+        this._engine.dispatchEvent("emitterDestroyed", {
+            container: this.container,
+            data: {
+                emitter: this,
+            },
+        });
+    }
+    emit() {
+        if (this._paused) {
+            return;
+        }
+        const quantity = getRangeValue(this.options.rate.quantity);
+        this.emitParticles(quantity);
+    }
+    emitParticles(quantity) {
+        var _a, _b, _c;
+        const position = this.getPosition(), size = this.getSize(), singleParticlesOptions = itemFromSingleOrMultiple(this._particlesOptions);
+        for (let i = 0; i < quantity; i++) {
+            const particlesOptions = deepExtend({}, singleParticlesOptions);
+            if (this.spawnColor) {
+                const hslAnimation = (_a = this.options.spawnColor) === null || _a === void 0 ? void 0 : _a.animation;
+                if (hslAnimation) {
+                    this.spawnColor.h = this.setColorAnimation(hslAnimation.h, this.spawnColor.h, 360);
+                    this.spawnColor.s = this.setColorAnimation(hslAnimation.s, this.spawnColor.s, 100);
+                    this.spawnColor.l = this.setColorAnimation(hslAnimation.l, this.spawnColor.l, 100);
+                }
+                if (!particlesOptions.color) {
+                    particlesOptions.color = {
+                        value: this.spawnColor,
+                    };
+                }
+                else {
+                    particlesOptions.color.value = this.spawnColor;
+                }
+            }
+            if (!position) {
+                return;
+            }
+            const pPosition = (_c = (_b = this._shape) === null || _b === void 0 ? void 0 : _b.randomPosition(position, size, this.fill)) !== null && _c !== void 0 ? _c : position;
+            this.container.particles.addParticle(pPosition, particlesOptions);
+        }
+    }
+    prepareToDie() {
+        var _a;
+        if (this._paused) {
+            return;
+        }
+        const duration = (_a = this.options.life) === null || _a === void 0 ? void 0 : _a.duration;
+        if (this.container.retina.reduceFactor &&
+            (this._lifeCount > 0 || this._immortal) &&
+            duration !== undefined &&
+            duration > 0) {
+            this._duration = duration * 1000;
+        }
+    }
+    setColorAnimation(animation, initValue, maxValue) {
+        var _a;
+        const container = this.container;
+        if (!animation.enable) {
+            return initValue;
+        }
+        const colorOffset = randomInRange(animation.offset), delay = getRangeValue(this.options.rate.delay), emitFactor = (1000 * delay) / container.retina.reduceFactor, colorSpeed = getRangeValue((_a = animation.speed) !== null && _a !== void 0 ? _a : 0);
+        return (initValue + (colorSpeed * container.fpsLimit) / emitFactor + colorOffset * 3.6) % maxValue;
+    }
+}

package/browser/Emitters.js

@@ -0,0 +1,119 @@
+import { arrayRandomIndex, executeOnSingleOrMultiple, itemFromArray } from "@tsparticles/engine";
+import { Emitter } from "./Options/Classes/Emitter";
+import { EmitterInstance } from "./EmitterInstance";
+export class Emitters {
+    constructor(engine, container) {
+        this.container = container;
+        this._engine = engine;
+        this.array = [];
+        this.emitters = [];
+        this.interactivityEmitters = {
+            random: {
+                count: 1,
+                enable: false,
+            },
+            value: [],
+        };
+        container.getEmitter = (idxOrName) => idxOrName === undefined || typeof idxOrName === "number"
+            ? this.array[idxOrName || 0]
+            : this.array.find((t) => t.name === idxOrName);
+        container.addEmitter = (options, position) => this.addEmitter(options, position);
+        container.removeEmitter = (idxOrName) => {
+            const emitter = container.getEmitter(idxOrName);
+            if (emitter) {
+                this.removeEmitter(emitter);
+            }
+        };
+        container.playEmitter = (idxOrName) => {
+            const emitter = container.getEmitter(idxOrName);
+            if (emitter) {
+                emitter.externalPlay();
+            }
+        };
+        container.pauseEmitter = (idxOrName) => {
+            const emitter = container.getEmitter(idxOrName);
+            if (emitter) {
+                emitter.externalPause();
+            }
+        };
+    }
+    addEmitter(options, position) {
+        const emitterOptions = new Emitter();
+        emitterOptions.load(options);
+        const emitter = new EmitterInstance(this._engine, this, this.container, emitterOptions, position);
+        this.array.push(emitter);
+        return emitter;
+    }
+    handleClickMode(mode) {
+        const emitterOptions = this.emitters, modeEmitters = this.interactivityEmitters;
+        if (mode === "emitter") {
+            let emittersModeOptions;
+            if (modeEmitters && modeEmitters.value instanceof Array) {
+                if (modeEmitters.value.length > 0 && modeEmitters.random.enable) {
+                    emittersModeOptions = [];
+                    const usedIndexes = [];
+                    for (let i = 0; i < modeEmitters.random.count; i++) {
+                        const idx = arrayRandomIndex(modeEmitters.value);
+                        if (usedIndexes.includes(idx) && usedIndexes.length < modeEmitters.value.length) {
+                            i--;
+                            continue;
+                        }
+                        usedIndexes.push(idx);
+                        emittersModeOptions.push(itemFromArray(modeEmitters.value, idx));
+                    }
+                }
+                else {
+                    emittersModeOptions = modeEmitters.value;
+                }
+            }
+            else {
+                emittersModeOptions = modeEmitters === null || modeEmitters === void 0 ? void 0 : modeEmitters.value;
+            }
+            const emittersOptions = emittersModeOptions !== null && emittersModeOptions !== void 0 ? emittersModeOptions : emitterOptions, ePosition = this.container.interactivity.mouse.clickPosition;
+            executeOnSingleOrMultiple(emittersOptions, (emitter) => {
+                this.addEmitter(emitter, ePosition);
+            });
+        }
+    }
+    async init() {
+        this.emitters = this.container.actualOptions.emitters;
+        this.interactivityEmitters = this.container.actualOptions.interactivity.modes.emitters;
+        if (this.emitters instanceof Array) {
+            for (const emitterOptions of this.emitters) {
+                this.addEmitter(emitterOptions);
+            }
+        }
+        else {
+            this.addEmitter(this.emitters);
+        }
+    }
+    pause() {
+        for (const emitter of this.array) {
+            emitter.pause();
+        }
+    }
+    play() {
+        for (const emitter of this.array) {
+            emitter.play();
+        }
+    }
+    removeEmitter(emitter) {
+        const index = this.array.indexOf(emitter);
+        if (index >= 0) {
+            this.array.splice(index, 1);
+        }
+    }
+    resize() {
+        for (const emitter of this.array) {
+            emitter.resize();
+        }
+    }
+    stop() {
+        this.array = [];
+    }
+    update(delta) {
+        for (const emitter of this.array) {
+            emitter.update(delta);
+        }
+    }
+}

package/browser/EmittersEngine.js

@@ -0,0 +1 @@
+export {};

package/browser/Enums/EmitterClickMode.js

@@ -0,0 +1 @@
+export {};

package/browser/Enums/EmitterShapeType.js

@@ -0,0 +1 @@
+export {};

package/browser/IEmitterShape.js

@@ -0,0 +1 @@
+export {};

package/browser/Options/Classes/Emitter.js

@@ -0,0 +1,62 @@
+import { AnimatableColor, deepExtend, executeOnSingleOrMultiple, setRangeValue } from "@tsparticles/engine";
+import { EmitterLife } from "./EmitterLife";
+import { EmitterRate } from "./EmitterRate";
+import { EmitterSize } from "./EmitterSize";
+export class Emitter {
+    constructor() {
+        this.autoPlay = true;
+        this.fill = true;
+        this.life = new EmitterLife();
+        this.rate = new EmitterRate();
+        this.shape = "square";
+        this.startCount = 0;
+    }
+    load(data) {
+        if (data === undefined) {
+            return;
+        }
+        if (data.autoPlay !== undefined) {
+            this.autoPlay = data.autoPlay;
+        }
+        if (data.size !== undefined) {
+            if (this.size === undefined) {
+                this.size = new EmitterSize();
+            }
+            this.size.load(data.size);
+        }
+        if (data.direction !== undefined) {
+            this.direction = data.direction;
+        }
+        this.domId = data.domId;
+        if (data.fill !== undefined) {
+            this.fill = data.fill;
+        }
+        this.life.load(data.life);
+        this.name = data.name;
+        this.particles = executeOnSingleOrMultiple(data.particles, (particles) => {
+            return deepExtend({}, particles);
+        });
+        this.rate.load(data.rate);
+        if (data.shape !== undefined) {
+            this.shape = data.shape;
+        }
+        if (data.position !== undefined) {
+            this.position = {};
+            if (data.position.x !== undefined) {
+                this.position.x = setRangeValue(data.position.x);
+            }
+            if (data.position.y !== undefined) {
+                this.position.y = setRangeValue(data.position.y);
+            }
+        }
+        if (data.spawnColor !== undefined) {
+            if (this.spawnColor === undefined) {
+                this.spawnColor = new AnimatableColor();
+            }
+            this.spawnColor.load(data.spawnColor);
+        }
+        if (data.startCount !== undefined) {
+            this.startCount = data.startCount;
+        }
+    }
+}

package/browser/Options/Classes/EmitterLife.js

@@ -0,0 +1,22 @@
+export class EmitterLife {
+    constructor() {
+        this.wait = false;
+    }
+    load(data) {
+        if (data === undefined) {
+            return;
+        }
+        if (data.count !== undefined) {
+            this.count = data.count;
+        }
+        if (data.delay !== undefined) {
+            this.delay = data.delay;
+        }
+        if (data.duration !== undefined) {
+            this.duration = data.duration;
+        }
+        if (data.wait !== undefined) {
+            this.wait = data.wait;
+        }
+    }
+}

package/browser/Options/Classes/EmitterRate.js

@@ -0,0 +1,18 @@
+import { setRangeValue } from "@tsparticles/engine";
+export class EmitterRate {
+    constructor() {
+        this.quantity = 1;
+        this.delay = 0.1;
+    }
+    load(data) {
+        if (data === undefined) {
+            return;
+        }
+        if (data.quantity !== undefined) {
+            this.quantity = setRangeValue(data.quantity);
+        }
+        if (data.delay !== undefined) {
+            this.delay = setRangeValue(data.delay);
+        }
+    }
+}

package/browser/Options/Classes/EmitterSize.js

@@ -0,0 +1,21 @@
+export class EmitterSize {
+    constructor() {
+        this.mode = "percent";
+        this.height = 0;
+        this.width = 0;
+    }
+    load(data) {
+        if (data === undefined) {
+            return;
+        }
+        if (data.mode !== undefined) {
+            this.mode = data.mode;
+        }
+        if (data.height !== undefined) {
+            this.height = data.height;
+        }
+        if (data.width !== undefined) {
+            this.width = data.width;
+        }
+    }
+}

package/browser/Options/Interfaces/IEmitter.js

@@ -0,0 +1 @@
+export {};

package/browser/Options/Interfaces/IEmitterLife.js

@@ -0,0 +1 @@
+export {};

package/browser/Options/Interfaces/IEmitterRate.js

@@ -0,0 +1 @@
+export {};

package/browser/Options/Interfaces/IEmitterSize.js

@@ -0,0 +1 @@
+export {};

package/browser/ShapeManager.js

@@ -0,0 +1,17 @@
+const shapes = new Map();
+export class ShapeManager {
+    constructor(engine) {
+        this._engine = engine;
+    }
+    addShape(name, drawer) {
+        if (!this.getShape(name)) {
+            shapes.set(name, drawer);
+        }
+    }
+    getShape(name) {
+        return shapes.get(name);
+    }
+    getSupportedShapes() {
+        return shapes.keys();
+    }
+}

package/browser/Shapes/Circle/CircleShape.js

@@ -0,0 +1,24 @@
+import { getRandom } from "@tsparticles/engine";
+export class CircleShape {
+    randomPosition(position, size, fill) {
+        const generateTheta = (x, y) => {
+            const u = getRandom() / 4.0, theta = Math.atan((y / x) * Math.tan(2 * Math.PI * u)), v = getRandom();
+            if (v < 0.25) {
+                return theta;
+            }
+            else if (v < 0.5) {
+                return Math.PI - theta;
+            }
+            else if (v < 0.75) {
+                return Math.PI + theta;
+            }
+            else {
+                return -theta;
+            }
+        }, radius = (x, y, theta) => (x * y) / Math.sqrt((y * Math.cos(theta)) ** 2 + (x * Math.sin(theta)) ** 2), [a, b] = [size.width / 2, size.height / 2], randomTheta = generateTheta(a, b), maxRadius = radius(a, b, randomTheta), randomRadius = fill ? maxRadius * Math.sqrt(getRandom()) : maxRadius;
+        return {
+            x: position.x + randomRadius * Math.cos(randomTheta),
+            y: position.y + randomRadius * Math.sin(randomTheta),
+        };
+    }
+}