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

    Root elements

    Exported array and function (to modules). Root elements are the boxes whose dimensions define the dimensions and positioning of all that they contain. All <canvas> elements are root elements. Scrawl-canvas also allows other DOM elements (typically <div> elements) to be defined as root elements called stacks, whose child elements can then be positioned and dimensioned just like entity objects in a canvas.

    Stacks can be nested within each other, and canvases can also be nested inside a stack. (Nothing can nest inside a canvas element). Only the top level stack will be included in the rootElements array.

    The Scrawl-canvas Display cycle can start at the rootElements array, with each member of the array processed in turn.

  • §

    Imports

    import { artefact } from "../core/library.js";
    
    import { getRootElementsSort, setRootElementsSort } from './system-flags.js';
    
    import { pushUnique, removeItem } from './utilities.js';
    
    import { releaseArray, requestArray } from './array-pool.js';
  • §

    Shared constants

    import { _floor } from './shared-vars.js';
  • §

    Local constants

    const rootElements = [],
        rootElements_sorted = [];
  • §

    Exported helper functions

    export const rootElementsAdd = (val) => {
        pushUnique(rootElements, val);
        setRootElementsSort(true);
    };
    
    export const rootElementsRemove = (val) => {
        removeItem(rootElements, val);
        setRootElementsSort(true);
    };
    
    export const rootElementsIncludes = (val) => rootElements.includes(val);
  • §

    Functionality

    export const getSortedRootElements = () => {
    
        if (getRootElementsSort()) sortRootElements();
        return rootElements_sorted;
    };
    
    const sortRootElements = function () {
    
        setRootElementsSort(false);
    
        const buckets = requestArray();
    
        let obj, order, i, iz;
    
        for (i = 0, iz = rootElements.length; i < iz; i++) {
    
            obj = artefact[rootElements[i]];
    
            if (obj) {
    
                order = _floor(obj.order) || 0;
    
                if (!buckets[order]) buckets[order] = requestArray();
    
                buckets[order].push(obj.name);
            }
        }
        rootElements_sorted.length = 0;
    
        for (i = 0, iz = buckets.length; i < iz; i++) {
    
            obj = buckets[i];
    
            if (obj) {
    
                rootElements_sorted.push(...obj);
                releaseArray(obj);
            }
        }
        releaseArray(buckets);
    };