@tsparticles/plugin-emitters-shape-polygon 3.0.0-beta.4

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

package/browser/EmittersPolygonShape.js

@@ -0,0 +1,20 @@
+import { EmitterShapeBase } from "@tsparticles/plugin-emitters";
+import { generateRandomPointOnPolygonPerimeter, generateRandomPointWithinPolygon, generateRandomPolygon, } from "./utils.js";
+export class EmittersPolygonShape extends EmitterShapeBase {
+    constructor(position, size, fill, options) {
+        super(position, size, fill, options);
+        this.sides = options.sides;
+        this.angle = (options.angle * Math.PI) / 180;
+        this.polygon = generateRandomPolygon(position, this.sides, size.width / 2, this.angle);
+    }
+    async init() {
+    }
+    async randomPosition() {
+        const fill = this.fill, polygon = this.polygon, res = fill ? generateRandomPointWithinPolygon(polygon) : generateRandomPointOnPolygonPerimeter(polygon);
+        return res ? { position: res } : null;
+    }
+    resize(position, size) {
+        super.resize(position, size);
+        this.polygon = generateRandomPolygon(position, this.sides, size.width / 2, this.angle);
+    }
+}

package/browser/EmittersPolygonShapeGenerator.js

@@ -0,0 +1,9 @@
+import { EmittersPolygonShape } from "./EmittersPolygonShape.js";
+import { EmittersPolygonShapeOptions } from "./Options/Classes/EmittersPolygonShapeOptions.js";
+export class EmittersPolygonShapeGenerator {
+    generate(position, size, fill, options) {
+        const shapeOptions = new EmittersPolygonShapeOptions();
+        shapeOptions.load(options);
+        return new EmittersPolygonShape(position, size, fill, shapeOptions);
+    }
+}

package/browser/Options/Classes/EmittersPolygonShapeOptions.js

@@ -0,0 +1,17 @@
+export class EmittersPolygonShapeOptions {
+    constructor() {
+        this.angle = 0;
+        this.sides = 5;
+    }
+    load(data) {
+        if (!data) {
+            return;
+        }
+        if (data.angle !== undefined) {
+            this.angle = data.angle;
+        }
+        if (data.sides !== undefined) {
+            this.sides = data.sides;
+        }
+    }
+}

package/browser/Options/Interfaces/IEmittersPolygonShapeOptions.js

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

package/browser/index.js

@@ -0,0 +1,7 @@
+import { EmittersPolygonShapeGenerator } from "./EmittersPolygonShapeGenerator.js";
+export async function loadEmittersShapePolygon(engine, refresh = true) {
+    const emittersEngine = engine;
+    emittersEngine.addEmitterShapeGenerator &&
+        emittersEngine.addEmitterShapeGenerator("polygon", new EmittersPolygonShapeGenerator());
+    await emittersEngine.refresh(refresh);
+}

package/browser/package.json

@@ -0,0 +1 @@
+{ "type": "module" }

package/browser/utils.js

@@ -0,0 +1,56 @@
+import { getRandom } from "@tsparticles/engine";
+export function generateRandomPolygon(position, sides, radius, rotationAngle = 0) {
+    const polygon = [], angle = (Math.PI * 2) / sides;
+    for (let i = 0; i < sides; i++) {
+        const currentAngle = angle * i + rotationAngle;
+        polygon.push({
+            x: position.x + radius * Math.cos(currentAngle),
+            y: position.y + radius * Math.sin(currentAngle),
+        });
+    }
+    return polygon;
+}
+export function generateRandomPointWithinPolygon(polygon) {
+    const min = { ...polygon[0] }, max = { ...polygon[0] };
+    for (const point of polygon) {
+        if (point.x < min.x) {
+            min.x = point.x;
+        }
+        if (point.x > max.x) {
+            max.x = point.x;
+        }
+        if (point.y < min.y) {
+            min.y = point.y;
+        }
+        if (point.y > max.y) {
+            max.y = point.y;
+        }
+    }
+    let randomPoint = null;
+    for (let attempts = 0; attempts < 100; attempts++) {
+        const tmpPoint = {
+            x: min.x + getRandom() * (max.x - min.x),
+            y: min.y + getRandom() * (max.y - min.y),
+        };
+        if (isPointInPolygon(tmpPoint, polygon)) {
+            randomPoint = tmpPoint;
+            break;
+        }
+    }
+    return randomPoint;
+}
+export function generateRandomPointOnPolygonPerimeter(polygon) {
+    const sideIndex = Math.floor(getRandom() * polygon.length), startPoint = polygon[sideIndex], endPoint = polygon[(sideIndex + 1) % polygon.length], t = getRandom();
+    return { x: startPoint.x + (endPoint.x - startPoint.x) * t, y: startPoint.y + (endPoint.y - startPoint.y) * t };
+}
+export function isPointInPolygon(point, polygon) {
+    let inside = false;
+    for (let i = 0, j = polygon.length - 1; i < polygon.length; j = i++) {
+        const pi = polygon[i], pj = polygon[j];
+        const intersect = pi.y > point.y !== pj.y > point.y && point.x < ((pj.x - pi.x) * (point.y - pi.y)) / (pj.y - pi.y) + pi.x;
+        if (intersect) {
+            inside = !inside;
+        }
+    }
+    return inside;
+}

