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

package/browser/Options/Classes/Tilt.js

@@ -0,0 +1,24 @@
+import { TiltAnimation } from "./TiltAnimation";
+import { ValueWithRandom } from "@tsparticles/engine";
+export class Tilt extends ValueWithRandom {
+    constructor() {
+        super();
+        this.animation = new TiltAnimation();
+        this.direction = "clockwise";
+        this.enable = false;
+        this.value = 0;
+    }
+    load(data) {
+        super.load(data);
+        if (!data) {
+            return;
+        }
+        this.animation.load(data.animation);
+        if (data.direction !== undefined) {
+            this.direction = data.direction;
+        }
+        if (data.enable !== undefined) {
+            this.enable = data.enable;
+        }
+    }
+}

package/browser/Options/Classes/TiltAnimation.js

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

package/browser/Options/Interfaces/ITilt.js

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

package/browser/Options/Interfaces/ITiltAnimation.js

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

package/browser/TiltDirection.js

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

package/browser/TiltUpdater.js

@@ -0,0 +1,97 @@
+import { getRandom, getRangeValue } from "@tsparticles/engine";
+import { Tilt } from "./Options/Classes/Tilt";
+function updateTilt(particle, delta) {
+    var _a, _b;
+    if (!particle.tilt || !particle.options.tilt) {
+        return;
+    }
+    const tilt = particle.options.tilt, tiltAnimation = tilt.animation, speed = ((_a = particle.tilt.velocity) !== null && _a !== void 0 ? _a : 0) * delta.factor, max = 2 * Math.PI, decay = (_b = particle.tilt.decay) !== null && _b !== void 0 ? _b : 1;
+    if (!tiltAnimation.enable) {
+        return;
+    }
+    switch (particle.tilt.status) {
+        case "increasing":
+            particle.tilt.value += speed;
+            if (particle.tilt.value > max) {
+                particle.tilt.value -= max;
+            }
+            break;
+        case "decreasing":
+        default:
+            particle.tilt.value -= speed;
+            if (particle.tilt.value < 0) {
+                particle.tilt.value += max;
+            }
+            break;
+    }
+    if (particle.tilt.velocity && decay !== 1) {
+        particle.tilt.velocity *= decay;
+    }
+}
+export class TiltUpdater {
+    constructor(container) {
+        this.container = container;
+    }
+    getTransformValues(particle) {
+        var _a;
+        const tilt = ((_a = particle.tilt) === null || _a === void 0 ? void 0 : _a.enable) && particle.tilt;
+        return {
+            b: tilt ? Math.cos(tilt.value) * tilt.cosDirection : undefined,
+            c: tilt ? Math.sin(tilt.value) * tilt.sinDirection : undefined,
+        };
+    }
+    init(particle) {
+        var _a;
+        const tiltOptions = particle.options.tilt;
+        if (!tiltOptions) {
+            return;
+        }
+        particle.tilt = {
+            enable: tiltOptions.enable,
+            value: (getRangeValue(tiltOptions.value) * Math.PI) / 180,
+            sinDirection: getRandom() >= 0.5 ? 1 : -1,
+            cosDirection: getRandom() >= 0.5 ? 1 : -1,
+        };
+        let tiltDirection = tiltOptions.direction;
+        if (tiltDirection === "random") {
+            const index = Math.floor(getRandom() * 2);
+            tiltDirection = index > 0 ? "counter-clockwise" : "clockwise";
+        }
+        switch (tiltDirection) {
+            case "counter-clockwise":
+            case "counterClockwise":
+                particle.tilt.status = "decreasing";
+                break;
+            case "clockwise":
+                particle.tilt.status = "increasing";
+                break;
+        }
+        const tiltAnimation = (_a = particle.options.tilt) === null || _a === void 0 ? void 0 : _a.animation;
+        if (tiltAnimation === null || tiltAnimation === void 0 ? void 0 : tiltAnimation.enable) {
+            particle.tilt.decay = 1 - getRangeValue(tiltAnimation.decay);
+            particle.tilt.velocity = (getRangeValue(tiltAnimation.speed) / 360) * this.container.retina.reduceFactor;
+            if (!tiltAnimation.sync) {
+                particle.tilt.velocity *= getRandom();
+            }
+        }
+    }
+    isEnabled(particle) {
+        var _a;
+        const tiltAnimation = (_a = particle.options.tilt) === null || _a === void 0 ? void 0 : _a.animation;
+        return !particle.destroyed && !particle.spawning && !!(tiltAnimation === null || tiltAnimation === void 0 ? void 0 : tiltAnimation.enable);
+    }
+    loadOptions(options, ...sources) {
+        if (!options.tilt) {
+            options.tilt = new Tilt();
+        }
+        for (const source of sources) {
+            options.tilt.load(source === null || source === void 0 ? void 0 : source.tilt);
+        }
+    }
+    update(particle, delta) {
+        if (!this.isEnabled(particle)) {
+            return;
+        }
+        updateTilt(particle, delta);
+    }
+}

