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

package/browser/CircleWarp.js

@@ -0,0 +1,50 @@
+import { Circle, Rectangle } from "@tsparticles/engine";
+export class CircleWarp extends Circle {
+    constructor(x, y, radius, canvasSize) {
+        super(x, y, radius);
+        this.canvasSize = canvasSize;
+        this.canvasSize = Object.assign({}, canvasSize);
+    }
+    contains(point) {
+        if (super.contains(point)) {
+            return true;
+        }
+        const posNE = {
+            x: point.x - this.canvasSize.width,
+            y: point.y,
+        };
+        if (super.contains(posNE)) {
+            return true;
+        }
+        const posSE = {
+            x: point.x - this.canvasSize.width,
+            y: point.y - this.canvasSize.height,
+        };
+        if (super.contains(posSE)) {
+            return true;
+        }
+        const posSW = {
+            x: point.x,
+            y: point.y - this.canvasSize.height,
+        };
+        return super.contains(posSW);
+    }
+    intersects(range) {
+        if (super.intersects(range)) {
+            return true;
+        }
+        const rect = range, circle = range, newPos = {
+            x: range.position.x - this.canvasSize.width,
+            y: range.position.y - this.canvasSize.height,
+        };
+        if (circle.radius !== undefined) {
+            const biggerCircle = new Circle(newPos.x, newPos.y, circle.radius * 2);
+            return super.intersects(biggerCircle);
+        }
+        else if (rect.size !== undefined) {
+            const rectSW = new Rectangle(newPos.x, newPos.y, rect.size.width * 2, rect.size.height * 2);
+            return super.intersects(rectSW);
+        }
+        return false;
+    }
+}

package/browser/ILink.js

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

package/browser/LinkContainer.js

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

package/browser/LinkInstance.js