package/cjs/EmittersPolygonShape.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EmittersPolygonShape = void 0;
+const plugin_emitters_1 = require("@tsparticles/plugin-emitters");
+const utils_js_1 = require("./utils.js");
+class EmittersPolygonShape extends plugin_emitters_1.EmitterShapeBase {
+    constructor(position, size, fill, options) {
+        super(position, size, fill, options);
+        this.sides = options.sides;
+        this.angle = (options.angle * Math.PI) / 180;
+        this.polygon = (0, utils_js_1.generateRandomPolygon)(position, this.sides, size.width / 2, this.angle);
+    }
+    async init() {
+    }
+    async randomPosition() {
+        const fill = this.fill, polygon = this.polygon, res = fill ? (0, utils_js_1.generateRandomPointWithinPolygon)(polygon) : (0, utils_js_1.generateRandomPointOnPolygonPerimeter)(polygon);
+        return res ? { position: res } : null;
+    }
+    resize(position, size) {
+        super.resize(position, size);
+        this.polygon = (0, utils_js_1.generateRandomPolygon)(position, this.sides, size.width / 2, this.angle);
+    }
+}
+exports.EmittersPolygonShape = EmittersPolygonShape;

package/cjs/EmittersPolygonShapeGenerator.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EmittersPolygonShapeGenerator = void 0;
+const EmittersPolygonShape_js_1 = require("./EmittersPolygonShape.js");
+const EmittersPolygonShapeOptions_js_1 = require("./Options/Classes/EmittersPolygonShapeOptions.js");
+class EmittersPolygonShapeGenerator {
+    generate(position, size, fill, options) {
+        const shapeOptions = new EmittersPolygonShapeOptions_js_1.EmittersPolygonShapeOptions();
+        shapeOptions.load(options);
+        return new EmittersPolygonShape_js_1.EmittersPolygonShape(position, size, fill, shapeOptions);
+    }
+}
+exports.EmittersPolygonShapeGenerator = EmittersPolygonShapeGenerator;

package/cjs/Options/Classes/EmittersPolygonShapeOptions.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EmittersPolygonShapeOptions = void 0;
+class EmittersPolygonShapeOptions {
+    constructor() {
+        this.angle = 0;
+        this.sides = 5;
+    }
+    load(data) {
+        if (!data) {
+            return;
+        }
+        if (data.angle !== undefined) {
+            this.angle = data.angle;
+        }
+        if (data.sides !== undefined) {
+            this.sides = data.sides;
+        }
+    }
+}
+exports.EmittersPolygonShapeOptions = EmittersPolygonShapeOptions;

package/cjs/Options/Interfaces/IEmittersPolygonShapeOptions.js

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

package/cjs/index.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadEmittersShapePolygon = void 0;
+const EmittersPolygonShapeGenerator_js_1 = require("./EmittersPolygonShapeGenerator.js");
+async function loadEmittersShapePolygon(engine, refresh = true) {
+    const emittersEngine = engine;
+    emittersEngine.addEmitterShapeGenerator &&
+        emittersEngine.addEmitterShapeGenerator("polygon", new EmittersPolygonShapeGenerator_js_1.EmittersPolygonShapeGenerator());
+    await emittersEngine.refresh(refresh);
+}
+exports.loadEmittersShapePolygon = loadEmittersShapePolygon;

package/cjs/package.json

@@ -0,0 +1 @@
+{ "type": "commonjs" }

