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

package/browser/Options/Classes/Roll.js

@@ -0,0 +1,30 @@
+import { OptionsColor, setRangeValue } from "@tsparticles/engine";
+import { RollLight } from "./RollLight";
+export class Roll {
+    constructor() {
+        this.darken = new RollLight();
+        this.enable = false;
+        this.enlighten = new RollLight();
+        this.mode = "vertical";
+        this.speed = 25;
+    }
+    load(data) {
+        if (!data) {
+            return;
+        }
+        if (data.backColor !== undefined) {
+            this.backColor = OptionsColor.create(this.backColor, data.backColor);
+        }
+        this.darken.load(data.darken);
+        if (data.enable !== undefined) {
+            this.enable = data.enable;
+        }
+        this.enlighten.load(data.enlighten);
+        if (data.mode !== undefined) {
+            this.mode = data.mode;
+        }
+        if (data.speed !== undefined) {
+            this.speed = setRangeValue(data.speed);
+        }
+    }
+}

package/browser/Options/Classes/RollLight.js

@@ -0,0 +1,18 @@
+import { setRangeValue } from "@tsparticles/engine";
+export class RollLight {
+    constructor() {
+        this.enable = false;
+        this.value = 0;
+    }
+    load(data) {
+        if (!data) {
+            return;
+        }
+        if (data.enable !== undefined) {
+            this.enable = data.enable;
+        }
+        if (data.value !== undefined) {
+            this.value = setRangeValue(data.value);
+        }
+    }
+}

package/browser/Options/Interfaces/IRoll.js

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

package/browser/Options/Interfaces/IRollLight.js

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

package/browser/RollMode.js

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

package/browser/RollUpdater.js

@@ -0,0 +1,84 @@
+import { getRandom, getRangeValue, rangeColorToHsl } from "@tsparticles/engine";
+import { Roll } from "./Options/Classes/Roll";
+function updateRoll(particle, delta) {
+    const roll = particle.options.roll;
+    if (!particle.roll || !(roll === null || roll === void 0 ? void 0 : roll.enable)) {
+        return;
+    }
+    const speed = particle.roll.speed * delta.factor, max = 2 * Math.PI;
+    particle.roll.angle += speed;
+    if (particle.roll.angle > max) {
+        particle.roll.angle -= max;
+    }
+}
+export class RollUpdater {
+    getTransformValues(particle) {
+        var _a;
+        const roll = ((_a = particle.roll) === null || _a === void 0 ? void 0 : _a.enable) && particle.roll, rollHorizontal = roll && roll.horizontal, rollVertical = roll && roll.vertical;
+        return {
+            a: rollHorizontal ? Math.cos(roll.angle) : undefined,
+            d: rollVertical ? Math.sin(roll.angle) : undefined,
+        };
+    }
+    init(particle) {
+        const rollOpt = particle.options.roll;
+        if (rollOpt === null || rollOpt === void 0 ? void 0 : rollOpt.enable) {
+            particle.roll = {
+                enable: rollOpt.enable,
+                horizontal: rollOpt.mode === "horizontal" || rollOpt.mode === "both",
+                vertical: rollOpt.mode === "vertical" || rollOpt.mode === "both",
+                angle: getRandom() * Math.PI * 2,
+                speed: getRangeValue(rollOpt.speed) / 360,
+            };
+            if (rollOpt.backColor) {
+                particle.backColor = rangeColorToHsl(rollOpt.backColor);
+            }
+            else if (rollOpt.darken.enable && rollOpt.enlighten.enable) {
+                const alterType = getRandom() >= 0.5 ? "darken" : "enlighten";
+                particle.roll.alter = {
+                    type: alterType,
+                    value: getRangeValue(alterType === "darken" ? rollOpt.darken.value : rollOpt.enlighten.value),
+                };
+            }
+            else if (rollOpt.darken.enable) {
+                particle.roll.alter = {
+                    type: "darken",
+                    value: getRangeValue(rollOpt.darken.value),
+                };
+            }
+            else if (rollOpt.enlighten.enable) {
+                particle.roll.alter = {
+                    type: "enlighten",
+                    value: getRangeValue(rollOpt.enlighten.value),
+                };
+            }
+        }
+        else {
+            particle.roll = {
+                enable: false,
+                horizontal: false,
+                vertical: false,
+                angle: 0,
+                speed: 0,
+            };
+        }
+    }
+    isEnabled(particle) {
+        const roll = particle.options.roll;
+        return !particle.destroyed && !particle.spawning && !!(roll === null || roll === void 0 ? void 0 : roll.enable);
+    }
+    loadOptions(options, ...sources) {
+        if (!options.roll) {
+            options.roll = new Roll();
+        }
+        for (const source of sources) {
+            options.roll.load(source === null || source === void 0 ? void 0 : source.roll);
+        }
+    }
+    update(particle, delta) {
+        if (!this.isEnabled(particle)) {
+            return;
+        }
+        updateRoll(particle, delta);
+    }
+}