@@ -0,0 +1,143 @@
+import { drawLinkLine, drawLinkTriangle } from "./Utils";
+import { getDistance, getLinkColor, getRandom, getRangeValue, rangeColorToRgb } from "@tsparticles/engine";
+function getLinkKey(ids) {
+    ids.sort((a, b) => a - b);
+    return ids.join("_");
+}
+function setLinkFrequency(particles, dictionary) {
+    const key = getLinkKey(particles.map((t) => t.id));
+    let res = dictionary.get(key);
+    if (res === undefined) {
+        res = getRandom();
+        dictionary.set(key, res);
+    }
+    return res;
+}
+export class LinkInstance {
+    constructor(container) {
+        this.container = container;
+        this._freqs = {
+            links: new Map(),
+            triangles: new Map(),
+        };
+    }
+    drawParticle(context, particle) {
+        var _a;
+        const pOptions = particle.options;
+        if (!particle.links || particle.links.length <= 0) {
+            return;
+        }
+        const p1Links = particle.links.filter((l) => pOptions.links && this.getLinkFrequency(particle, l.destination) <= pOptions.links.frequency);
+        for (const link of p1Links) {
+            this.drawTriangles(pOptions, particle, link, p1Links);
+            if (link.opacity > 0 && ((_a = particle.retina.linksWidth) !== null && _a !== void 0 ? _a : 0) > 0) {
+                this.drawLinkLine(particle, link);
+            }
+        }
+    }
+    async init() {
+        this._freqs.links = new Map();
+        this._freqs.triangles = new Map();
+    }
+    particleCreated(particle) {
+        particle.links = [];
+        if (!particle.options.links) {
+            return;
+        }
+        const ratio = this.container.retina.pixelRatio;
+        particle.retina.linksDistance = particle.options.links.distance * ratio;
+        particle.retina.linksWidth = particle.options.links.width * ratio;
+    }
+    particleDestroyed(particle) {
+        particle.links = [];
+    }
+    drawLinkLine(p1, link) {
+        const container = this.container, options = container.actualOptions, p2 = link.destination, pos1 = p1.getPosition(), pos2 = p2.getPosition();
+        let opacity = link.opacity;
+        container.canvas.draw((ctx) => {
+            var _a, _b, _c;
+            if (!p1.options.links) {
+                return;
+            }
+            let colorLine;
+            const twinkle = (_a = p1.options.twinkle) === null || _a === void 0 ? void 0 : _a.lines;
+            if (twinkle === null || twinkle === void 0 ? void 0 : twinkle.enable) {
+                const twinkleFreq = twinkle.frequency, twinkleRgb = rangeColorToRgb(twinkle.color), twinkling = getRandom() < twinkleFreq;
+                if (twinkling && twinkleRgb) {
+                    colorLine = twinkleRgb;
+                    opacity = getRangeValue(twinkle.opacity);
+                }
+            }
+            if (!colorLine) {
+                const linksOptions = p1.options.links, linkColor = (linksOptions === null || linksOptions === void 0 ? void 0 : linksOptions.id) !== undefined
+                    ? container.particles.linksColors.get(linksOptions.id)
+                    : container.particles.linksColor;
+                colorLine = getLinkColor(p1, p2, linkColor);
+            }
+            if (!colorLine) {
+                return;
+            }
+            const width = (_b = p1.retina.linksWidth) !== null && _b !== void 0 ? _b : 0, maxDistance = (_c = p1.retina.linksDistance) !== null && _c !== void 0 ? _c : 0;
+            drawLinkLine(ctx, width, pos1, pos2, maxDistance, container.canvas.size, p1.options.links.warp, options.backgroundMask.enable, options.backgroundMask.composite, colorLine, opacity, p1.options.links.shadow);
+        });
+    }
+    drawLinkTriangle(p1, link1, link2) {
+        var _a;
+        if (!p1.options.links) {
+            return;
+        }
+        const container = this.container, options = container.actualOptions, p2 = link1.destination, p3 = link2.destination, triangleOptions = p1.options.links.triangles, opacityTriangle = (_a = triangleOptions.opacity) !== null && _a !== void 0 ? _a : (link1.opacity + link2.opacity) / 2;
+        if (opacityTriangle <= 0) {
+            return;
+        }
+        container.canvas.draw((ctx) => {
+            var _a;
+            const pos1 = p1.getPosition(), pos2 = p2.getPosition(), pos3 = p3.getPosition(), linksDistance = (_a = p1.retina.linksDistance) !== null && _a !== void 0 ? _a : 0;
+            if (getDistance(pos1, pos2) > linksDistance ||
+                getDistance(pos3, pos2) > linksDistance ||
+                getDistance(pos3, pos1) > linksDistance) {
+                return;
+            }
+            let colorTriangle = rangeColorToRgb(triangleOptions.color);
+            if (!colorTriangle) {
+                const linksOptions = p1.options.links, linkColor = (linksOptions === null || linksOptions === void 0 ? void 0 : linksOptions.id) !== undefined
+                    ? container.particles.linksColors.get(linksOptions.id)
+                    : container.particles.linksColor;
+                colorTriangle = getLinkColor(p1, p2, linkColor);
+            }
+            if (!colorTriangle) {
+                return;
+            }
+            drawLinkTriangle(ctx, pos1, pos2, pos3, options.backgroundMask.enable, options.backgroundMask.composite, colorTriangle, opacityTriangle);
+        });
+    }
+    drawTriangles(options, p1, link, p1Links) {
+        var _a, _b, _c;
+        const p2 = link.destination;
+        if (!(((_a = options.links) === null || _a === void 0 ? void 0 : _a.triangles.enable) && ((_b = p2.options.links) === null || _b === void 0 ? void 0 : _b.triangles.enable))) {
+            return;
+        }
+        const vertices = (_c = p2.links) === null || _c === void 0 ? void 0 : _c.filter((t) => {
+            const linkFreq = this.getLinkFrequency(p2, t.destination);
+            return (p2.options.links &&
+                linkFreq <= p2.options.links.frequency &&
+                p1Links.findIndex((l) => l.destination === t.destination) >= 0);
+        });
+        if (!(vertices === null || vertices === void 0 ? void 0 : vertices.length)) {
+            return;
+        }
+        for (const vertex of vertices) {
+            const p3 = vertex.destination, triangleFreq = this.getTriangleFrequency(p1, p2, p3);
+            if (triangleFreq > options.links.triangles.frequency) {
+                continue;
+            }
+            this.drawLinkTriangle(p1, link, vertex);
+        }
+    }
+    getLinkFrequency(p1, p2) {
+        return setLinkFrequency([p1, p2], this._freqs.links);
+    }
+    getTriangleFrequency(p1, p2, p3) {
+        return setLinkFrequency([p1, p2, p3], this._freqs.triangles);
+    }
+}

