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

    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.

  • §

    Imports

    import { constructors } from '../core/library.js';
    
    import { doCreate, pushUnique, Ωempty } from '../helper/utilities.js';
    
    import baseMix from '../mixin/base.js';
    import stylesMix from '../mixin/styles.js';
  • §

    Shared constants

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

    Local constants

    const T_GRADIENT = 'Gradient';
  • §

    Gradient constructor

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

    Gradient prototype

    const P = Gradient.prototype = doCreate();
    
    P.type = T_GRADIENT;
    P.lib = STYLES;
    P.isArtefact = false;
    P.isAsset = false;
  • §

    Mixins

    baseMix(P);
    stylesMix(P);
  • §

    Gradient attributes

    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) {
    
            const engine = cell.engine;
    
            if (engine) {
    
                const gradient = engine.createLinearGradient(...this.gradientArgs);
    
                return this.addStopsToGradient(gradient, this.paletteStart, this.paletteEnd, this.cyclePalette);
            }
        }
        return BLANK;
    };
  • §

    updateGradientArgs - internal function

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

    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,
        colors: [
            [0, 'black'],
            [99, 'red'],
            [199, 'black'],
            [299, 'blue'],
            [399, 'black'],
            [499, 'gold'],
            [599, 'black'],
            [699, 'green'],
            [799, 'black'],
            [899, 'lavender'],
            [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',
    });
    
    export const makeGradient = function (items) {
    
        if (!items) return false;
        return new Gradient(items);
    };
    
    constructors.Gradient = Gradient;