package/browser/index.js

@@ -0,0 +1,4 @@
+import { RollUpdater } from "./RollUpdater";
+export async function loadRollUpdater(engine) {
+    await engine.addParticleUpdater("roll", () => new RollUpdater());
+}

package/cjs/Options/Classes/Roll.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Roll = void 0;
+const engine_1 = require("@tsparticles/engine");
+const RollLight_1 = require("./RollLight");
+class Roll {
+    constructor() {
+        this.darken = new RollLight_1.RollLight();
+        this.enable = false;
+        this.enlighten = new RollLight_1.RollLight();
+        this.mode = "vertical";
+        this.speed = 25;
+    }
+    load(data) {
+        if (!data) {
+            return;
+        }
+        if (data.backColor !== undefined) {
+            this.backColor = engine_1.OptionsColor.create(this.backColor, data.backColor);
+        }
+        this.darken.load(data.darken);
+        if (data.enable !== undefined) {
+            this.enable = data.enable;
+        }
+        this.enlighten.load(data.enlighten);
+        if (data.mode !== undefined) {
+            this.mode = data.mode;
+        }
+        if (data.speed !== undefined) {
+            this.speed = (0, engine_1.setRangeValue)(data.speed);
+        }
+    }
+}
+exports.Roll = Roll;

package/cjs/Options/Classes/RollLight.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RollLight = void 0;
+const engine_1 = require("@tsparticles/engine");
+class RollLight {
+    constructor() {
+        this.enable = false;
+        this.value = 0;
+    }
+    load(data) {
+        if (!data) {
+            return;
+        }
+        if (data.enable !== undefined) {
+            this.enable = data.enable;
+        }
+        if (data.value !== undefined) {
+            this.value = (0, engine_1.setRangeValue)(data.value);
+        }
+    }
+}
+exports.RollLight = RollLight;

package/cjs/Options/Interfaces/IRoll.js

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

package/cjs/Options/Interfaces/IRollLight.js

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

package/cjs/RollMode.js

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

package/cjs/RollUpdater.js

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RollUpdater = void 0;
+const engine_1 = require("@tsparticles/engine");
+const Roll_1 = require("./Options/Classes/Roll");
+function updateRoll(particle, delta) {
+    const roll = particle.options.roll;
+    if (!particle.roll || !(roll === null || roll === void 0 ? void 0 : roll.enable)) {
+        return;
+    }
+    const speed = particle.roll.speed * delta.factor, max = 2 * Math.PI;
+    particle.roll.angle += speed;
+    if (particle.roll.angle > max) {
+        particle.roll.angle -= max;
+    }
+}
+class RollUpdater {
+    getTransformValues(particle) {
+        var _a;
+        const roll = ((_a = particle.roll) === null || _a === void 0 ? void 0 : _a.enable) && particle.roll, rollHorizontal = roll && roll.horizontal, rollVertical = roll && roll.vertical;
+        return {
+            a: rollHorizontal ? Math.cos(roll.angle) : undefined,
+            d: rollVertical ? Math.sin(roll.angle) : undefined,
+        };
+    }
+    init(particle) {
+        const rollOpt = particle.options.roll;
+        if (rollOpt === null || rollOpt === void 0 ? void 0 : rollOpt.enable) {
+            particle.roll = {
+                enable: rollOpt.enable,
+                horizontal: rollOpt.mode === "horizontal" || rollOpt.mode === "both",
+                vertical: rollOpt.mode === "vertical" || rollOpt.mode === "both",
+                angle: (0, engine_1.getRandom)() * Math.PI * 2,
+                speed: (0, engine_1.getRangeValue)(rollOpt.speed) / 360,
+            };
+            if (rollOpt.backColor) {
+                particle.backColor = (0, engine_1.rangeColorToHsl)(rollOpt.backColor);
+            }
+            else if (rollOpt.darken.enable && rollOpt.enlighten.enable) {
+                const alterType = (0, engine_1.getRandom)() >= 0.5 ? "darken" : "enlighten";
+                particle.roll.alter = {
+                    type: alterType,
+                    value: (0, engine_1.getRangeValue)(alterType === "darken" ? rollOpt.darken.value : rollOpt.enlighten.value),
+                };
+            }
+            else if (rollOpt.darken.enable) {
+                particle.roll.alter = {
+                    type: "darken",
+                    value: (0, engine_1.getRangeValue)(rollOpt.darken.value),
+                };
+            }
+            else if (rollOpt.enlighten.enable) {
+                particle.roll.alter = {
+                    type: "enlighten",
+                    value: (0, engine_1.getRangeValue)(rollOpt.enlighten.value),
+                };
+            }
+        }
+        else {
+            particle.roll = {
+                enable: false,
+                horizontal: false,
+                vertical: false,
+                angle: 0,
+                speed: 0,
+            };
+        }
+    }
+    isEnabled(particle) {
+        const roll = particle.options.roll;
+        return !particle.destroyed && !particle.spawning && !!(roll === null || roll === void 0 ? void 0 : roll.enable);
+    }
+    loadOptions(options, ...sources) {
+        if (!options.roll) {
+            options.roll = new Roll_1.Roll();
+        }
+        for (const source of sources) {
+            options.roll.load(source === null || source === void 0 ? void 0 : source.roll);
+        }
+    }
+    update(particle, delta) {
+        if (!this.isEnabled(particle)) {
+            return;
+        }
+        updateRoll(particle, delta);
+    }
+}
+exports.RollUpdater = RollUpdater;

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.loadRollUpdater = void 0;
+const RollUpdater_1 = require("./RollUpdater");
+function loadRollUpdater(engine) {
+    return __awaiter(this, void 0, void 0, function* () {
+        yield engine.addParticleUpdater("roll", () => new RollUpdater_1.RollUpdater());
+    });
+}
+exports.loadRollUpdater = loadRollUpdater;

