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

    Tetragon factory

    A factory for generating various straight-line tetragonal shape-based entitys

  • §

    Imports

    import { constructors } from '../core/library.js';
    
    import { addStrings, doCreate, mergeOver, Ωempty } from '../helper/utilities.js';
    
    import baseMix from '../mixin/base.js';
    import shapeMix from '../mixin/shape-basic.js';
  • §

    Shared constants

    import { ENTITY, RADIUS_X, RADIUS_XY, RADIUS_Y, ZERO_PATH } from '../helper/shared-vars.js';
  • §

    Local constants

    const T_TETRAGON = 'Tetragon',
        TETRAGON = 'tetragon';
  • §

    Tetragon constructor

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

    Tetragon prototype

    const P = Tetragon.prototype = doCreate();
    P.type = T_TETRAGON;
    P.lib = ENTITY;
    P.isArtefact = true;
    P.isAsset = false;
  • §

    Mixins

    baseMix(P);
    shapeMix(P);
  • §

    Tetragon attributes

    const defaultAttributes = {
    
        radiusX: 5,
        radiusY: 5,
        intersectX: 0.5,
        intersectY: 0.5,
    };
    P.defs = mergeOver(P.defs, defaultAttributes);
  • §

    Packet management

    No additional packet functionality required

  • §

    Clone management

    No additional clone functionality required

  • §

    Kill management

    No additional kill functionality required

  • §

    Get, Set, deltaSet

    const S = P.setters,
        D = P.deltaSetters;
    
    S.radius = function (item) {
    
        this.setRectHelper(item, RADIUS_XY);
    };
    S.radiusX = function (item) {
    
        this.setRectHelper(item, RADIUS_X);
    };
    S.radiusY = function (item) {
    
        this.setRectHelper(item, RADIUS_Y);
    };
    D.radius = function (item) {
    
        this.deltaRectHelper(item, RADIUS_XY);
    };
    D.radiusX = function (item) {
    
        this.deltaRectHelper(item, RADIUS_X);
    };
    D.radiusY = function (item) {
    
        this.deltaRectHelper(item, RADIUS_Y);
    };
    
    S.intersectX = function (item) {
    
        if (item.toFixed) {
    
            this.intersectX = item;
            this.updateDirty();
        }
    };
    S.intersectY = function (item) {
    
        if (item.toFixed) {
    
            this.intersectY = item;
            this.updateDirty();
        }
    };
    D.intersectX = function (item) {
    
        if (item.toFixed) {
    
            this.intersectX += item;
            this.updateDirty();
        }
    };
    D.intersectY = function (item) {
    
        if (item.toFixed) {
    
            this.intersectY += item;
            this.updateDirty();
        }
    };
  • §

    Prototype functions

  • §

    setRectHelper - internal setter helper function

    P.setRectHelper = function (item, corners) {
    
        this.updateDirty();
    
        corners.forEach(corner => {
    
            this[corner] = item;
        }, this);
    };
  • §

    deltaRectHelper - internal setter helper function

    P.deltaRectHelper = function (item, corners) {
    
        this.updateDirty();
    
        corners.forEach(corner => {
    
            this[corner] = addStrings(this[corner], item);
        }, this);
    };
  • §

    cleanSpecies - internal helper function - called by prepareStamp

    P.cleanSpecies = function () {
    
        this.dirtySpecies = false;
        this.pathDefinition = this.makeTetragonPath();
    };
  • §

    makeTetragonPath - internal helper function - called by cleanSpecies

    P.makeTetragonPath = function () {
    
        const radiusX = this.radiusX,
            radiusY = this.radiusY;
    
        let width, height;
    
        if (radiusX.substring || radiusY.substring) {
    
            const host = this.getHost();
    
            if (host) {
    
                const [hW, hH] = host.currentDimensions;
    
                const rx = (radiusX.substring) ? (parseFloat(radiusX) / 100) * hW : radiusX,
                    ry = (radiusY.substring) ? (parseFloat(radiusY) / 100) * hH : radiusY;
    
                width = rx * 2;
                height = ry * 2;
            }
        }
        else {
    
            width = radiusX * 2;
            height = radiusY * 2;
        }
    
        const port = parseFloat((width * this.intersectX).toFixed(2)),
            starboard = parseFloat((width - port).toFixed(2)),
            fore = parseFloat((height * this.intersectY).toFixed(2)),
            aft = parseFloat((height - fore).toFixed(2));
    
        let myData = ZERO_PATH;
    
        myData += `l${starboard},${fore} ${-starboard},${aft} ${-port},${-aft} ${port},${-fore}z`;
    
        return myData;
    };
    
    P.calculateLocalPathAdditionalActions = function () {
    
        let scale = this.scale;
    
        if (scale < 0.001) scale = 0.001;
    
        const [x, y] = this.localBox;
    
        this.pathDefinition = this.pathDefinition.replace(ZERO_PATH, `m${-x / scale},${-y / scale}`);
    
        this.pathCalculatedOnce = false;
  • §

    ALWAYS, when invoking calculateLocalPath from calculateLocalPathAdditionalActions, include the second argument, set to true! Failure to do this leads to an infinite loop which will make your machine weep.

    • We need to recalculate the local path to take into account the offset required to put the Tetragon entity’s start coordinates at the top-left of the local box, and to recalculate the data used by other artefacts to place themselves on, or move along, its path.
        this.calculateLocalPath(this.pathDefinition, true);
    };
  • §

    Factories

  • §
    makeTetragon

    Scrawl-canvas uses lines internally to create the Shape path.

    • The main shape of the tetragon is determined by differing radius lengths in the x and y directions, as set by the attributes radiusX and radiusY; to set both radiuses to the same value, use radius instead.
    • The radius values can be: absolute (using Number values); or relative using %-String values - with the y radius representing a portion of the Cell container’s height and the x radius the Cell’s width.
    • The radiuses (as diameter lines) cross in the middle of the tetragon shape. We can move the position of where the intersection happens by setting a float Number value between 0.0 - 1.0 (or beyond those limits) for the intersectX and intersectY attributes.
    • intersectX (default: 0.5) represents the point at which the y diameter crosses the x diameter, with 0 being the left end and 1 being the right end.
    • intersectY (default: 0.5) represents the point at which the x diameter crosses the y diameter, with 0 being the top end and 1 being the bottom end.
    scrawl.makeTetragon({
    
        name: 'diamond',
    
        fillStyle: 'lightGreen',
        method: 'fillAndDraw',
    
        startX: 20,
        startY: 750,
    
        radiusX: 40,
        radiusY: 60,
    });
    
    export const makeTetragon = function (items) {
    
        if (!items) return false;
        items.species = TETRAGON;
        return new Tetragon(items);
    };
    
    constructors.Tetragon = Tetragon;