package/browser/LinkParticle.js

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

package/browser/Linker.js

@@ -0,0 +1,119 @@
+import { Circle, ParticlesInteractorBase, getDistance, getLinkRandomColor } from "@tsparticles/engine";
+import { CircleWarp } from "./CircleWarp";
+import { Links } from "./Options/Classes/Links";
+function getLinkDistance(pos1, pos2, optDistance, canvasSize, warp) {
+    let distance = getDistance(pos1, pos2);
+    if (!warp || distance <= optDistance) {
+        return distance;
+    }
+    const pos2NE = {
+        x: pos2.x - canvasSize.width,
+        y: pos2.y,
+    };
+    distance = getDistance(pos1, pos2NE);
+    if (distance <= optDistance) {
+        return distance;
+    }
+    const pos2SE = {
+        x: pos2.x - canvasSize.width,
+        y: pos2.y - canvasSize.height,
+    };
+    distance = getDistance(pos1, pos2SE);
+    if (distance <= optDistance) {
+        return distance;
+    }
+    const pos2SW = {
+        x: pos2.x,
+        y: pos2.y - canvasSize.height,
+    };
+    distance = getDistance(pos1, pos2SW);
+    return distance;
+}
+export class Linker extends ParticlesInteractorBase {
+    constructor(container) {
+        super(container);
+        this.linkContainer = container;
+    }
+    clear() {
+    }
+    init() {
+        this.linkContainer.particles.linksColor = undefined;
+        this.linkContainer.particles.linksColors = new Map();
+    }
+    async interact(p1) {
+        var _a;
+        if (!p1.options.links) {
+            return;
+        }
+        p1.links = [];
+        const pos1 = p1.getPosition(), container = this.container, canvasSize = container.canvas.size;
+        if (pos1.x < 0 || pos1.y < 0 || pos1.x > canvasSize.width || pos1.y > canvasSize.height) {
+            return;
+        }
+        const linkOpt1 = p1.options.links, optOpacity = linkOpt1.opacity, optDistance = (_a = p1.retina.linksDistance) !== null && _a !== void 0 ? _a : 0, warp = linkOpt1.warp, range = warp
+            ? new CircleWarp(pos1.x, pos1.y, optDistance, canvasSize)
+            : new Circle(pos1.x, pos1.y, optDistance), query = container.particles.quadTree.query(range);
+        for (const p2 of query) {
+            const linkOpt2 = p2.options.links;
+            if (p1 === p2 ||
+                !(linkOpt2 === null || linkOpt2 === void 0 ? void 0 : linkOpt2.enable) ||
+                linkOpt1.id !== linkOpt2.id ||
+                p2.spawning ||
+                p2.destroyed ||
+                !p2.links ||
+                p1.links.map((t) => t.destination).indexOf(p2) !== -1 ||
+                p2.links.map((t) => t.destination).indexOf(p1) !== -1) {
+                continue;
+            }
+            const pos2 = p2.getPosition();
+            if (pos2.x < 0 || pos2.y < 0 || pos2.x > canvasSize.width || pos2.y > canvasSize.height) {
+                continue;
+            }
+            const distance = getLinkDistance(pos1, pos2, optDistance, canvasSize, warp && linkOpt2.warp);
+            if (distance > optDistance) {
+                return;
+            }
+            const opacityLine = (1 - distance / optDistance) * optOpacity;
+            this.setColor(p1);
+            p1.links.push({
+                destination: p2,
+                opacity: opacityLine,
+            });
+        }
+    }
+    isEnabled(particle) {
+        var _a;
+        return !!((_a = particle.options.links) === null || _a === void 0 ? void 0 : _a.enable);
+    }
+    loadParticlesOptions(options, ...sources) {
+        var _a, _b;
+        if (!options.links) {
+            options.links = new Links();
+        }
+        for (const source of sources) {
+            options.links.load((_b = (_a = source === null || source === void 0 ? void 0 : source.links) !== null && _a !== void 0 ? _a : source === null || source === void 0 ? void 0 : source.lineLinked) !== null && _b !== void 0 ? _b : source === null || source === void 0 ? void 0 : source.line_linked);
+        }
+    }
+    reset() {
+    }
+    setColor(p1) {
+        if (!p1.options.links) {
+            return;
+        }
+        const container = this.linkContainer, linksOptions = p1.options.links;
+        let linkColor = linksOptions.id === undefined
+            ? container.particles.linksColor
+            : container.particles.linksColors.get(linksOptions.id);
+        if (linkColor) {
+            return;
+        }
+        const optColor = linksOptions.color;
+        linkColor = getLinkRandomColor(optColor, linksOptions.blink, linksOptions.consent);
+        if (linksOptions.id === undefined) {
+            container.particles.linksColor = linkColor;
+        }
+        else {
+            container.particles.linksColors.set(linksOptions.id, linkColor);
+        }
+    }
+}