package/cjs/utils.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isPointInPolygon = exports.generateRandomPointOnPolygonPerimeter = exports.generateRandomPointWithinPolygon = exports.generateRandomPolygon = void 0;
+const engine_1 = require("@tsparticles/engine");
+function generateRandomPolygon(position, sides, radius, rotationAngle = 0) {
+    const polygon = [], angle = (Math.PI * 2) / sides;
+    for (let i = 0; i < sides; i++) {
+        const currentAngle = angle * i + rotationAngle;
+        polygon.push({
+            x: position.x + radius * Math.cos(currentAngle),
+            y: position.y + radius * Math.sin(currentAngle),
+        });
+    }
+    return polygon;
+}
+exports.generateRandomPolygon = generateRandomPolygon;
+function generateRandomPointWithinPolygon(polygon) {
+    const min = { ...polygon[0] }, max = { ...polygon[0] };
+    for (const point of polygon) {
+        if (point.x < min.x) {
+            min.x = point.x;
+        }
+        if (point.x > max.x) {
+            max.x = point.x;
+        }
+        if (point.y < min.y) {
+            min.y = point.y;
+        }
+        if (point.y > max.y) {
+            max.y = point.y;
+        }
+    }
+    let randomPoint = null;
+    for (let attempts = 0; attempts < 100; attempts++) {
+        const tmpPoint = {
+            x: min.x + (0, engine_1.getRandom)() * (max.x - min.x),
+            y: min.y + (0, engine_1.getRandom)() * (max.y - min.y),
+        };
+        if (isPointInPolygon(tmpPoint, polygon)) {
+            randomPoint = tmpPoint;
+            break;
+        }
+    }
+    return randomPoint;
+}
+exports.generateRandomPointWithinPolygon = generateRandomPointWithinPolygon;
+function generateRandomPointOnPolygonPerimeter(polygon) {
+    const sideIndex = Math.floor((0, engine_1.getRandom)() * polygon.length), startPoint = polygon[sideIndex], endPoint = polygon[(sideIndex + 1) % polygon.length], t = (0, engine_1.getRandom)();
+    return { x: startPoint.x + (endPoint.x - startPoint.x) * t, y: startPoint.y + (endPoint.y - startPoint.y) * t };
+}
+exports.generateRandomPointOnPolygonPerimeter = generateRandomPointOnPolygonPerimeter;
+function isPointInPolygon(point, polygon) {
+    let inside = false;
+    for (let i = 0, j = polygon.length - 1; i < polygon.length; j = i++) {
+        const pi = polygon[i], pj = polygon[j];
+        const intersect = pi.y > point.y !== pj.y > point.y && point.x < ((pj.x - pi.x) * (point.y - pi.y)) / (pj.y - pi.y) + pi.x;
+        if (intersect) {
+            inside = !inside;
+        }
+    }
+    return inside;
+}
+exports.isPointInPolygon = isPointInPolygon;

package/esm/EmittersPolygonShape.js

@@ -0,0 +1,20 @@
+import { EmitterShapeBase } from "@tsparticles/plugin-emitters";
+import { generateRandomPointOnPolygonPerimeter, generateRandomPointWithinPolygon, generateRandomPolygon, } from "./utils.js";
+export class EmittersPolygonShape extends EmitterShapeBase {
+    constructor(position, size, fill, options) {
+        super(position, size, fill, options);
+        this.sides = options.sides;
+        this.angle = (options.angle * Math.PI) / 180;
+        this.polygon = generateRandomPolygon(position, this.sides, size.width / 2, this.angle);
+    }
+    async init() {
+    }
+    async randomPosition() {
+        const fill = this.fill, polygon = this.polygon, res = fill ? generateRandomPointWithinPolygon(polygon) : generateRandomPointOnPolygonPerimeter(polygon);
+        return res ? { position: res } : null;
+    }
+    resize(position, size) {
+        super.resize(position, size);
+        this.polygon = generateRandomPolygon(position, this.sides, size.width / 2, this.angle);
+    }
+}

package/esm/EmittersPolygonShapeGenerator.js

@@ -0,0 +1,9 @@
+import { EmittersPolygonShape } from "./EmittersPolygonShape.js";
+import { EmittersPolygonShapeOptions } from "./Options/Classes/EmittersPolygonShapeOptions.js";
+export class EmittersPolygonShapeGenerator {
+    generate(position, size, fill, options) {
+        const shapeOptions = new EmittersPolygonShapeOptions();
+        shapeOptions.load(options);
+        return new EmittersPolygonShape(position, size, fill, shapeOptions);
+    }
+}

package/esm/Options/Classes/EmittersPolygonShapeOptions.js

@@ -0,0 +1,17 @@
+export class EmittersPolygonShapeOptions {
+    constructor() {
+        this.angle = 0;
+        this.sides = 5;
+    }
+    load(data) {
+        if (!data) {
+            return;
+        }
+        if (data.angle !== undefined) {
+            this.angle = data.angle;
+        }
+        if (data.sides !== undefined) {
+            this.sides = data.sides;
+        }
+    }
+}

package/esm/Options/Interfaces/IEmittersPolygonShapeOptions.js

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

