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

    Line factory

    A factory for generating straight linbe shape-based entitys

  • §

    Imports

    import { constructors } from '../core/library.js';
    
    import { doCreate, Ωempty } from '../helper/utilities.js';
    
    import baseMix from '../mixin/base.js';
    import shapeMix from '../mixin/shape-basic.js';
    import curveMix from '../mixin/shape-curve.js';
  • §

    Shared constants

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

    Local constants

    const LINE = 'line';
  • §

    Line constructor

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

    Line prototype

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

    Mixins

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

    Line attributes

    No additional attributes required

  • §

    Packet management

    No additional packet functionality required

  • §

    Clone management

    No additional clone functionality required

  • §

    Kill management

    No additional kill functionality required

  • §

    Get, Set, deltaSet

    No additional getter/setter functionality required

  • §

    Prototype functions

  • §

    cleanSpecies - internal helper function - called by prepareStamp

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

    makeLinePath - internal helper function - called by cleanSpecies

    P.makeLinePath = function () {
    
        let p = ZERO_PATH;
        const { currentStampPosition, currentEnd } = this;
    
        if (currentStampPosition && currentEnd) {
    
            const [startX, startY] = this.currentStampPosition;
            const [endX, endY] = this.currentEnd;
    
            const x = (endX - startX).toFixed(2),
                y = (endY - startY).toFixed(2);
    
            p = `m0,0l${x},${y}`;
        }
        return p;
    };
  • §

    cleanDimensions - internal helper function called by prepareStamp

    • Dimensional data has no meaning in the context of Shape entitys (beyond positioning handle Coordinates): width and height are emergent properties that cannot be set on the entity.
    P.cleanDimensions = function () {
    
        this.dirtyDimensions = false;
        this.dirtyHandle = true;
        this.dirtyOffset = true;
    
        this.dirtyStart = true;
        this.dirtyEnd = true;
    };
    
    P.preparePinsForStamp = function () {
    
        const dirtyPins = this.dirtyPins,
            ePivot = this.endPivot,
            ePath = this.endPath;
    
        let i, iz, name;
    
        for (i = 0, iz = dirtyPins.length; i < iz; i++) {
    
            name = dirtyPins[i];
    
            if ((ePivot && ePivot.name === name) || (ePath && ePath.name === name)) {
    
                this.dirtyEnd = true;
                if (this.endLockTo.includes(PATH)) this.currentEndPathData = false;
            }
        }
        dirtyPins.length = 0;
    };
  • §

    Factories

  • §
    makeLine

    Accepts argument with attributes:

    • start (startX, startY) Coordinate, or pivot/mimic/path reference artefact (required)
    • end (endX, endY) Coordinate, or endPivot/endPath reference artefact (required)
    • If using reference artefacts, may also need to set the lockTo (lockXTo, lockYTo) and endLockTo lock attributes
    • additional reference-linked attributes for the end coordinate: endPivotCorner, addEndPivotHandle, addEndPivotOffset, endPathPosition, addEndPathHandle, addEndPathOffset
    scrawl.makeLine({
    
        name: 'my-line',
    
        startX: 20,
        startY: 300,
    
        endX: 580,
        endY: 275,
    
        lineWidth: 3,
        lineCap: 'round',
    
        strokeStyle: 'darkgoldenrod',
        method: 'draw',
    });
    
    export const makeLine = function (items) {
    
        if (!items) return false;
        items.species = LINE;
        return new Line(items);
    };
    
    constructors.Line = Line;