• Jump To … +
    ./source/core/animationloop.js ./source/core/document.js ./source/core/events.js ./source/core/init.js ./source/core/library.js ./source/core/random-seed.js ./source/core/snippets.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/conicGradient.js ./source/factory/coordinate.js ./source/factory/crescent.js ./source/factory/element.js ./source/factory/emitter.js ./source/factory/filter.js ./source/factory/filterEngine-bluenoiseData.js ./source/factory/filterEngine.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/lineSpiral.js ./source/factory/loom.js ./source/factory/mesh.js ./source/factory/net.js ./source/factory/noiseAsset.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/rawAsset.js ./source/factory/rdAsset.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/assetAdvancedFunctionality.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
  • §

    AssetAdvancedFunctionality mixin

    The following functionality is shared between NoiseAsset and RdAsset objects

  • §

    Imports

    import { mergeOver, pushUnique, λnull, Ωempty } from '../core/utilities.js';
    import { makeGradient } from '../factory/gradient.js';
  • §

    Export function

    export default function (P = Ωempty) {
  • §

    Shared attributes

        let defaultAttributes = {
    
            choke: 15,
  • §

    paletteStart, paletteEnd pseudo-attributes - We don’t need to use the entire palette when building a gradient; we can restrict the palette using these start and end attributes.

  • §

    The cyclePalette pseudo-attribute tells the Palette object how to handle situations where the paletteStart value is greater than the paletteEnd value:

    • when false, we reverse the color stops
    • when true, we keep the normal order of color stops and pass through the 1/0 border
  • §

    The Gradient’s delta object is not stored in the defs object; it acts in a similar way to the artefact delta object - though it is restricted to adding delta values to Number and ‘String%’ attributes.

    The colors pseudo-attribute can be used to pass through an array of palette color objects to the Gradient Palette object. The data is not retained by the gradient object.

    • A better approach to managing gradient colors after it has been created is to use the gradient.updateColor and gradient.removeColor functions
  • §

    The easing pseudo-attribute represents a transformation that will be applied to a copy of the color stops Array - this allows us to create non-linear gradients. Value is passed through to the Palette object

  • §

    The precision pseudo-attribute - value is passed through to the Gradient Palette object

  • §

    The colorSpace - String pseudo-attribute defines the color space to be used by the Gradient Palette’s Color object for its internal calculations - value is passed through to the Palette object

    • Accepted values from: 'RGB', 'HSL', 'HWB', 'XYZ', 'LAB', 'LCH', 'OKLAB', 'OKLCH' with RGB as the default

    The returnColorAs - String pseudo-attribute defines the type of color String the Gradient Palette’s Color object will return - value is passed through to the Gradient Palette object

    • Accepted values from: 'RGB', 'HSL', 'HWB', 'LAB', 'LCH', 'OKLAB', 'OKLCH' with RGB as the default
        };
        P.defs = mergeOver(P.defs, defaultAttributes);
  • §

    Packet management

    No additional packet management functionality defined here

  • §

    Clone management

    No additional clone functionality defined here

  • §

    Kill management

    No additional kill functionality defined here

  • §

    Get, Set, deltaSet

    These all route get/set/setDelta attribute changes through to the Gradient object

        let S = P.setters, 
            D = P.deltaSetters;
    
        S.paletteStart = function (item) {
    
            if (this.gradient) this.gradient.set({ paletteStart: item });
        };
        D.paletteStart = function (item) {
    
            if (this.gradient) this.gradient.setDelta({ paletteStart: item });
        };
    
        S.paletteEnd = function (item) {
    
            if (this.gradient) this.gradient.set({ paletteEnd: item });
        };
    
        D.paletteEnd = function (item) {
    
            if (this.gradient) this.gradient.setDelta({ paletteEnd: item });
        };
    
        S.colors = function (item) {
    
            if (this.gradient) this.gradient.set({ colors: item });
        };
    
        S.precision = function (item) {
    
            if (this.gradient) this.gradient.set({ precision: item });
        };
    
        S.easing = function (item) {
    
            if (this.gradient) this.gradient.set({ easing: item });
        };
        S.easingFunction = S.easing;
    
        S.colorSpace = function (item) {
    
            if (this.gradient) this.gradient.set({ colorSpace: item });
        };
        S.returnColorAs = function (item) {
    
            if (this.gradient) this.gradient.set({ returnColorAs: item });
        };
    
        S.cyclePalette = function (item) {
    
            if (this.gradient) this.gradient.set({ cyclePalette: item });
        };
    
        S.delta = function (items = Ωempty) {
    
            if (this.gradient) this.gradient.set({ delta: items });
        };
  • §

    Prototype functions

  • §

    installElement - internal function, used by the constructor

        P.installElement = function (name) {
    
            let element = document.createElement('canvas');
            element.id = name;
            this.element = element;
            this.engine = this.element.getContext('2d');
  • §

    The color canvas allows us to map contour-like lines across a noise or rd asset’s output.

            let color = document.createElement('canvas');
            color.id = `${name}-color`;
            color.width = 256;
            color.height = 1;
            this.colorElement = color;
            this.colorEngine = this.colorElement.getContext('2d');
    
            this.gradient = makeGradient({
                name: `${name}-gradient`,
                endX: '100%',
                delta: {
                    paletteStart: 0,
                    paletteEnd: 0,
                },
                cyclePalette: false,
            });
    
            this.gradientLastUpdated = 0;
    
            return this;
        };
  • §

    checkSource

    • Gets invoked by subscribers (who have a handle to the asset instance object) as part of the display cycle.
    • Assets will automatically pass this call onto notifySubscribers, where dirty flags get checked and rectified
        P.checkSource = function (width, height) {
    
            this.notifySubscribers();
        };
  • §

    getData function called by Cell objects when calculating required updates to its CanvasRenderingContext2D engine, specifically for an entity’s fillStyle, strokeStyle and shadowColor attributes.

    • This is the point when we clean Scrawl-canvas assets which have told their subscribers that asset data/attributes have updated
        P.getData = function (entity, cell) {
    
            this.notifySubscribers();
    
            return this.buildStyle(cell);
        };
  • §

    notifySubscribers - If the gradient is to be animated, then we need to update the asset at some point (generally the start) of each Display cycle by invoking this function

        P.update = function () {
    
            this.dirtyOutput = true;
        };
  • §

    notifySubscribers, notifySubscriber - overwrites the functions defined in mixin/asset.js

        P.notifySubscribers = function () {
    
            if (this.dirtyOutput) this.cleanOutput();
    
            this.subscribers.forEach(sub => this.notifySubscriber(sub), this);
        };
    
        P.notifySubscriber = function (sub) {
    
            sub.sourceNaturalWidth = this.width;
            sub.sourceNaturalHeight = this.height;
            sub.sourceLoaded = true;
            sub.source = this.element;
            sub.dirtyImage = true;
            sub.dirtyCopyStart = true;
            sub.dirtyCopyDimensions = true;
            sub.dirtyImageSubscribers = true;
        };
  • §

    paintCanvas - internal function called by the cleanOutput function

        P.paintCanvas = function () {
    
            if (this.checkOutputValuesExist()) {
    
                if (this.dirtyOutput) {
    
                    this.dirtyOutput = false;
    
                    const {element, engine, width, height, colorElement, colorEngine, gradient, choke, gradientLastUpdated } = this;
    
                    const palette = gradient.palette;
  • §

    Update the Canvas element’s dimensions - this will also clear the canvas display

                    element.width = width;
                    element.height = height;
    
                    let img = engine.getImageData(0, 0, width, height),
                        iData = img.data,
                        len = width * height,
                        i, v, c;
    
                    const now = Date.now();
    
                    if (gradientLastUpdated + choke < now) {
    
                        gradient.updateByDelta();
                        this.gradientLastUpdated = now;
                    }
    
                    if (palette.dirtyPalette) palette.recalculate();
    
                    let G = colorEngine.createLinearGradient(0, 0, 255, 0);
    
                    gradient.addStopsToGradient(G, gradient.paletteStart, gradient.paletteEnd, gradient.cyclePalette);
    
                    colorEngine.fillStyle = G;
                    colorEngine.fillRect(0, 0, 256, 1);
    
                    let gData = colorEngine.getImageData(0, 0, 256, 1).data;
    
                    for (i = 0; i < len; i++) {
    
                        v = Math.floor(this.getOutputValue(i, width) * 255) * 4;
                        
                        c = i * 4;
    
                        iData[c] = gData[v];
                        iData[++c] = gData[++v];
                        iData[++c] = gData[++v];
                        iData[++c] = gData[++v];
                    }
                    engine.putImageData(img, 0, 0);
                }
            }
        };
  • §

    Return the prototype

        return P;
    };