@tsparticles/shape-polygon 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,71 @@
+[![banner](https://particles.js.org/images/banner2.png)](https://particles.js.org)
+
+# tsParticles Polygon Shape
+
+[![jsDelivr](https://data.jsdelivr.com/v1/package/npm/tsparticles-shape-polygon/badge)](https://www.jsdelivr.com/package/npm/tsparticles-shape-polygon)
+[![npmjs](https://badge.fury.io/js/tsparticles-shape-polygon.svg)](https://www.npmjs.com/package/tsparticles-shape-polygon)
+[![npmjs](https://img.shields.io/npm/dt/tsparticles-shape-polygon)](https://www.npmjs.com/package/tsparticles-shape-polygon) [![GitHub Sponsors](https://img.shields.io/github/sponsors/matteobruni)](https://github.com/sponsors/matteobruni)
+
+[tsParticles](https://github.com/matteobruni/tsparticles) additional polygon shape.
+
+## How to use it
+
+### CDN / Vanilla JS / jQuery
+
+The CDN/Vanilla version JS has one required file in vanilla configuration:
+
+Including the `tsparticles.shape.polygon.min.js` file will export the function to load the shape:
+
+```javascript
+loadPolygonShape;
+```
+
+### Usage
+
+Once the scripts are loaded you can set up `tsParticles` and the shape like this:
+
+```javascript
+(async () => {
+  await loadPolygonShape();
+
+  await tsParticles.load({
+    id: "tsparticles",
+    options: {
+      /* options */
+      /* here you can use particles.shape.type: "polygon" */
+    },
+  });
+})();
+```
+
+### ESM / CommonJS
+
+This package is compatible also with ES or CommonJS modules, firstly this needs to be installed, like this:
+
+```shell
+$ npm install tsparticles-shape-polygon
+```
+
+or
+
+```shell
+$ yarn add tsparticles-shape-polygon
+```
+
+Then you need to import it in the app, like this:
+
+```javascript
+const { tsParticles } = require("tsparticles-engine");
+const { loadPolygonShape } = require("tsparticles-shape-polygon");
+
+loadPolygonShape(tsParticles);
+```
+
+or
+
+```javascript
+import { tsParticles } from "tsparticles-engine";
+import { loadPolygonShape } from "tsparticles-shape-polygon";
+
+loadPolygonShape(tsParticles);
+```

package/browser/IPolygonShape.js

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

package/browser/ISide.js

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

package/browser/ISideCount.js

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

package/browser/PolygonDrawer.js

@@ -0,0 +1,19 @@
+import { PolygonDrawerBase } from "./PolygonDrawerBase";
+export class PolygonDrawer extends PolygonDrawerBase {
+    getCenter(particle, radius) {
+        return {
+            x: -radius / (particle.sides / 3.5),
+            y: -radius / (2.66 / 3.5),
+        };
+    }
+    getSidesData(particle, radius) {
+        const sides = particle.sides;
+        return {
+            count: {
+                denominator: 1,
+                numerator: sides,
+            },
+            length: (radius * 2.66) / (sides / 3),
+        };
+    }
+}

package/browser/PolygonDrawerBase.js

@@ -0,0 +1,22 @@
+import { getRangeValue } from "@tsparticles/engine";
+export class PolygonDrawerBase {
+    draw(context, particle, radius) {
+        const start = this.getCenter(particle, radius), side = this.getSidesData(particle, radius), sideCount = side.count.numerator * side.count.denominator, decimalSides = side.count.numerator / side.count.denominator, interiorAngleDegrees = (180 * (decimalSides - 2)) / decimalSides, interiorAngle = Math.PI - (Math.PI * interiorAngleDegrees) / 180;
+        if (!context) {
+            return;
+        }
+        context.beginPath();
+        context.translate(start.x, start.y);
+        context.moveTo(0, 0);
+        for (let i = 0; i < sideCount; i++) {
+            context.lineTo(side.length, 0);
+            context.translate(side.length, 0);
+            context.rotate(interiorAngle);
+        }
+    }
+    getSidesCount(particle) {
+        var _a, _b;
+        const polygon = particle.shapeData, sides = Math.round(getRangeValue((_b = (_a = polygon === null || polygon === void 0 ? void 0 : polygon.sides) !== null && _a !== void 0 ? _a : polygon === null || polygon === void 0 ? void 0 : polygon.nb_sides) !== null && _b !== void 0 ? _b : 5));
+        return sides;
+    }
+}

package/browser/TriangleDrawer.js

@@ -0,0 +1,21 @@
+import { PolygonDrawerBase } from "./PolygonDrawerBase";
+export class TriangleDrawer extends PolygonDrawerBase {
+    getCenter(particle, radius) {
+        return {
+            x: -radius,
+            y: radius / 1.66,
+        };
+    }
+    getSidesCount() {
+        return 3;
+    }
+    getSidesData(particle, radius) {
+        return {
+            count: {
+                denominator: 2,
+                numerator: 3,
+            },
+            length: radius * 2,
+        };
+    }
+}

package/browser/index.js

@@ -0,0 +1,12 @@
+import { PolygonDrawer } from "./PolygonDrawer";
+import { TriangleDrawer } from "./TriangleDrawer";
+export async function loadGenericPolygonShape(engine) {
+    await engine.addShape("polygon", new PolygonDrawer());
+}
+export async function loadTriangleShape(engine) {
+    await engine.addShape("triangle", new TriangleDrawer());
+}
+export async function loadPolygonShape(engine) {
+    await loadGenericPolygonShape(engine);
+    await loadTriangleShape(engine);
+}

package/cjs/IPolygonShape.js

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

package/cjs/ISide.js

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

package/cjs/ISideCount.js

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

package/cjs/PolygonDrawer.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PolygonDrawer = void 0;
+const PolygonDrawerBase_1 = require("./PolygonDrawerBase");
+class PolygonDrawer extends PolygonDrawerBase_1.PolygonDrawerBase {
+    getCenter(particle, radius) {
+        return {
+            x: -radius / (particle.sides / 3.5),
+            y: -radius / (2.66 / 3.5),
+        };
+    }
+    getSidesData(particle, radius) {
+        const sides = particle.sides;
+        return {
+            count: {
+                denominator: 1,
+                numerator: sides,
+            },
+            length: (radius * 2.66) / (sides / 3),
+        };
+    }
+}
+exports.PolygonDrawer = PolygonDrawer;

package/cjs/PolygonDrawerBase.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PolygonDrawerBase = void 0;
+const engine_1 = require("@tsparticles/engine");
+class PolygonDrawerBase {
+    draw(context, particle, radius) {
+        const start = this.getCenter(particle, radius), side = this.getSidesData(particle, radius), sideCount = side.count.numerator * side.count.denominator, decimalSides = side.count.numerator / side.count.denominator, interiorAngleDegrees = (180 * (decimalSides - 2)) / decimalSides, interiorAngle = Math.PI - (Math.PI * interiorAngleDegrees) / 180;
+        if (!context) {
+            return;
+        }
+        context.beginPath();
+        context.translate(start.x, start.y);
+        context.moveTo(0, 0);
+        for (let i = 0; i < sideCount; i++) {
+            context.lineTo(side.length, 0);
+            context.translate(side.length, 0);
+            context.rotate(interiorAngle);
+        }
+    }
+    getSidesCount(particle) {
+        var _a, _b;
+        const polygon = particle.shapeData, sides = Math.round((0, engine_1.getRangeValue)((_b = (_a = polygon === null || polygon === void 0 ? void 0 : polygon.sides) !== null && _a !== void 0 ? _a : polygon === null || polygon === void 0 ? void 0 : polygon.nb_sides) !== null && _b !== void 0 ? _b : 5));
+        return sides;
+    }
+}
+exports.PolygonDrawerBase = PolygonDrawerBase;

package/cjs/TriangleDrawer.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TriangleDrawer = void 0;
+const PolygonDrawerBase_1 = require("./PolygonDrawerBase");
+class TriangleDrawer extends PolygonDrawerBase_1.PolygonDrawerBase {
+    getCenter(particle, radius) {
+        return {
+            x: -radius,
+            y: radius / 1.66,
+        };
+    }
+    getSidesCount() {
+        return 3;
+    }
+    getSidesData(particle, radius) {
+        return {
+            count: {
+                denominator: 2,
+                numerator: 3,
+            },
+            length: radius * 2,
+        };
+    }
+}
+exports.TriangleDrawer = TriangleDrawer;

package/cjs/index.js

@@ -0,0 +1,33 @@
+"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.loadPolygonShape = exports.loadTriangleShape = exports.loadGenericPolygonShape = void 0;
+const PolygonDrawer_1 = require("./PolygonDrawer");
+const TriangleDrawer_1 = require("./TriangleDrawer");
+function loadGenericPolygonShape(engine) {
+    return __awaiter(this, void 0, void 0, function* () {
+        yield engine.addShape("polygon", new PolygonDrawer_1.PolygonDrawer());
+    });
+}
+exports.loadGenericPolygonShape = loadGenericPolygonShape;
+function loadTriangleShape(engine) {
+    return __awaiter(this, void 0, void 0, function* () {
+        yield engine.addShape("triangle", new TriangleDrawer_1.TriangleDrawer());
+    });
+}
+exports.loadTriangleShape = loadTriangleShape;
+function loadPolygonShape(engine) {
+    return __awaiter(this, void 0, void 0, function* () {
+        yield loadGenericPolygonShape(engine);
+        yield loadTriangleShape(engine);
+    });
+}
+exports.loadPolygonShape = loadPolygonShape;

package/esm/IPolygonShape.js

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

package/esm/ISide.js

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

package/esm/ISideCount.js

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

package/esm/PolygonDrawer.js

@@ -0,0 +1,19 @@
+import { PolygonDrawerBase } from "./PolygonDrawerBase";
+export class PolygonDrawer extends PolygonDrawerBase {
+    getCenter(particle, radius) {
+        return {
+            x: -radius / (particle.sides / 3.5),
+            y: -radius / (2.66 / 3.5),
+        };
+    }
+    getSidesData(particle, radius) {
+        const sides = particle.sides;
+        return {
+            count: {
+                denominator: 1,
+                numerator: sides,
+            },
+            length: (radius * 2.66) / (sides / 3),
+        };
+    }
+}

package/esm/PolygonDrawerBase.js

@@ -0,0 +1,22 @@
+import { getRangeValue } from "@tsparticles/engine";
+export class PolygonDrawerBase {
+    draw(context, particle, radius) {
+        const start = this.getCenter(particle, radius), side = this.getSidesData(particle, radius), sideCount = side.count.numerator * side.count.denominator, decimalSides = side.count.numerator / side.count.denominator, interiorAngleDegrees = (180 * (decimalSides - 2)) / decimalSides, interiorAngle = Math.PI - (Math.PI * interiorAngleDegrees) / 180;
+        if (!context) {
+            return;
+        }
+        context.beginPath();
+        context.translate(start.x, start.y);
+        context.moveTo(0, 0);
+        for (let i = 0; i < sideCount; i++) {
+            context.lineTo(side.length, 0);
+            context.translate(side.length, 0);
+            context.rotate(interiorAngle);
+        }
+    }
+    getSidesCount(particle) {
+        var _a, _b;
+        const polygon = particle.shapeData, sides = Math.round(getRangeValue((_b = (_a = polygon === null || polygon === void 0 ? void 0 : polygon.sides) !== null && _a !== void 0 ? _a : polygon === null || polygon === void 0 ? void 0 : polygon.nb_sides) !== null && _b !== void 0 ? _b : 5));
+        return sides;
+    }
+}

package/esm/TriangleDrawer.js

@@ -0,0 +1,21 @@
+import { PolygonDrawerBase } from "./PolygonDrawerBase";
+export class TriangleDrawer extends PolygonDrawerBase {
+    getCenter(particle, radius) {
+        return {
+            x: -radius,
+            y: radius / 1.66,
+        };
+    }
+    getSidesCount() {
+        return 3;
+    }
+    getSidesData(particle, radius) {
+        return {
+            count: {
+                denominator: 2,
+                numerator: 3,
+            },
+            length: radius * 2,
+        };
+    }
+}

package/esm/index.js

@@ -0,0 +1,12 @@
+import { PolygonDrawer } from "./PolygonDrawer";
+import { TriangleDrawer } from "./TriangleDrawer";
+export async function loadGenericPolygonShape(engine) {
+    await engine.addShape("polygon", new PolygonDrawer());
+}
+export async function loadTriangleShape(engine) {
+    await engine.addShape("triangle", new TriangleDrawer());
+}
+export async function loadPolygonShape(engine) {
+    await loadGenericPolygonShape(engine);
+    await loadTriangleShape(engine);
+}

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@tsparticles/shape-polygon",
+  "version": "3.0.0-alpha.0",
+  "description": "tsParticles polygon shape",
+  "homepage": "https://particles.js.org",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/matteobruni/tsparticles.git",
+    "directory": "shapes/polygon"
+  },
+  "keywords": [
+    "front-end",
+    "frontend",
+    "tsparticles",
+    "particles",
+    "particle",
+    "canvas",
+    "jsparticles",
+    "xparticles",
+    "particles-js",
+    "particles.js",
+    "particles-ts",
+    "particles.ts",
+    "typescript",
+    "javascript",
+    "animation",
+    "web",
+    "html5",
+    "web-design",
+    "webdesign",
+    "css",
+    "html",
+    "css3",
+    "animated",
+    "background",
+    "@tsparticles/shape"
+  ],
+  "author": "Matteo Bruni <matteo.bruni@me.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/matteobruni/tsparticles/issues"
+  },
+  "main": "cjs/index.js",
+  "jsdelivr": "tsparticles.shape.polygon.min.js",
+  "unpkg": "tsparticles.shape.polygon.min.js",
+  "module": "esm/index.js",
+  "types": "types/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@tsparticles/engine": "^3.0.0-alpha.0"
+  }
+}