@tsparticles/plugin-polygon-mask 3.0.0-alpha.0

package/browser/PolygonMaskInstance.js

@@ -0,0 +1,388 @@
+import { calcClosestPtOnSegment, drawPolygonMask, drawPolygonMaskPath, parsePaths, segmentBounce } from "./utils";
+import { deepExtend, getDistance, getDistances, getRandom, itemFromArray } from "@tsparticles/engine";
+const noPolygonDataLoaded = "No polygon data loaded.", noPolygonFound = "No polygon found, you need to specify SVG url in config.";
+export class PolygonMaskInstance {
+    constructor(container, engine) {
+        this._container = container;
+        this._engine = engine;
+        this.dimension = {
+            height: 0,
+            width: 0,
+        };
+        this._moveRadius = 0;
+        this._scale = 1;
+    }
+    clickPositionValid(position) {
+        const options = this._container.actualOptions.polygon;
+        return (!!(options === null || options === void 0 ? void 0 : options.enable) &&
+            options.type !== "none" &&
+            options.type !== "inline" &&
+            this.checkInsidePolygon(position));
+    }
+    draw(context) {
+        var _a;
+        if (!((_a = this.paths) === null || _a === void 0 ? void 0 : _a.length)) {
+            return;
+        }
+        const options = this._container.actualOptions.polygon;
+        if (!(options === null || options === void 0 ? void 0 : options.enable)) {
+            return;
+        }
+        const polygonDraw = options.draw;
+        if (!polygonDraw.enable) {
+            return;
+        }
+        const rawData = this.raw;
+        for (const path of this.paths) {
+            const path2d = path.path2d;
+            if (!context) {
+                continue;
+            }
+            if (path2d && this.offset) {
+                drawPolygonMaskPath(context, path2d, polygonDraw.stroke, this.offset);
+            }
+            else if (rawData) {
+                drawPolygonMask(context, rawData, polygonDraw.stroke);
+            }
+        }
+    }
+    async init() {
+        const container = this._container, polygonMaskOptions = container.actualOptions.polygon, pxRatio = container.retina.pixelRatio;
+        if (!polygonMaskOptions) {
+            return;
+        }
+        this._moveRadius = polygonMaskOptions.move.radius * pxRatio;
+        this._scale = polygonMaskOptions.scale * pxRatio;
+        if (polygonMaskOptions.enable) {
+            await this.initRawData();
+        }
+    }
+    particleBounce(particle, delta, direction) {
+        return this.polygonBounce(particle, delta, direction);
+    }
+    particlePosition(position) {
+        var _a, _b;
+        const options = this._container.actualOptions.polygon;
+        if (!((options === null || options === void 0 ? void 0 : options.enable) && ((_b = (_a = this.raw) === null || _a === void 0 ? void 0 : _a.length) !== null && _b !== void 0 ? _b : 0) > 0)) {
+            return;
+        }
+        return deepExtend({}, position ? position : this.randomPoint());
+    }
+    particlesInitialization() {
+        const options = this._container.actualOptions.polygon;
+        if ((options === null || options === void 0 ? void 0 : options.enable) &&
+            options.type === "inline" &&
+            (options.inline.arrangement === "one-per-point" ||
+                options.inline.arrangement === "per-point")) {
+            this.drawPoints();
+            return true;
+        }
+        return false;
+    }
+    resize() {
+        const container = this._container, options = container.actualOptions.polygon;
+        if (!((options === null || options === void 0 ? void 0 : options.enable) && options.type !== "none")) {
+            return;
+        }
+        if (this.redrawTimeout) {
+            clearTimeout(this.redrawTimeout);
+        }
+        this.redrawTimeout = window.setTimeout(async () => {
+            await this.initRawData(true);
+            await container.particles.redraw();
+        }, 250);
+    }
+    stop() {
+        delete this.raw;
+        delete this.paths;
+    }
+    checkInsidePolygon(position) {
+        var _a, _b;
+        const container = this._container, options = container.actualOptions.polygon;
+        if (!(options === null || options === void 0 ? void 0 : options.enable) || options.type === "none" || options.type === "inline") {
+            return true;
+        }
+        if (!this.raw) {
+            throw new Error(noPolygonFound);
+        }
+        const canvasSize = container.canvas.size, x = (_a = position === null || position === void 0 ? void 0 : position.x) !== null && _a !== void 0 ? _a : getRandom() * canvasSize.width, y = (_b = position === null || position === void 0 ? void 0 : position.y) !== null && _b !== void 0 ? _b : getRandom() * canvasSize.height;
+        let inside = false;
+        for (let i = 0, j = this.raw.length - 1; i < this.raw.length; j = i++) {
+            const pi = this.raw[i], pj = this.raw[j], intersect = pi.y > y !== pj.y > y && x < ((pj.x - pi.x) * (y - pi.y)) / (pj.y - pi.y) + pi.x;
+            if (intersect) {
+                inside = !inside;
+            }
+        }
+        return options.type === "inside"
+            ? inside
+            : options.type === "outside"
+                ? !inside
+                : false;
+    }
+    createPath2D() {
+        var _a, _b;
+        const container = this._container, options = container.actualOptions.polygon;
+        if (!options || !((_a = this.paths) === null || _a === void 0 ? void 0 : _a.length)) {
+            return;
+        }
+        for (const path of this.paths) {
+            const pathData = (_b = path.element) === null || _b === void 0 ? void 0 : _b.getAttribute("d");
+            if (pathData) {
+                const path2d = new Path2D(pathData), matrix = document.createElementNS("http://www.w3.org/2000/svg", "svg").createSVGMatrix(), finalPath = new Path2D(), transform = matrix.scale(this._scale);
+                if (finalPath.addPath) {
+                    finalPath.addPath(path2d, transform);
+                    path.path2d = finalPath;
+                }
+                else {
+                    delete path.path2d;
+                }
+            }
+            else {
+                delete path.path2d;
+            }
+            if (path.path2d || !this.raw) {
+                continue;
+            }
+            path.path2d = new Path2D();
+            path.path2d.moveTo(this.raw[0].x, this.raw[0].y);
+            this.raw.forEach((pos, i) => {
+                var _a;
+                if (i > 0) {
+                    (_a = path.path2d) === null || _a === void 0 ? void 0 : _a.lineTo(pos.x, pos.y);
+                }
+            });
+            path.path2d.closePath();
+        }
+    }
+    async downloadSvgPath(svgUrl, force) {
+        const options = this._container.actualOptions.polygon;
+        if (!options) {
+            return;
+        }
+        const url = svgUrl || options.url, forceDownload = force !== null && force !== void 0 ? force : false;
+        if (!url || (this.paths !== undefined && !forceDownload)) {
+            return this.raw;
+        }
+        const req = await fetch(url);
+        if (!req.ok) {
+            throw new Error("tsParticles Error - Error occurred during polygon mask download");
+        }
+        return this.parseSvgPath(await req.text(), force);
+    }
+    drawPoints() {
+        if (!this.raw) {
+            return;
+        }
+        for (const item of this.raw) {
+            this._container.particles.addParticle({
+                x: item.x,
+                y: item.y,
+            });
+        }
+    }
+    getEquidistantPointByIndex(index) {
+        var _a, _b, _c, _d, _e, _f, _g;
+        const container = this._container, options = container.actualOptions, polygonMaskOptions = options.polygon;
+        if (!polygonMaskOptions) {
+            return;
+        }
+        if (!this.raw || !this.raw.length || !((_a = this.paths) === null || _a === void 0 ? void 0 : _a.length))
+            throw new Error(noPolygonDataLoaded);
+        let offset = 0, point;
+        const totalLength = this.paths.reduce((tot, path) => tot + path.length, 0), distance = totalLength / options.particles.number.value;
+        for (const path of this.paths) {
+            const pathDistance = distance * index - offset;
+            if (pathDistance <= path.length) {
+                point = path.element.getPointAtLength(pathDistance);
+                break;
+            }
+            else {
+                offset += path.length;
+            }
+        }
+        const scale = this._scale;
+        return {
+            x: ((_b = point === null || point === void 0 ? void 0 : point.x) !== null && _b !== void 0 ? _b : 0) * scale + ((_d = (_c = this.offset) === null || _c === void 0 ? void 0 : _c.x) !== null && _d !== void 0 ? _d : 0),
+            y: ((_e = point === null || point === void 0 ? void 0 : point.y) !== null && _e !== void 0 ? _e : 0) * scale + ((_g = (_f = this.offset) === null || _f === void 0 ? void 0 : _f.y) !== null && _g !== void 0 ? _g : 0),
+        };
+    }
+    getPointByIndex(index) {
+        if (!this.raw || !this.raw.length) {
+            throw new Error(noPolygonDataLoaded);
+        }
+        const coords = this.raw[index % this.raw.length];
+        return {
+            x: coords.x,
+            y: coords.y,
+        };
+    }
+    getRandomPoint() {
+        if (!this.raw || !this.raw.length) {
+            throw new Error(noPolygonDataLoaded);
+        }
+        const coords = itemFromArray(this.raw);
+        return {
+            x: coords.x,
+            y: coords.y,
+        };
+    }
+    getRandomPointByLength() {
+        var _a, _b, _c;
+        const container = this._container, options = container.actualOptions.polygon;
+        if (!options) {
+            return;
+        }
+        if (!this.raw || !this.raw.length || !((_a = this.paths) === null || _a === void 0 ? void 0 : _a.length)) {
+            throw new Error(noPolygonDataLoaded);
+        }
+        const path = itemFromArray(this.paths), distance = Math.floor(getRandom() * path.length) + 1, point = path.element.getPointAtLength(distance), scale = this._scale;
+        return {
+            x: point.x * scale + (((_b = this.offset) === null || _b === void 0 ? void 0 : _b.x) || 0),
+            y: point.y * scale + (((_c = this.offset) === null || _c === void 0 ? void 0 : _c.y) || 0),
+        };
+    }
+    async initRawData(force) {
+        const options = this._container.actualOptions.polygon;
+        if (!options) {
+            return;
+        }
+        if (options.url) {
+            this.raw = await this.downloadSvgPath(options.url, force);
+        }
+        else if (options.data) {
+            const data = options.data;
+            let svg;
+            if (typeof data !== "string") {
+                const path = data.path instanceof Array
+                    ? data.path.map((t) => `<path d="${t}" />`).join("")
+                    : `<path d="${data.path}" />`;
+                const namespaces = 'xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink"';
+                svg = `<svg ${namespaces} width="${data.size.width}" height="${data.size.height}">${path}</svg>`;
+            }
+            else {
+                svg = data;
+            }
+            this.raw = this.parseSvgPath(svg, force);
+        }
+        this.createPath2D();
+        this._engine.dispatchEvent("polygonMaskLoaded", {
+            container: this._container,
+        });
+    }
+    parseSvgPath(xml, force) {
+        var _a, _b, _c;
+        const forceDownload = force !== null && force !== void 0 ? force : false;
+        if (this.paths !== undefined && !forceDownload) {
+            return this.raw;
+        }
+        const container = this._container, options = container.actualOptions.polygon;
+        if (!options) {
+            return;
+        }
+        const parser = new DOMParser(), doc = parser.parseFromString(xml, "image/svg+xml"), svg = doc.getElementsByTagName("svg")[0];
+        let svgPaths = svg.getElementsByTagName("path");
+        if (!svgPaths.length) {
+            svgPaths = doc.getElementsByTagName("path");
+        }
+        this.paths = [];
+        for (let i = 0; i < svgPaths.length; i++) {
+            const path = svgPaths.item(i);
+            if (path) {
+                this.paths.push({
+                    element: path,
+                    length: path.getTotalLength(),
+                });
+            }
+        }
+        const scale = this._scale;
+        this.dimension.width = parseFloat((_a = svg.getAttribute("width")) !== null && _a !== void 0 ? _a : "0") * scale;
+        this.dimension.height = parseFloat((_b = svg.getAttribute("height")) !== null && _b !== void 0 ? _b : "0") * scale;
+        const position = (_c = options.position) !== null && _c !== void 0 ? _c : {
+            x: 50,
+            y: 50,
+        };
+        this.offset = {
+            x: (container.canvas.size.width * position.x) / 100 - this.dimension.width / 2,
+            y: (container.canvas.size.height * position.y) / 100 - this.dimension.height / 2,
+        };
+        return parsePaths(this.paths, scale, this.offset);
+    }
+    polygonBounce(particle, _delta, direction) {
+        const options = this._container.actualOptions.polygon;
+        if (!this.raw || !(options === null || options === void 0 ? void 0 : options.enable) || direction !== "top") {
+            return false;
+        }
+        if (options.type === "inside" || options.type === "outside") {
+            let closest, dx, dy;
+            const pos = particle.getPosition(), radius = particle.getRadius();
+            for (let i = 0, j = this.raw.length - 1; i < this.raw.length; j = i++) {
+                const pi = this.raw[i], pj = this.raw[j];
+                closest = calcClosestPtOnSegment(pi, pj, pos);
+                const dist = getDistances(pos, closest);
+                [dx, dy] = [dist.dx, dist.dy];
+                if (dist.distance < radius) {
+                    segmentBounce(pi, pj, particle.velocity);
+                    return true;
+                }
+            }
+            if (closest && dx !== undefined && dy !== undefined && !this.checkInsidePolygon(pos)) {
+                const factor = { x: 1, y: 1 };
+                if (particle.position.x >= closest.x) {
+                    factor.x = -1;
+                }
+                if (particle.position.y >= closest.y) {
+                    factor.y = -1;
+                }
+                particle.position.x = closest.x + radius * 2 * factor.x;
+                particle.position.y = closest.y + radius * 2 * factor.y;
+                particle.velocity.mult(-1);
+                return true;
+            }
+        }
+        else if (options.type === "inline" && particle.initialPosition) {
+            const dist = getDistance(particle.initialPosition, particle.getPosition());
+            if (dist > this._moveRadius) {
+                particle.velocity.x = particle.velocity.y / 2 - particle.velocity.x;
+                particle.velocity.y = particle.velocity.x / 2 - particle.velocity.y;
+                return true;
+            }
+        }
+        return false;
+    }
+    randomPoint() {
+        const container = this._container, options = container.actualOptions.polygon;
+        if (!options) {
+            return;
+        }
+        let position;
+        if (options.type === "inline") {
+            switch (options.inline.arrangement) {
+                case "random-point":
+                    position = this.getRandomPoint();
+                    break;
+                case "random-length":
+                    position = this.getRandomPointByLength();
+                    break;
+                case "equidistant":
+                    position = this.getEquidistantPointByIndex(container.particles.count);
+                    break;
+                case "one-per-point":
+                case "per-point":
+                default:
+                    position = this.getPointByIndex(container.particles.count);
+            }
+        }
+        else {
+            position = {
+                x: getRandom() * container.canvas.size.width,
+                y: getRandom() * container.canvas.size.height,
+            };
+        }
+        if (this.checkInsidePolygon(position)) {
+            return position;
+        }
+        else {
+            return this.randomPoint();
+        }
+    }
+}

