@tsparticles/engine 3.2.2 → 3.4.0

package/browser/Core/Engine.js

@@ -1,11 +1,13 @@
 import { errorPrefix, generatedAttribute } from "./Utils/Constants.js";
 import { executeOnSingleOrMultiple, getLogger, itemFromSingleOrMultiple } from "../Utils/Utils.js";
+import { Container } from "./Container.js";
 import { EventDispatcher } from "../Utils/EventDispatcher.js";
+import { EventType } from "../Enums/Types/EventType.js";
 import { getRandom } from "../Utils/NumberUtils.js";
 async function getItemsFromInitializer(container, map, initializers, force = false) {
     let res = map.get(container);
     if (!res || force) {
-        res = await Promise.all([...initializers.values()].map((t) => t(container)));
+        res = await Promise.all([...initializers.values()].map(t => t(container)));
         map.set(container, res);
     }
     return res;
@@ -22,6 +24,46 @@ async function getDataFromUrl(data) {
     getLogger().error(`${errorPrefix} ${response.status} while retrieving config file`);
     return data.fallback;
 }
+const generatedTrue = "true", generatedFalse = "false", canvasTag = "canvas", getCanvasFromContainer = (domContainer) => {
+    let canvasEl;
+    if (domContainer instanceof HTMLCanvasElement || domContainer.tagName.toLowerCase() === canvasTag) {
+        canvasEl = domContainer;
+        if (!canvasEl.dataset[generatedAttribute]) {
+            canvasEl.dataset[generatedAttribute] = generatedFalse;
+        }
+    }
+    else {
+        const existingCanvases = domContainer.getElementsByTagName(canvasTag);
+        if (existingCanvases.length) {
+            const firstIndex = 0;
+            canvasEl = existingCanvases[firstIndex];
+            canvasEl.dataset[generatedAttribute] = generatedFalse;
+        }
+        else {
+            canvasEl = document.createElement(canvasTag);
+            canvasEl.dataset[generatedAttribute] = generatedTrue;
+            domContainer.appendChild(canvasEl);
+        }
+    }
+    const fullPercent = "100%";
+    if (!canvasEl.style.width) {
+        canvasEl.style.width = fullPercent;
+    }
+    if (!canvasEl.style.height) {
+        canvasEl.style.height = fullPercent;
+    }
+    return canvasEl;
+}, getDomContainer = (id, source) => {
+    let domContainer = source ?? document.getElementById(id);
+    if (domContainer) {
+        return domContainer;
+    }
+    domContainer = document.createElement("div");
+    domContainer.id = id;
+    domContainer.dataset[generatedAttribute] = generatedTrue;
+    document.body.append(domContainer);
+    return domContainer;
+};
 export class Engine {
     constructor() {
         this._configs = new Map();
@@ -49,16 +91,19 @@ export class Engine {
         }
         return res;
     }
+    get items() {
+        return this._domArray;
+    }
     get version() {
-        return "3.2.2";
+        return "3.4.0";
     }
     addConfig(config) {
         const key = config.key ?? config.name ?? "default";
         this._configs.set(key, config);
-        this._eventDispatcher.dispatchEvent("configAdded", { data: { name: key, config } });
+        this._eventDispatcher.dispatchEvent(EventType.configAdded, { data: { name: key, config } });
     }
     async addEffect(effect, drawer, refresh = true) {
-        executeOnSingleOrMultiple(effect, (type) => {
+        executeOnSingleOrMultiple(effect, type => {
             if (!this.getEffectDrawer(type)) {
                 this.effectDrawers.set(type, drawer);
             }
@@ -98,12 +143,13 @@ export class Engine {
         }
         await this.refresh(refresh);
     }
-    async addShape(shape, drawer, refresh = true) {
-        executeOnSingleOrMultiple(shape, (type) => {
-            if (!this.getShapeDrawer(type)) {
-                this.shapeDrawers.set(type, drawer);
+    async addShape(drawer, refresh = true) {
+        for (const validType of drawer.validTypes) {
+            if (this.getShapeDrawer(validType)) {
+                continue;
             }
-        });
+            this.shapeDrawers.set(validType, drawer);
+        }
         await this.refresh(refresh);
     }
     clearPlugins(container) {
@@ -115,16 +161,10 @@ export class Engine {
         this._eventDispatcher.dispatchEvent(type, args);
     }
     dom() {
-        return this._domArray;
+        return this.items;
     }
     domItem(index) {
-        const dom = this.dom(), item = dom[index];
-        if (!item || item.destroyed) {
-            const deleteCount = 1;
-            dom.splice(index, deleteCount);
-            return;
-        }
-        return item;
+        return this.item(index);
     }
     async getAvailablePlugins(container) {
         const res = new Map();
@@ -139,16 +179,16 @@ export class Engine {
         return this.effectDrawers.get(type);
     }
     async getInteractors(container, force = false) {
-        return await getItemsFromInitializer(container, this.interactors, this._initializers.interactors, force);
+        return getItemsFromInitializer(container, this.interactors, this._initializers.interactors, force);
     }
     async getMovers(container, force = false) {
-        return await getItemsFromInitializer(container, this.movers, this._initializers.movers, force);
+        return getItemsFromInitializer(container, this.movers, this._initializers.movers, force);
     }
     getPathGenerator(type) {
         return this.pathGenerators.get(type);
     }
     getPlugin(plugin) {
-        return this.plugins.find((t) => t.id === plugin);
+        return this.plugins.find(t => t.id === plugin);
     }
     getPreset(preset) {
         return this.presets.get(preset);
@@ -163,7 +203,7 @@ export class Engine {
         return this.shapeDrawers.keys();
     }
     async getUpdaters(container, force = false) {
-        return await getItemsFromInitializer(container, this.updaters, this._initializers.updaters, force);
+        return getItemsFromInitializer(container, this.updaters, this._initializers.updaters, force);
     }
     init() {
         if (this._initialized) {
@@ -171,89 +211,57 @@ export class Engine {
         }
         this._initialized = true;
     }
+    item(index) {
+        const { items } = this, item = items[index];
+        if (!item || item.destroyed) {
+            const deleteCount = 1;
+            items.splice(index, deleteCount);
+            return;
+        }
+        return item;
+    }
     async load(params) {
         const randomFactor = 10000, id = params.id ?? params.element?.id ?? `tsparticles${Math.floor(getRandom() * randomFactor)}`, { index, url } = params, options = url ? await getDataFromUrl({ fallback: params.options, url, index }) : params.options;
-        let domContainer = params.element ?? document.getElementById(id);
-        if (!domContainer) {
-            domContainer = document.createElement("div");
-            domContainer.id = id;
-            document.body.append(domContainer);
-        }
-        const currentOptions = itemFromSingleOrMultiple(options, index), dom = this.dom(), oldIndex = dom.findIndex((v) => v.id.description === id), minIndex = 0;
+        const currentOptions = itemFromSingleOrMultiple(options, index), { items } = this, oldIndex = items.findIndex(v => v.id.description === id), minIndex = 0, newItem = new Container(this, id, currentOptions);
         if (oldIndex >= minIndex) {
-            const old = this.domItem(oldIndex);
+            const old = this.item(oldIndex), one = 1, none = 0, deleteCount = old ? one : none;
             if (old && !old.destroyed) {
-                old.destroy();
-                const deleteCount = 1;
-                dom.splice(oldIndex, deleteCount);
-            }
-        }
-        let canvasEl;
-        if (domContainer.tagName.toLowerCase() === "canvas") {
-            canvasEl = domContainer;
-            canvasEl.dataset[generatedAttribute] = "false";
-        }
-        else {
-            const existingCanvases = domContainer.getElementsByTagName("canvas");
-            if (existingCanvases.length) {
-                const firstIndex = 0;
-                canvasEl = existingCanvases[firstIndex];
-                canvasEl.dataset[generatedAttribute] = "false";
+                old.destroy(false);
             }
-            else {
-                canvasEl = document.createElement("canvas");
-                canvasEl.dataset[generatedAttribute] = "true";
-                domContainer.appendChild(canvasEl);
-            }
-        }
-        if (!canvasEl.style.width) {
-            canvasEl.style.width = "100%";
-        }
-        if (!canvasEl.style.height) {
-            canvasEl.style.height = "100%";
-        }
-        const { Container } = await import("./Container.js"), newItem = new Container(this, id, currentOptions);
-        if (oldIndex >= minIndex) {
-            const deleteCount = 0;
-            dom.splice(oldIndex, deleteCount, newItem);
+            items.splice(oldIndex, deleteCount, newItem);
         }
         else {
-            dom.push(newItem);
+            items.push(newItem);
         }
+        const domContainer = getDomContainer(id, params.element), canvasEl = getCanvasFromContainer(domContainer);
         newItem.canvas.loadCanvas(canvasEl);
         await newItem.start();
         return newItem;
     }
     loadOptions(options, sourceOptions) {
-        for (const plugin of this.plugins) {
-            plugin.loadOptions(options, sourceOptions);
-        }
+        this.plugins.forEach(plugin => plugin.loadOptions?.(options, sourceOptions));
     }
     loadParticlesOptions(container, options, ...sourceOptions) {
         const updaters = this.updaters.get(container);
         if (!updaters) {
             return;
         }
-        for (const updater of updaters) {
-            updater.loadOptions?.(options, ...sourceOptions);
-        }
+        updaters.forEach(updater => updater.loadOptions?.(options, ...sourceOptions));
     }
     async refresh(refresh = true) {
         if (!refresh) {
             return;
         }
-        await Promise.all(this.dom().map((t) => t.refresh()));
+        await Promise.all(this.items.map(t => t.refresh()));
     }
     removeEventListener(type, listener) {
         this._eventDispatcher.removeEventListener(type, listener);
     }
     setOnClickHandler(callback) {
-        const dom = this.dom();
-        if (!dom.length) {
+        const { items } = this;
+        if (!items.length) {
             throw new Error(`${errorPrefix} can only set click handlers after calling tsParticles.load()`);
         }
-        for (const domItem of dom) {
-            domItem.addClickHandler(callback);
-        }
+        items.forEach(item => item.addClickHandler(callback));
     }
 }

package/browser/Core/Particle.js

@@ -3,10 +3,15 @@ import { calcExactPositionOrRandomFromSize, clamp, degToRad, getDistance, getPar
 import { deepExtend, getPosition, initParticleNumericAnimationValue, isInArray, itemFromSingleOrMultiple, } from "../Utils/Utils.js";
 import { errorPrefix, millisecondsToSeconds } from "./Utils/Constants.js";
 import { getHslFromAnimation, rangeColorToRgb } from "../Utils/ColorUtils.js";
+import { EventType } from "../Enums/Types/EventType.js";
 import { Interactivity } from "../Options/Classes/Interactivity/Interactivity.js";
+import { MoveDirection } from "../Enums/Directions/MoveDirection.js";
+import { OutMode } from "../Enums/Modes/OutMode.js";
+import { ParticleOutType } from "../Enums/Types/ParticleOutType.js";
+import { PixelMode } from "../Enums/Modes/PixelMode.js";
 import { alterHsl } from "../Utils/CanvasUtils.js";
 import { loadParticlesOptions } from "../Utils/OptionsUtils.js";
-const defaultRetryCount = 0, double = 2, half = 0.5, squareExp = 2;
+const defaultRetryCount = 0, double = 2, half = 0.5, squareExp = 2, randomString = "random";
 function loadEffectData(effect, effectOptions, id, reduceDuplicates) {
     const effectData = effectOptions.options[effect];
     if (!effectData) {
@@ -55,7 +60,7 @@ export class Particle {
             }), pos = Vector3d.create(exactPosition.x, exactPosition.y, zIndex), radius = this.getRadius(), outModes = this.options.move.outModes, fixHorizontal = (outMode) => {
                 fixOutMode({
                     outMode,
-                    checkModes: ["bounce"],
+                    checkModes: [OutMode.bounce],
                     coord: pos.x,
                     maxCoord: container.canvas.size.width,
                     setCb: (value) => (pos.x += value),
@@ -64,7 +69,7 @@ export class Particle {
             }, fixVertical = (outMode) => {
                 fixOutMode({
                     outMode,
-                    checkModes: ["bounce"],
+                    checkModes: [OutMode.bounce],
                     coord: pos.y,
                     maxCoord: container.canvas.size.height,
                     setCb: (value) => (pos.y += value),
@@ -83,7 +88,7 @@ export class Particle {
         };
         this._calculateVelocity = () => {
             const baseVelocity = getParticleBaseVelocity(this.direction), res = baseVelocity.copy(), moveOptions = this.options.move;
-            if (moveOptions.direction === "inside" || moveOptions.direction === "outside") {
+            if (moveOptions.direction === MoveDirection.inside || moveOptions.direction === MoveDirection.outside) {
                 return res;
             }
             const rad = degToRad(getRangeValue(moveOptions.angle.value)), radOffset = degToRad(getRangeValue(moveOptions.angle.offset)), range = {
@@ -111,9 +116,9 @@ export class Particle {
             if (retries >= minRetries && tryCount > retries) {
                 throw new Error(`${errorPrefix} particle is overlapping and can't be placed`);
             }
-            return !!this.container.particles.find((particle) => getDistance(pos, particle.position) < radius + particle.getRadius());
+            return !!this.container.particles.find(particle => getDistance(pos, particle.position) < radius + particle.getRadius());
         };
-        this._getRollColor = (color) => {
+        this._getRollColor = color => {
             if (!color || !this.roll || (!this.backColor && !this.roll.alter)) {
                 return color;
             }
@@ -129,7 +134,7 @@ export class Particle {
             }
             return color;
         };
-        this._initPosition = (position) => {
+        this._initPosition = position => {
             const container = this.container, zIndexValue = getRangeValue(this.options.zIndex.value), minZ = 0;
             this.position = this._calcPosition(container, position, clamp(zIndexValue, minZ, container.zLayers));
             this.initialPosition = this.position.copy();
@@ -137,15 +142,15 @@ export class Particle {
             this.moveCenter = {
                 ...getPosition(this.options.move.center, canvasSize),
                 radius: this.options.move.center.radius ?? defaultRadius,
-                mode: this.options.move.center.mode ?? "percent",
+                mode: this.options.move.center.mode ?? PixelMode.percent,
             };
             this.direction = getParticleDirectionAngle(this.options.move.direction, this.position, this.moveCenter);
             switch (this.options.move.direction) {
-                case "inside":
-                    this.outType = "inside";
+                case MoveDirection.inside:
+                    this.outType = ParticleOutType.inside;
                     break;
-                case "outside":
-                    this.outType = "outside";
+                case MoveDirection.outside:
+                    this.outType = ParticleOutType.outside;
                     break;
             }
             this.offset = Vector.origin;
@@ -168,19 +173,19 @@ export class Particle {
             updater.particleDestroyed?.(this, override);
         }
         pathGenerator?.reset(this);
-        this._engine.dispatchEvent("particleDestroyed", {
+        this._engine.dispatchEvent(EventType.particleDestroyed, {
             container: this.container,
             data: {
                 particle: this,
             },
         });
     }
-    async draw(delta) {
+    draw(delta) {
         const container = this.container, canvas = container.canvas;
         for (const [, plugin] of container.plugins) {
-            await canvas.drawParticlePlugin(plugin, this, delta);
+            canvas.drawParticlePlugin(plugin, this, delta);
         }
-        await canvas.drawParticle(this, delta);
+        canvas.drawParticle(this, delta);
     }
     getFillColor() {
         return this._getRollColor(this.bubble.color ?? getHslFromAnimation(this.color));
@@ -201,7 +206,7 @@ export class Particle {
     getStrokeColor() {
         return this._getRollColor(this.bubble.color ?? getHslFromAnimation(this.strokeColor));
     }
-    async init(id, position, overrideOptions, group) {
+    init(id, position, overrideOptions, group) {
         const container = this.container, engine = this._engine;
         this.id = id;
         this.group = group;
@@ -213,14 +218,15 @@ export class Particle {
         this.lastPathTime = 0;
         this.destroyed = false;
         this.unbreakable = false;
+        this.isRotating = false;
         this.rotation = 0;
         this.misplaced = false;
         this.retina = {
             maxDistance: {},
         };
-        this.outType = "normal";
+        this.outType = ParticleOutType.normal;
         this.ignoresResizeRatio = true;
-        const pxRatio = container.retina.pixelRatio, mainOptions = container.actualOptions, particlesOptions = loadParticlesOptions(this._engine, container, mainOptions.particles), effectType = particlesOptions.effect.type, shapeType = particlesOptions.shape.type, { reduceDuplicates } = particlesOptions;
+        const pxRatio = container.retina.pixelRatio, mainOptions = container.actualOptions, particlesOptions = loadParticlesOptions(this._engine, container, mainOptions.particles), { reduceDuplicates } = particlesOptions, effectType = particlesOptions.effect.type, shapeType = particlesOptions.shape.type;
         this.effect = itemFromSingleOrMultiple(effectType, this.id, reduceDuplicates);
         this.shape = itemFromSingleOrMultiple(shapeType, this.id, reduceDuplicates);
         const effectOptions = particlesOptions.effect, shapeOptions = particlesOptions.shape;
@@ -240,6 +246,14 @@ export class Particle {
                 }
             }
         }
+        if (this.effect === randomString) {
+            const availableEffects = [...this.container.effectDrawers.keys()];
+            this.effect = availableEffects[Math.floor(Math.random() * availableEffects.length)];
+        }
+        if (this.shape === randomString) {
+            const availableShapes = [...this.container.shapeDrawers.keys()];
+            this.shape = availableShapes[Math.floor(Math.random() * availableShapes.length)];
+        }
         this.effectData = loadEffectData(this.effect, effectOptions, this.id, reduceDuplicates);
         this.shapeData = loadShapeData(this.shape, shapeOptions, this.id, reduceDuplicates);
         particlesOptions.load(overrideOptions);
@@ -265,7 +279,7 @@ export class Particle {
         if (pathOptions.generator) {
             this.pathGenerator = this._engine.getPathGenerator(pathOptions.generator);
             if (this.pathGenerator && container.addPath(pathOptions.generator, this.pathGenerator)) {
-                await this.pathGenerator.init(container);
+                this.pathGenerator.init(container);
             }
         }
         container.retina.initParticle(this);
@@ -294,7 +308,7 @@ export class Particle {
             }
         }
         if (effectDrawer?.loadEffect) {
-            await effectDrawer.loadEffect(this);
+            effectDrawer.loadEffect(this);
         }
         let shapeDrawer = container.shapeDrawers.get(this.shape);
         if (!shapeDrawer) {
@@ -304,7 +318,7 @@ export class Particle {
             }
         }
         if (shapeDrawer?.loadShape) {
-            await shapeDrawer.loadShape(this);
+            shapeDrawer.loadShape(this);
         }
         const sideCountFunc = shapeDrawer?.getSidesCount;
         if (sideCountFunc) {
@@ -313,13 +327,13 @@ export class Particle {
         this.spawning = false;
         this.shadowColor = rangeColorToRgb(this.options.shadow.color);
         for (const updater of particles.updaters) {
-            await updater.init(this);
+            updater.init(this);
         }
         for (const mover of particles.movers) {
-            await mover.init?.(this);
+            mover.init?.(this);
         }
-        await effectDrawer?.particleInit?.(container, this);
-        await shapeDrawer?.particleInit?.(container, this);
+        effectDrawer?.particleInit?.(container, this);
+        shapeDrawer?.particleInit?.(container, this);
         for (const [, plugin] of container.plugins) {
             plugin.particleCreated?.(this);
         }