scrawl-canvas
Version:
Version 8.9.4 - 19 Nov 2022
1,041 lines (689 loc) • 65.1 kB
HTML
<!DOCTYPE html>
<html>
<head>
<title>Cog factory</title>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width, target-densitydpi=160dpi, initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<link rel="stylesheet" media="all" href="../../docco.css" />
</head>
<body>
<div id="container">
<div id="background"></div>
<ul id="jump_to">
<li>
<a class="large" href="javascript:void(0);">Jump To …</a>
<a class="small" href="javascript:void(0);">+</a>
<div id="jump_wrapper">
<div id="jump_page_wrapper">
<div id="jump_page">
<a class="source" href="../core/animationloop.html">
./source/core/animationloop.js
</a>
<a class="source" href="../core/document.html">
./source/core/document.js
</a>
<a class="source" href="../core/events.html">
./source/core/events.js
</a>
<a class="source" href="../core/init.html">
./source/core/init.js
</a>
<a class="source" href="../core/library.html">
./source/core/library.js
</a>
<a class="source" href="../core/random-seed.html">
./source/core/random-seed.js
</a>
<a class="source" href="../core/snippets.html">
./source/core/snippets.js
</a>
<a class="source" href="../core/userInteraction.html">
./source/core/userInteraction.js
</a>
<a class="source" href="../core/utilities.html">
./source/core/utilities.js
</a>
<a class="source" href="action.html">
./source/factory/action.js
</a>
<a class="source" href="anchor.html">
./source/factory/anchor.js
</a>
<a class="source" href="animation.html">
./source/factory/animation.js
</a>
<a class="source" href="bezier.html">
./source/factory/bezier.js
</a>
<a class="source" href="block.html">
./source/factory/block.js
</a>
<a class="source" href="canvas.html">
./source/factory/canvas.js
</a>
<a class="source" href="cell.html">
./source/factory/cell.js
</a>
<a class="source" href="cog.html">
./source/factory/cog.js
</a>
<a class="source" href="color.html">
./source/factory/color.js
</a>
<a class="source" href="conicGradient.html">
./source/factory/conicGradient.js
</a>
<a class="source" href="coordinate.html">
./source/factory/coordinate.js
</a>
<a class="source" href="crescent.html">
./source/factory/crescent.js
</a>
<a class="source" href="element.html">
./source/factory/element.js
</a>
<a class="source" href="emitter.html">
./source/factory/emitter.js
</a>
<a class="source" href="filter.html">
./source/factory/filter.js
</a>
<a class="source" href="filterEngine-bluenoiseData.html">
./source/factory/filterEngine-bluenoiseData.js
</a>
<a class="source" href="filterEngine.html">
./source/factory/filterEngine.js
</a>
<a class="source" href="fontAttributes.html">
./source/factory/fontAttributes.js
</a>
<a class="source" href="gradient.html">
./source/factory/gradient.js
</a>
<a class="source" href="grid.html">
./source/factory/grid.js
</a>
<a class="source" href="group.html">
./source/factory/group.js
</a>
<a class="source" href="imageAsset.html">
./source/factory/imageAsset.js
</a>
<a class="source" href="line.html">
./source/factory/line.js
</a>
<a class="source" href="lineSpiral.html">
./source/factory/lineSpiral.js
</a>
<a class="source" href="loom.html">
./source/factory/loom.js
</a>
<a class="source" href="mesh.html">
./source/factory/mesh.js
</a>
<a class="source" href="net.html">
./source/factory/net.js
</a>
<a class="source" href="noiseAsset.html">
./source/factory/noiseAsset.js
</a>
<a class="source" href="oval.html">
./source/factory/oval.js
</a>
<a class="source" href="palette.html">
./source/factory/palette.js
</a>
<a class="source" href="particle.html">
./source/factory/particle.js
</a>
<a class="source" href="particleForce.html">
./source/factory/particleForce.js
</a>
<a class="source" href="particleHistory.html">
./source/factory/particleHistory.js
</a>
<a class="source" href="particleSpring.html">
./source/factory/particleSpring.js
</a>
<a class="source" href="particleWorld.html">
./source/factory/particleWorld.js
</a>
<a class="source" href="pattern.html">
./source/factory/pattern.js
</a>
<a class="source" href="phrase.html">
./source/factory/phrase.js
</a>
<a class="source" href="picture.html">
./source/factory/picture.js
</a>
<a class="source" href="polygon.html">
./source/factory/polygon.js
</a>
<a class="source" href="polyline.html">
./source/factory/polyline.js
</a>
<a class="source" href="quadratic.html">
./source/factory/quadratic.js
</a>
<a class="source" href="quaternion.html">
./source/factory/quaternion.js
</a>
<a class="source" href="radialGradient.html">
./source/factory/radialGradient.js
</a>
<a class="source" href="rawAsset.html">
./source/factory/rawAsset.js
</a>
<a class="source" href="rdAsset.html">
./source/factory/rdAsset.js
</a>
<a class="source" href="rectangle.html">
./source/factory/rectangle.js
</a>
<a class="source" href="renderAnimation.html">
./source/factory/renderAnimation.js
</a>
<a class="source" href="shape.html">
./source/factory/shape.js
</a>
<a class="source" href="spiral.html">
./source/factory/spiral.js
</a>
<a class="source" href="spriteAsset.html">
./source/factory/spriteAsset.js
</a>
<a class="source" href="stack.html">
./source/factory/stack.js
</a>
<a class="source" href="star.html">
./source/factory/star.js
</a>
<a class="source" href="state.html">
./source/factory/state.js
</a>
<a class="source" href="tetragon.html">
./source/factory/tetragon.js
</a>
<a class="source" href="ticker.html">
./source/factory/ticker.js
</a>
<a class="source" href="tracer.html">
./source/factory/tracer.js
</a>
<a class="source" href="tween.html">
./source/factory/tween.js
</a>
<a class="source" href="unstackedElement.html">
./source/factory/unstackedElement.js
</a>
<a class="source" href="vector.html">
./source/factory/vector.js
</a>
<a class="source" href="videoAsset.html">
./source/factory/videoAsset.js
</a>
<a class="source" href="wheel.html">
./source/factory/wheel.js
</a>
<a class="source" href="../mixin/anchor.html">
./source/mixin/anchor.js
</a>
<a class="source" href="../mixin/asset.html">
./source/mixin/asset.js
</a>
<a class="source" href="../mixin/assetAdvancedFunctionality.html">
./source/mixin/assetAdvancedFunctionality.js
</a>
<a class="source" href="../mixin/assetConsumer.html">
./source/mixin/assetConsumer.js
</a>
<a class="source" href="../mixin/base.html">
./source/mixin/base.js
</a>
<a class="source" href="../mixin/cascade.html">
./source/mixin/cascade.js
</a>
<a class="source" href="../mixin/delta.html">
./source/mixin/delta.js
</a>
<a class="source" href="../mixin/displayShape.html">
./source/mixin/displayShape.js
</a>
<a class="source" href="../mixin/dom.html">
./source/mixin/dom.js
</a>
<a class="source" href="../mixin/entity.html">
./source/mixin/entity.js
</a>
<a class="source" href="../mixin/filter.html">
./source/mixin/filter.js
</a>
<a class="source" href="../mixin/mimic.html">
./source/mixin/mimic.js
</a>
<a class="source" href="../mixin/path.html">
./source/mixin/path.js
</a>
<a class="source" href="../mixin/pattern.html">
./source/mixin/pattern.js
</a>
<a class="source" href="../mixin/pivot.html">
./source/mixin/pivot.js
</a>
<a class="source" href="../mixin/position.html">
./source/mixin/position.js
</a>
<a class="source" href="../mixin/shapeBasic.html">
./source/mixin/shapeBasic.js
</a>
<a class="source" href="../mixin/shapeCurve.html">
./source/mixin/shapeCurve.js
</a>
<a class="source" href="../mixin/shapePathCalculation.html">
./source/mixin/shapePathCalculation.js
</a>
<a class="source" href="../mixin/styles.html">
./source/mixin/styles.js
</a>
<a class="source" href="../mixin/tween.html">
./source/mixin/tween.js
</a>
</div>
</div>
</li>
</ul>
<ul class="sections">
<li id="section-1">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-1">§</a>
</div>
<h1 id="cog-factory">Cog factory</h1>
<p>A factory for generating star shape-based entitys</p>
<p>Path-defined entitys represent a diverse range of shapes rendered onto a DOM <canvas> element using the Canvas API’s <a href="https://developer.mozilla.org/en-US/docs/Web/API/Path2D">Path2D interface</a>. They use the <a href="../mixin/shapeBasic.html">shapeBasic</a> and <a href="../mixin/shapePathCalculation.html">shapePathCalculation</a> (some also use <a href="../mixin/shapeCurve.html">shapeCurve</a>) mixins to define much of their functionality.</p>
<p>All path-defined entitys can be positioned, cloned, filtered etc:</p>
<ul>
<li>Positioning functionality for the entity is supplied by the <strong>position</strong> mixin, while rendering functionality comes from the <strong>entity</strong> mixin. </li>
<li>Dimensions, however, have little meaning for path-defined entitys - their width and height are determined by their SVG path data Strings; use <code>scale</code> instead.</li>
<li>Path-defined entitys can use CSS color Strings for their fillStyle and strokeStyle values, alongside <strong>Gradient</strong>, <strong>RadialGradient</strong>, <strong>Color</strong> and <strong>Pattern</strong> objects. </li>
<li>They will also accept <strong>Filter</strong> objects.</li>
<li>They can use <strong>Anchor</strong> objects for user navigation. </li>
<li>They can be rendered to the canvas by including them in a <strong>Cell</strong> object’s <strong>Group</strong>. </li>
<li>They can be <strong>animated</strong> directly, or using delta animation, or act as the target for <strong>Tween</strong> animations.</li>
<li>Path-defined entitys can be cloned, and killed.</li>
</ul>
</div>
</li>
<li id="section-2">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-2">§</a>
</div>
<h4 id="using-path-defined-entitys-as-scrawl-canvas-paths">Using path-defined entitys as Scrawl-canvas paths</h4>
<p>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:</p>
<ul>
<li>To enable a path-defined entity to be used as a path by other artefacts, set its <code>useAsPath</code> flag to <code>true</code>.</li>
<li>The artefact can then set its <code>path</code> attribute to the path-defined entity’s name-String (or the entity itself), and set its <code>lockTo</code> Array values to <code>"path"</code>.</li>
<li>We position the artefact by setting its <code>pathPosition</code> attribute to a float Number value between <code>0.0 - 1.0</code>, with <code>0</code> being the start of the path, and <code>1</code> being its end.</li>
<li>Path-defined entitys can use other path-defined entitys as a path.</li>
<li>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.</li>
<li>Artefacts (and letters) can be rotated so that they match the rotation at that point along the path - <em><strong>tangential rotation</strong></em> by setting their <code>addPathRotation</code> flag to <code>true</code>.</li>
<li>Animate an artefact along the path by either using the artefact’s <code>delta</code> object, or triggering a Tween to perform the movement.</li>
</ul>
</div>
</li>
<li id="section-3">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-3">§</a>
</div>
<h4 id="demos">Demos:</h4>
<ul>
<li><a href="../../demo/canvas-011.html">Canvas-011</a> - Shape entity (make, clone, method); drag and drop shape entitys</li>
<li><a href="../../demo/canvas-012.html">Canvas-012</a> - Shape entity position; shape entity as a path for other artefacts to follow</li>
<li><a href="../../demo/canvas-013.html">Canvas-013</a> - Path-defined entitys: oval, rectangle, line, quadratic, bezier, tetragon, polygon, star, spiral, cog</li>
<li><a href="../../demo/canvas-014.html">Canvas-014</a> - Line, quadratic and bezier entitys - control lock alternatives</li>
<li><a href="../../demo/canvas-018.html">Canvas-018</a> - Phrase entity - text along a path</li>
<li><a href="../../demo/canvas-024.html">Canvas-024</a> - Loom entity functionality</li>
<li><a href="../../demo/canvas-030.html">Canvas-030</a> - Polyline entity functionality</li>
<li><a href="../../demo/canvas-038.html">Canvas-038</a> - Responsive Shape-based entitys</li>
<li><a href="../../demo/dom-015.html">DOM-015</a> - Use stacked DOM artefact corners as pivot points</li>
<li><a href="../../demo/packets-002.html">Packets-002</a> - Scrawl-canvas packets - save and load a range of different entitys</li>
</ul>
</div>
</li>
<li id="section-4">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-4">§</a>
</div>
<h4 id="imports">Imports</h4>
</div>
<div class="content"><div class='highlight'><pre><span class="hljs-keyword">import</span> { constructors } <span class="hljs-keyword">from</span> <span class="hljs-string">'../core/library.js'</span>;
<span class="hljs-keyword">import</span> { mergeOver, Ωempty } <span class="hljs-keyword">from</span> <span class="hljs-string">'../core/utilities.js'</span>;
<span class="hljs-keyword">import</span> { requestVector, releaseVector } <span class="hljs-keyword">from</span> <span class="hljs-string">'./vector.js'</span>;
<span class="hljs-keyword">import</span> baseMix <span class="hljs-keyword">from</span> <span class="hljs-string">'../mixin/base.js'</span>;
<span class="hljs-keyword">import</span> shapeMix <span class="hljs-keyword">from</span> <span class="hljs-string">'../mixin/shapeBasic.js'</span>;</pre></div></div>
</li>
<li id="section-5">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-5">§</a>
</div>
<h4 id="cog-constructor">Cog constructor</h4>
</div>
<div class="content"><div class='highlight'><pre><span class="hljs-keyword">const</span> <span class="hljs-title class_">Cog</span> = <span class="hljs-keyword">function</span> (<span class="hljs-params">items = Ωempty</span>) {
<span class="hljs-variable language_">this</span>.<span class="hljs-title function_">shapeInit</span>(items);
<span class="hljs-keyword">return</span> <span class="hljs-variable language_">this</span>;
};</pre></div></div>
</li>
<li id="section-6">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-6">§</a>
</div>
<h4 id="cog-prototype">Cog prototype</h4>
</div>
<div class="content"><div class='highlight'><pre><span class="hljs-keyword">let</span> P = <span class="hljs-title class_">Cog</span>.<span class="hljs-property"><span class="hljs-keyword">prototype</span></span> = <span class="hljs-title class_">Object</span>.<span class="hljs-title function_">create</span>(<span class="hljs-title class_">Object</span>.<span class="hljs-property"><span class="hljs-keyword">prototype</span></span>);
P.<span class="hljs-property">type</span> = <span class="hljs-string">'Cog'</span>;
P.<span class="hljs-property">lib</span> = <span class="hljs-string">'entity'</span>;
P.<span class="hljs-property">isArtefact</span> = <span class="hljs-literal">true</span>;
P.<span class="hljs-property">isAsset</span> = <span class="hljs-literal">false</span>;</pre></div></div>
</li>
<li id="section-7">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-7">§</a>
</div>
<h4 id="mixins">Mixins</h4>
<ul>
<li><a href="../mixin/base.html">base</a></li>
<li><a href="../mixin/shapeBasic.html">shapeBasic</a></li>
</ul>
</div>
<div class="content"><div class='highlight'><pre>P = <span class="hljs-title function_">baseMix</span>(P);
P = <span class="hljs-title function_">shapeMix</span>(P);</pre></div></div>
</li>
<li id="section-8">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-8">§</a>
</div>
<h4 id="cog-attributes">Cog attributes</h4>
<ul>
<li>Attributes defined in the <a href="../mixin/base.html">base mixin</a>: <strong>name</strong>.</li>
<li>Attributes defined in the <a href="../mixin/position.html">position mixin</a>: <strong>group, visibility, order, calculateOrder, stampOrder, start, <em>startX</em>, <em>startY</em>, handle, <em>handleX</em>, <em>handleY</em>, offset, <em>offsetX</em>, <em>offsetY</em>, dimensions, <em>width</em>, <em>height</em>, pivoted, mimicked, lockTo, <em>lockXTo</em>, <em>lockYTo</em>, scale, roll, noUserInteraction, noPositionDependencies, noCanvasEngineUpdates, noFilters, noPathUpdates, purge, bringToFrontOnDrag</strong>.</li>
<li>Attributes defined in the <a href="../mixin/delta.html">delta mixin</a>: <strong>delta, noDeltaUpdates</strong>.</li>
<li>Attributes defined in the <a href="../mixin/pivot.html">pivot mixin</a>: <strong>pivot, pivotCorner, addPivotHandle, addPivotOffset, addPivotRotation</strong>.</li>
<li>Attributes defined in the <a href="../mixin/mimic.html">mimic mixin</a>: <strong>mimic, useMimicDimensions, useMimicScale, useMimicStart, useMimicHandle, useMimicOffset, useMimicRotation, useMimicFlip, addOwnDimensionsToMimic, addOwnScaleToMimic, addOwnStartToMimic, addOwnHandleToMimic, addOwnOffsetToMimic, addOwnRotationToMimic</strong>.</li>
<li>Attributes defined in the <a href="../mixin/path.html">path mixin</a>: <strong>path, pathPosition, addPathHandle, addPathOffset, addPathRotation, constantPathSpeed</strong>.</li>
<li>Attributes defined in the <a href="../mixin/entity.html">entity mixin</a>: <strong>method, pathObject, winding, flipReverse, flipUpend, scaleOutline, lockFillStyleToEntity, lockStrokeStyleToEntity, onEnter, onLeave, onDown, onUp, <em>fillStyle, strokeStyle, globalAlpha, globalCompositeOperation, lineWidth, lineCap, lineJoin, lineDash, lineDashOffset, miterLimit, shadowOffsetX, shadowOffsetY, shadowBlur, shadowColor, filter</em></strong>.</li>
<li>Attributes defined in the <a href="../mixin/anchor.html">anchor mixin</a>: <strong>anchor</strong>.</li>
<li>Attributes defined in the <a href="../mixin/filter.html">filter mixin</a>: <strong>filters, isStencil</strong>.</li>
<li>Attributes defined in the <a href="../mixin/shapeBasic.html">shapeBasic mixin</a>: <strong>species, useAsPath, precision, pathDefinition, showBoundingBox, boundingBoxColor, minimumBoundingBoxDimensions, constantPathSpeed</strong>.</li>
</ul>
</div>
<div class="content"><div class='highlight'><pre><span class="hljs-keyword">let</span> defaultAttributes = {
<span class="hljs-attr">outerRadius</span>: <span class="hljs-number">0</span>,
<span class="hljs-attr">innerRadius</span>: <span class="hljs-number">0</span>,
<span class="hljs-attr">outerControlsDistance</span>: <span class="hljs-number">0</span>,
<span class="hljs-attr">innerControlsDistance</span>: <span class="hljs-number">0</span>,
<span class="hljs-attr">outerControlsOffset</span>: <span class="hljs-number">0</span>,
<span class="hljs-attr">innerControlsOffset</span>: <span class="hljs-number">0</span>,
<span class="hljs-attr">points</span>: <span class="hljs-number">0</span>,
<span class="hljs-attr">twist</span>: <span class="hljs-number">0</span>,
<span class="hljs-attr">curve</span>: <span class="hljs-string">'bezier'</span>,
};
P.<span class="hljs-property">defs</span> = <span class="hljs-title function_">mergeOver</span>(P.<span class="hljs-property">defs</span>, defaultAttributes);</pre></div></div>
</li>
<li id="section-9">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-9">§</a>
</div>
<h4 id="packet-management">Packet management</h4>
<p>No additional packet functionality required</p>
</div>
</li>
<li id="section-10">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-10">§</a>
</div>
<h4 id="clone-management">Clone management</h4>
<p>No additional clone functionality required</p>
</div>
</li>
<li id="section-11">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-11">§</a>
</div>
<h4 id="kill-management">Kill management</h4>
<p>No additional kill functionality required</p>
</div>
</li>
<li id="section-12">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-12">§</a>
</div>
<h4 id="get-set-deltaset">Get, Set, deltaSet</h4>
</div>
<div class="content"><div class='highlight'><pre><span class="hljs-keyword">let</span> S = P.<span class="hljs-property">setters</span>,
D = P.<span class="hljs-property">deltaSetters</span>;</pre></div></div>
</li>
<li id="section-13">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-13">§</a>
</div>
<p><strong>outerRadius</strong>, <strong>innerRadius</strong></p>
</div>
<div class="content"><div class='highlight'><pre>S.<span class="hljs-property">outerRadius</span> = <span class="hljs-keyword">function</span> (<span class="hljs-params">item</span>) {
<span class="hljs-variable language_">this</span>.<span class="hljs-property">outerRadius</span> = item;
<span class="hljs-variable language_">this</span>.<span class="hljs-title function_">updateDirty</span>();
};
D.<span class="hljs-property">outerRadius</span> = <span class="hljs-keyword">function</span> (<span class="hljs-params">item</span>) {
<span class="hljs-variable language_">this</span>.<span class="hljs-property">outerRadius</span> += item;
<span class="hljs-variable language_">this</span>.<span class="hljs-title function_">updateDirty</span>();
};
S.<span class="hljs-property">innerRadius</span> = <span class="hljs-keyword">function</span> (<span class="hljs-params">item</span>) {
<span class="hljs-variable language_">this</span>.<span class="hljs-property">innerRadius</span> = item;
<span class="hljs-variable language_">this</span>.<span class="hljs-title function_">updateDirty</span>();
};
D.<span class="hljs-property">innerRadius</span> = <span class="hljs-keyword">function</span> (<span class="hljs-params">item</span>) {
<span class="hljs-variable language_">this</span>.<span class="hljs-property">innerRadius</span> += item;
<span class="hljs-variable language_">this</span>.<span class="hljs-title function_">updateDirty</span>();
};</pre></div></div>
</li>
<li id="section-14">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-14">§</a>
</div>
<p><strong>outerControlsDistance</strong>, <strong>innerControlsDistance</strong></p>
</div>
<div class="content"><div class='highlight'><pre>S.<span class="hljs-property">outerControlsDistance</span> = <span class="hljs-keyword">function</span> (<span class="hljs-params">item</span>) {
<span class="hljs-variable language_">this</span>.<span class="hljs-property">outerControlsDistance</span> = item;
<span class="hljs-variable language_">this</span>.<span class="hljs-title function_">updateDirty</span>();
};
D.<span class="hljs-property">outerControlsDistance</span> = <span class="hljs-keyword">function</span> (<span class="hljs-params">item</span>) {
<span class="hljs-variable language_">this</span>.<span class="hljs-property">outerControlsDistance</span> += item;
<span class="hljs-variable language_">this</span>.<span class="hljs-title function_">updateDirty</span>();
};
S.<span class="hljs-property">innerControlsDistance</span> = <span class="hljs-keyword">function</span> (<span class="hljs-params">item</span>) {
<span class="hljs-variable language_">this</span>.<span class="hljs-property">innerControlsDistance</span> = item;
<span class="hljs-variable language_">this</span>.<span class="hljs-title function_">updateDirty</span>();
};
D.<span class="hljs-property">innerControlsDistance</span> = <span class="hljs-keyword">function</span> (<span class="hljs-params">item</span>) {
<span class="hljs-variable language_">this</span>.<span class="hljs-property">innerControlsDistance</span> += item;
<span class="hljs-variable language_">this</span>.<span class="hljs-title function_">updateDirty</span>();
};</pre></div></div>
</li>
<li id="section-15">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-15">§</a>
</div>
<p><strong>outerControlsOffset</strong>, <strong>innerControlsOffset</strong></p>
</div>
<div class="content"><div class='highlight'><pre>S.<span class="hljs-property">outerControlsOffset</span> = <span class="hljs-keyword">function</span> (<span class="hljs-params">item</span>) {
<span class="hljs-variable language_">this</span>.<span class="hljs-property">outerControlsOffset</span> = item;
<span class="hljs-variable language_">this</span>.<span class="hljs-title function_">updateDirty</span>();
};
D.<span class="hljs-property">outerControlsOffset</span> = <span class="hljs-keyword">function</span> (<span class="hljs-params">item</span>) {
<span class="hljs-variable language_">this</span>.<span class="hljs-property">outerControlsOffset</span> += item;
<span class="hljs-variable language_">this</span>.<span class="hljs-title function_">updateDirty</span>();
};
S.<span class="hljs-property">innerControlsOffset</span> = <span class="hljs-keyword">function</span> (<span class="hljs-params">item</span>) {
<span class="hljs-variable language_">this</span>.<span class="hljs-property">innerControlsOffset</span> = item;
<span class="hljs-variable language_">this</span>.<span class="hljs-title function_">updateDirty</span>();
};
D.<span class="hljs-property">innerControlsOffset</span> = <span class="hljs-keyword">function</span> (<span class="hljs-params">item</span>) {
<span class="hljs-variable language_">this</span>.<span class="hljs-property">innerControlsOffset</span> += item;
<span class="hljs-variable language_">this</span>.<span class="hljs-title function_">updateDirty</span>();
};</pre></div></div>
</li>
<li id="section-16">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-16">§</a>
</div>
<p><strong>points</strong></p>
</div>
<div class="content"><div class='highlight'><pre>S.<span class="hljs-property">points</span> = <span class="hljs-keyword">function</span> (<span class="hljs-params">item</span>) {
<span class="hljs-variable language_">this</span>.<span class="hljs-property">points</span> = item;
<span class="hljs-variable language_">this</span>.<span class="hljs-title function_">updateDirty</span>();
};
D.<span class="hljs-property">points</span> = <span class="hljs-keyword">function</span> (<span class="hljs-params">item</span>) {
<span class="hljs-variable language_">this</span>.<span class="hljs-property">points</span> += item;
<span class="hljs-variable language_">this</span>.<span class="hljs-title function_">updateDirty</span>();
};</pre></div></div>
</li>
<li id="section-17">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-17">§</a>
</div>
<p><strong>twist</strong></p>
</div>
<div class="content"><div class='highlight'><pre>S.<span class="hljs-property">twist</span> = <span class="hljs-keyword">function</span> (<span class="hljs-params">item</span>) {
<span class="hljs-variable language_">this</span>.<span class="hljs-property">twist</span> = item;
<span class="hljs-variable language_">this</span>.<span class="hljs-title function_">updateDirty</span>();
};
D.<span class="hljs-property">twist</span> = <span class="hljs-keyword">function</span> (<span class="hljs-params">item</span>) {
<span class="hljs-variable language_">this</span>.<span class="hljs-property">twist</span> += item;
<span class="hljs-variable language_">this</span>.<span class="hljs-title function_">updateDirty</span>();
};</pre></div></div>
</li>
<li id="section-18">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-18">§</a>
</div>
<p><strong>useBezierCurve</strong></p>
</div>
<div class="content"><div class='highlight'><pre>S.<span class="hljs-property">curve</span> = <span class="hljs-keyword">function</span> (<span class="hljs-params">item</span>) {
<span class="hljs-keyword">if</span> (item && [<span class="hljs-string">'line'</span>, <span class="hljs-string">'quadratic'</span>, <span class="hljs-string">'bezier'</span>].<span class="hljs-title function_">indexOf</span>(item) >= <span class="hljs-number">0</span>) {
<span class="hljs-variable language_">this</span>.<span class="hljs-property">curve</span> = item;
<span class="hljs-variable language_">this</span>.<span class="hljs-title function_">updateDirty</span>();
}
<span class="hljs-keyword">else</span> {
<span class="hljs-variable language_">this</span>.<span class="hljs-property">curve</span> = <span class="hljs-string">'bezier'</span>;
<span class="hljs-variable language_">this</span>.<span class="hljs-title function_">updateDirty</span>();
}
};</pre></div></div>
</li>
<li id="section-19">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-19">§</a>
</div>
<h4 id="prototype-functions">Prototype functions</h4>
</div>
</li>
<li id="section-20">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-20">§</a>
</div>
<p><code>cleanSpecies</code> - internal helper function - called by <code>prepareStamp</code></p>
</div>
<div class="content"><div class='highlight'><pre>P.<span class="hljs-property">cleanSpecies</span> = <span class="hljs-keyword">function</span> (<span class="hljs-params"></span>) {
<span class="hljs-variable language_">this</span>.<span class="hljs-property">dirtySpecies</span> = <span class="hljs-literal">false</span>;
<span class="hljs-keyword">let</span> p = <span class="hljs-string">'M0,0'</span>;
p = <span class="hljs-variable language_">this</span>.<span class="hljs-title function_">makeCogPath</span>();
<span class="hljs-variable language_">this</span>.<span class="hljs-property">pathDefinition</span> = p;
};</pre></div></div>
</li>
<li id="section-21">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-21">§</a>
</div>
<p><code>makeCogPath</code> - internal helper function - called by <code>cleanSpecies</code></p>
</div>
<div class="content"><div class='highlight'><pre>P.<span class="hljs-property">makeCogPath</span> = <span class="hljs-keyword">function</span> (<span class="hljs-params"></span>) {
<span class="hljs-keyword">let</span> {points, twist, outerRadius, innerRadius, outerControlsDistance, innerControlsDistance, outerControlsOffset, innerControlsOffset, curve} = <span class="hljs-variable language_">this</span>;
<span class="hljs-keyword">let</span> turn = <span class="hljs-number">360</span> / points,
xPts = [],
currentTrailX, currentTrailY, currentPointX, currentPointY, currentLeadX, currentLeadY,
controlStartX, controlStartY, deltaX, deltaY, controlEndX, controlEndY,
myMin, myXoffset, myYoffset, i,
myPath = <span class="hljs-string">''</span>;
<span class="hljs-keyword">if</span> (outerRadius.<span class="hljs-property">substring</span> || innerRadius.<span class="hljs-property">substring</span> || outerControlsDistance.<span class="hljs-property">substring</span> || innerControlsDistance.<span class="hljs-property">substring</span> || outerControlsOffset.<span class="hljs-property">substring</span> || innerControlsOffset.<span class="hljs-property">substring</span>) {
<span class="hljs-keyword">let</span> host = <span class="hljs-variable language_">this</span>.<span class="hljs-title function_">getHost</span>();
<span class="hljs-keyword">if</span> (host) {
<span class="hljs-keyword">let</span> [hW, hH] = host.<span class="hljs-property">currentDimensions</span>;
outerRadius = (outerRadius.<span class="hljs-property">substring</span>) ? (<span class="hljs-built_in">parseFloat</span>(outerRadius) / <span class="hljs-number">100</span>) * hW : outerRadius;
innerRadius = (innerRadius.<span class="hljs-property">substring</span>) ? (<span class="hljs-built_in">parseFloat</span>(innerRadius) / <span class="hljs-number">100</span>) * hW : innerRadius;
outerControlsDistance = (outerControlsDistance.<span class="hljs-property">substring</span>) ? (<span class="hljs-built_in">parseFloat</span>(outerControlsDistance) / <span class="hljs-number">100</span>) * hW : outerControlsDistance;
innerControlsDistance = (innerControlsDistance.<span class="hljs-property">substring</span>) ? (<span class="hljs-built_in">parseFloat</span>(innerControlsDistance) / <span class="hljs-number">100</span>) * hW : innerControlsDistance;
outerControlsOffset = (outerControlsOffset.<span class="hljs-property">substring</span>) ? (<span class="hljs-built_in">parseFloat</span>(outerControlsOffset) / <span class="hljs-number">100</span>) * hW : outerControlsOffset;
innerControlsOffset = (innerControlsOffset.<span class="hljs-property">substring</span>) ? (<span class="hljs-built_in">parseFloat</span>(innerControlsOffset) / <span class="hljs-number">100</span>) * hW : innerControlsOffset;
}
}
<span class="hljs-keyword">let</span> outerPoint = <span class="hljs-title function_">requestVector</span>({<span class="hljs-attr">x</span>: <span class="hljs-number">0</span>, <span class="hljs-attr">y</span>: -outerRadius}),
innerPoint = <span class="hljs-title function_">requestVector</span>({<span class="hljs-attr">x</span>: <span class="hljs-number">0</span>, <span class="hljs-attr">y</span>: -innerRadius}),
outerPointLead = <span class="hljs-title function_">requestVector</span>({<span class="hljs-attr">x</span>: outerControlsDistance + outerControlsOffset, <span class="hljs-attr">y</span>: -outerRadius}),
innerPointTrail = <span class="hljs-title function_">requestVector</span>({<span class="hljs-attr">x</span>: -innerControlsDistance + innerControlsOffset, <span class="hljs-attr">y</span>: -innerRadius}),
innerPointLead = <span class="hljs-title function_">requestVector</span>({<span class="hljs-attr">x</span>: innerControlsDistance + innerControlsOffset, <span class="hljs-attr">y</span>: -innerRadius}),
outerPointTrail = <span class="hljs-title function_">requestVector</span>({<span class="hljs-attr">x</span>: -outerControlsDistance + outerControlsOffset, <span class="hljs-attr">y</span>: -outerRadius});
innerPointTrail.<span class="hljs-title function_">rotate</span>(-turn/<span class="hljs-number">2</span>);
innerPointTrail.<span class="hljs-title function_">rotate</span>(twist);
innerPoint.<span class="hljs-title function_">rotate</span>(-turn/<span class="hljs-number">2</span>);
innerPoint.<span class="hljs-title function_">rotate</span>(twist);
innerPointLead.<span class="hljs-title function_">rotate</span>(-turn/<span class="hljs-number">2</span>);
innerPointLead.<span class="hljs-title function_">rotate</span>(twist);
currentPointX = outerPoint.<span class="hljs-property">x</span>;
currentPointY = outerPoint.<span class="hljs-property">y</span>;
xPts.<span class="hljs-title function_">push</span>(currentPointX);
<span class="hljs-keyword">if</span> (curve == <span class="hljs-string">'bezier'</span>) {
<span class="hljs-keyword">for</span> (i = <span class="hljs-number">0</span>; i < points; i++) {
deltaX = <span class="hljs-built_in">parseFloat</span>((outerPointLead.<span class="hljs-property">x</span> - currentPointX).<span class="hljs-title function_">toFixed</span>(<span class="hljs-number">1</span>));
deltaY = <span class="hljs-built_in">parseFloat</span>((outerPointLead.<span class="hljs-property">y</span> - currentPointY).<span class="hljs-title function_">toFixed</span>(<span class="hljs-number">1</span>));
myPath += <span class="hljs-string">`<span class="hljs-subst">${deltaX}</span>,<span class="hljs-subst">${deltaY}</span> `</span>;
innerPointTrail.<span class="hljs-title function_">rotate</span>(turn);
innerPoint.<span class="hljs-title function_">rotate</span>(turn);
innerPointLead.<span class="hljs-title function_">rotate</span>(turn);
deltaX = <span class="hljs-built_in">parseFloat</span>((innerPointTrail.<span class="hljs-property">x</span> - currentPointX).<span class="hljs-title function_">toFixed</span>(<span class="hljs-number">1</span>));
deltaY = <span class="hljs-built_in">parseFloat</span>((innerPointTrail.<span class="hljs-property">y</span> - currentPointY).<span class="hljs-title function_">toFixed</span>(<span class="hljs-number">1</span>));
myPath += <span class="hljs-string">`<span class="hljs-subst">${deltaX}</span>,<span class="hljs-subst">${deltaY}</span> `</span>;
deltaX = <span class="hljs-built_in">parseFloat</span>((innerPoint.<span class="hljs-property">x</span> - currentPointX).<span class="hljs-title function_">toFixed</span>(<span class="hljs-number">1</span>));
currentPointX += deltaX;
xPts.<span class="hljs-title function_">push</span>(currentPointX);
deltaY = <span class="hljs-built_in">parseFloat</span>((innerPoint.<span class="hljs-property">y</span> - currentPointY).<span class="hljs-title function_">toFixed</span>(<span class="hljs-number">1</span>));
currentPointY += deltaY;
myPath += <span class="hljs-string">`<span class="hljs-subst">${deltaX}</span>,<span class="hljs-subst">${deltaY}</span> `</span>;
deltaX = <span class="hljs-built_in">parseFloat</span>((innerPointLead.<span class="hljs-property">x</span> - currentPointX).<span class="hljs-title function_">toFixed</span>(<span class="hljs-number">1</span>));
deltaY = <span class="hljs-built_in">parseFloat</span>((innerPointLead.<span class="hljs-property">y</span> - currentPointY).<span class="hljs-title function_">toFixed</span>(<span class="hljs-number">1</span>));
myPath += <span class="hljs-string">`<span class="hljs-subst">${deltaX}</span>,<span class="hljs-subst">${deltaY}</span> `</span>;
outerPointTrail.<span class="hljs-title function_">rotate</span>(turn);
outerPoint.<span class="hljs-title function_">rotate</span>(turn);
outerPointLead.<span class="hljs-title function_">rotate</span>(turn);
deltaX = <span class="hljs-built_in">parseFloat</span>((outerPointTrail.<span class="hljs-property">x</span> - currentPointX).<span class="hljs-title function_">toFixed</span>(<span class="hljs-number">1</span>));
deltaY = <span class="hljs-built_in">parseFloat</span>((outerPointTrail.<span class="hljs-property">y</span> - currentPointY).<span class="hljs-title function_">toFixed</span>(<span class="hljs-number">1</span>));
myPath += <span class="hljs-string">`<span class="hljs-subst">${deltaX}</span>,<span class="hljs-subst">${deltaY}</span> `</span>;
deltaX = <span class="hljs-built_in">parseFloat</span>((outerPoint.<span class="hljs-property">x</s