package/esm/Options/Classes/Roll.js

@@ -0,0 +1,30 @@
+import { OptionsColor, setRangeValue } from "@tsparticles/engine";
+import { RollLight } from "./RollLight";
+export class Roll {
+    constructor() {
+        this.darken = new RollLight();
+        this.enable = false;
+        this.enlighten = new RollLight();
+        this.mode = "vertical";
+        this.speed = 25;
+    }
+    load(data) {
+        if (!data) {
+            return;
+        }
+        if (data.backColor !== undefined) {
+            this.backColor = OptionsColor.create(this.backColor, data.backColor);
+        }
+        this.darken.load(data.darken);
+        if (data.enable !== undefined) {
+            this.enable = data.enable;
+        }
+        this.enlighten.load(data.enlighten);
+        if (data.mode !== undefined) {
+            this.mode = data.mode;
+        }
+        if (data.speed !== undefined) {
+            this.speed = setRangeValue(data.speed);
+        }
+    }
+}

package/esm/Options/Classes/RollLight.js

@@ -0,0 +1,18 @@
+import { setRangeValue } from "@tsparticles/engine";
+export class RollLight {
+    constructor() {
+        this.enable = false;
+        this.value = 0;
+    }
+    load(data) {
+        if (!data) {
+            return;
+        }
+        if (data.enable !== undefined) {
+            this.enable = data.enable;
+        }
+        if (data.value !== undefined) {
+            this.value = setRangeValue(data.value);
+        }
+    }
+}

package/esm/Options/Interfaces/IRoll.js

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

package/esm/Options/Interfaces/IRollLight.js

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

package/esm/RollMode.js

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

package/esm/RollUpdater.js

