• Jump To … +
    ./source/asset-management/image-asset.js ./source/asset-management/noise-asset.js ./source/asset-management/raw-asset.js ./source/asset-management/reaction-diffusion-asset.js ./source/asset-management/sprite-asset.js ./source/asset-management/video-asset.js ./source/core/animation-loop.js ./source/core/display-cycle.js ./source/core/document.js ./source/core/events.js ./source/core/init.js ./source/core/library.js ./source/core/snippets.js ./source/core/user-interaction.js ./source/factory/action.js ./source/factory/anchor.js ./source/factory/animation.js ./source/factory/bezier.js ./source/factory/block.js ./source/factory/button.js ./source/factory/canvas.js ./source/factory/cell.js ./source/factory/cog.js ./source/factory/color.js ./source/factory/conic-gradient.js ./source/factory/crescent.js ./source/factory/element.js ./source/factory/emitter.js ./source/factory/enhanced-label.js ./source/factory/filter.js ./source/factory/gradient.js ./source/factory/grid.js ./source/factory/group.js ./source/factory/label.js ./source/factory/line-spiral.js ./source/factory/line.js ./source/factory/loom.js ./source/factory/mesh.js ./source/factory/net.js ./source/factory/oval.js ./source/factory/particle-force.js ./source/factory/particle-spring.js ./source/factory/particle-world.js ./source/factory/particle.js ./source/factory/pattern.js ./source/factory/picture.js ./source/factory/polygon.js ./source/factory/polyline.js ./source/factory/quadratic.js ./source/factory/radial-gradient.js ./source/factory/rectangle.js ./source/factory/render-animation.js ./source/factory/shape.js ./source/factory/spiral.js ./source/factory/stack.js ./source/factory/star.js ./source/factory/tetragon.js ./source/factory/ticker.js ./source/factory/tracer.js ./source/factory/tween.js ./source/factory/unstacked-element.js ./source/factory/wheel.js ./source/helper/array-pool.js ./source/helper/color-engine.js ./source/helper/document-root-elements.js ./source/helper/filter-engine-bluenoise-data.js ./source/helper/filter-engine.js ./source/helper/random-seed.js ./source/helper/shape-path-calculation.js ./source/helper/shared-vars.js ./source/helper/system-flags.js ./source/helper/utilities.js ./source/helper/workstore.js ./source/mixin/anchor.js ./source/mixin/asset-advanced-functionality.js ./source/mixin/asset-consumer.js ./source/mixin/asset.js ./source/mixin/base.js ./source/mixin/button.js ./source/mixin/cascade.js ./source/mixin/cell-key-functions.js ./source/mixin/delta.js ./source/mixin/display-shape.js ./source/mixin/dom.js ./source/mixin/entity.js ./source/mixin/filter.js ./source/mixin/hidden-dom-elements.js ./source/mixin/mimic.js ./source/mixin/path.js ./source/mixin/pattern.js ./source/mixin/pivot.js ./source/mixin/position.js ./source/mixin/shape-basic.js ./source/mixin/shape-curve.js ./source/mixin/styles.js ./source/mixin/text.js ./source/mixin/tween.js ./source/scrawl.js ./source/untracked-factory/cell-fragment.js ./source/untracked-factory/coordinate.js ./source/untracked-factory/drag-zone.js ./source/untracked-factory/keyboard-zone.js ./source/untracked-factory/observe-update.js ./source/untracked-factory/palette.js ./source/untracked-factory/particle-history.js ./source/untracked-factory/quaternion.js ./source/untracked-factory/state.js ./source/untracked-factory/text-style.js ./source/untracked-factory/vector.js
  • §

    Polygon factory

    A factory for generating various straight-edged polygon shape-based entitys

  • §

    Imports

    import { constructors } from '../core/library.js';
    
    import { doCreate, mergeOver, Ωempty } from '../helper/utilities.js';
    
    import { releaseVector, requestVector } from '../untracked-factory/vector.js';
    
    import { releaseArray, requestArray } from '../helper/array-pool.js';
    
    import baseMix from '../mixin/base.js';
    import shapeMix from '../mixin/shape-basic.js';
  • §

    Shared constants

    import { _abs, _max, _min, ENTITY, ZERO_STR } from '../helper/shared-vars.js';
  • §

    Local constants

    const POLYGON = 'polygon',
        T_POLYGON = 'Polygon';
  • §

    Polygon constructor

    const Polygon = function (items = Ωempty) {
    
        this.shapeInit(items);
        return this;
    };
  • §

    Polygon prototype

    const P = Polygon.prototype = doCreate();
    P.type = T_POLYGON;
    P.lib = ENTITY;
    P.isArtefact = true;
    P.isAsset = false;
  • §

    Mixins

    baseMix(P);
    shapeMix(P);
  • §

    Polygon attributes

    const defaultAttributes = {
    
        sides: 0,
        sideLength: 0,
  • §

    DEPRECATED - this is the (misleading) old name for the sideLength attribute

        radius: 0,
    };
    P.defs = mergeOver(P.defs, defaultAttributes);
  • §

    Packet management

    No additional packet functionality required

  • §

    Clone management

    No additional clone functionality required

  • §

    Kill management

    No additional kill functionality required

  • §

    Get, Set, deltaSet

    const S = P.setters,
        D = P.deltaSetters;
  • §

    sides

    S.sides = function (item) {
    
        this.sides = item;
        this.updateDirty();
    };
    D.sides = function (item) {
    
        this.sides += item;
        this.updateDirty();
    };
  • §

    sideLength

    S.sideLength = function (item) {
    
        this.sideLength = item;
        this.updateDirty();
    };
    D.sideLength = function (item) {
    
        this.sideLength += item;
        this.updateDirty();
    };
  • §

    DEPRECATED - this is the (misleading) old name for the sideLength attribute

    S.radius = function (item) {
    
        this.radius = item;
        this.updateDirty();
    };
    D.radius = function (item) {
    
        this.radius += item;
        this.updateDirty();
    };
  • §

    Prototype functions

  • §

    cleanSpecies - internal helper function - called by prepareStamp

    P.cleanSpecies = function () {
    
        this.dirtySpecies = false;
        this.pathDefinition = this.makePolygonPath();
    };
  • §

    makePolygonPath - internal helper function - called by cleanSpecies

    P.makePolygonPath = function () {
  • §

    radius attribute is deprecated!

        const sideLength = this.sideLength || this.radius,
            sides = this.sides,
            turn = 360 / sides,
            yPts = requestArray();
    
        let currentY = 0,
            myPath = ZERO_STR;
    
        const v = requestVector({x: 0, y: -sideLength});
    
        for (let i = 0; i < sides; i++) {
    
            v.rotate(turn);
            currentY += v.y;
            yPts.push(currentY);
            myPath += `${v.x.toFixed(1)},${v.y.toFixed(1)} `;
        }
    
        releaseVector(v);
    
        const myMin = _min(...yPts),
            myMax = _max(...yPts),
            myYoffset = (((_abs(myMin) + _abs(myMax)) - sideLength) / 2).toFixed(1);
    
        myPath = `m0,${myYoffset}l${myPath}z`;
    
        releaseArray(yPts);
    
        return myPath;
    };
  • §

    Factories

  • §
    makePolygon

    Accepts argument with attributes:

    • sides (required) - integer positive Number (greater than 2) representing the number of sides the Shape will have
    • sideLength (required) - float Number representing the length (in px) of each of the shape’s sides.
    scrawl.makePolygon({
    
        name: 'triangle',
    
        startX: 20,
        startY: 935,
    
        sideLength: 60,
        sides: 3,
    
        fillStyle: 'lightblue',
        method: 'fillAndDraw',
    });
    
    export const makePolygon = function (items) {
    
        if (!items) return false;
        items.species = POLYGON;
        return new Polygon(items);
    };
    
    constructors.Polygon = Polygon;