• Jump To … +
    ./source/core/animationloop.js ./source/core/component.js ./source/core/document.js ./source/core/events.js ./source/core/init.js ./source/core/library.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/coordinate.js ./source/factory/element.js ./source/factory/emitter.js ./source/factory/filter.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/loom.js ./source/factory/mesh.js ./source/factory/net.js ./source/factory/noise.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/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/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 ./source/worker/filter-string.js ./source/worker/filter.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 { mergeOver, pushUnique, isa_boolean } from '../core/utilities.js';
  • ¶

    Export function

    export default function (P = {}) {
  • ¶

    Shared attributes

        let defaultAttributes = {
  • ¶

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

            mimic: '',
  • ¶

    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);
        mergeOver(P, 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

        let G = P.getters,
            S = P.setters,
            D = P.deltaSetters;
  • ¶

    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 {
    
                let oldMimic = this.mimic,
                    name = this.name;
    
                let newMimic = (item.substring) ? artefact[item] : item;
                
                if (!newMimic) {
    
                    newMimic = asset[item];
    
                    if (newMimic && newMimic.type !== 'Cell') newMimic = false;
                }
    
                if (newMimic && newMimic.name) {
    
                    if (oldMimic && oldMimic.name !== newMimic.name) removeItem(oldMimic.mimicked, name);
    
                    pushUnique(newMimic.mimicked, name);
    
                    this.mimic = newMimic;
                    this.dirtyStampPositions = true;
                    this.dirtyStampHandlePositions = true;
                }
            }
        };
  • ¶

    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 () {
    
            let DMH = this.dirtyMimicHandle;
            let DMO = this.dirtyMimicOffset;
            let DMR = this.dirtyMimicRotation;
            let DMS = this.dirtyMimicScale;
            let DMD = this.dirtyMimicDimensions;
    
            this.mimicked.forEach(name => {
    
                let instance = artefact[name];
    
                if (!instance) {
    
                    instance = asset[name];
    
                    if (!instance || instance.type !== 'Cell') instance = false;
                }
    
                if (instance) {
    
                    if (instance.useMimicStart) instance.dirtyStart = true;
                    if (DMH && instance.useMimicHandle) instance.dirtyHandle = true;
                    if (DMO && instance.useMimicOffset) instance.dirtyOffset = true;
                    if (DMR && instance.useMimicRotation) instance.dirtyRotation = true;
                    if (DMS && instance.useMimicScale) instance.dirtyScale = true;
                    if (DMD && instance.useMimicDimensions) instance.dirtyDimensions = true;
                }
            });
    
            this.dirtyMimicHandle = false;
            this.dirtyMimicOffset = false;
            this.dirtyMimicRotation = false;
            this.dirtyMimicScale = false;
            this.dirtyMimicDimensions = false;
        };
  • ¶

    Return the prototype

        return P;
    };