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

    Gradient factory

    Scrawl-canvas Gradient objects implement the Canvas API’s createLinearGradient method. The resulting CanvasGradient object can be used by any Scrawl-canvas entity as its fillStyle or strokeStyle.

    • Most gradient-related functionality has been coded up in the styles mixin, and is documented there.
    • Gradients fully participate in the Scrawl-canvas packet system, thus can be saved, restored, cloned, killed, etc.
    • Gradients can be animated in a variety of ways; the can act as target objects for Scrawl-canvas Tweens.

    Gradients can be applied to an entity in two different ways, depending on the entity’s lockFillStyleToEntity and lockStrokeStyleToEntity attribute flags:

    • Cell-locked Gradients will cover the entire Cell; an entity moved from one part of the display to another will show different parts of the gradient
    • Entity-locked Gradients display their entire color range on the entity, move with the entity and even rotate with the entity.
  • ¶

    Demos:

    • Canvas-003 - Linear gradients
    • Canvas-005 - Cell-locked, and Entity-locked, gradients; animating gradients by delta, and by tween
    • Canvas-022 - Grid entity - basic functionality (color, gradients)
  • ¶

    Imports

    import { constructors } from '../core/library.js';
    import { pushUnique } from '../core/utilities.js';
    
    import baseMix from '../mixin/base.js';
    import stylesMix from '../mixin/styles.js';
  • ¶

    Gradient constructor

    const Gradient = function (items = {}) {
    
        this.stylesInit(items);
        return this;
    };
  • ¶

    Gradient prototype

    let P = Gradient.prototype = Object.create(Object.prototype);
    
    P.type = 'Gradient';
    P.lib = 'styles';
    P.isArtefact = false;
    P.isAsset = false;
  • ¶

    Mixins

    P = baseMix(P);
    P = stylesMix(P);
  • ¶

    Gradient attributes

    • Attributes defined in the base mixin: name.
    • Attributes defined in the styles mixin: start, end, palette, paletteStart, paletteEnd, cyclePalette.
    • Attributes defined in the Palette factory: colors, cyclic.

    No additional attributes are defined in this file.

  • ¶

    Packet management

    P.packetObjects = pushUnique(P.packetObjects, ['palette']);
  • ¶

    Clone management

    No additional clone functionality required

  • ¶

    Kill management

    No additional kill functionality required

  • ¶

    Get, Set, deltaSet

    No additional functionality required

  • ¶

    Prototype functions

  • ¶

    buildStyle - internal function: creates the linear gradient on the Cell’s CanvasRenderingContext2D engine, and then adds the color stops to it.

    P.buildStyle = function (cell = {}) {
        
        if (cell) {
    
            let engine = cell.engine;
    
            if (engine) {
    
                let gradient = engine.createLinearGradient(...this.gradientArgs);
                
                return this.addStopsToGradient(gradient, this.paletteStart, this.paletteEnd, this.cyclePalette);
            }
        }
        return 'rgba(0,0,0,0)';
    };
  • ¶

    updateGradientArgs - internal function

    P.updateGradientArgs = function (x, y) {
    
        let gradientArgs = this.gradientArgs,
            currentStart = this.currentStart,
            currentEnd = this.currentEnd;
    
        let sx = currentStart[0] + x,
            sy = currentStart[1] + y,
            ex = currentEnd[0] + x,
            ey = currentEnd[1] + y;
  • ¶

    check to correct situation where coordinates represent a ‘0 x 0’ box - which will cause errors in some browsers

        if (sx === ex && sy === ey) ex++;
    
        gradientArgs.length = 0;
        gradientArgs.push(sx, sy, ex, ey);
    };
  • ¶

    Factory

    scrawl.makeGradient({
        name: 'colored-pipes',
        endX: '100%',
        cyclePalette: true
    })
    .updateColor(0, 'black')
    .updateColor(49, 'yellow')
    .updateColor(99, 'black')
    .updateColor(149, 'lightyellow')
    .updateColor(199, 'black')
    .updateColor(249, 'goldenrod')
    .updateColor(299, 'black')
    .updateColor(349, 'lemonchiffon')
    .updateColor(399, 'black')
    .updateColor(449, 'gold')
    .updateColor(499, 'black')
    .updateColor(549, 'tan')
    .updateColor(599, 'black')
    .updateColor(649, 'wheat')
    .updateColor(699, 'black')
    .updateColor(749, 'yellowgreen')
    .updateColor(799, 'black')
    .updateColor(849, 'peachpuff')
    .updateColor(899, 'black')
    .updateColor(949, 'papayawhip')
    .updateColor(999, 'black');
    
    scrawl.makeBlock({
    
        name: 'animated-block',
    
        width: 150,
        height: 150,
    
        startX: 180,
        startY: 120,
    
        handleX: 'center',
        handleY: 'center',
    
        strokeStyle: 'coral',
        fillStyle: 'colored-pipes',
        lineWidth: 2,
    
        method: 'fillAndDraw',
    });
    const makeGradient = function (items) {
        return new Gradient(items);
    };
    
    constructors.Gradient = Gradient;
  • ¶

    Exports

    export {
        makeGradient,
    };