• 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
  • §

    Spiral factory

    A factory for generating spiral shape-based entitys

  • §

    Imports

    import { constructors } from '../core/library.js';
    
    import { doCreate, mergeOver, Ωempty } from '../helper/utilities.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 { _floor, ENTITY, ZERO_PATH } from '../helper/shared-vars.js';
  • §

    Local constants

    const SPIRAL = 'spiral',
        T_SPIRAL = 'Spiral';
    
    const FIRST_TURN = [
        [0.043, 0, 0.082, -0.035, 0.088, -0.088],
        [0.007, -0.057, -0.024, -0.121, -0.088, -0.162],
        [-0.07, -0.045, -0.169, -0.054, -0.265, -0.015],
        [-0.106, 0.043, -0.194, 0.138, -0.235, 0.265],
        [-0.044, 0.139, -0.026, 0.3, 0.058, 0.442],
        [0.091, 0.153, 0.25, 0.267, 0.442, 0.308],
        [0.206, 0.044, 0.431, -0.001, 0.619, -0.131],
        [0.2, -0.139, 0.34, -0.361, 0.381, -0.619]
    ];
    const SUBSEQUENT_TURNS = [
        [0, -0.27, -0.11, -0.52, -0.29, -0.71],
        [-0.19, -0.19, -0.44, -0.29, -0.71, -0.29],
        [-0.27, 0, -0.52, 0.11, -0.71, 0.29],
        [-0.19, 0.19, -0.29, 0.44, -0.29, 0.71],
        [0, 0.27, 0.11, 0.52, 0.29, 0.71],
        [0.19, 0.19, 0.44, 0.29, 0.71, 0.29],
        [0.27, 0, 0.52, -0.11, 0.71, -0.29],
        [0.19, -0.19, 0.29, -0.44, 0.29, -0.71]
    ];
  • §

    Spiral constructor

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

    Spiral prototype

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

    Mixins

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

    Spiral attributes

    const defaultAttributes = {
    
        loops: 1,
        loopIncrement: 1,
        drawFromLoop: 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;
  • §

    loops

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

    loopIncrement

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

    drawFromLoop

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

    Prototype functions

  • §

    cleanSpecies - internal helper function - called by prepareStamp

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

    makeSpiralPath - internal helper function - called by cleanSpecies

    P.makeSpiralPath = function () {
    
        const loops = _floor(this.loops),
            loopIncrement = this.loopIncrement,
            drawFromLoop = _floor(this.drawFromLoop),
            currentTurn = requestArray();
    
        let x1, y1, x2, y2, x3, y3,
            sx1, sy1, sx2, sy2, sx3, sy3;
    
        for (let i = 0, iz = FIRST_TURN.length; i < iz; i++) {
    
            [x1, y1, x2, y2, x3, y3] = FIRST_TURN[i];
            currentTurn.push([x1 * loopIncrement, y1 * loopIncrement, x2 * loopIncrement, y2 * loopIncrement, x3 * loopIncrement, y3 * loopIncrement]);
        }
    
        let path = ZERO_PATH;
    
        for (let j = 0; j < loops; j++) {
    
            for (let i = 0, iz = currentTurn.length; i < iz; i++) {
    
                [x1, y1, x2, y2, x3, y3] = currentTurn[i];
    
                if (j >= drawFromLoop) path += `c${x1},${y1} ${x2},${y2} ${x3},${y3}`;
    
                [sx1, sy1, sx2, sy2, sx3, sy3] = SUBSEQUENT_TURNS[i];
                currentTurn[i] = [x1 + (sx1 * loopIncrement), y1 + (sy1 * loopIncrement), x2 + (sx2 * loopIncrement), y2 + (sy2 * loopIncrement), x3 + (sx3 * loopIncrement), y3 + (sy3 * loopIncrement)];
            }
        }
        releaseArray(currentTurn);
    
        return path;
    };
    
    P.calculateLocalPathAdditionalActions = function () {
    
        const [x, y] = this.localBox,
            scale = this.scale;
    
        this.pathDefinition = this.pathDefinition.replace(ZERO_PATH, `m${-x / scale},${-y / scale}`);
    
        this.pathCalculatedOnce = false;
  • §

    ALWAYS, when invoking calculateLocalPath from calculateLocalPathAdditionalActions, include the second argument, set to true! Failure to do this leads to an infinite loop which will make your machine weep.

    • We need to recalculate the local path to take into account the offset required to put the Spiral entity’s start coordinates at the top-left of the local box, and to recalculate the data used by other artefacts to place themselves on, or move along, its path.
        this.calculateLocalPath(this.pathDefinition, true);
    };
  • §

    Factories

  • §
    makeSpiral

    A spiral drawn from an inner-radius outwards by a given number of loops, with the distance between each loop determined by a given increment. Accepts argument with attributes:

    • loops (required) - positive float Number representing the number of times the Shape line will wind arount the Shape’s center point
    • loopIncrement - float Number representative of the distance between successive loops; negative values have the effect of rotating the spiral 180 degrees
    • drawFromLoop - positive integer Number representing the loop on which the spiral starts to be drawn
    scrawl.makeSpiral({
    
        name: 'mySpiral',
    
        strokeStyle: 'darkgreen',
        method: 'draw',
    
        startX: 50,
        startY: 100,
    
        loops: 5,
        loopIncrement: 0.8,
        drawFromLoop: 1,
    });
    
    export const makeSpiral = function (items) {
    
        if (!items) return false;
        items.species = SPIRAL;
        return new Spiral(items);
    };
    
    constructors.Spiral = Spiral;