package/browser/Options/Classes/Links.js

@@ -0,0 +1,54 @@
+import { LinksShadow } from "./LinksShadow";
+import { LinksTriangle } from "./LinksTriangle";
+import { OptionsColor } from "@tsparticles/engine";
+export class Links {
+    constructor() {
+        this.blink = false;
+        this.color = new OptionsColor();
+        this.color.value = "#fff";
+        this.consent = false;
+        this.distance = 100;
+        this.enable = false;
+        this.frequency = 1;
+        this.opacity = 1;
+        this.shadow = new LinksShadow();
+        this.triangles = new LinksTriangle();
+        this.width = 1;
+        this.warp = false;
+    }
+    load(data) {
+        if (!data) {
+            return;
+        }
+        if (data.id !== undefined) {
+            this.id = data.id;
+        }
+        if (data.blink !== undefined) {
+            this.blink = data.blink;
+        }
+        this.color = OptionsColor.create(this.color, data.color);
+        if (data.consent !== undefined) {
+            this.consent = data.consent;
+        }
+        if (data.distance !== undefined) {
+            this.distance = data.distance;
+        }
+        if (data.enable !== undefined) {
+            this.enable = data.enable;
+        }
+        if (data.frequency !== undefined) {
+            this.frequency = data.frequency;
+        }
+        if (data.opacity !== undefined) {
+            this.opacity = data.opacity;
+        }
+        this.shadow.load(data.shadow);
+        this.triangles.load(data.triangles);
+        if (data.width !== undefined) {
+            this.width = data.width;
+        }
+        if (data.warp !== undefined) {
+            this.warp = data.warp;
+        }
+    }
+}

package/browser/Options/Classes/LinksShadow.js

@@ -0,0 +1,21 @@
+import { OptionsColor } from "@tsparticles/engine";
+export class LinksShadow {
+    constructor() {
+        this.blur = 5;
+        this.color = new OptionsColor();
+        this.color.value = "#000";
+        this.enable = false;
+    }
+    load(data) {
+        if (!data) {
+            return;
+        }
+        if (data.blur !== undefined) {
+            this.blur = data.blur;
+        }
+        this.color = OptionsColor.create(this.color, data.color);
+        if (data.enable !== undefined) {
+            this.enable = data.enable;
+        }
+    }
+}

package/browser/Options/Classes/LinksTriangle.js

@@ -0,0 +1,24 @@
+import { OptionsColor } from "@tsparticles/engine";
+export class LinksTriangle {
+    constructor() {
+        this.enable = false;
+        this.frequency = 1;
+    }
+    load(data) {
+        if (!data) {
+            return;
+        }
+        if (data.color !== undefined) {
+            this.color = OptionsColor.create(this.color, data.color);
+        }
+        if (data.enable !== undefined) {
+            this.enable = data.enable;
+        }
+        if (data.frequency !== undefined) {
+            this.frequency = data.frequency;
+        }
+        if (data.opacity !== undefined) {
+            this.opacity = data.opacity;
+        }
+    }
+}

package/browser/Options/Classes/ParticlesLinkOptions.js

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

package/browser/Options/Interfaces/ILinks.js

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

package/browser/Options/Interfaces/ILinksShadow.js

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

package/browser/Options/Interfaces/ILinksTriangle.js

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

package/browser/Options/Interfaces/IParticlesLinkOptions.js

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

package/browser/Utils.js

