- 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

- §

  # Shape factory

  A factory for generating shape-based entitys from SVG path Strings

  Path-defined entitys represent a diverse range of shapes rendered onto a DOM <canvas> element using the Canvas API’s Path2D interface. They use the shapeBasic and shapePathCalculation (some also use shapeCurve) mixins to define much of their functionality.

  All path-defined entitys can be positioned, cloned, filtered etc:

  - Positioning functionality for the entity is supplied by the position mixin, while rendering functionality comes from the entity mixin.
  - Dimensions, however, have little meaning for path-defined entitys - their width and height are determined by their SVG path data Strings; use `scale` instead.
  - Path-defined entitys can use CSS color Strings for their fillStyle and strokeStyle values, alongside Gradient, RadialGradient, Color and Pattern objects.
  - They will also accept Filter objects.
  - They can use Anchor objects for user navigation.
  - They can be rendered to the canvas by including them in a Cell object’s Group.
  - They can be animated directly, or using delta animation, or act as the target for Tween animations.
  - Path-defined entitys can be cloned, and killed.
- §

  #### Using path-defined entitys as Scrawl-canvas paths

  A path is a track - straight, or curved, or as complex as required - placed across a container which artefacts can use as a source of their positioning data. We can animate an artifact to move along the path:

  - To enable a path-defined entity to be used as a path by other artefacts, set its `useAsPath` flag to `true`.
  - The artefact can then set its `path` attribute to the path-defined entity’s name-String (or the entity itself), and set its `lockTo` Array values to `"path"`.
  - We position the artefact by setting its `pathPosition` attribute to a float Number value between `0.0 - 1.0`, with `0` being the start of the path, and `1` being its end.
  - Path-defined entitys can use other path-defined entitys as a path.
  - Phrase entitys can use a path to position their text block; they can also use a path to position each letter individually along the path.
  - Artefacts (and letters) can be rotated so that they match the rotation at that point along the path - tangential rotation by setting their `addPathRotation` flag to `true`.
  - Animate an artefact along the path by either using the artefact’s `delta` object, or triggering a Tween to perform the movement.
- §

  #### Demos:

  - Canvas-011 - Shape entity (make, clone, method); drag and drop shape entitys
  - Canvas-012 - Shape entity position; shape entity as a path for other artefacts to follow
  - Canvas-013 - Path-defined entitys: oval, rectangle, line, quadratic, bezier, tetragon, polygon, star, spiral
  - Canvas-014 - Line, quadratic and bezier entitys - control lock alternatives
  - Canvas-018 - Phrase entity - text along a path
  - Canvas-024 - Loom entity functionality
  - Canvas-030 - Polyline entity functionality
  - Canvas-038 - Responsive Shape-based entitys
  - DOM-015 - Use stacked DOM artefact corners as pivot points
  - Packets-002 - Scrawl-canvas packets - save and load a range of different entitys
- §

  #### Imports

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

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

      import baseMix from '../mixin/base.js';
      import shapeMix from '../mixin/shape-basic.js';

      import { T_SHAPE, ENTITY } from '../core/shared-vars.js';

- §

  #### Shape constructor

      const Shape = function (items = Ωempty) {

          this.shapeInit(items);
          return this;
      };

- §

  #### Shape prototype

      const P = Shape.prototype = doCreate();
      P.type = T_SHAPE;
      P.lib = ENTITY;
      P.isArtefact = true;
      P.isAsset = false;

- §

  #### Mixins

  - base
  - shapeBasic

      baseMix(P);
      shapeMix(P);

- §

  #### Shape attributes

  - Attributes defined in the base mixin: name.
  - Attributes defined in the position mixin: group, visibility, order, calculateOrder, stampOrder, start, startX, startY, handle, handleX, handleY, offset, offsetX, offsetY, dimensions, width, height, pivoted, mimicked, lockTo, lockXTo, lockYTo, scale, roll, noUserInteraction, noPositionDependencies, noCanvasEngineUpdates, noFilters, noPathUpdates, purge, bringToFrontOnDrag.
  - Attributes defined in the delta mixin: delta, noDeltaUpdates.
  - Attributes defined in the pivot mixin: pivot, pivotCorner, addPivotHandle, addPivotOffset, addPivotRotation.
  - Attributes defined in the mimic mixin: mimic, useMimicDimensions, useMimicScale, useMimicStart, useMimicHandle, useMimicOffset, useMimicRotation, useMimicFlip, addOwnDimensionsToMimic, addOwnScaleToMimic, addOwnStartToMimic, addOwnHandleToMimic, addOwnOffsetToMimic, addOwnRotationToMimic.
  - Attributes defined in the path mixin: path, pathPosition, addPathHandle, addPathOffset, addPathRotation, constantPathSpeed.
  - Attributes defined in the entity mixin: method, pathObject, winding, flipReverse, flipUpend, scaleOutline, lockFillStyleToEntity, lockStrokeStyleToEntity, onEnter, onLeave, onDown, onUp, fillStyle, strokeStyle, globalAlpha, globalCompositeOperation, lineWidth, lineCap, lineJoin, lineDash, lineDashOffset, miterLimit, shadowOffsetX, shadowOffsetY, shadowBlur, shadowColor, filter.
  - Attributes defined in the anchor mixin: anchor.
  - Attributes defined in the filter mixin: filters, isStencil.
  - Attributes defined in the shapeBasic mixin: species, useAsPath, precision, pathDefinition, showBoundingBox, boundingBoxColor, minimumBoundingBoxDimensions, constantPathSpeed.

  No additional attributes defined here.

      const defaultAttributes = {};
      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

  let S = P.setters;

- §

  #### Prototype functions

- §

  `cleanSpecies` - internal helper function - called by `prepareStamp`

      P.cleanSpecies = function () {

          this.dirtySpecies = false;
      };

      P.cleanStampHandlePositionsAdditionalActions = function () {

          const box = this.localBox,
              stampHandle = this.currentStampHandlePosition;

          stampHandle[0] += box[0];
          stampHandle[1] += box[1];
      };

- §

  #### Factories

- §

  ##### makeShape

  Accepts argument with attributes:

  - `pathDefinition` (required) - an SVG `d` attribute String

      scrawl.makeShape({

          name: 'myArrow',

          pathDefinition: 'M266.2,703.1 h-178 L375.1,990 l287-286.9 H481.9 C507.4,365,683.4,91.9,911.8,25.5 877,15.4,840.9,10,803.9,10 525.1,10,295.5,313.4,266.2,703.1 z',

          startX: 300,
          startY: 200,
          handleX: '50%',
          handleY: '50%',

          scale: 0.2,
          scaleOutline: false,

          fillStyle: 'lightgreen',

          method: 'fill',
      });

      export const makeShape = function (items) {

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

      constructors.Shape = Shape;