package/esm/index.js

@@ -0,0 +1,7 @@
+import { EmittersPolygonShapeGenerator } from "./EmittersPolygonShapeGenerator.js";
+export async function loadEmittersShapePolygon(engine, refresh = true) {
+    const emittersEngine = engine;
+    emittersEngine.addEmitterShapeGenerator &&
+        emittersEngine.addEmitterShapeGenerator("polygon", new EmittersPolygonShapeGenerator());
+    await emittersEngine.refresh(refresh);
+}

package/esm/package.json

@@ -0,0 +1 @@
+{ "type": "module" }

package/esm/utils.js

@@ -0,0 +1,56 @@
+import { getRandom } from "@tsparticles/engine";
+export function generateRandomPolygon(position, sides, radius, rotationAngle = 0) {
+    const polygon = [], angle = (Math.PI * 2) / sides;
+    for (let i = 0; i < sides; i++) {
+        const currentAngle = angle * i + rotationAngle;
+        polygon.push({
+            x: position.x + radius * Math.cos(currentAngle),
+            y: position.y + radius * Math.sin(currentAngle),
+        });
+    }
+    return polygon;
+}
+export function generateRandomPointWithinPolygon(polygon) {
+    const min = { ...polygon[0] }, max = { ...polygon[0] };
+    for (const point of polygon) {
+        if (point.x < min.x) {
+            min.x = point.x;
+        }
+        if (point.x > max.x) {
+            max.x = point.x;
+        }
+        if (point.y < min.y) {
+            min.y = point.y;
+        }
+        if (point.y > max.y) {
+            max.y = point.y;
+        }
+    }
+    let randomPoint = null;
+    for (let attempts = 0; attempts < 100; attempts++) {
+        const tmpPoint = {
+            x: min.x + getRandom() * (max.x - min.x),
+            y: min.y + getRandom() * (max.y - min.y),
+        };
+        if (isPointInPolygon(tmpPoint, polygon)) {
+            randomPoint = tmpPoint;
+            break;
+        }
+    }
+    return randomPoint;
+}
+export function generateRandomPointOnPolygonPerimeter(polygon) {
+    const sideIndex = Math.floor(getRandom() * polygon.length), startPoint = polygon[sideIndex], endPoint = polygon[(sideIndex + 1) % polygon.length], t = getRandom();
+    return { x: startPoint.x + (endPoint.x - startPoint.x) * t, y: startPoint.y + (endPoint.y - startPoint.y) * t };
+}
+export function isPointInPolygon(point, polygon) {
+    let inside = false;
+    for (let i = 0, j = polygon.length - 1; i < polygon.length; j = i++) {
+        const pi = polygon[i], pj = polygon[j];
+        const intersect = pi.y > point.y !== pj.y > point.y && point.x < ((pj.x - pi.x) * (point.y - pi.y)) / (pj.y - pi.y) + pi.x;
+        if (intersect) {
+            inside = !inside;
+        }
+    }
+    return inside;
+}

package/package.json

@@ -0,0 +1,109 @@
+{
+  "name": "@tsparticles/plugin-emitters-shape-polygon",
+  "version": "3.0.0-beta.4",
+  "description": "tsParticles emitters shape polygon plugin",
+  "homepage": "https://particles.js.org",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/tsparticles/tsparticles.git",
+    "directory": "plugins/emitterShapes/polygon"
+  },
+  "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"
+  ],
+  "author": "Matteo Bruni <matteo.bruni@me.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/tsparticles/tsparticles/issues"
+  },
+  "funding": [
+    {
+      "type": "github",
+      "url": "https://github.com/sponsors/matteobruni"
+    },
+    {
+      "type": "github",
+      "url": "https://github.com/sponsors/tsparticles"
+    },
+    {
+      "type": "buymeacoffee",
+      "url": "https://www.buymeacoffee.com/matteobruni"
+    }
+  ],
+  "sideEffects": false,
+  "jsdelivr": "tsparticles.plugin.emitters.shape.polygon.min.js",
+  "unpkg": "tsparticles.plugin.emitters.shape.polygon.min.js",
+  "browser": "browser/index.js",
+  "main": "cjs/index.js",
+  "module": "esm/index.js",
+  "types": "types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./types/index.d.ts",
+      "browser": "./browser/index.js",
+      "import": "./esm/index.js",
+      "require": "./cjs/index.js",
+      "umd": "./umd/index.js",
+      "default": "./cjs/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "dependencies": {
+    "@tsparticles/engine": "^3.0.0-beta.4",
+    "@tsparticles/plugin-emitters": "^3.0.0-beta.4"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}