• Jump To … +
    ./source/core/animationloop.js ./source/core/component.js ./source/core/document.js ./source/core/events.js ./source/core/init.js ./source/core/library.js ./source/core/userInteraction.js ./source/core/utilities.js ./source/factory/action.js ./source/factory/anchor.js ./source/factory/animation.js ./source/factory/bezier.js ./source/factory/block.js ./source/factory/canvas.js ./source/factory/cell.js ./source/factory/cog.js ./source/factory/color.js ./source/factory/coordinate.js ./source/factory/element.js ./source/factory/emitter.js ./source/factory/filter.js ./source/factory/fontAttributes.js ./source/factory/gradient.js ./source/factory/grid.js ./source/factory/group.js ./source/factory/imageAsset.js ./source/factory/line.js ./source/factory/loom.js ./source/factory/mesh.js ./source/factory/net.js ./source/factory/noise.js ./source/factory/oval.js ./source/factory/palette.js ./source/factory/particle.js ./source/factory/particleForce.js ./source/factory/particleHistory.js ./source/factory/particleSpring.js ./source/factory/particleWorld.js ./source/factory/pattern.js ./source/factory/phrase.js ./source/factory/picture.js ./source/factory/polygon.js ./source/factory/polyline.js ./source/factory/quadratic.js ./source/factory/quaternion.js ./source/factory/radialGradient.js ./source/factory/rectangle.js ./source/factory/renderAnimation.js ./source/factory/shape.js ./source/factory/spiral.js ./source/factory/spriteAsset.js ./source/factory/stack.js ./source/factory/star.js ./source/factory/state.js ./source/factory/tetragon.js ./source/factory/ticker.js ./source/factory/tracer.js ./source/factory/tween.js ./source/factory/unstackedElement.js ./source/factory/vector.js ./source/factory/videoAsset.js ./source/factory/wheel.js ./source/mixin/anchor.js ./source/mixin/asset.js ./source/mixin/assetConsumer.js ./source/mixin/base.js ./source/mixin/cascade.js ./source/mixin/delta.js ./source/mixin/displayShape.js ./source/mixin/dom.js ./source/mixin/entity.js ./source/mixin/filter.js ./source/mixin/mimic.js ./source/mixin/path.js ./source/mixin/pattern.js ./source/mixin/pivot.js ./source/mixin/position.js ./source/mixin/shapeBasic.js ./source/mixin/shapeCurve.js ./source/mixin/shapePathCalculation.js ./source/mixin/styles.js ./source/mixin/tween.js ./source/worker/filter-string.js ./source/worker/filter.js
  • ¶

    Bezier factory

    A factory for generating bezier curve shape-based entitys

    Path-defined entitys represent a diverse range of shapes rendered onto a DOM <canvas> element using the Canvas API’s Path2D interface. They use the shapeBasic and shapePathCalculation (some also use shapeCurve) mixins to define much of their functionality.

    All path-defined entitys can be positioned, cloned, filtered etc:

    • Positioning functionality for the entity is supplied by the position mixin, while rendering functionality comes from the entity mixin.
    • Dimensions, however, have little meaning for path-defined entitys - their width and height are determined by their SVG path data Strings; use scale instead.
    • Path-defined entitys can use CSS color Strings for their fillStyle and strokeStyle values, alongside Gradient, RadialGradient, Color and Pattern objects.
    • They will also accept Filter objects.
    • They can use Anchor objects for user navigation.
    • They can be rendered to the canvas by including them in a Cell object’s Group.
    • They can be animated directly, or using delta animation, or act as the target for Tween animations.
    • Path-defined entitys can be cloned, and killed.
  • ¶

    Using path-defined entitys as Scrawl-canvas paths

    A path is a track - straight, or curved, or as complex as required - placed across a container which artefacts can use as a source of their positioning data. We can animate an artifact to move along the path:

    • To enable a path-defined entity to be used as a path by other artefacts, set its useAsPath flag to true.
    • The artefact can then set its path attribute to the path-defined entity’s name-String (or the entity itself), and set its lockTo Array values to "path".
    • We position the artefact by setting its pathPosition attribute to a float Number value between 0.0 - 1.0, with 0 being the start of the path, and 1 being its end.
    • Path-defined entitys can use other path-defined entitys as a path.
    • Phrase entitys can use a path to position their text block; they can also use a path to position each letter individually along the path.
    • Artefacts (and letters) can be rotated so that they match the rotation at that point along the path - tangential rotation by setting their addPathRotation flag to true.
    • Animate an artefact along the path by either using the artefact’s delta object, or triggering a Tween to perform the movement.
  • ¶

    Demos:

    • Canvas-011 - Shape entity (make, clone, method); drag and drop shape entitys
    • Canvas-012 - Shape entity position; shape entity as a path for other artefacts to follow
    • Canvas-013 - Path-defined entitys: oval, rectangle, line, quadratic, bezier, tetragon, polygon, star, spiral
    • Canvas-014 - Line, quadratic and bezier entitys - control lock alternatives
    • Canvas-018 - Phrase entity - text along a path
    • Canvas-024 - Loom entity functionality
    • Canvas-030 - Polyline entity functionality
    • Canvas-038 - Responsive Shape-based entitys
    • DOM-015 - Use stacked DOM artefact corners as pivot points
    • Component-004 - Scrawl-canvas packets - save and load a range of different entitys
  • ¶

    Imports

    import { constructors, artefact } from '../core/library.js';
    import { mergeOver, addStrings, pushUnique } from '../core/utilities.js';
    
    import { makeCoordinate } from './coordinate.js';
    
    import baseMix from '../mixin/base.js';
    import shapeMix from '../mixin/shapeBasic.js';
    import curveMix from '../mixin/shapeCurve.js';
  • ¶

    Bezier constructor

    const Bezier = function (items = {}) {
    
        this.startControl = makeCoordinate();
        this.endControl = makeCoordinate();
    
        this.currentStartControl = makeCoordinate();
        this.currentEndControl = makeCoordinate();
    
        this.startControlLockTo = 'coord';
        this.endControlLockTo = 'coord';
    
        this.curveInit(items);
        this.shapeInit(items);
    
        this.dirtyStartControl = true;
        this.dirtyEndControl = true;
    
        return this;
    };
  • ¶

    Bezier prototype

    let P = Bezier.prototype = Object.create(Object.prototype);
    P.type = 'Bezier';
    P.lib = 'entity';
    P.isArtefact = true;
    P.isAsset = false;
  • ¶

    Mixins

    • base
    • shapeBasic
    • shapeCurve
    P = baseMix(P);
    P = shapeMix(P);
    P = curveMix(P);
  • ¶

    Bezier attributes

    • Attributes defined in the base mixin: name.
    • Attributes defined in the position mixin: group, visibility, order, start, startX, startY, handle, handleX, handleY, offset, offsetX, offsetY, dimensions, width, height, pivoted, mimicked, lockTo, lockXTo, lockYTo, scale, roll, noUserInteraction, noPositionDependencies, noCanvasEngineUpdates, noFilters, noPathUpdates, purge, bringToFrontOnDrag.
    • Attributes defined in the delta mixin: delta, noDeltaUpdates.
    • Attributes defined in the pivot mixin: pivot, pivotCorner, addPivotHandle, addPivotOffset, addPivotRotation.
    • Attributes defined in the mimic mixin: mimic, useMimicDimensions, useMimicScale, useMimicStart, useMimicHandle, useMimicOffset, useMimicRotation, useMimicFlip, addOwnDimensionsToMimic, addOwnScaleToMimic, addOwnStartToMimic, addOwnHandleToMimic, addOwnOffsetToMimic, addOwnRotationToMimic.
    • Attributes defined in the path mixin: path, pathPosition, addPathHandle, addPathOffset, addPathRotation, constantPathSpeed.
    • Attributes defined in the entity mixin: method, pathObject, winding, flipReverse, flipUpend, scaleOutline, lockFillStyleToEntity, lockStrokeStyleToEntity, onEnter, onLeave, onDown, onUp, fillStyle, strokeStyle, globalAlpha, globalCompositeOperation, lineWidth, lineCap, lineJoin, lineDash, lineDashOffset, miterLimit, shadowOffsetX, shadowOffsetY, shadowBlur, shadowColor, filter.
    • Attributes defined in the anchor mixin: anchor.
    • Attributes defined in the filter mixin: filters, isStencil.
    • Attributes defined in the shapeBasic mixin: species, useAsPath, precision, pathDefinition, showBoundingBox, boundingBoxColor, minimumBoundingBoxDimensions, constantPathSpeed.
    • Attributes defined in the shapeCurve mixin: end, endPivot, endPivotCorner, addEndPivotHandle, addEndPivotOffset, endPath, endPathPosition, addEndPathHandle, addEndPathOffset, endLockTo, useStartAsControlPoint.
    let defaultAttributes = {
  • ¶

    The startControl coordinate (‘pin’) defines the bezier curve’s first control point.

    • Similar to the start coordinate, the startControl coordinate can be updated using the pseudo-attributes startControlX and startControlY.
        startControl: null,
  • ¶

    startControlPivot, startControlPivotCorner, addStartControlPivotHandle, addStartControlPivotOffset

    • Like the start coordinate, the startControl coordinate can be pivoted to another artefact. These attributes are used in the same way as the pivot, ‘pivotCorner’, addPivotHandle and addPivotOffset attributes.
        startControlPivot: '',
        startControlPivotCorner: '',
        addStartControlPivotHandle: false,
        addStartControlPivotOffset: false,
  • ¶

    startControlPath, startControlPathPosition, addStartControlPathHandle, addStartControlPathOffset

    • Like the start coordinate, the startControl coordinate can be pathed to another artefact. These attributes are used in the same way as the path, ‘pathPosition’, addPathHandle and addPathOffset attributes.
        startControlPath: '',
        startControlPathPosition: 0,
        addStartControlPathHandle: false,
        addStartControlPathOffset: true,
  • ¶

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

        startControlParticle: '',
  • ¶

    The endControl coordinate (‘pin’) defines the bezier curve’s second control point.

    • Similar to the start coordinate, the endControl coordinate can be updated using the pseudo-attributes endControlX and endControlY.
        endControl: null,
  • ¶

    endControlPivot, endControlPivotCorner, addEndControlPivotHandle, addEndControlPivotOffset

    • Like the start coordinate, the endControl coordinate can be pivoted to another artefact. These attributes are used in the same way as the pivot, ‘pivotCorner’, addPivotHandle and addPivotOffset attributes.
        endControlPivot: '',
        endControlPivotCorner: '',
        addEndControlPivotHandle: false,
        addEndControlPivotOffset: false,
  • ¶

    endControlPath, endControlPathPosition, addEndControlPathHandle, addEndControlPathOffset

    • Like the start coordinate, the endControl coordinate can be pathed to another artefact. These attributes are used in the same way as the path, ‘pathPosition’, addPathHandle and addPathOffset attributes.
        endControlPath: '',
        endControlPathPosition: 0,
        addEndControlPathHandle: false,
        addEndControlPathOffset: true,
  • ¶

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

        endControlParticle: '',
  • ¶

    startControlLockTo, endControlLockTo

    • Like the start coordinate, the startControl and endControl coordinate can swap between using absolute and relative positioning by setting this attribute. Accepted values are: coord (default, for absolute positioning), pivot, path, mouse.
    • These coordinates do not support ‘mimic’ relative positioning.
    • These locks do not support setting the x and y coordinates separately - their value is a string argument, not an [x, y] array!
        startControlLockTo: '',
        endControlLockTo: '',
    };
    P.defs = mergeOver(P.defs, defaultAttributes);
  • ¶

    Packet management

    P.packetExclusions = pushUnique(P.packetExclusions, []);
    P.packetExclusionsByRegex = pushUnique(P.packetExclusionsByRegex, []);
    P.packetCoordinates = pushUnique(P.packetCoordinates, ['startControl', 'endControl']);
    P.packetObjects = pushUnique(P.packetObjects, ['startControlPivot', 'startControlPath', 'endControlPivot', 'endControlPath']);
    P.packetFunctions = pushUnique(P.packetFunctions, []);
  • ¶

    Clone management

    No additional clone functionality required

  • ¶

    Kill management

    No additional kill functionality required

  • ¶

    Get, Set, deltaSet

    let G = P.getters,
        S = P.setters,
        D = P.deltaSetters;
  • ¶

    endControlPivot

    S.endControlPivot = function (item) {
    
        this.setControlHelper(item, 'endControlPivot', 'endControl');
        this.updateDirty();
        this.dirtyEndControl = true;
    };
  • ¶

    endControlParticle

    S.endControlParticle = function (item) {
    
        this.setControlHelper(item, 'endControlParticle', 'endControl');
        this.updateDirty();
        this.dirtyEndControl = true;
    };
  • ¶

    endControlPath

    S.endControlPath = function (item) {
    
        this.setControlHelper(item, 'endControlPath', 'endControl');
        this.updateDirty();
        this.dirtyEndControl = true;
        this.currentEndControlPathData = false;
    };
  • ¶

    endControlPathPosition

    S.endControlPathPosition = function (item) {
    
        this.endControlPathPosition = item;
        this.dirtyEndControl = true;
        this.currentEndControlPathData = false;
    };
    D.endControlPathPosition = function (item) {
    
        this.endControlPathPosition += item;
        this.dirtyEndControl = true;
        this.currentEndControlPathData = false;
    };
  • ¶

    startControlPivot

    S.startControlPivot = function (item) {
    
        this.setControlHelper(item, 'startControlPivot', 'startControl');
        this.updateDirty();
        this.dirtyStartControl = true;
    };
  • ¶

    startControlParticle

    S.startControlParticle = function (item) {
    
        this.setControlHelper(item, 'startControlParticle', 'startControl');
        this.updateDirty();
        this.dirtyStartControl = true;
    };
  • ¶

    startControlPath

    S.startControlPath = function (item) {
    
        this.setControlHelper(item, 'startControlPath', 'startControl');
        this.updateDirty();
        this.dirtyStartControl = true;
        this.currentStartControlPathData = false;
    };
  • ¶

    startControlPathPosition

    S.startControlPathPosition = function (item) {
    
        this.startControlPathPosition = item;
        this.dirtyStartControl = true;
        this.currentStartControlPathData = false;
    };
    D.startControlPathPosition = function (item) {
    
        this.startControlPathPosition += item;
        this.dirtyStartControl = true;
        this.currentStartControlPathData = false;
    };
  • ¶

    startControl

    • pseudo-attributes startControlX, startControlY
    S.startControlX = function (coord) {
    
        if (coord != null) {
    
            this.startControl[0] = coord;
            this.updateDirty();
            this.dirtyStartControl = true;
            this.currentStartControlPathData = false;
        }
    };
    S.startControlY = function (coord) {
    
        if (coord != null) {
    
            this.startControl[1] = coord;
            this.updateDirty();
            this.dirtyStartControl = true;
            this.currentStartControlPathData = false;
        }
    };
    S.startControl = function (x, y) {
    
        this.setCoordinateHelper('startControl', x, y);
        this.updateDirty();
        this.dirtyStartControl = true;
        this.currentStartControlPathData = false;
    };
    D.startControlX = function (coord) {
    
        let c = this.startControl;
        c[0] = addStrings(c[0], coord);
        this.updateDirty();
        this.dirtyStartControl = true;
        this.currentStartControlPathData = false;
    };
    D.startControlY = function (coord) {
    
        let c = this.startControl;
        c[1] = addStrings(c[1], coord);
        this.updateDirty();
        this.dirtyStartControl = true;
        this.currentStartControlPathData = false;
    };
    D.startControl = function (x, y) {
    
        this.setDeltaCoordinateHelper('startControl', x, y);
        this.updateDirty();
        this.dirtyStartControl = true;
        this.currentStartControlPathData = false;
    };
  • ¶

    endControl

    • pseudo-attributes endControlX, endControlY
    S.endControlX = function (coord) {
    
        if (coord != null) {
    
            this.endControl[0] = coord;
            this.updateDirty();
            this.dirtyEndControl = true;
            this.currentEndControlPathData = false;
        }
    };
    S.endControlY = function (coord) {
    
        if (coord != null) {
    
            this.endControl[1] = coord;
            this.updateDirty();
            this.dirtyEndControl = true;
            this.currentEndControlPathData = false;
        }
    };
    S.endControl = function (x, y) {
    
        this.setCoordinateHelper('endControl', x, y);
        this.updateDirty();
        this.dirtyEndControl = true;
        this.currentEndControlPathData = false;
    };
    D.endControlX = function (coord) {
    
        let c = this.endControl;
        c[0] = addStrings(c[0], coord);
        this.updateDirty();
        this.dirtyEndControl = true;
        this.currentEndControlPathData = false;
    };
    D.endControlY = function (coord) {
    
        let c = this.endControl;
        c[1] = addStrings(c[1], coord);
        this.updateDirty();
        this.dirtyEndControl = true;
        this.currentEndControlPathData = false;
    };
    D.endControl = function (x, y) {
    
        this.setDeltaCoordinateHelper('endControl', x, y);
        this.updateDirty();
        this.dirtyEndControl = true;
        this.currentEndControlPathData = false;
    };
  • ¶

    startControlLockTo

    S.startControlLockTo = function (item) {
    
        this.startControlLockTo = item;
        this.updateDirty();
        this.dirtyStartControlLock = true;
    };
  • ¶

    endControlLockTo

    S.endControlLockTo = function (item) {
    
        this.endControlLockTo = item;
        this.updateDirty();
        this.dirtyEndControlLock = true;
        this.currentEndControlPathData = false;
    };
  • ¶

    Prototype functions

  • ¶

    cleanSpecies - internal helper function - called by prepareStamp

    P.cleanSpecies = function () {
    
        this.dirtySpecies = false;
    
        let p = 'M0,0';
    
        p = this.makeBezierPath();
        
        this.pathDefinition = p;
    };
  • ¶

    makeBezierPath - internal helper function - called by cleanSpecies

    P.makeBezierPath = function () {
        
        let [startX, startY] = this.currentStampPosition;
        let [startControlX, startControlY] = this.currentStartControl;
        let [endControlX, endControlY] = this.currentEndControl;
        let [endX, endY] = this.currentEnd;
    
        let scx = (startControlX - startX).toFixed(2),
            scy = (startControlY - startY).toFixed(2),
            ecx = (endControlX - startX).toFixed(2),
            ecy = (endControlY - startY).toFixed(2),
            ex = (endX - startX).toFixed(2),
            ey = (endY - startY).toFixed(2);
    
        return `m0,0c${scx},${scy} ${ecx},${ecy} ${ex},${ey}`;
    };
  • ¶

    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.dirtyStartControl = true;
        this.dirtyEndControl = true;
        this.dirtyEnd = true;
    };
    
    P.preparePinsForStamp = function () {
    
        let ePivot = this.endPivot,
            ePath = this.endPath,
            scPivot = this.startControlPivot,
            scPath = this.startControlPath,
            ecPivot = this.endControlPivot,
            ecPath = this.endControlPath;
    
        this.dirtyPins.forEach(name => {
    
            if ((scPivot && scPivot.name === name) || (scPath && scPath.name === name)) {
    
                this.dirtyStartControl = true;
                if (this.startControlLockTo.includes('path')) this.currentStartControlPathData = false;
            }
    
            if ((ecPivot && ecPivot.name === name) || (ecPath && ecPath.name === name)) {
    
                this.dirtyEndControl = true;
                if (this.endControlLockTo.includes('path')) this.currentEndControlPathData = false;
            }
    
            if ((ePivot && ePivot.name === name) || (ePath && ePath.name === name)) {
    
                this.dirtyEnd = true;
                if (this.endLockTo.includes('path')) this.currentEndPathData = false;
            }
        });
        this.dirtyPins.length = 0;
    };
  • ¶

    Factories

  • ¶
    makeBezier

    Accepts argument with attributes:

    • start (startX, startY) Coordinate, or pivot/mimic/path reference artefact (required)
    • startControl (startControlX, startControlY) Coordinate, or startControlPivot/startControlPath reference artefact (required)
    • endControl (endCcontrolX___, __endCcontrolY_) Coordinate, or endControlPivot/endControlPath 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), startControlLockTo, endControlLockTo and endLockTo lock attributes
    • additional reference-linked attributes for the startControl coordinate: startControlPivotCorner, addStartControlPivotHandle, addStartControlPivotOffset, startControlPathPosition, addStartControlPathHandle, addStartControlPathOffset
    • additional reference-linked attributes for the endControl coordinate: endControlPivotCorner, addEndControlPivotHandle, addEndControlPivotOffset, endControlPathPosition, addEndControlPathHandle, addEndControlPathOffset
    • additional reference-linked attributes for the end coordinate: endPivotCorner, addEndPivotHandle, addEndPivotOffset, endPathPosition, addEndPathHandle, addEndPathOffset
    scrawl.makeBezier({
    
        name: 'bezier-curve',
    
        startX: '5%',
        startY: '36%',
    
        startControlX: '40%',
        startControlY: '31%',
    
        endControlX: '60%',
        endControlY: '41%',
    
        endX: '95%',
        endY: '36%',
    
        handleY: 'center',
    
        lineWidth: 3,
        lineCap: 'round',
        strokeStyle: 'linen',
    
        method: 'draw',
    });
    const makeBezier = function (items = {}) {
    
        items.species = 'bezier';
        return new Bezier(items);
    };
    
    constructors.Bezier = Bezier;
  • ¶

    Exports

    export {
        makeBezier,
    };