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

    Pivot mixin

    This mixin defines the attributes and functionality required by an artefact so that it can position and rotate itself using 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 { CORNER_LABELS, PIVOT, START, T_BEZIER, T_CELL, T_LINE, T_POLYLINE, T_QUADRATIC, ZERO_STR } from '../helper/shared-vars.js';
  • §

    Local constants (none defined)

  • §

    Export function

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

    Shared attributes

        const defaultAttributes = {
  • §

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

            pivot: ZERO_STR,
  • §

    pivotCorner - Element artefacts allow other artefacts to use their corner positions as pivots, by setting this attribute to topLeft, topRight, bottomRight or bottomLeft; default is '' to use the Element’s start coordinate.

            pivotCorner: ZERO_STR,
  • §

    pivotPin - Polyline entitys comprise a set of pin coordinates with the start being pin[0]; can reference other pins by setting this attribute to the appropriate index value (for example, the second pin will be pin[1]).

            pivotPin: 0,
  • §

    pivotIndex - EnhancedLabel entitys comprise a set of TextUnits, each with their own startData coordinate; we can reference that coordinate by setting this attribute to the appropriate index value (number).

    • Defaults to ‘-1’, which means we should use the entity’s layoutTemplate artefact’s start position
            pivotIndex: -1,
  • §

    addPivotHandle, addPivotOffset, addPivotRotation - Boolean flags. When set, the artifact will add its own values to the reference artefact’s values, rather than use them as replacement values.

            addPivotHandle: false,
            addPivotOffset: true,
            addPivotRotation: false,
        };
        P.defs = mergeOver(P.defs, defaultAttributes);
  • §

    Packet management

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

    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

  • §

    pivot

        S.pivot = function (item) {
    
            if (isa_boolean(item) && !item) {
    
                this.pivot = null;
    
                if (this.lockTo[0] === PIVOT) this.lockTo[0] = START;
                if (this.lockTo[1] === PIVOT) this.lockTo[1] = START;
    
                this.dirtyStampPositions = true;
                this.dirtyStampHandlePositions = true;
            }
            else {
    
                const oldPivot = this.pivot,
                    name = this.name;
    
                let newPivot = (item.substring) ? artefact[item] : item;
    
                if (!newPivot) {
    
                    newPivot = asset[item];
    
                    if (newPivot && newPivot.type !== T_CELL) newPivot = false;
                }
    
                if (newPivot && newPivot.name) {
    
                    if (oldPivot && oldPivot.name !== newPivot.name) removeItem(oldPivot.pivoted, name);
    
                    pushUnique(newPivot.pivoted, name);
    
                    this.pivot = newPivot;
                    this.dirtyStampPositions = true;
                    this.dirtyStampHandlePositions = true;
                }
  • §

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

                else if (newPivot == null) this.pivot = item;
            }
        };
  • §

    pivotCorner

        S.pivotCorner = function (item) {
    
            if (CORNER_LABELS.includes(item)) this.pivotCorner = item;
            this.dirtyStart = true;
        };
  • §

    pivotIndex

        S.pivotIndex = function (item) {
    
            this.pivotIndex = item;
            this.dirtyStart = true;
        };
  • §

    addPivotHandle, addPivotOffset, addPivotRotation

        S.addPivotHandle = function (item) {
    
            this.addPivotHandle = item;
            this.dirtyHandle = true;
        };
        S.addPivotOffset = function (item) {
    
            this.addPivotOffset = item;
            this.dirtyOffset = true;
        };
        S.addPivotRotation = function (item) {
    
            this.addPivotRotation = item;
            this.dirtyRotation = true;
        };
  • §

    Prototype functions

  • §

    updatePivotSubscribers

        P.updatePivotSubscribers = function () {
    
            let art;
    
            this.pivoted.forEach(name => {
    
                art = artefact[name];
    
                if (!art) {
    
                    art = asset[name];
    
                    if (!art || art.type !== T_CELL) art = false;
                }
    
                if (art) {
    
                    art.dirtyStart = true;
                    if (art.addPivotHandle) art.dirtyHandle = true;
                    if (art.addPivotOffset) art.dirtyOffset = true;
                    if (art.addPivotRotation) art.dirtyRotation = true;
    
                    if (art.type === T_POLYLINE) art.dirtyPins = true;
                    else if (art.type === T_LINE || art.type === T_QUADRATIC || art.type === T_BEZIER) art.dirtyPins.push(this.name);
                }
            }, this);
        };
    }