scrawl-canvas
Version:
Version 8.9.4 - 19 Nov 2022
1,166 lines (739 loc) • 86.8 kB
HTML
<!DOCTYPE html>
<html>
<head>
<title>Shape-basic mixin</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="../factory/action.html">
./source/factory/action.js
</a>
<a class="source" href="../factory/anchor.html">
./source/factory/anchor.js
</a>
<a class="source" href="../factory/animation.html">
./source/factory/animation.js
</a>
<a class="source" href="../factory/bezier.html">
./source/factory/bezier.js
</a>
<a class="source" href="../factory/block.html">
./source/factory/block.js
</a>
<a class="source" href="../factory/canvas.html">
./source/factory/canvas.js
</a>
<a class="source" href="../factory/cell.html">
./source/factory/cell.js
</a>
<a class="source" href="../factory/cog.html">
./source/factory/cog.js
</a>
<a class="source" href="../factory/color.html">
./source/factory/color.js
</a>
<a class="source" href="../factory/conicGradient.html">
./source/factory/conicGradient.js
</a>
<a class="source" href="../factory/coordinate.html">
./source/factory/coordinate.js
</a>
<a class="source" href="../factory/crescent.html">
./source/factory/crescent.js
</a>
<a class="source" href="../factory/element.html">
./source/factory/element.js
</a>
<a class="source" href="../factory/emitter.html">
./source/factory/emitter.js
</a>
<a class="source" href="../factory/filter.html">
./source/factory/filter.js
</a>
<a class="source" href="../factory/filterEngine-bluenoiseData.html">
./source/factory/filterEngine-bluenoiseData.js
</a>
<a class="source" href="../factory/filterEngine.html">
./source/factory/filterEngine.js
</a>
<a class="source" href="../factory/fontAttributes.html">
./source/factory/fontAttributes.js
</a>
<a class="source" href="../factory/gradient.html">
./source/factory/gradient.js
</a>
<a class="source" href="../factory/grid.html">
./source/factory/grid.js
</a>
<a class="source" href="../factory/group.html">
./source/factory/group.js
</a>
<a class="source" href="../factory/imageAsset.html">
./source/factory/imageAsset.js
</a>
<a class="source" href="../factory/line.html">
./source/factory/line.js
</a>
<a class="source" href="../factory/lineSpiral.html">
./source/factory/lineSpiral.js
</a>
<a class="source" href="../factory/loom.html">
./source/factory/loom.js
</a>
<a class="source" href="../factory/mesh.html">
./source/factory/mesh.js
</a>
<a class="source" href="../factory/net.html">
./source/factory/net.js
</a>
<a class="source" href="../factory/noiseAsset.html">
./source/factory/noiseAsset.js
</a>
<a class="source" href="../factory/oval.html">
./source/factory/oval.js
</a>
<a class="source" href="../factory/palette.html">
./source/factory/palette.js
</a>
<a class="source" href="../factory/particle.html">
./source/factory/particle.js
</a>
<a class="source" href="../factory/particleForce.html">
./source/factory/particleForce.js
</a>
<a class="source" href="../factory/particleHistory.html">
./source/factory/particleHistory.js
</a>
<a class="source" href="../factory/particleSpring.html">
./source/factory/particleSpring.js
</a>
<a class="source" href="../factory/particleWorld.html">
./source/factory/particleWorld.js
</a>
<a class="source" href="../factory/pattern.html">
./source/factory/pattern.js
</a>
<a class="source" href="../factory/phrase.html">
./source/factory/phrase.js
</a>
<a class="source" href="../factory/picture.html">
./source/factory/picture.js
</a>
<a class="source" href="../factory/polygon.html">
./source/factory/polygon.js
</a>
<a class="source" href="../factory/polyline.html">
./source/factory/polyline.js
</a>
<a class="source" href="../factory/quadratic.html">
./source/factory/quadratic.js
</a>
<a class="source" href="../factory/quaternion.html">
./source/factory/quaternion.js
</a>
<a class="source" href="../factory/radialGradient.html">
./source/factory/radialGradient.js
</a>
<a class="source" href="../factory/rawAsset.html">
./source/factory/rawAsset.js
</a>
<a class="source" href="../factory/rdAsset.html">
./source/factory/rdAsset.js
</a>
<a class="source" href="../factory/rectangle.html">
./source/factory/rectangle.js
</a>
<a class="source" href="../factory/renderAnimation.html">
./source/factory/renderAnimation.js
</a>
<a class="source" href="../factory/shape.html">
./source/factory/shape.js
</a>
<a class="source" href="../factory/spiral.html">
./source/factory/spiral.js
</a>
<a class="source" href="../factory/spriteAsset.html">
./source/factory/spriteAsset.js
</a>
<a class="source" href="../factory/stack.html">
./source/factory/stack.js
</a>
<a class="source" href="../factory/star.html">
./source/factory/star.js
</a>
<a class="source" href="../factory/state.html">
./source/factory/state.js
</a>
<a class="source" href="../factory/tetragon.html">
./source/factory/tetragon.js
</a>
<a class="source" href="../factory/ticker.html">
./source/factory/ticker.js
</a>
<a class="source" href="../factory/tracer.html">
./source/factory/tracer.js
</a>
<a class="source" href="../factory/tween.html">
./source/factory/tween.js
</a>
<a class="source" href="../factory/unstackedElement.html">
./source/factory/unstackedElement.js
</a>
<a class="source" href="../factory/vector.html">
./source/factory/vector.js
</a>
<a class="source" href="../factory/videoAsset.html">
./source/factory/videoAsset.js
</a>
<a class="source" href="../factory/wheel.html">
./source/factory/wheel.js
</a>
<a class="source" href="anchor.html">
./source/mixin/anchor.js
</a>
<a class="source" href="asset.html">
./source/mixin/asset.js
</a>
<a class="source" href="assetAdvancedFunctionality.html">
./source/mixin/assetAdvancedFunctionality.js
</a>
<a class="source" href="assetConsumer.html">
./source/mixin/assetConsumer.js
</a>
<a class="source" href="base.html">
./source/mixin/base.js
</a>
<a class="source" href="cascade.html">
./source/mixin/cascade.js
</a>
<a class="source" href="delta.html">
./source/mixin/delta.js
</a>
<a class="source" href="displayShape.html">
./source/mixin/displayShape.js
</a>
<a class="source" href="dom.html">
./source/mixin/dom.js
</a>
<a class="source" href="entity.html">
./source/mixin/entity.js
</a>
<a class="source" href="filter.html">
./source/mixin/filter.js
</a>
<a class="source" href="mimic.html">
./source/mixin/mimic.js
</a>
<a class="source" href="path.html">
./source/mixin/path.js
</a>
<a class="source" href="pattern.html">
./source/mixin/pattern.js
</a>
<a class="source" href="pivot.html">
./source/mixin/pivot.js
</a>
<a class="source" href="position.html">
./source/mixin/position.js
</a>
<a class="source" href="shapeBasic.html">
./source/mixin/shapeBasic.js
</a>
<a class="source" href="shapeCurve.html">
./source/mixin/shapeCurve.js
</a>
<a class="source" href="shapePathCalculation.html">
./source/mixin/shapePathCalculation.js
</a>
<a class="source" href="styles.html">
./source/mixin/styles.js
</a>
<a class="source" href="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="shape-basic-mixin">Shape-basic mixin</h1>
<p>This mixin defines the key attributes and functionality for all Scrawl-canvas <strong>path-defined entitys</strong>. </p>
</div>
</li>
<li id="section-2">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-2">§</a>
</div>
<h4 id="imports">Imports</h4>
</div>
<div class="content"><div class='highlight'><pre><span class="hljs-keyword">import</span> { radian, artefact } <span class="hljs-keyword">from</span> <span class="hljs-string">'../core/library.js'</span>;
<span class="hljs-keyword">import</span> { mergeOver, xt, λ<span class="hljs-literal">null</span>, pushUnique, Ω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">'../factory/vector.js'</span>;
<span class="hljs-keyword">import</span> calculatePath <span class="hljs-keyword">from</span> <span class="hljs-string">'./shapePathCalculation.js'</span>;
<span class="hljs-keyword">import</span> entityMix <span class="hljs-keyword">from</span> <span class="hljs-string">'./entity.js'</span>;</pre></div></div>
</li>
<li id="section-3">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-3">§</a>
</div>
<h4 id="export-function">Export function</h4>
</div>
<div class="content"><div class='highlight'><pre><span class="hljs-keyword">export</span> <span class="hljs-keyword">default</span> <span class="hljs-keyword">function</span> (<span class="hljs-params">P = Ωempty</span>) {</pre></div></div>
</li>
<li id="section-4">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-4">§</a>
</div>
<h4 id="mixins">Mixins</h4>
<ul>
<li><a href="../mixin/entity.html">entity</a></li>
</ul>
</div>
<div class="content"><div class='highlight'><pre> P = <span class="hljs-title function_">entityMix</span>(P);</pre></div></div>
</li>
<li id="section-5">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-5">§</a>
</div>
<h4 id="shared-attributes">Shared attributes</h4>
</div>
<div class="content"><div class='highlight'><pre> <span class="hljs-keyword">let</span> defaultAttributes = {
<span class="hljs-attr">species</span>: <span class="hljs-string">''</span>,
<span class="hljs-attr">useAsPath</span>: <span class="hljs-literal">false</span>,
<span class="hljs-attr">precision</span>: <span class="hljs-number">10</span>,
<span class="hljs-attr">constantPathSpeed</span>: <span class="hljs-literal">false</span>,
<span class="hljs-attr">pathDefinition</span>: <span class="hljs-string">''</span>,
<span class="hljs-attr">showBoundingBox</span>: <span class="hljs-literal">false</span>,
<span class="hljs-attr">boundingBoxColor</span>: <span class="hljs-string">'rgba(0,0,0,0.5)'</span>,
<span class="hljs-attr">minimumBoundingBoxDimensions</span>: <span class="hljs-number">20</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-6">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-6">§</a>
</div>
<h4 id="packet-management">Packet management</h4>
</div>
<div class="content"><div class='highlight'><pre> P.<span class="hljs-property">packetExclusions</span> = <span class="hljs-title function_">pushUnique</span>(P.<span class="hljs-property">packetExclusions</span>, [<span class="hljs-string">'dimensions'</span>, <span class="hljs-string">'pathed'</span>]);
P.<span class="hljs-property">packetExclusionsByRegex</span> = <span class="hljs-title function_">pushUnique</span>(P.<span class="hljs-property">packetExclusionsByRegex</span>, []);
P.<span class="hljs-property">packetCoordinates</span> = <span class="hljs-title function_">pushUnique</span>(P.<span class="hljs-property">packetCoordinates</span>, []);
P.<span class="hljs-property">packetObjects</span> = <span class="hljs-title function_">pushUnique</span>(P.<span class="hljs-property">packetObjects</span>, []);
P.<span class="hljs-property">packetFunctions</span> = <span class="hljs-title function_">pushUnique</span>(P.<span class="hljs-property">packetFunctions</span>, []);
P.<span class="hljs-property">finalizePacketOut</span> = <span class="hljs-keyword">function</span> (<span class="hljs-params">copy, items</span>) {
<span class="hljs-keyword">let</span> stateCopy = <span class="hljs-title class_">JSON</span>.<span class="hljs-title function_">parse</span>(<span class="hljs-variable language_">this</span>.<span class="hljs-property">state</span>.<span class="hljs-title function_">saveAsPacket</span>(items))[<span class="hljs-number">3</span>];
copy = <span class="hljs-title function_">mergeOver</span>(copy, stateCopy);
copy = <span class="hljs-variable language_">this</span>.<span class="hljs-title function_">handlePacketAnchor</span>(copy, items);
<span class="hljs-keyword">return</span> copy;
};</pre></div></div>
</li>
<li id="section-7">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-7">§</a>
</div>
<h4 id="clone-management">Clone management</h4>
<p>No additional clone functionality defined here</p>
</div>
</li>
<li id="section-8">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-8">§</a>
</div>
<h4 id="kill-management">Kill management</h4>
<p>No additional kill functionality defined here</p>
</div>
</li>
<li id="section-9">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-9">§</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> G = P.<span class="hljs-property">getters</span>,
S = P.<span class="hljs-property">setters</span>,
D = P.<span class="hljs-property">deltaSetters</span>;
S.<span class="hljs-property">species</span> = <span class="hljs-keyword">function</span> (<span class="hljs-params">item</span>) {
<span class="hljs-keyword">if</span> (<span class="hljs-title function_">xt</span>(item)) {
<span class="hljs-variable language_">this</span>.<span class="hljs-property">species</span> = item;
<span class="hljs-variable language_">this</span>.<span class="hljs-title function_">updateDirty</span>();
}
};
S.<span class="hljs-property">precision</span> = <span class="hljs-keyword">function</span> (<span class="hljs-params">item</span>) {
<span class="hljs-keyword">if</span> (<span class="hljs-title function_">xt</span>(item) && item.<span class="hljs-property">toFixed</span>) {
<span class="hljs-variable language_">this</span>.<span class="hljs-property">precision</span> = item;
<span class="hljs-variable language_">this</span>.<span class="hljs-title function_">updateDirty</span>();
}
};
S.<span class="hljs-property">constantPathSpeed</span> = <span class="hljs-keyword">function</span> (<span class="hljs-params">item</span>) {
<span class="hljs-variable language_">this</span>.<span class="hljs-property">constantPathSpeed</span> = item;
<span class="hljs-variable language_">this</span>.<span class="hljs-title function_">updateDirty</span>();
};</pre></div></div>
</li>
<li id="section-10">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-10">§</a>
</div>
<p>Invalidate <strong>dimensions</strong> setters - dimensions are an emergent property of shapes, not a defining property</p>
</div>
<div class="content"><div class='highlight'><pre> S.<span class="hljs-property">width</span> = λ<span class="hljs-literal">null</span>;
S.<span class="hljs-property">height</span> = λ<span class="hljs-literal">null</span>;
S.<span class="hljs-property">dimensions</span> = λ<span class="hljs-literal">null</span>;
D.<span class="hljs-property">width</span> = λ<span class="hljs-literal">null</span>;
D.<span class="hljs-property">height</span> = λ<span class="hljs-literal">null</span>;
D.<span class="hljs-property">dimensions</span> = λ<span class="hljs-literal">null</span>;</pre></div></div>
</li>
<li id="section-11">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-11">§</a>
</div>
<p><strong>pathDefinition</strong></p>
</div>
<div class="content"><div class='highlight'><pre> S.<span class="hljs-property">pathDefinition</span> = <span class="hljs-keyword">function</span> (<span class="hljs-params">item</span>) {
<span class="hljs-keyword">if</span> (item.<span class="hljs-property">substring</span>) <span class="hljs-variable language_">this</span>.<span class="hljs-property">pathDefinition</span> = item;
<span class="hljs-variable language_">this</span>.<span class="hljs-property">pathCalculatedOnce</span> = <span class="hljs-literal">false</span>;
<span class="hljs-variable language_">this</span>.<span class="hljs-property">dirtyPathObject</span> = <span class="hljs-literal">true</span>;
};</pre></div></div>
</li>
<li id="section-12">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-12">§</a>
</div>
<h4 id="prototype-functions">Prototype functions</h4>
</div>
</li>
<li id="section-13">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-13">§</a>
</div>
<p><code>updateDirty</code> - internal setter helper function</p>
</div>
<div class="content"><div class='highlight'><pre> P.<span class="hljs-property">updateDirty</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">true</span>;
<span class="hljs-variable language_">this</span>.<span class="hljs-property">dirtyPathObject</span> = <span class="hljs-literal">true</span>;
<span class="hljs-variable language_">this</span>.<span class="hljs-property">dirtyFilterIdentifier</span> = <span class="hljs-literal">true</span>;
};</pre></div></div>
</li>
<li id="section-14">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-14">§</a>
</div>
<p><code>midInitActions</code> - internal constructor helper function</p>
</div>
<div class="content"><div class='highlight'><pre> P.<span class="hljs-property">midInitActions</span> = <span class="hljs-keyword">function</span> (<span class="hljs-params">items</span>) {
<span class="hljs-variable language_">this</span>.<span class="hljs-title function_">set</span>(items);
};</pre></div></div>
</li>
<li id="section-15">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-15">§</a>
</div>
<p><code>shapeInit</code> - internal constructor helper function</p>
</div>
<div class="content"><div class='highlight'><pre> P.<span class="hljs-property">shapeInit</span> = <span class="hljs-keyword">function</span> (<span class="hljs-params">items</span>) {
<span class="hljs-variable language_">this</span>.<span class="hljs-title function_">entityInit</span>(items);
<span class="hljs-variable language_">this</span>.<span class="hljs-property">units</span> = [];
<span class="hljs-variable language_">this</span>.<span class="hljs-property">unitLengths</span> = [];
<span class="hljs-variable language_">this</span>.<span class="hljs-property">unitPartials</span> = [];
<span class="hljs-variable language_">this</span>.<span class="hljs-property">pathed</span> = [];
<span class="hljs-variable language_">this</span>.<span class="hljs-property">localBox</span> = [];
};</pre></div></div>
</li>
<li id="section-16">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-16">§</a>
</div>
<h4 id="path-related-functionality">Path-related functionality</h4>
</div>
</li>
<li id="section-17">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-17">§</a>
</div>
<p><code>positionPointOnPath</code></p>
</div>
<div class="content"><div class='highlight'><pre> P.<span class="hljs-property">positionPointOnPath</span> = <span class="hljs-keyword">function</span> (<span class="hljs-params">vals</span>) {
<span class="hljs-keyword">let</span> v = <span class="hljs-title function_">requestVector</span>(vals);
v.<span class="hljs-title function_">vectorSubtract</span>(<span class="hljs-variable language_">this</span>.<span class="hljs-property">currentStampHandlePosition</span>);
<span class="hljs-keyword">if</span>(<span class="hljs-variable language_">this</span>.<span class="hljs-property">flipReverse</span>) v.<span class="hljs-property">x</span> = -v.<span class="hljs-property">x</span>;
<span class="hljs-keyword">if</span>(<span class="hljs-variable language_">this</span>.<span class="hljs-property">flipUpend</span>) v.<span class="hljs-property">y</span> = -v.<span class="hljs-property">y</span>;
v.<span class="hljs-title function_">rotate</span>(<span class="hljs-variable language_">this</span>.<span class="hljs-property">roll</span>);
v.<span class="hljs-title function_">vectorAdd</span>(<span class="hljs-variable language_">this</span>.<span class="hljs-property">currentStampPosition</span>);
<span class="hljs-keyword">let</span> res = {
<span class="hljs-attr">x</span>: v.<span class="hljs-property">x</span>,
<span class="hljs-attr">y</span>: v.<span class="hljs-property">y</span>
}
<span class="hljs-title function_">releaseVector</span>(v);
<span class="hljs-keyword">return</span> res;
};</pre></div></div>
</li>
<li id="section-18">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-18">§</a>
</div>
<p><code>getBezierXY</code></p>
</div>
<div class="content"><div class='highlight'><pre> P.<span class="hljs-property">getBezierXY</span> = <span class="hljs-keyword">function</span> (<span class="hljs-params">t, sx, sy, cp1x, cp1y, cp2x, cp2y, ex, ey</span>) {
<span class="hljs-keyword">let</span> T = <span class="hljs-number">1</span> - t;
<span class="hljs-keyword">return</span> {
<span class="hljs-attr">x</span>: (<span class="hljs-title class_">Math</span>.<span class="hljs-title function_">pow</span>(T, <span class="hljs-number">3</span>) * sx) + (<span class="hljs-number">3</span> * t * <span class="hljs-title class_">Math</span>.<span class="hljs-title function_">pow</span>(T, <span class="hljs-number">2</span>) * cp1x) + (<span class="hljs-number">3</span> * t * t * T * cp2x) + (t * t * t * ex),
<span class="hljs-attr">y</span>: (<span class="hljs-title class_">Math</span>.<span class="hljs-title function_">pow</span>(T, <span class="hljs-number">3</span>) * sy) + (<span class="hljs-number">3</span> * t * <span class="hljs-title class_">Math</span>.<span class="hljs-title function_">pow</span>(T, <span class="hljs-number">2</span>) * cp1y) + (<span class="hljs-number">3</span> * t * t * T * cp2y) + (t * t * t * ey)
};
};</pre></div></div>
</li>
<li id="section-19">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-19">§</a>
</div>
<p><code>getQuadraticXY</code></p>
</div>
<div class="content"><div class='highlight'><pre> P.<span class="hljs-property">getQuadraticXY</span> = <span class="hljs-keyword">function</span> (<span class="hljs-params">t, sx, sy, cp1x, cp1y, ex, ey</span>) {
<span class="hljs-keyword">let</span> T = <span class="hljs-number">1</span> - t;
<span class="hljs-keyword">return</span> {
<span class="hljs-attr">x</span>: T * T * sx + <span class="hljs-number">2</span> * T * t * cp1x + t * t * ex,
<span class="hljs-attr">y</span>: T * T * sy + <span class="hljs-number">2</span> * T * t * cp1y + t * t * ey
};
};</pre></div></div>
</li>
<li id="section-20">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-20">§</a>
</div>
<p><code>getLinearXY</code></p>
</div>
<div class="content"><div class='highlight'><pre> P.<span class="hljs-property">getLinearXY</span> = <span class="hljs-keyword">function</span> (<span class="hljs-params">t, sx, sy, ex, ey</span>) {
<span class="hljs-keyword">return</span> {
<span class="hljs-attr">x</span>: sx + ((ex - sx) * t),
<span class="hljs-attr">y</span>: sy + ((ey - sy) * t)
};
};</pre></div></div>
</li>
<li id="section-21">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-21">§</a>
</div>
<p><code>getBezierAngle</code></p>
</div>
<div class="content"><div class='highlight'><pre> P.<span class="hljs-property">getBezierAngle</span> = <span class="hljs-keyword">function</span> (<span class="hljs-params">t, sx, sy, cp1x, cp1y, cp2x, cp2y, ex, ey</span>) {
<span class="hljs-keyword">let</span> T = <span class="hljs-number">1</span> - t,
dx = <span class="hljs-title class_">Math</span>.<span class="hljs-title function_">pow</span>(T, <span class="hljs-number">2</span>) * (cp1x - sx) + <span class="hljs-number">2</span> * t * T * (cp2x - cp1x) + t * t * (ex - cp2x),
dy = <span class="hljs-title class_">Math</span>.<span class="hljs-title function_">pow</span>(T, <span class="hljs-number">2</span>) * (cp1y - sy) + <span class="hljs-number">2</span> * t * T * (cp2y - cp1y) + t * t * (ey - cp2y);
<span class="hljs-keyword">return</span> (-<span class="hljs-title class_">Math</span>.<span class="hljs-title function_">atan2</span>(dx, dy) + (<span class="hljs-number">0.5</span> * <span class="hljs-title class_">Math</span>.<span class="hljs-property">PI</span>)) / radian;
};</pre></div></div>
</li>
<li id="section-22">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-22">§</a>
</div>
<p><code>getQuadraticAngle</code></p>
</div>
<div class="content"><div class='highlight'><pre> P.<span class="hljs-property">getQuadraticAngle</span> = <span class="hljs-keyword">function</span> (<span class="hljs-params">t, sx, sy, cp1x, cp1y, ex, ey</span>) {
<span class="hljs-keyword">let</span> T = <span class="hljs-number">1</span> - t,
dx = <span class="hljs-number">2</span> * T * (cp1x - sx) + <span class="hljs-number">2</span> * t * (ex - cp1x),
dy = <span class="hljs-number">2</span> * T * (cp1y - sy) + <span class="hljs-number">2</span> * t * (ey - cp1y);
<span class="hljs-keyword">return</span> (-<span class="hljs-title class_">Math</span>.<span class="hljs-title function_">atan2</span>(dx, dy) + (<span class="hljs-number">0.5</span> * <span class="hljs-title class_">Math</span>.<span class="hljs-property">PI</span>)) / radian;
};</pre></div></div>
</li>
<li id="section-23">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-23">§</a>
</div>
<p><code>getLinearAngle</code></p>
</div>
<div class="content"><div class='highlight'><pre> P.<span class="hljs-property">getLinearAngle</span> = <span class="hljs-keyword">function</span> (<span class="hljs-params">t, sx, sy, ex, ey</span>) {
<span class="hljs-keyword">let</span> dx = ex - sx,
dy = ey - sy;
<span class="hljs-keyword">return</span> (-<span class="hljs-title class_">Math</span>.<span class="hljs-title function_">atan2</span>(dx, dy) + (<span class="hljs-number">0.5</span> * <span class="hljs-title class_">Math</span>.<span class="hljs-property">PI</span>)) / radian;
};</pre></div></div>
</li>
<li id="section-24">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-24">§</a>
</div>
<p><code>getConstantPosition</code> - internal function called by <code>getPathPositionData</code></p>
</div>
<div class="content"><div class='highlight'><pre> P.<span class="hljs-property">getConstantPosition</span> = <span class="hljs-keyword">function</span> (<span class="hljs-params">pos</span>) {
<span class="hljs-keyword">if</span> (!pos || !pos.<span class="hljs-property">toFixed</span> || <span class="hljs-built_in">isNaN</span>(pos)) <span class="hljs-keyword">return</span> <span class="hljs-number">0</span>;
<span class="hljs-keyword">if</span> (pos >= <span class="hljs-number">1</span>) <span class="hljs-keyword">return</span> <span class="hljs-number">0.9999</span>;
<span class="hljs-keyword">let</span> positions = <span class="hljs-variable language_">this</span>.<span class="hljs-property">unitPositions</span>;
<span class="hljs-keyword">if</span> (positions && positions.<span class="hljs-property">length</span>) {
<span class="hljs-keyword">let</span> len = <span class="hljs-variable language_">this</span>.<span class="hljs-property">length</span>,
progress = <span class="hljs-variable language_">this</span>.<span class="hljs-property">unitProgression</span>,
positions = <span class="hljs-variable language_">this</span>.<span class="hljs-property">unitPositions</span>,
requiredProgress = pos * len,
index = -<span class="hljs-number">1</span>,
currentProgress, indexProgress, lastProgress, diffProgress,
currentPosition, indexPosition, nextPosition, diffPosition;
<span class="hljs-keyword">for</span> (<span class="hljs-keyword">let</span> i = <span class="hljs-number">0</span>, iz = progress.<span class="hljs-property">length</span>; i < iz; i++) {
<span class="hljs-keyword">if</span> (requiredProgress <= progress[i]) {
index = i - <span class="hljs-number">1</span>;
<span class="hljs-keyword">break</span>;
}
}
<span class="hljs-keyword">if</span> (index < <span class="hljs-number">0</span>) {</pre></div></div>
</li>
<li id="section-25">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-25">§</a>
</div>
<p>first segment</p>
</div>
<div class="content"><div class='highlight'><pre> indexProgress = progress[<span class="hljs-number">0</span>];
currentPosition = (requiredProgress / indexProgress) * positions[<span class="hljs-number">0</span>];
}
<span class="hljs-keyword">else</span> {</pre></div></div>
</li>
<li id="section-26">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-26">§</a>
</div>
<p>subsequent segments - progress is pixel lengths</p>
</div>
<div class="content"><div class='highlight'><pre> indexProgress = progress[index];
lastProgress = (index) ? progress[index - <span class="hljs-number">1</span>] : <span class="hljs-number">0</span>;
diffProgress = indexProgress - lastProgress;</pre></div></div>
</li>
<li id="section-27">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-27">§</a>
</div>
<p>… and position is in the range 0-1</p>
</div>
<div class="content"><div class='highlight'><pre> indexPosition = positions[index];
nextPosition = positions[index + <span class="hljs-number">1</span>];
diffPosition = nextPosition - indexPosition;
currentPosition = indexPosition + (((requiredProgress - indexProgress) / diffProgress) * diffPosition);
}
<span class="hljs-keyword">return</span> currentPosition;
}
<span class="hljs-keyword">else</span> <span class="hljs-keyword">return</span> pos;
};</pre></div></div>
</li>
<li id="section-28">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-28">§</a>
</div>
<p><code>buildPathPositionObject</code> - internal function called by <code>getPathPositionData</code></p>
</div>
<div class="content"><div class='highlight'><pre> P.<span class="hljs-property">buildPathPositionObject</span> = <span class="hljs-keyword">function</span> (<span class="hljs-params">unit, myLen</span>) {
<span class="hljs-keyword">if</span> (unit) {
<span class="hljs-keyword">let</span> [unitSpecies, ...vars] = unit;
<span class="hljs-keyword">let</span> myPoint, angle;
<span class="hljs-keyword">switch</span> (unitSpecies) {
<span class="hljs-keyword">case</span> <span class="hljs-string">'linear'</span> :
myPoint = <span class="hljs-variable language_">this</span>.<span class="hljs-title function_">positionPointOnPath</span>(<span class="hljs-variable language_">this</span>.<span class="hljs-title function_">getLinearXY</span>(myLen, ...vars));
angle = <span class="hljs-variable language_">this</span>.<span class="hljs-title function_">getLinearAngle</span>(myLen, ...vars);
<span class="hljs-keyword">break</span>;
<span class="hljs-keyword">case</span> <span class="hljs-string">'quadratic'</span> :
myPoint = <span class="hljs-variable language_">this</span>.<span class="hljs-title function_">positionPointOnPath</span>(<span class="hljs-variable language_">this</span>.<span class="hljs-title function_">getQuadraticXY</span>(myLen, ...vars));
angle = <span class="hljs-variable language_">this</span>.<span class="hljs-title function_">getQuadraticAngle</span>(myLen, ...vars);
<span class="hljs-keyword">break</span>;
<span class="hljs-keyword">case</span> <span class="hljs-string">'bezier'</span> :
myPoint = <span class="hljs-variable language_">this</span>.<span class="hljs-title function_">positionPointOnPath</span>(<span class="hljs-variable language_">this</span>.<span class="hljs-title function_">getBezierXY</span>(myLen, ...vars));
angle = <span class="hljs-variable language_">this</span>.<span class="hljs-title function_">getBezierAngle</span>(myLen, ...vars);
<span class="hljs-keyword">break</span>;
}
<span class="hljs-keyword">let</span> flipAngle = <span class="hljs-number">0</span>
<span class="hljs-keyword">if</span> (<span class="hljs-variable language_">this</span>.<span class="hljs-property">flipReverse</span>) flipAngle++;
<span class="hljs-keyword">if</span> (<span class="hljs-variable language_">this</span>.<span class="hljs-property">flipUpend</span>) flipAngle++;
<span class="hljs-keyword">if</span> (flipAngle === <span class="hljs-number">1</span>) angle = -angle;
angle += <span class="hljs-variable language_">this</span>.<span class="hljs-property">roll</span>;
myPoint.<span class="hljs-property">angle</span> = angle;
<span class="hljs-keyword">return</span> myPoint;
}
<span class="hljs-keyword">return</span> <span class="hljs-literal">false</span>;
}</pre></div></div>
</li>
<li id="section-29">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-29">§</a>
</div>
<p><code>getPathPositionData</code> - function called by <code>getPathPositionData</code></p>
<ul>
<li>Also useful in user code to retrieve the Cell-relative coordinates of any point (measured as a float Number between <code>0</code> and <code>1</code> along the path)</li>
<li>The second argument - a Boolean - rectifies for constant speed</li>
</ul>
</div>
<div class="content"><div class='highlight'><pre> P.<span class="hljs-property">getPathPositionData</span> = <span class="hljs-keyword">function</span> (<span class="hljs-params">pos, constantSpeed = <span class="hljs-literal">false</span></span>) {
<span class="hljs-keyword">if</span> (<span class="hljs-variable language_">this</span>.<span class="hljs-property">useAsPath</span> && <span class="hljs-title function_">xt</span>(pos) && pos.<span class="hljs-property">toFixed</span>) {
<span class="hljs-keyword">let</span> remainder = pos % <span class="hljs-number">1</span>,
unitPartials = <span class="hljs-variable language_">this</span>.<span class="hljs-property">unitPartials</span>,
previousLen = <span class="hljs-number">0</span>,
stoppingLen, myLen, i, iz, unit, species;</pre></div></div>
</li>
<li id="section-30">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-30">§</a>
</div>
<p>… because sometimes everything d