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

    RadialGradient factory

    Scrawl-canvas RadialGradient objects implement the Canvas API’s createRadialGradient 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 { addStrings, doCreate, isa_number, mergeOver, pushUnique, Ωempty } from '../helper/utilities.js';
    
    import baseMix from '../mixin/base.js';
    import stylesMix from '../mixin/styles.js';
  • §

    Shared constants

    import { BLANK, BOTTOM, CENTER, LEFT, RIGHT, STYLES, TOP } from '../helper/shared-vars.js';
  • §

    Local constants

    const T_RADIAL_GRADIENT = 'RadialGradient';
  • §

    RadialGradient constructor

    const RadialGradient = function (items = Ωempty) {
    
        this.currentStartRadius = 0;
        this.currentEndRadius = 0;
    
        this.stylesInit(items);
        return this;
    };
  • §

    RadialGradient prototype

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

    Mixins

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

    RadialGradient attributes

    const defaultAttributes = {
  • §

    RadialGradients calculate their gradients spanning between two circles, whose sizes are determined by the startRadius and endRadius attributes. Values can be:

    • Absolute - Numbers, measured in pixels.
    • Relative - String% - as a percentage of the containing Cell’s width
        startRadius: 0,
        endRadius: 0,
    };
    P.defs = mergeOver(P.defs, defaultAttributes);
  • §

    In addition to the attributes defined in the base and styles mixins, Gradients also pass through Palette attributes to their Palette object.

    Attributes from base mixin:

    • name

    Attributes from styles mixin:

    • start
    • startX
    • startY
    • end
    • endX
    • endY
    • palette
    • paletteStart
    • paletteEnd
    • cyclePalette

    Attributes from the palette factory:

    • colors
    • cyclic
  • §

    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

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

    The getter functions myradialgradient.get('startRadius') and myradialgradient.get('endRadius') return the current radius values as Numbers, measuring pixels

    G.startRadius = function () {
    
        return this.currentStartRadius;
    };
    G.endRadius = function () {
    
        return this.currentEndRadius;
    };
  • §

    Both startRadius and endRadius attributes can be set and deltaSet

    S.startRadius = function (item) {
    
        this.startRadius = item;
        this.dirtyStyle = true;
    };
    S.endRadius = function (item) {
    
        this.endRadius = item;
        this.dirtyStyle = true;
    };
    D.startRadius = function (item) {
    
        this.startRadius = addStrings(this.startRadius, item);
        this.dirtyStyle = true;
    };
    D.endRadius = function (item) {
    
        this.endRadius = addStrings(this.endRadius, item);
        this.dirtyStyle = true;
    };
  • §

    Prototype functions

  • §

    cleanRadius - internal function to calculate the current radius values (in px) of the start and end radii

    P.cleanRadius = function (width) {
    
        const convertLength = (val, len) => {
    
            if (isa_number(val)) return val;
    
            else {
    
                switch(val){
    
                    case TOP :
                    case LEFT :
                        return 0;
    
                    case BOTTOM :
                    case RIGHT :
                        return len;
    
                    case CENTER :
                        return len / 2;
    
                    default :
                        val = parseFloat(val);
    
                        if (!isa_number(val)) return 0;
    
                        return ( val / 100) * len;
                }
            }
        };
    
        this.currentStartRadius = (width) ? convertLength(this.startRadius, width) : this.defs.startRadius;
        this.currentEndRadius = (width) ? convertLength(this.endRadius, width) : this.defs.endRadius;
    };
  • §

    buildStyle - internal function: creates the radial 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.createRadialGradient(...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,
            sr = this.currentStartRadius;
    
        let er = this.currentEndRadius;
    
        const 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 && sr === er) er++;
    
        gradientArgs.length = 0;
        gradientArgs.push(sx, sy, sr, ex, ey, er);
    };
  • §

    Factory

    let graddy = scrawl.makeRadialGradient({
    
        name: 'mygradient',
    
        startX: '50%',
        startY: '50%',
        endX: '50%',
        endY: '50%',
    
        endRadius: 300,
    });
    
    scrawl.makeBlock({
    
        name: 'myblock',
    
        width: '90%',
        height: '90%',
        startX: '5%',
        startY: '5%',
    
        fillStyle: graddy,
        strokeStyle: 'coral',
        lineWidth: 2,
    
        method: 'fillAndDraw',
    });
    
    export const makeRadialGradient = function (items) {
    
        if (!items) return false;
        return new RadialGradient(items);
    };
    
    constructors.RadialGradient = RadialGradient;