- Jump To … +
  ./source/core/animation-loop.js ./source/core/display-cycle.js ./source/core/document-root-elements.js ./source/core/document.js ./source/core/events.js ./source/core/init.js ./source/core/library.js ./source/core/random-seed.js ./source/core/shared-vars.js ./source/core/snippets.js ./source/core/system-flags.js ./source/core/user-interaction.js ./source/core/utilities.js ./source/factory/action.js ./source/factory/anchor.js ./source/factory/animation.js ./source/factory/array-pool.js ./source/factory/bezier.js ./source/factory/block.js ./source/factory/canvas.js ./source/factory/cell-fragment.js ./source/factory/cell.js ./source/factory/cog.js ./source/factory/color.js ./source/factory/conic-gradient.js ./source/factory/coordinate.js ./source/factory/crescent.js ./source/factory/drag-zone.js ./source/factory/element.js ./source/factory/emitter.js ./source/factory/filter-engine-bluenoise-data.js ./source/factory/filter-engine.js ./source/factory/filter.js ./source/factory/font-attributes.js ./source/factory/gradient.js ./source/factory/grid.js ./source/factory/group.js ./source/factory/image-asset.js ./source/factory/keyboard-zone.js ./source/factory/line-spiral.js ./source/factory/line.js ./source/factory/loom.js ./source/factory/mesh.js ./source/factory/net.js ./source/factory/noise-asset.js ./source/factory/observe-update.js ./source/factory/oval.js ./source/factory/palette.js ./source/factory/particle-force.js ./source/factory/particle-history.js ./source/factory/particle-spring.js ./source/factory/particle-world.js ./source/factory/particle.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/radial-gradient.js ./source/factory/raw-asset.js ./source/factory/reaction-diffusion-asset.js ./source/factory/rectangle.js ./source/factory/render-animation.js ./source/factory/shape.js ./source/factory/spiral.js ./source/factory/sprite-asset.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/unstacked-element.js ./source/factory/vector.js ./source/factory/video-asset.js ./source/factory/wheel.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/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/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/shape-path-calculation.js ./source/mixin/styles.js ./source/mixin/tween.js

- §

  # UnstackedElement factory

- §

  To be aware - this artefact factory is HIGHLY EXPERIMENTAL; its API will be subject to short-notice breaking changes as we amend and inprove the artefact’s functionality

- §

  TODO - documentation

- §

  #### To instantiate objects from the factory

- §

  #### Library storage

- §

  #### Clone functionality

- §

  #### Kill functionality

- §

  ## Imports

      import { constructors } from '../core/library.js';

      import { doCreate, mergeOver, xt, Ωempty } from '../core/utilities.js';

      import { makeCanvas } from './canvas.js';

      import baseMix from '../mixin/base.js';

      import { _computed, _entries, _floor, _max, ABSOLUTE, AUTO, CANVAS, DATA_SCRAWL_NAME, HEIGHT, RELATIVE, STATIC, T_UNSTACKED_ELEMENT, UE_INCLUDED_STYLES, UE_MIMICKED_STYLES, UNSTACKEDELEMENT, WIDTH, Z_INDEX } from '../core/shared-vars.js';

- §

  ## UnstackedElement constructor

      const UnstackedElement = function (el) {

          const name = el.id || el.name;

          this.makeName(name);
          this.register();

          el.setAttribute(DATA_SCRAWL_NAME, this.name);
          this.domElement = el;

          this.elementComputedStyles = _computed(el);
          this.hostStyles = {};

          this.canvasStartX = 0;
          this.canvasStartY = 0;
          this.canvasWidth = 0;
          this.canvasHeight = 0;
          this.canvasZIndex = 0;

          return this;
      };

- §

  ## UnstackedElement object prototype setup

      const P = UnstackedElement.prototype = doCreate();
      P.type = T_UNSTACKED_ELEMENT;
      P.lib = UNSTACKEDELEMENT;
      P.isArtefact = false;
      P.isAsset = false;

- §

  Apply mixins to prototype object

      baseMix(P);

- §

  ## Define default attributes

      const defaultAttributes = {

- §

  TODO - documentation

          canvasOnTop: false,

      };
      P.defs = mergeOver(P.defs, defaultAttributes);

- §

  ## Packet management

  TODO

- §

  ## Define getter, setter and deltaSetter functions

  TODO

- §

  ## Define prototype functions

  TODO - documentation

- §

  This is going to be rewritten as part of the “kill” review/recode work

      P.demolish = function () {

          return true;
      };