package/browser/index.js

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

package/cjs/Options/Classes/Tilt.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Tilt = void 0;
+const TiltAnimation_1 = require("./TiltAnimation");
+const engine_1 = require("@tsparticles/engine");
+class Tilt extends engine_1.ValueWithRandom {
+    constructor() {
+        super();
+        this.animation = new TiltAnimation_1.TiltAnimation();
+        this.direction = "clockwise";
+        this.enable = false;
+        this.value = 0;
+    }
+    load(data) {
+        super.load(data);
+        if (!data) {
+            return;
+        }
+        this.animation.load(data.animation);
+        if (data.direction !== undefined) {
+            this.direction = data.direction;
+        }
+        if (data.enable !== undefined) {
+            this.enable = data.enable;
+        }
+    }
+}
+exports.Tilt = Tilt;

package/cjs/Options/Classes/TiltAnimation.js

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

package/cjs/Options/Interfaces/ITilt.js

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

package/cjs/Options/Interfaces/ITiltAnimation.js

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

package/cjs/TiltDirection.js

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

package/cjs/TiltUpdater.js

@@ -0,0 +1,101 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TiltUpdater = void 0;
+const engine_1 = require("@tsparticles/engine");
+const Tilt_1 = require("./Options/Classes/Tilt");
+function updateTilt(particle, delta) {
+    var _a, _b;
+    if (!particle.tilt || !particle.options.tilt) {
+        return;
+    }
+    const tilt = particle.options.tilt, tiltAnimation = tilt.animation, speed = ((_a = particle.tilt.velocity) !== null && _a !== void 0 ? _a : 0) * delta.factor, max = 2 * Math.PI, decay = (_b = particle.tilt.decay) !== null && _b !== void 0 ? _b : 1;
+    if (!tiltAnimation.enable) {
+        return;
+    }
+    switch (particle.tilt.status) {
+        case "increasing":
+            particle.tilt.value += speed;
+            if (particle.tilt.value > max) {
+                particle.tilt.value -= max;
+            }
+            break;
+        case "decreasing":
+        default:
+            particle.tilt.value -= speed;
+            if (particle.tilt.value < 0) {
+                particle.tilt.value += max;
+            }
+            break;
+    }
+    if (particle.tilt.velocity && decay !== 1) {
+        particle.tilt.velocity *= decay;
+    }
+}
+class TiltUpdater {
+    constructor(container) {
+        this.container = container;
+    }
+    getTransformValues(particle) {
+        var _a;
+        const tilt = ((_a = particle.tilt) === null || _a === void 0 ? void 0 : _a.enable) && particle.tilt;
+        return {
+            b: tilt ? Math.cos(tilt.value) * tilt.cosDirection : undefined,
+            c: tilt ? Math.sin(tilt.value) * tilt.sinDirection : undefined,
+        };
+    }
+    init(particle) {
+        var _a;
+        const tiltOptions = particle.options.tilt;
+        if (!tiltOptions) {
+            return;
+        }
+        particle.tilt = {
+            enable: tiltOptions.enable,
+            value: ((0, engine_1.getRangeValue)(tiltOptions.value) * Math.PI) / 180,
+            sinDirection: (0, engine_1.getRandom)() >= 0.5 ? 1 : -1,
+            cosDirection: (0, engine_1.getRandom)() >= 0.5 ? 1 : -1,
+        };
+        let tiltDirection = tiltOptions.direction;
+        if (tiltDirection === "random") {
+            const index = Math.floor((0, engine_1.getRandom)() * 2);
+            tiltDirection = index > 0 ? "counter-clockwise" : "clockwise";
+        }
+        switch (tiltDirection) {
+            case "counter-clockwise":
+            case "counterClockwise":
+                particle.tilt.status = "decreasing";
+                break;
+            case "clockwise":
+                particle.tilt.status = "increasing";
+                break;
+        }
+        const tiltAnimation = (_a = particle.options.tilt) === null || _a === void 0 ? void 0 : _a.animation;
+        if (tiltAnimation === null || tiltAnimation === void 0 ? void 0 : tiltAnimation.enable) {
+            particle.tilt.decay = 1 - (0, engine_1.getRangeValue)(tiltAnimation.decay);
+            particle.tilt.velocity = ((0, engine_1.getRangeValue)(tiltAnimation.speed) / 360) * this.container.retina.reduceFactor;
+            if (!tiltAnimation.sync) {
+                particle.tilt.velocity *= (0, engine_1.getRandom)();
+            }
+        }
+    }
+    isEnabled(particle) {
+        var _a;
+        const tiltAnimation = (_a = particle.options.tilt) === null || _a === void 0 ? void 0 : _a.animation;
+        return !particle.destroyed && !particle.spawning && !!(tiltAnimation === null || tiltAnimation === void 0 ? void 0 : tiltAnimation.enable);
+    }
+    loadOptions(options, ...sources) {
+        if (!options.tilt) {
+            options.tilt = new Tilt_1.Tilt();
+        }
+        for (const source of sources) {
+            options.tilt.load(source === null || source === void 0 ? void 0 : source.tilt);
+        }
+    }
+    update(particle, delta) {
+        if (!this.isEnabled(particle)) {
+            return;
+        }
+        updateTilt(particle, delta);
+    }
+}
+exports.TiltUpdater = TiltUpdater;

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.loadTiltUpdater = void 0;
+const TiltUpdater_1 = require("./TiltUpdater");
+function loadTiltUpdater(engine) {
+    return __awaiter(this, void 0, void 0, function* () {
+        yield engine.addParticleUpdater("tilt", (container) => new TiltUpdater_1.TiltUpdater(container));
+    });
+}
+exports.loadTiltUpdater = loadTiltUpdater;