@@ -0,0 +1,77 @@
+import { drawLine, drawTriangle, getDistance, getDistances, getStyleFromRgb, rangeColorToRgb, } from "@tsparticles/engine";
+export function drawLinkLine(context, width, begin, end, maxDistance, canvasSize, warp, backgroundMask, composite, colorLine, opacity, shadow) {
+    let drawn = false;
+    if (getDistance(begin, end) <= maxDistance) {
+        drawLine(context, begin, end);
+        drawn = true;
+    }
+    else if (warp) {
+        let pi1;
+        let pi2;
+        const endNE = {
+            x: end.x - canvasSize.width,
+            y: end.y,
+        };
+        const d1 = getDistances(begin, endNE);
+        if (d1.distance <= maxDistance) {
+            const yi = begin.y - (d1.dy / d1.dx) * begin.x;
+            pi1 = { x: 0, y: yi };
+            pi2 = { x: canvasSize.width, y: yi };
+        }
+        else {
+            const endSW = {
+                x: end.x,
+                y: end.y - canvasSize.height,
+            };
+            const d2 = getDistances(begin, endSW);
+            if (d2.distance <= maxDistance) {
+                const yi = begin.y - (d2.dy / d2.dx) * begin.x;
+                const xi = -yi / (d2.dy / d2.dx);
+                pi1 = { x: xi, y: 0 };
+                pi2 = { x: xi, y: canvasSize.height };
+            }
+            else {
+                const endSE = {
+                    x: end.x - canvasSize.width,
+                    y: end.y - canvasSize.height,
+                };
+                const d3 = getDistances(begin, endSE);
+                if (d3.distance <= maxDistance) {
+                    const yi = begin.y - (d3.dy / d3.dx) * begin.x;
+                    const xi = -yi / (d3.dy / d3.dx);
+                    pi1 = { x: xi, y: yi };
+                    pi2 = { x: pi1.x + canvasSize.width, y: pi1.y + canvasSize.height };
+                }
+            }
+        }
+        if (pi1 && pi2) {
+            drawLine(context, begin, pi1);
+            drawLine(context, end, pi2);
+            drawn = true;
+        }
+    }
+    if (!drawn) {
+        return;
+    }
+    context.lineWidth = width;
+    if (backgroundMask) {
+        context.globalCompositeOperation = composite;
+    }
+    context.strokeStyle = getStyleFromRgb(colorLine, opacity);
+    if (shadow.enable) {
+        const shadowColor = rangeColorToRgb(shadow.color);
+        if (shadowColor) {
+            context.shadowBlur = shadow.blur;
+            context.shadowColor = getStyleFromRgb(shadowColor);
+        }
+    }
+    context.stroke();
+}
+export function drawLinkTriangle(context, pos1, pos2, pos3, backgroundMask, composite, colorTriangle, opacityTriangle) {
+    drawTriangle(context, pos1, pos2, pos3);
+    if (backgroundMask) {
+        context.globalCompositeOperation = composite;
+    }
+    context.fillStyle = getStyleFromRgb(colorTriangle, opacityTriangle);
+    context.fill();
+}

package/browser/index.js

@@ -0,0 +1,12 @@
+import { loadInteraction } from "./interaction";
+import { loadPlugin } from "./plugin";
+export async function loadParticlesLinksInteraction(engine) {
+    await loadInteraction(engine);
+    await loadPlugin(engine);
+}
+export * from "./Options/Classes/Links";
+export * from "./Options/Classes/LinksShadow";
+export * from "./Options/Classes/LinksTriangle";
+export * from "./Options/Interfaces/ILinks";
+export * from "./Options/Interfaces/ILinksShadow";
+export * from "./Options/Interfaces/ILinksTriangle";

package/browser/interaction.js

@@ -0,0 +1,4 @@
+import { Linker } from "./Linker";
+export async function loadInteraction(engine) {
+    await engine.addInteractor("particlesLinks", (container) => new Linker(container));
+}

package/browser/plugin.js

@@ -0,0 +1,18 @@
+import { LinkInstance } from "./LinkInstance";
+class LinksPlugin {
+    constructor() {
+        this.id = "links";
+    }
+    getPlugin(container) {
+        return new LinkInstance(container);
+    }
+    loadOptions() {
+    }
+    needsPlugin() {
+        return true;
+    }
+}
+export async function loadPlugin(engine) {
+    const plugin = new LinksPlugin();
+    await engine.addPlugin(plugin);
+}