@tsparticles/updater-destroy 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 Destroy Updater
+
+[![jsDelivr](https://data.jsdelivr.com/v1/package/npm/tsparticles-updater-destroy/badge)](https://www.jsdelivr.com/package/npm/tsparticles-updater-destroy)
+[![npmjs](https://badge.fury.io/js/tsparticles-updater-destroy.svg)](https://www.npmjs.com/package/tsparticles-updater-destroy)
+[![npmjs](https://img.shields.io/npm/dt/tsparticles-updater-destroy)](https://www.npmjs.com/package/tsparticles-updater-destroy) [![GitHub Sponsors](https://img.shields.io/github/sponsors/matteobruni)](https://github.com/sponsors/matteobruni)
+
+[tsParticles](https://github.com/matteobruni/tsparticles) updater plugin for destroy animations.
+
+## How to use it
+
+### CDN / Vanilla JS / jQuery
+
+The CDN/Vanilla version JS has one required file in vanilla configuration:
+
+Including the `tsparticles.updater.destroy.min.js` file will export the function to load the updater plugin:
+
+```javascript
+loadDestroyUpdater;
+```
+
+### Usage
+
+Once the scripts are loaded you can set up `tsParticles` and the updater plugin like this:
+
+```javascript
+(async () => {
+  await loadDestroyUpdater();
+
+  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-updater-destroy
+```
+
+or
+
+```shell
+$ yarn add tsparticles-updater-destroy
+```
+
+Then you need to import it in the app, like this:
+
+```javascript
+const { tsParticles } = require("tsparticles-engine");
+const { loadDestroyUpdater } = require("tsparticles-updater-destroy");
+
+loadDestroyUpdater(tsParticles);
+```
+
+or
+
+```javascript
+import { tsParticles } from "tsparticles-engine";
+import { loadDestroyUpdater } from "tsparticles-updater-destroy";
+
+loadDestroyUpdater(tsParticles);
+```

package/browser/DestroyUpdater.js

@@ -0,0 +1,125 @@
+import { getRangeValue, getValue, itemFromSingleOrMultiple, loadParticlesOptions, randomInRange, setRangeValue, } from "@tsparticles/engine";
+import { Destroy } from "./Options/Classes/Destroy";
+export class DestroyUpdater {
+    constructor(engine, container) {
+        this.engine = engine;
+        this.container = container;
+    }
+    init(particle) {
+        const container = this.container, particlesOptions = particle.options, destroyOptions = particlesOptions.destroy;
+        if (!destroyOptions) {
+            return;
+        }
+        particle.splitCount = 0;
+        const destroyBounds = destroyOptions.bounds;
+        if (!particle.destroyBounds) {
+            particle.destroyBounds = {};
+        }
+        if (destroyBounds.bottom) {
+            particle.destroyBounds.bottom = (getRangeValue(destroyBounds.bottom) * container.canvas.size.height) / 100;
+        }
+        if (destroyBounds.left) {
+            particle.destroyBounds.left = (getRangeValue(destroyBounds.left) * container.canvas.size.width) / 100;
+        }
+        if (destroyBounds.right) {
+            particle.destroyBounds.right = (getRangeValue(destroyBounds.right) * container.canvas.size.width) / 100;
+        }
+        if (destroyBounds.top) {
+            particle.destroyBounds.top = (getRangeValue(destroyBounds.top) * container.canvas.size.height) / 100;
+        }
+    }
+    isEnabled(particle) {
+        return !particle.destroyed;
+    }
+    loadOptions(options, ...sources) {
+        if (!options.destroy) {
+            options.destroy = new Destroy();
+        }
+        for (const source of sources) {
+            options.destroy.load(source === null || source === void 0 ? void 0 : source.destroy);
+        }
+    }
+    particleDestroyed(particle, override) {
+        if (override) {
+            return;
+        }
+        const destroyOptions = particle.options.destroy;
+        if (destroyOptions && destroyOptions.mode === "split") {
+            this.split(particle);
+        }
+    }
+    update(particle) {
+        if (!this.isEnabled(particle)) {
+            return;
+        }
+        const position = particle.getPosition(), bounds = particle.destroyBounds;
+        if (!bounds) {
+            return;
+        }
+        if ((bounds.bottom !== undefined && position.y >= bounds.bottom) ||
+            (bounds.left !== undefined && position.x <= bounds.left) ||
+            (bounds.right !== undefined && position.x >= bounds.right) ||
+            (bounds.top !== undefined && position.y <= bounds.top)) {
+            particle.destroy();
+        }
+    }
+    addSplitParticle(parent, splitParticlesOptions) {
+        const destroyOptions = parent.options.destroy;
+        if (!destroyOptions) {
+            return;
+        }
+        const splitOptions = destroyOptions.split, options = loadParticlesOptions(this.engine, this.container, parent.options), factor = getValue(splitOptions.factor);
+        options.color.load({
+            value: {
+                hsl: parent.getFillColor(),
+            },
+        });
+        options.move.load({
+            center: {
+                x: parent.position.x,
+                y: parent.position.y,
+                mode: "precise",
+            },
+        });
+        if (typeof options.size.value === "number") {
+            options.size.value /= factor;
+        }
+        else {
+            options.size.value.min /= factor;
+            options.size.value.max /= factor;
+        }
+        options.load(splitParticlesOptions);
+        const offset = splitOptions.sizeOffset ? setRangeValue(-parent.size.value, parent.size.value) : 0, position = {
+            x: parent.position.x + randomInRange(offset),
+            y: parent.position.y + randomInRange(offset),
+        };
+        return this.container.particles.addParticle(position, options, parent.group, (particle) => {
+            var _a;
+            if (particle.size.value < 0.5) {
+                return false;
+            }
+            particle.velocity.length = randomInRange(setRangeValue(parent.velocity.length, particle.velocity.length));
+            particle.splitCount = ((_a = parent.splitCount) !== null && _a !== void 0 ? _a : 0) + 1;
+            particle.unbreakable = true;
+            setTimeout(() => {
+                particle.unbreakable = false;
+            }, 500);
+            return true;
+        });
+    }
+    split(particle) {
+        const destroyOptions = particle.options.destroy;
+        if (!destroyOptions) {
+            return;
+        }
+        const splitOptions = destroyOptions.split;
+        if (splitOptions.count >= 0 &&
+            (particle.splitCount === undefined || particle.splitCount++ > splitOptions.count)) {
+            return;
+        }
+        const rate = getValue(splitOptions.rate), particlesSplitOptions = itemFromSingleOrMultiple(splitOptions.particles);
+        for (let i = 0; i < rate; i++) {
+            this.addSplitParticle(particle, particlesSplitOptions);
+        }
+    }
+}

package/browser/Enums/DestroyMode.js

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

package/browser/Options/Classes/Destroy.js

@@ -0,0 +1,21 @@
+import { DestroyBounds } from "./DestroyBounds";
+import { Split } from "./Split";
+export class Destroy {
+    constructor() {
+        this.bounds = new DestroyBounds();
+        this.mode = "none";
+        this.split = new Split();
+    }
+    load(data) {
+        if (!data) {
+            return;
+        }
+        if (data.mode) {
+            this.mode = data.mode;
+        }
+        if (data.bounds) {
+            this.bounds.load(data.bounds);
+        }
+        this.split.load(data.split);
+    }
+}

package/browser/Options/Classes/DestroyBounds.js

@@ -0,0 +1,20 @@
+import { setRangeValue } from "@tsparticles/engine";
+export class DestroyBounds {
+    load(data) {
+        if (!data) {
+            return;
+        }
+        if (data.bottom !== undefined) {
+            this.bottom = setRangeValue(data.bottom);
+        }
+        if (data.left !== undefined) {
+            this.left = setRangeValue(data.left);
+        }
+        if (data.right !== undefined) {
+            this.right = setRangeValue(data.right);
+        }
+        if (data.top !== undefined) {
+            this.top = setRangeValue(data.top);
+        }
+    }
+}

package/browser/Options/Classes/Split.js

@@ -0,0 +1,27 @@
+import { deepExtend, executeOnSingleOrMultiple } from "@tsparticles/engine";
+import { SplitFactor } from "./SplitFactor";
+import { SplitRate } from "./SplitRate";
+export class Split {
+    constructor() {
+        this.count = 1;
+        this.factor = new SplitFactor();
+        this.rate = new SplitRate();
+        this.sizeOffset = true;
+    }
+    load(data) {
+        if (!data) {
+            return;
+        }
+        if (data.count !== undefined) {
+            this.count = data.count;
+        }
+        this.factor.load(data.factor);
+        this.rate.load(data.rate);
+        this.particles = executeOnSingleOrMultiple(data.particles, (particles) => {
+            return deepExtend({}, particles);
+        });
+        if (data.sizeOffset !== undefined) {
+            this.sizeOffset = data.sizeOffset;
+        }
+    }
+}

package/browser/Options/Classes/SplitFactor.js

@@ -0,0 +1,7 @@
+import { ValueWithRandom } from "@tsparticles/engine";
+export class SplitFactor extends ValueWithRandom {
+    constructor() {
+        super();
+        this.value = 3;
+    }
+}

package/browser/Options/Classes/SplitRate.js

@@ -0,0 +1,7 @@
+import { ValueWithRandom } from "@tsparticles/engine";
+export class SplitRate extends ValueWithRandom {
+    constructor() {
+        super();
+        this.value = { min: 4, max: 9 };
+    }
+}

package/browser/Options/Interfaces/IDestroy.js

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

package/browser/Options/Interfaces/IDestroyBounds.js

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

package/browser/Options/Interfaces/ISplit.js

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

package/browser/index.js

@@ -0,0 +1,4 @@
+import { DestroyUpdater } from "./DestroyUpdater";
+export async function loadDestroyUpdater(engine) {
+    await engine.addParticleUpdater("destroy", (container) => new DestroyUpdater(engine, container));
+}

package/cjs/DestroyUpdater.js

@@ -0,0 +1,129 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DestroyUpdater = void 0;
+const engine_1 = require("@tsparticles/engine");
+const Destroy_1 = require("./Options/Classes/Destroy");
+class DestroyUpdater {
+    constructor(engine, container) {
+        this.engine = engine;
+        this.container = container;
+    }
+    init(particle) {
+        const container = this.container, particlesOptions = particle.options, destroyOptions = particlesOptions.destroy;
+        if (!destroyOptions) {
+            return;
+        }
+        particle.splitCount = 0;
+        const destroyBounds = destroyOptions.bounds;
+        if (!particle.destroyBounds) {
+            particle.destroyBounds = {};
+        }
+        if (destroyBounds.bottom) {
+            particle.destroyBounds.bottom = ((0, engine_1.getRangeValue)(destroyBounds.bottom) * container.canvas.size.height) / 100;
+        }
+        if (destroyBounds.left) {
+            particle.destroyBounds.left = ((0, engine_1.getRangeValue)(destroyBounds.left) * container.canvas.size.width) / 100;
+        }
+        if (destroyBounds.right) {
+            particle.destroyBounds.right = ((0, engine_1.getRangeValue)(destroyBounds.right) * container.canvas.size.width) / 100;
+        }
+        if (destroyBounds.top) {
+            particle.destroyBounds.top = ((0, engine_1.getRangeValue)(destroyBounds.top) * container.canvas.size.height) / 100;
+        }
+    }
+    isEnabled(particle) {
+        return !particle.destroyed;
+    }
+    loadOptions(options, ...sources) {
+        if (!options.destroy) {
+            options.destroy = new Destroy_1.Destroy();
+        }
+        for (const source of sources) {
+            options.destroy.load(source === null || source === void 0 ? void 0 : source.destroy);
+        }
+    }
+    particleDestroyed(particle, override) {
+        if (override) {
+            return;
+        }
+        const destroyOptions = particle.options.destroy;
+        if (destroyOptions && destroyOptions.mode === "split") {
+            this.split(particle);
+        }
+    }
+    update(particle) {
+        if (!this.isEnabled(particle)) {
+            return;
+        }
+        const position = particle.getPosition(), bounds = particle.destroyBounds;
+        if (!bounds) {
+            return;
+        }
+        if ((bounds.bottom !== undefined && position.y >= bounds.bottom) ||
+            (bounds.left !== undefined && position.x <= bounds.left) ||
+            (bounds.right !== undefined && position.x >= bounds.right) ||
+            (bounds.top !== undefined && position.y <= bounds.top)) {
+            particle.destroy();
+        }
+    }
+    addSplitParticle(parent, splitParticlesOptions) {
+        const destroyOptions = parent.options.destroy;
+        if (!destroyOptions) {
+            return;
+        }
+        const splitOptions = destroyOptions.split, options = (0, engine_1.loadParticlesOptions)(this.engine, this.container, parent.options), factor = (0, engine_1.getValue)(splitOptions.factor);
+        options.color.load({
+            value: {
+                hsl: parent.getFillColor(),
+            },
+        });
+        options.move.load({
+            center: {
+                x: parent.position.x,
+                y: parent.position.y,
+                mode: "precise",
+            },
+        });
+        if (typeof options.size.value === "number") {
+            options.size.value /= factor;
+        }
+        else {
+            options.size.value.min /= factor;
+            options.size.value.max /= factor;
+        }
+        options.load(splitParticlesOptions);
+        const offset = splitOptions.sizeOffset ? (0, engine_1.setRangeValue)(-parent.size.value, parent.size.value) : 0, position = {
+            x: parent.position.x + (0, engine_1.randomInRange)(offset),
+            y: parent.position.y + (0, engine_1.randomInRange)(offset),
+        };
+        return this.container.particles.addParticle(position, options, parent.group, (particle) => {
+            var _a;
+            if (particle.size.value < 0.5) {
+                return false;
+            }
+            particle.velocity.length = (0, engine_1.randomInRange)((0, engine_1.setRangeValue)(parent.velocity.length, particle.velocity.length));
+            particle.splitCount = ((_a = parent.splitCount) !== null && _a !== void 0 ? _a : 0) + 1;
+            particle.unbreakable = true;
+            setTimeout(() => {
+                particle.unbreakable = false;
+            }, 500);
+            return true;
+        });
+    }
+    split(particle) {
+        const destroyOptions = particle.options.destroy;
+        if (!destroyOptions) {
+            return;
+        }
+        const splitOptions = destroyOptions.split;
+        if (splitOptions.count >= 0 &&
+            (particle.splitCount === undefined || particle.splitCount++ > splitOptions.count)) {
+            return;
+        }
+        const rate = (0, engine_1.getValue)(splitOptions.rate), particlesSplitOptions = (0, engine_1.itemFromSingleOrMultiple)(splitOptions.particles);
+        for (let i = 0; i < rate; i++) {
+            this.addSplitParticle(particle, particlesSplitOptions);
+        }
+    }
+}
+exports.DestroyUpdater = DestroyUpdater;

package/cjs/Enums/DestroyMode.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/cjs/Options/Classes/Destroy.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Destroy = void 0;
+const DestroyBounds_1 = require("./DestroyBounds");
+const Split_1 = require("./Split");
+class Destroy {
+    constructor() {
+        this.bounds = new DestroyBounds_1.DestroyBounds();
+        this.mode = "none";
+        this.split = new Split_1.Split();
+    }
+    load(data) {
+        if (!data) {
+            return;
+        }
+        if (data.mode) {
+            this.mode = data.mode;
+        }
+        if (data.bounds) {
+            this.bounds.load(data.bounds);
+        }
+        this.split.load(data.split);
+    }
+}
+exports.Destroy = Destroy;

package/cjs/Options/Classes/DestroyBounds.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DestroyBounds = void 0;
+const engine_1 = require("@tsparticles/engine");
+class DestroyBounds {
+    load(data) {
+        if (!data) {
+            return;
+        }
+        if (data.bottom !== undefined) {
+            this.bottom = (0, engine_1.setRangeValue)(data.bottom);
+        }
+        if (data.left !== undefined) {
+            this.left = (0, engine_1.setRangeValue)(data.left);
+        }
+        if (data.right !== undefined) {
+            this.right = (0, engine_1.setRangeValue)(data.right);
+        }
+        if (data.top !== undefined) {
+            this.top = (0, engine_1.setRangeValue)(data.top);
+        }
+    }
+}
+exports.DestroyBounds = DestroyBounds;

package/cjs/Options/Classes/Split.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Split = void 0;
+const engine_1 = require("@tsparticles/engine");
+const SplitFactor_1 = require("./SplitFactor");
+const SplitRate_1 = require("./SplitRate");
+class Split {
+    constructor() {
+        this.count = 1;
+        this.factor = new SplitFactor_1.SplitFactor();
+        this.rate = new SplitRate_1.SplitRate();
+        this.sizeOffset = true;
+    }
+    load(data) {
+        if (!data) {
+            return;
+        }
+        if (data.count !== undefined) {
+            this.count = data.count;
+        }
+        this.factor.load(data.factor);
+        this.rate.load(data.rate);
+        this.particles = (0, engine_1.executeOnSingleOrMultiple)(data.particles, (particles) => {
+            return (0, engine_1.deepExtend)({}, particles);
+        });
+        if (data.sizeOffset !== undefined) {
+            this.sizeOffset = data.sizeOffset;
+        }
+    }
+}
+exports.Split = Split;

package/cjs/Options/Classes/SplitFactor.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SplitFactor = void 0;
+const engine_1 = require("@tsparticles/engine");
+class SplitFactor extends engine_1.ValueWithRandom {
+    constructor() {
+        super();
+        this.value = 3;
+    }
+}
+exports.SplitFactor = SplitFactor;

package/cjs/Options/Classes/SplitRate.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SplitRate = void 0;
+const engine_1 = require("@tsparticles/engine");
+class SplitRate extends engine_1.ValueWithRandom {
+    constructor() {
+        super();
+        this.value = { min: 4, max: 9 };
+    }
+}
+exports.SplitRate = SplitRate;

package/cjs/Options/Interfaces/IDestroy.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/cjs/Options/Interfaces/IDestroyBounds.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/cjs/Options/Interfaces/ISplit.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/cjs/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadDestroyUpdater = void 0;
+const DestroyUpdater_1 = require("./DestroyUpdater");
+function loadDestroyUpdater(engine) {
+    return __awaiter(this, void 0, void 0, function* () {
+        yield engine.addParticleUpdater("destroy", (container) => new DestroyUpdater_1.DestroyUpdater(engine, container));
+    });
+}
+exports.loadDestroyUpdater = loadDestroyUpdater;