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

    Quadratic factory

    A factory for generating quadratic curve shape-based entitys

  • §

    Imports

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

    Shared constants

    import { CONTROL, ENTITY, PATH, QUADRATIC, T_QUADRATIC, ZERO_PATH, ZERO_STR } from '../helper/shared-vars.js';
  • §

    Local constants

    const CONTROL_PARTICLE = 'controlParticle',
        CONTROL_PATH = 'controlPath',
        CONTROL_PIVOT = 'controlPivot';
  • §

    Quadratic constructor

    const Quadratic = function (items = Ωempty) {
    
        this.control = makeCoordinate();
        this.currentControl = makeCoordinate();
        this.controlLockTo = 'coord';
    
        this.curveInit(items);
        this.shapeInit(items);
    
        this.dirtyControl = true;
    
        return this;
    };
  • §

    Quadratic prototype

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

    Mixins

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

    Quadratic attributes

    const defaultAttributes = {
  • §

    The control coordinate (‘pin’) defines the quadratic curve’s control point.

    • Similar to the start coordinate, the control coordinate can be updated using the pseudo-attributes controlX and controlY.
        control: null,
  • §

    controlPivot, controlPivotCorner, addControlPivotHandle, addControlPivotOffset

    • Like the start coordinate, the control coordinate can be pivoted to another artefact. These attributes are used in the same way as the pivot, ‘pivotCorner’, addPivotHandle and addPivotOffset attributes.
        controlPivot: ZERO_STR,
        controlPivotCorner: ZERO_STR,
        controlPivotIndex: -1,
        addControlPivotHandle: false,
        addControlPivotOffset: false,
  • §

    controlPath, controlPathPosition, addControlPathHandle, addControlPathOffset

    • Like the start coordinate, the control coordinate can be pathed to another artefact. These attributes are used in the same way as the path, ‘pathPosition’, addPathHandle and addPathOffset attributes.
        controlPath: ZERO_STR,
        controlPathPosition: 0,
        addControlPathHandle: false,
        addControlPathOffset: true,
  • §

    controlParticle - attribute to store any particle the artefact mey be using for its position reference

        controlParticle: ZERO_STR,
  • §

    controlLockTo

    • Like the start coordinate, the control coordinate can swap between using absolute and relative positioning by setting this attribute. Accepted values are: coord (default, for absolute positioning), pivot, path, mouse.
    • The control coordinate does not support ‘mimic’ relative positioning.
    • The control lock does not support setting the x and y coordinates separately - its value is a string argument, not an [x, y] array!
        controlLockTo: ZERO_STR,
    };
    P.defs = mergeOver(P.defs, defaultAttributes);
  • §

    Packet management

    P.packetCoordinates = pushUnique(P.packetCoordinates, ['control']);
    P.packetObjects = pushUnique(P.packetObjects, ['controlPivot', 'controlPath']);
  • §

    Clone management

    No additional clone functionality required

  • §

    Kill management

    No additional kill functionality required

  • §

    Get, Set, deltaSet

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

    controlPivot

    S.controlPivot = function (item) {
    
        this.setControlHelper(item, CONTROL_PIVOT, CONTROL);
        this.updateDirty();
        this.dirtyControl = true;
    };
  • §

    controlParticle

    S.controlParticle = function (item) {
    
        this.setControlHelper(item, CONTROL_PARTICLE, CONTROL);
        this.updateDirty();
        this.dirtyControl = true;
    };
  • §

    controlPath

    S.controlPath = function (item) {
    
        this.setControlHelper(item, CONTROL_PATH, CONTROL);
        this.updateDirty();
        this.dirtyControl = true;
        this.currentControlPathData = false;
    };
  • §

    controlPathPosition

    S.controlPathPosition = function (item) {
    
        this.controlPathPosition = item;
        this.dirtyControl = true;
        this.currentControlPathData = false;
        this.dirtyFilterIdentifier = true;
    };
    D.controlPathPosition = function (item) {
    
        this.controlPathPosition += item;
        this.dirtyControl = true;
        this.currentControlPathData = false;
        this.dirtyFilterIdentifier = true;
    };
  • §

    control

    • pseudo-attributes controlX, controlY
    G.controlPositionX = function () {
    
        return this.currentControl[0];
    };
    G.controlPositionY = function () {
    
        return this.currentControl[1];
    };
    G.controlPosition = function () {
    
        return [].concat(this.currentControl);
    };
    
    S.controlX = function (coord) {
    
        if (coord != null) {
    
            this.control[0] = coord;
            this.updateDirty();
            this.dirtyControl = true;
            this.currentControlPathData = false;
        }
    };
    S.controlY = function (coord) {
    
        if (coord != null) {
    
            this.control[1] = coord;
            this.updateDirty();
            this.dirtyControl = true;
            this.currentControlPathData = false;
        }
    };
    S.control = function (x, y) {
    
        this.setCoordinateHelper(CONTROL, x, y);
        this.updateDirty();
        this.dirtyControl = true;
        this.currentControlPathData = false;
    };
    D.controlX = function (coord) {
    
        const c = this.control;
        c[0] = addStrings(c[0], coord);
        this.updateDirty();
        this.dirtyControl = true;
        this.currentControlPathData = false;
    };
    D.controlY = function (coord) {
    
        const c = this.control;
        c[1] = addStrings(c[1], coord);
        this.updateDirty();
        this.dirtyControl = true;
        this.currentControlPathData = false;
    };
    D.control = function (x, y) {
    
        this.setDeltaCoordinateHelper(CONTROL, x, y);
        this.updateDirty();
        this.dirtyControl = true;
        this.currentControlPathData = false;
    };
  • §

    controlLockTo

    S.controlLockTo = function (item) {
    
        this.controlLockTo = item;
        this.updateDirty();
        this.dirtyControlLock = true;
        this.currentControlPathData = false;
    };
  • §

    Prototype functions

  • §

    cleanSpecies - internal helper function - called by prepareStamp

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

    makeQuadraticPath - internal helper function - called by cleanSpecies

    P.makeQuadraticPath = function () {
    
        const [startX, startY] = this.currentStampPosition;
        const [controlX, controlY] = this.currentControl;
        const [endX, endY] = this.currentEnd;
    
        return `${ZERO_PATH}q${(controlX - startX).toFixed(2)},${(controlY - startY).toFixed(2)} ${(endX - startX).toFixed(2)},${(endY - startY).toFixed(2)}`;
    };
  • §

    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.dirtyControl = true;
        this.dirtyEnd = true;
    
        this.dirtyFilterIdentifier = true;
    };
    
    P.preparePinsForStamp = function () {
    
        const dirtyPins = this.dirtyPins,
            ePivot = this.endPivot,
            ePath = this.endPath,
            cPivot = this.controlPivot,
            cPath = this.controlPath;
    
        for (let i = 0, iz = dirtyPins.length, name; i < iz; i++) {
    
            name = dirtyPins[i];
    
            if ((cPivot && cPivot.name === name) || (cPath && cPath.name === name)) {
    
                this.dirtyControl = true;
                if (this.controlLockTo.includes(PATH)) this.currentControlPathData = false;
            }
    
            if ((ePivot && ePivot.name === name) || (ePath && ePath.name === name)) {
    
                this.dirtyEnd = true;
                if (this.endLockTo.includes(PATH)) this.currentEndPathData = false;
            }
        }
        dirtyPins.length = 0;
    };
  • §

    Factories

  • §
    makeQuadratic

    Accepts argument with attributes:

    • start (startX, startY) Coordinate, or pivot/mimic/path reference artefact (required)
    • control (controlX, controlY) Coordinate, or controlPivot/controlPath 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), controlLockTo and endLockTo lock attributes
    • additional reference-linked attributes for the control coordinate: controlPivotCorner, addControlPivotHandle, addControlPivotOffset, controlPathPosition, addControlPathHandle, addControlPathOffset
    • additional reference-linked attributes for the end coordinate: endPivotCorner, addEndPivotHandle, addEndPivotOffset, endPathPosition, addEndPathHandle, addEndPathOffset
    scrawl.makeQuadratic({
    
        name: 'my-quadratic',
    
        startX: '5%',
        startY: '26.5%',
    
        controlX: '50%',
        controlY: '18%',
    
        endX: '95%',
        endY: '26.5%',
    
        handleY: 'center',
    
        lineWidth: 3,
        lineCap: 'round',
        strokeStyle: 'darkseagreen',
    
        method: 'draw',
    });
    
    export const makeQuadratic = function (items = Ωempty) {
    
        if (!items) return false;
        items.species = QUADRATIC;
        return new Quadratic(items);
    };
    
    constructors.Quadratic = Quadratic;