package/esm/Options/Classes/Tilt.js

@@ -0,0 +1,24 @@
+import { TiltAnimation } from "./TiltAnimation";
+import { ValueWithRandom } from "@tsparticles/engine";
+export class Tilt extends ValueWithRandom {
+    constructor() {
+        super();
+        this.animation = new TiltAnimation();
+        this.direction = "clockwise";
+        this.enable = false;
+        this.value = 0;
+    }
+    load(data) {
+        super.load(data);
+        if (!data) {
+            return;
+        }
+        this.animation.load(data.animation);
+        if (data.direction !== undefined) {
+            this.direction = data.direction;
+        }
+        if (data.enable !== undefined) {
+            this.enable = data.enable;
+        }
+    }
+}

package/esm/Options/Classes/TiltAnimation.js

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

package/esm/Options/Interfaces/ITilt.js

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

package/esm/Options/Interfaces/ITiltAnimation.js

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

package/esm/TiltDirection.js

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

package/esm/TiltUpdater.js

@@ -0,0 +1,97 @@
+import { getRandom, getRangeValue } from "@tsparticles/engine";
+import { Tilt } from "./Options/Classes/Tilt";
+function updateTilt(particle, delta) {
+    var _a, _b;
+    if (!particle.tilt || !particle.options.tilt) {
+        return;
+    }
+    const tilt = particle.options.tilt, tiltAnimation = tilt.animation, speed = ((_a = particle.tilt.velocity) !== null && _a !== void 0 ? _a : 0) * delta.factor, max = 2 * Math.PI, decay = (_b = particle.tilt.decay) !== null && _b !== void 0 ? _b : 1;
+    if (!tiltAnimation.enable) {
+        return;
+    }
+    switch (particle.tilt.status) {
+        case "increasing":
+            particle.tilt.value += speed;
+            if (particle.tilt.value > max) {
+                particle.tilt.value -= max;
+            }
+            break;
+        case "decreasing":
+        default:
+            particle.tilt.value -= speed;
+            if (particle.tilt.value < 0) {
+                particle.tilt.value += max;
+            }
+            break;
+    }
+    if (particle.tilt.velocity && decay !== 1) {
+        particle.tilt.velocity *= decay;
+    }
+}
+export class TiltUpdater {
+    constructor(container) {
+        this.container = container;
+    }
+    getTransformValues(particle) {
+        var _a;
+        const tilt = ((_a = particle.tilt) === null || _a === void 0 ? void 0 : _a.enable) && particle.tilt;
+        return {
+            b: tilt ? Math.cos(tilt.value) * tilt.cosDirection : undefined,
+            c: tilt ? Math.sin(tilt.value) * tilt.sinDirection : undefined,
+        };
+    }
+    init(particle) {
+        var _a;
+        const tiltOptions = particle.options.tilt;
+        if (!tiltOptions) {
+            return;
+        }
+        particle.tilt = {
+            enable: tiltOptions.enable,
+            value: (getRangeValue(tiltOptions.value) * Math.PI) / 180,
+            sinDirection: getRandom() >= 0.5 ? 1 : -1,
+            cosDirection: getRandom() >= 0.5 ? 1 : -1,
+        };
+        let tiltDirection = tiltOptions.direction;
+        if (tiltDirection === "random") {
+            const index = Math.floor(getRandom() * 2);
+            tiltDirection = index > 0 ? "counter-clockwise" : "clockwise";
+        }
+        switch (tiltDirection) {
+            case "counter-clockwise":
+            case "counterClockwise":
+                particle.tilt.status = "decreasing";
+                break;
+            case "clockwise":
+                particle.tilt.status = "increasing";
+                break;
+        }
+        const tiltAnimation = (_a = particle.options.tilt) === null || _a === void 0 ? void 0 : _a.animation;
+        if (tiltAnimation === null || tiltAnimation === void 0 ? void 0 : tiltAnimation.enable) {
+            particle.tilt.decay = 1 - getRangeValue(tiltAnimation.decay);
+            particle.tilt.velocity = (getRangeValue(tiltAnimation.speed) / 360) * this.container.retina.reduceFactor;
+            if (!tiltAnimation.sync) {
+                particle.tilt.velocity *= getRandom();
+            }
+        }
+    }
+    isEnabled(particle) {
+        var _a;
+        const tiltAnimation = (_a = particle.options.tilt) === null || _a === void 0 ? void 0 : _a.animation;
+        return !particle.destroyed && !particle.spawning && !!(tiltAnimation === null || tiltAnimation === void 0 ? void 0 : tiltAnimation.enable);
+    }
+    loadOptions(options, ...sources) {
+        if (!options.tilt) {
+            options.tilt = new Tilt();
+        }
+        for (const source of sources) {
+            options.tilt.load(source === null || source === void 0 ? void 0 : source.tilt);
+        }
+    }
+    update(particle, delta) {
+        if (!this.isEnabled(particle)) {
+            return;
+        }
+        updateTilt(particle, delta);
+    }
+}

package/esm/index.js

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