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

    LineSpiral factory

    A factory for generating ‘degenerate’ spiral shape-based entitys

  • §

    Imports

    import { constructors } from '../core/library.js';
    
    import { doCreate, mergeOver, Ωempty } from '../helper/utilities.js';
    
    import { releaseCoordinate, requestCoordinate } from '../untracked-factory/coordinate.js';
    
    import baseMix from '../mixin/base.js';
    import shapeMix from '../mixin/shape-basic.js';
  • §

    Shared constants

    import { ENTITY, ZERO_PATH } from '../helper/shared-vars.js';
  • §

    Local constants

    const LINE_SPIRAL = 'linespiral',
        T_LINE_SPIRAL = 'LineSpiral';
  • §

    LineSpiral constructor

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

    LineSpiral prototype

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

    Mixins

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

    LineSpiral attributes

    const defaultAttributes = {
    
        startRadius: 0,
        radiusIncrement: 0.1,
        radiusIncrementAdjust: 1,
    
        startAngle: 0,
        angleIncrement: 5,
        angleIncrementAdjust: 1,
    
        stepLimit: 100,
    };
    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;
  • §

    startRadius

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

    radiusIncrement

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

    radiusIncrementAdjust

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

    startAngle

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

    angleIncrement

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

    angleIncrementAdjust

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

    stepLimit

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

    Prototype functions

  • §

    cleanSpecies - internal helper function - called by prepareStamp

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

    makeLineSpiralPath - internal helper function - called by cleanSpecies

    P.makeLineSpiralPath = function () {
    
        let path = `${ZERO_PATH} m`;
    
        const {startRadius, radiusIncrement, radiusIncrementAdjust, startAngle, angleIncrement, angleIncrementAdjust, stepLimit} = this;
    
        const coord = requestCoordinate();
    
        let currentAngle = startAngle,
            currentAngleIncrement = angleIncrement,
            currentRadius = startRadius,
            currentRadiusIncrement = radiusIncrement,
            counter = 0;
    
        coord.setFromArray([0, currentRadius]).rotate(currentAngle);
    
        path += `${coord[0].toFixed(1)},${coord[1].toFixed(1)}l`;
    
        while (counter < stepLimit) {
    
            counter ++;
    
            currentAngleIncrement *= angleIncrementAdjust;
            currentAngle += currentAngleIncrement;
    
            currentRadiusIncrement *= radiusIncrementAdjust;
            currentRadius += currentRadiusIncrement;
    
            coord.setFromArray([0, currentRadius]).rotate(currentAngle);
    
            path += `${coord[0].toFixed(1)},${coord[1].toFixed(1)} `;
        }
        releaseCoordinate(coord);
        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.makeLineSpiral({
    
        name: 'myLineSpiral',
    
        strokeStyle: 'darkgreen',
        method: 'draw',
    
        startX: 50,
        startY: 100,
    
        loops: 5,
        loopIncrement: 0.8,
        drawFromLoop: 1,
    });
    
    export const makeLineSpiral = function (items) {
    
        if (!items) return false;
        items.species = LINE_SPIRAL;
        return new LineSpiral(items);
    };
    
    constructors.LineSpiral = LineSpiral;