- §

  Adds a canvas element to sit behind the element, or in front of it, depending on the setting of the canvasOnTop attribute

      P.addCanvas = function (items = Ωempty) {

          if (!this.canvas) {

              const canvas = document.createElement(CANVAS),
                  el = this.domElement,
                  style = el.style;

              if (style.position == STATIC) style.position = RELATIVE;

              canvas.id = `${this.name}-canvas`;

              el.prepend(canvas);

              const art = makeCanvas({
                  name: `${this.name}-canvas`,
                  domElement: canvas,

                  position: ABSOLUTE,
              });

              this.canvas = art;

              art.set(items);

              this.updateCanvas();

              return art;
          }
      };

- §

  Observer function - runs on every RAF loop (when the DOM element is viewable); aim is to:

  - keep canvas dimensions exactly matched with its DOM element’s dimensions (including border/padding)
  - position the canvas correctly over/under the DOM element (taking into account border/padding)
  - maintain parity between other DOM element CSS values and those values on the canvas (eg border radius)

      P.checkElementStyleValues = function () {

          const results = {};

          const el = this.domElement,
              wrapper = this.canvas;

          if (el && wrapper && wrapper.domElement) {

              const host = this.hostStyles,
                  style = this.elementComputedStyles,
                  canvas = wrapper.domElement;

              let {x: elX, y: elY, width: elW, height: elH} = el.getBoundingClientRect();
              let {x: canvasX, y: canvasY} = canvas.getBoundingClientRect();
              let {width: styleW, height: styleH} = style;

              const styleZ = style.zIndex;

              elX = _floor(elX);
              elY = _floor(elY);
              canvasX = _floor(canvasX);
              canvasY = _floor(canvasY);
              elW = _floor(elW);
              elH = _floor(elH);
              styleW = _floor(parseFloat(styleW));
              styleH = _floor(parseFloat(styleH));

              let w, h, z, hi, si;

              UE_INCLUDED_STYLES.forEach(item => {

                  switch (item) {

                      case WIDTH :

                          w = _max(styleW, elW);
                          if (this.canvasWidth != w) {

                              this.canvasWidth = w;
                              this.dirtyDimensions = true;
                          }
                          break;

                      case HEIGHT :

                          h = _max(styleH, elH);
                          if (this.canvasHeight != h) {

                              this.canvasHeight = h;
                              this.dirtyDimensions = true;
                          }
                          break;

                      case Z_INDEX :

                          z = (styleZ == AUTO) ? 0 : parseInt(styleZ, 10);
                          z = (this.canvasOnTop) ? z + 1 : z - 1;

                          if (this.canvasZIndex != z) {

                              this.canvasZIndex = z;
                              this.dirtyZIndex = true;
                          }
                          break;

                      default :

                          hi = host[item];
                          si = style[item];

                          if(!xt(hi) || hi != si) {

                              host[item] = si;
                              results[item] = si;
                          }
                  }
              });

              const dx = elX - canvasX,
                  dy = elY - canvasY;

              if (dx || dy) {

                  this.canvasStartX += dx;
                  this.canvasStartY += dy;

                  this.dirtyStart = true;
              }
          }
          return results;
      };

- §

  Perform any updates reported by the observer function

- §

  UnstackedElement canvases keep their display and base canvases in dimensional sync - which means that relatively positioned and dimensioned entitys in the canvas (those set with appropriate ‘val%’ string values) will update in line with changes in the DOM element’s width, height, padding and margin values

      P.updateCanvas = function () {

          if (this.canvas && this.canvas.domElement) {

              const canvas = this.canvas,
                  style = canvas.domElement.style,
                  updates = this.checkElementStyleValues();

              for (const [key, value] of _entries(updates)) {

                  if (UE_MIMICKED_STYLES.includes(key)) {

                      style[key] = value;
                  }
              }

              if (this.dirtyStart) {

                  this.dirtyStart = false;

                  canvas.set({
                      startX: this.canvasStartX,
                      startY: this.canvasStartY,
                  });
              }

              if (this.dirtyDimensions) {

                  this.dirtyDimensions = false;

                  const w = this.canvasWidth,
                      h = this.canvasHeight;

                  canvas.set({
                      width: w,
                      height: h,
                  });
                  canvas.dirtyDimensions = true;

                  canvas.base.set({
                      width: w,
                      height: h,
                  });
                  canvas.base.dirtyDimensions = true;

                  canvas.cleanDimensions();
                  canvas.base.cleanDimensions();
              }

              if (this.dirtyZIndex) {

                  this.dirtyZIndex = false;
                  style.zIndex = this.canvasZIndex;
              }
          }
      };

- §

  ## Exported factory function

      export const makeUnstackedElement = function (items) {

          if (!items) return false;
          return new UnstackedElement(items);
      };

      constructors.UnstackedElement = UnstackedElement;