@@ -0,0 +1,84 @@
+import { getRandom, getRangeValue, rangeColorToHsl } from "@tsparticles/engine";
+import { Roll } from "./Options/Classes/Roll";
+function updateRoll(particle, delta) {
+    const roll = particle.options.roll;
+    if (!particle.roll || !(roll === null || roll === void 0 ? void 0 : roll.enable)) {
+        return;
+    }
+    const speed = particle.roll.speed * delta.factor, max = 2 * Math.PI;
+    particle.roll.angle += speed;
+    if (particle.roll.angle > max) {
+        particle.roll.angle -= max;
+    }
+}
+export class RollUpdater {
+    getTransformValues(particle) {
+        var _a;
+        const roll = ((_a = particle.roll) === null || _a === void 0 ? void 0 : _a.enable) && particle.roll, rollHorizontal = roll && roll.horizontal, rollVertical = roll && roll.vertical;
+        return {
+            a: rollHorizontal ? Math.cos(roll.angle) : undefined,
+            d: rollVertical ? Math.sin(roll.angle) : undefined,
+        };
+    }
+    init(particle) {
+        const rollOpt = particle.options.roll;
+        if (rollOpt === null || rollOpt === void 0 ? void 0 : rollOpt.enable) {
+            particle.roll = {
+                enable: rollOpt.enable,
+                horizontal: rollOpt.mode === "horizontal" || rollOpt.mode === "both",
+                vertical: rollOpt.mode === "vertical" || rollOpt.mode === "both",
+                angle: getRandom() * Math.PI * 2,
+                speed: getRangeValue(rollOpt.speed) / 360,
+            };
+            if (rollOpt.backColor) {
+                particle.backColor = rangeColorToHsl(rollOpt.backColor);
+            }
+            else if (rollOpt.darken.enable && rollOpt.enlighten.enable) {
+                const alterType = getRandom() >= 0.5 ? "darken" : "enlighten";
+                particle.roll.alter = {
+                    type: alterType,
+                    value: getRangeValue(alterType === "darken" ? rollOpt.darken.value : rollOpt.enlighten.value),
+                };
+            }
+            else if (rollOpt.darken.enable) {
+                particle.roll.alter = {
+                    type: "darken",
+                    value: getRangeValue(rollOpt.darken.value),
+                };
+            }
+            else if (rollOpt.enlighten.enable) {
+                particle.roll.alter = {
+                    type: "enlighten",
+                    value: getRangeValue(rollOpt.enlighten.value),
+                };
+            }
+        }
+        else {
+            particle.roll = {
+                enable: false,
+                horizontal: false,
+                vertical: false,
+                angle: 0,
+                speed: 0,
+            };
+        }
+    }
+    isEnabled(particle) {
+        const roll = particle.options.roll;
+        return !particle.destroyed && !particle.spawning && !!(roll === null || roll === void 0 ? void 0 : roll.enable);
+    }
+    loadOptions(options, ...sources) {
+        if (!options.roll) {
+            options.roll = new Roll();
+        }
+        for (const source of sources) {
+            options.roll.load(source === null || source === void 0 ? void 0 : source.roll);
+        }
+    }
+    update(particle, delta) {
+        if (!this.isEnabled(particle)) {
+            return;
+        }
+        updateRoll(particle, delta);
+    }
+}

package/esm/index.js

@@ -0,0 +1,4 @@
+import { RollUpdater } from "./RollUpdater";
+export async function loadRollUpdater(engine) {
+    await engine.addParticleUpdater("roll", () => new RollUpdater());
+}

package/package.json

@@ -0,0 +1,82 @@
+{
+  "name": "@tsparticles/updater-roll",
+  "version": "3.0.0-alpha.0",
+  "description": "tsParticles particles roll updater",
+  "homepage": "https://particles.js.org",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/matteobruni/tsparticles.git",
+    "directory": "updaters/roll"
+  },
+  "keywords": [
+    "front-end",
+    "frontend",
+    "tsparticles",
+    "particles.js",
+    "particlesjs",
+    "particles",
+    "particle",
+    "canvas",
+    "jsparticles",
+    "xparticles",
+    "particles-js",
+    "particles-bg",
+    "particles-bg-vue",
+    "particles-ts",
+    "particles.ts",
+    "react-particles-js",
+    "react-particles.js",
+    "react-particles",
+    "react",
+    "reactjs",
+    "vue-particles",
+    "ngx-particles",
+    "angular-particles",
+    "particleground",
+    "vue",
+    "vuejs",
+    "preact",
+    "preactjs",
+    "jquery",
+    "angularjs",
+    "angular",
+    "typescript",
+    "javascript",
+    "animation",
+    "web",
+    "html5",
+    "web-design",
+    "webdesign",
+    "css",
+    "html",
+    "css3",
+    "animated",
+    "background",
+    "confetti",
+    "canvas",
+    "fireworks",
+    "fireworks-js",
+    "confetti-js",
+    "confettijs",
+    "fireworksjs",
+    "canvas-confetti",
+    "@tsparticles/plugin",
+    "@tsparticles/updater"
+  ],
+  "author": "Matteo Bruni <matteo.bruni@me.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/matteobruni/tsparticles/issues"
+  },
+  "main": "cjs/index.js",
+  "jsdelivr": "tsparticles.updater.roll.min.js",
+  "unpkg": "tsparticles.updater.roll.min.js",
+  "module": "esm/index.js",
+  "types": "types/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@tsparticles/engine": "^3.0.0-alpha.0"
+  }
+}