package/browser/index.js

@@ -0,0 +1,33 @@
+import "./pathseg";
+import { PolygonMask } from "./Options/Classes/PolygonMask";
+import { PolygonMaskInstance } from "./PolygonMaskInstance";
+class PolygonMaskPlugin {
+    constructor(engine) {
+        this.id = "polygonMask";
+        this._engine = engine;
+    }
+    getPlugin(container) {
+        return new PolygonMaskInstance(container, this._engine);
+    }
+    loadOptions(options, source) {
+        if (!this.needsPlugin(source)) {
+            return;
+        }
+        let polygonOptions = options.polygon;
+        if ((polygonOptions === null || polygonOptions === void 0 ? void 0 : polygonOptions.load) === undefined) {
+            options.polygon = polygonOptions = new PolygonMask();
+        }
+        polygonOptions.load(source === null || source === void 0 ? void 0 : source.polygon);
+    }
+    needsPlugin(options) {
+        var _a, _b, _c;
+        return ((_b = (_a = options === null || options === void 0 ? void 0 : options.polygon) === null || _a === void 0 ? void 0 : _a.enable) !== null && _b !== void 0 ? _b : (((_c = options === null || options === void 0 ? void 0 : options.polygon) === null || _c === void 0 ? void 0 : _c.type) !== undefined && options.polygon.type !== "none"));
+    }
+}
+export async function loadPolygonMaskPlugin(engine) {
+    const plugin = new PolygonMaskPlugin(engine);
+    await engine.addPlugin(plugin);
+}
+export * from "./Enums/PolygonMaskInlineArrangement";
+export * from "./Enums/PolygonMaskMoveType";
+export * from "./Enums/PolygonMaskType";