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

    Mimic mixin

    This mixin defines additional attributes and functions to allow an artefact to use a range of attribute values set in another artefact.

  • §

    Imports

    import { artefact, asset } from '../core/library.js';
    
    import { isa_boolean, mergeOver, pushUnique, removeItem, Ωempty } from '../helper/utilities.js';
  • §

    Shared constants

    import { MIMIC, START, T_CELL, ZERO_STR } from '../helper/shared-vars.js';
  • §

    Local constants (none defined)

  • §

    Export function

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

    Shared attributes

        const defaultAttributes = {
  • §

    mimic - reference artefact object. Can also be set using the artefact’s name-String.

            mimic: ZERO_STR,
  • §

    useMimic… - a set of Boolean flags determining which attributes should be taken from the mimic reference artefact. By default, the artefact will use its own attribute values; setting any of these flags changes the behaviour for that attribute.

            useMimicDimensions: false,
            useMimicScale: false,
            useMimicStart: false,
            useMimicHandle: false,
            useMimicOffset: false,
            useMimicRotation: false,
            useMimicFlip: false,
  • §

    addOwn…ToMimic - a set of Boolean flags determining which mimic attributes should be added to this artefact’s own attribute values. By default, none are added; setting any of these flags changes the behaviour for that attribute.

            addOwnDimensionsToMimic: false,
            addOwnScaleToMimic: false,
            addOwnStartToMimic: false,
            addOwnHandleToMimic: false,
            addOwnOffsetToMimic: false,
            addOwnRotationToMimic: false,
        };
        P.defs = mergeOver(P.defs, defaultAttributes);
  • §

    Packet management

        P.packetObjects = pushUnique(P.packetObjects, ['mimic']);
  • §

    Clone management

    No additional clone functionality defined here

  • §

    Kill management

    No additional kill functionality defined here

  • §

    Get, Set, deltaSet

        const S = P.setters;
  • §

    Prototype functions

  • §

    mimic

        S.mimic = function (item) {
    
            if (isa_boolean(item) && !item) {
    
                this.mimic = null;
    
                if (this.lockTo[0] === MIMIC) this.lockTo[0] = START;
                if (this.lockTo[1] === MIMIC) this.lockTo[1] = START;
    
                this.dirtyStampPositions = true;
                this.dirtyStampHandlePositions = true;
            }
            else {
    
                const oldMimic = this.mimic,
                    name = this.name;
    
                let newMimic = (item.substring) ? artefact[item] : item;
    
                if (!newMimic) {
    
                    newMimic = asset[item];
    
                    if (newMimic && newMimic.type !== T_CELL) newMimic = false;
                }
    
                if (newMimic && newMimic.name) {
    
                    if (oldMimic && oldMimic.name !== newMimic.name) removeItem(oldMimic.mimicked, name);
    
                    pushUnique(newMimic.mimicked, name);
    
                    this.mimic = newMimic;
    
                    if (this.useMimicDimensions) this.dirtyDimensions = true;
                    if (this.useMimicScale) this.dirtyScale = true;
                    if (this.useMimicStart) this.dirtyStart = true;
                    if (this.useMimicHandle) this.dirtyHandle = true;
                    if (this.useMimicOffset) this.dirtyOffset = true;
                    if (this.useMimicRotation) this.dirtyRotation = true;
                }
  • §

    To help fix the bug where user has mimicked to an artefact which they have not yet defined

                else if (newMimic == null) this.mimic = item;
            }
        };
  • §

    useMimicDimensions, useMimicScale, useMimicStart, useMimicHandle, useMimicOffset, useMimicRotation

        S.useMimicDimensions = function (item) {
    
            this.useMimicDimensions = item;
            this.dirtyDimensions = true;
        };
        S.useMimicScale = function (item) {
    
            this.useMimicScale = item;
            this.dirtyScale = true;
        };
        S.useMimicStart = function (item) {
    
            this.useMimicStart = item;
            this.dirtyStart = true;
        };
        S.useMimicHandle = function (item) {
    
            this.useMimicHandle = item;
            this.dirtyHandle = true;
        };
        S.useMimicOffset = function (item) {
    
            this.useMimicOffset = item;
            this.dirtyOffset = true;
        };
        S.useMimicRotation = function (item) {
    
            this.useMimicRotation = item;
            this.dirtyRotation = true;
        };
  • §

    addOwnDimensionsToMimic, addOwnScaleToMimic, addOwnStartToMimic, addOwnHandleToMimic, addOwnOffsetToMimic, addOwnRotationToMimic

        S.addOwnDimensionsToMimic = function (item) {
    
            this.addOwnDimensionsToMimic = item;
            this.dirtyDimensions = true;
        };
        S.addOwnScaleToMimic = function (item) {
    
            this.addOwnScaleToMimic = item;
            this.dirtyScale = true;
        };
        S.addOwnStartToMimic = function (item) {
    
            this.addOwnStartToMimic = item;
            this.dirtyStart = true;
        };
        S.addOwnHandleToMimic = function (item) {
    
            this.addOwnHandleToMimic = item;
            this.dirtyHandle = true;
        };
        S.addOwnOffsetToMimic = function (item) {
    
            this.addOwnOffsetToMimic = item;
            this.dirtyOffset = true;
        };
        S.addOwnRotationToMimic = function (item) {
    
            this.addOwnRotationToMimic = item;
            this.dirtyRotation = true;
        };
  • §

    Prototype functions

  • §

    updateMimicSubscribers

        P.updateMimicSubscribers = function () {
    
            const DMH = this.dirtyMimicHandle,
                DMO = this.dirtyMimicOffset,
                DMR = this.dirtyMimicRotation,
                DMS = this.dirtyMimicScale,
                DMD = this.dirtyMimicDimensions;
    
            let m;
    
            this.mimicked.forEach(name => {
    
                m = artefact[name];
    
                if (!m) {
    
                    m = asset[name];
    
                    if (!m || m.type !== T_CELL) m = false;
                }
    
                if (m) {
    
                    if (m.useMimicStart) m.dirtyStart = true;
                    if (DMH && m.useMimicHandle) m.dirtyHandle = true;
                    if (DMO && m.useMimicOffset) m.dirtyOffset = true;
                    if (DMR && m.useMimicRotation) m.dirtyRotation = true;
                    if (DMS && m.useMimicScale) m.dirtyScale = true;
                    if (DMD && m.useMimicDimensions) m.dirtyDimensions = true;
                }
            });
    
            this.dirtyMimicHandle = false;
            this.dirtyMimicOffset = false;
            this.dirtyMimicRotation = false;
            this.dirtyMimicScale = false;
            this.dirtyMimicDimensions = false;
        };
    }