scrawl-canvas
Version:
Version 8.9.4 - 19 Nov 2022
698 lines (439 loc) • 28 kB
HTML
<html>
<head>
<title>Scrawl-canvas snippets</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="animationloop.html">
./source/core/animationloop.js
</a>
<a class="source" href="document.html">
./source/core/document.js
</a>
<a class="source" href="events.html">
./source/core/events.js
</a>
<a class="source" href="init.html">
./source/core/init.js
</a>
<a class="source" href="library.html">
./source/core/library.js
</a>
<a class="source" href="random-seed.html">
./source/core/random-seed.js
</a>
<a class="source" href="snippets.html">
./source/core/snippets.js
</a>
<a class="source" href="userInteraction.html">
./source/core/userInteraction.js
</a>
<a class="source" href="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="../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="scrawl-canvas-snippets">Scrawl-canvas snippets</h1>
</div>
</li>
<li id="section-2">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-2">§</a>
</div>
<p><em><strong>To be aware - this functionality is HIGHLY EXPERIMENTAL; it will be subject to short-notice breaking changes as we amend and inprove the concept of Scrawl-canvas snippets</strong></em></p>
</div>
</li>
<li id="section-3">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-3">§</a>
</div>
<p>TODO - documentation</p>
</div>
</li>
<li id="section-4">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-4">§</a>
</div>
<h2 id="imports">Imports</h2>
</div>
<div class="content"><div class='highlight'><pre><span class="hljs-keyword">import</span> { isa_dom, isa_boolean, isa_obj } <span class="hljs-keyword">from</span> <span class="hljs-string">"./utilities.js"</span>;
<span class="hljs-keyword">import</span> { artefact, unstackedelement } <span class="hljs-keyword">from</span> <span class="hljs-string">"./library.js"</span>;
<span class="hljs-keyword">import</span> { makeAnimationObserver } <span class="hljs-keyword">from</span> <span class="hljs-string">'./events.js'</span>;
<span class="hljs-keyword">import</span> { makeRender } <span class="hljs-keyword">from</span> <span class="hljs-string">"../factory/renderAnimation.js"</span>;
<span class="hljs-keyword">import</span> { makeUnstackedElement } <span class="hljs-keyword">from</span> <span class="hljs-string">"../factory/unstackedElement.js"</span>;</pre></div></div>
</li>
<li id="section-5">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-5">§</a>
</div>
<p>TODO - documentation</p>
</div>
<div class="content"><div class='highlight'><pre><span class="hljs-keyword">const</span> makeSnippet = <span class="hljs-keyword">function</span> (<span class="hljs-params">items</span>) {
<span class="hljs-keyword">let</span> domElement = (<span class="hljs-title function_">isa_dom</span>(items.<span class="hljs-property">domElement</span>)) ? items.<span class="hljs-property">domElement</span> : <span class="hljs-literal">false</span>,
animationHooks = (<span class="hljs-title function_">isa_obj</span>(items.<span class="hljs-property">animationHooks</span>)) ? items.<span class="hljs-property">animationHooks</span> : {},
canvasSpecs = (<span class="hljs-title function_">isa_obj</span>(items.<span class="hljs-property">canvasSpecs</span>)) ? items.<span class="hljs-property">canvasSpecs</span> : {},
observerSpecs = (<span class="hljs-title function_">isa_obj</span>(items.<span class="hljs-property">observerSpecs</span>)) ? items.<span class="hljs-property">observerSpecs</span> : {},
includeCanvas = (<span class="hljs-title function_">isa_boolean</span>(items.<span class="hljs-property">includeCanvas</span>)) ? items.<span class="hljs-property">includeCanvas</span> : <span class="hljs-literal">true</span>;
<span class="hljs-keyword">if</span> (domElement && domElement.<span class="hljs-property">id</span> && artefact[domElement.<span class="hljs-property">id</span>]) {
<span class="hljs-keyword">return</span> <span class="hljs-title function_">makeStackSnippet</span>(domElement, canvasSpecs, animationHooks, observerSpecs);
}
<span class="hljs-keyword">return</span> <span class="hljs-title function_">makeUnstackedSnippet</span>(domElement, canvasSpecs, animationHooks, observerSpecs, includeCanvas);
};</pre></div></div>
</li>
<li id="section-6">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-6">§</a>
</div>
<p>TODO - documentation</p>
</div>
<div class="content"><div class='highlight'><pre><span class="hljs-keyword">const</span> makeStackSnippet = <span class="hljs-keyword">function</span> (<span class="hljs-params">domElement, canvasSpecs, animationHooks, observerSpecs</span>) {
<span class="hljs-keyword">let</span> myElement = artefact[domElement.<span class="hljs-property">id</span>];
<span class="hljs-keyword">if</span> (!myElement) <span class="hljs-keyword">return</span> <span class="hljs-literal">false</span>;
canvasSpecs.<span class="hljs-property">baseMatchesCanvasDimensions</span> = <span class="hljs-literal">true</span>;
canvasSpecs.<span class="hljs-property">ignoreCanvasCssDimensions</span> = <span class="hljs-literal">true</span>;
canvasSpecs.<span class="hljs-property">checkForResize</span> = <span class="hljs-literal">true</span>;
<span class="hljs-keyword">let</span> myCanvas = myElement.<span class="hljs-title function_">addCanvas</span>(canvasSpecs);
myElement.<span class="hljs-property">elementComputedStyles</span> = <span class="hljs-variable language_">window</span>.<span class="hljs-title function_">getComputedStyle</span>(domElement);
animationHooks.<span class="hljs-property">name</span> = <span class="hljs-string">`<span class="hljs-subst">${myElement.name}</span>-animation`</span>;
animationHooks.<span class="hljs-property">target</span> = myCanvas;
<span class="hljs-keyword">let</span> myAnimation = <span class="hljs-title function_">makeRender</span>(animationHooks);
<span class="hljs-keyword">let</span> myObserver = <span class="hljs-title function_">makeAnimationObserver</span>(myAnimation, myElement, observerSpecs);
<span class="hljs-keyword">let</span> <span class="hljs-title function_">destroy</span> = (<span class="hljs-params"></span>) => {
<span class="hljs-title function_">myObserver</span>();
myAnimation.<span class="hljs-title function_">kill</span>();
myCanvas.<span class="hljs-title function_">demolish</span>();
myElement.<span class="hljs-title function_">demolish</span>(<span class="hljs-literal">true</span>);
};
<span class="hljs-keyword">return</span> {
<span class="hljs-attr">element</span>: myElement,
<span class="hljs-attr">canvas</span>: myCanvas,
<span class="hljs-attr">animation</span>: myAnimation,
<span class="hljs-attr">demolish</span>: destroy,
};
};</pre></div></div>
</li>
<li id="section-7">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-7">§</a>
</div>
<p>TODO - documentation</p>
</div>
<div class="content"><div class='highlight'><pre><span class="hljs-keyword">const</span> makeUnstackedSnippet = <span class="hljs-keyword">function</span> (<span class="hljs-params">domElement, canvasSpecs, animationHooks, observerSpecs, includeCanvas</span>) {
<span class="hljs-keyword">const</span> unsupportedElements = [<span class="hljs-string">'AREA'</span>, <span class="hljs-string">'BASE'</span>, <span class="hljs-string">'BR'</span>, <span class="hljs-string">'COL'</span>, <span class="hljs-string">'EMBED'</span>, <span class="hljs-string">'HR'</span>, <span class="hljs-string">'IMG'</span>, <span class="hljs-string">'INPUT'</span>, <span class="hljs-string">'KEYGEN'</span>, <span class="hljs-string">'LINK'</span>, <span class="hljs-string">'META'</span>, <span class="hljs-string">'PARAM'</span>, <span class="hljs-string">'SOURCE'</span>, <span class="hljs-string">'TRACK'</span>, <span class="hljs-string">'WBR'</span>];
<span class="hljs-keyword">if</span> (!domElement || unsupportedElements.<span class="hljs-title function_">indexOf</span>(domElement.<span class="hljs-property">tagName</span>) >= <span class="hljs-number">0</span>) <span class="hljs-keyword">return</span> {};
<span class="hljs-keyword">let</span> myElement,
id = domElement.<span class="hljs-property">id</span>;
<span class="hljs-keyword">if</span> (id && unstackedelement[id]) myElement = unstackedelement[id];
<span class="hljs-keyword">else</span> myElement = <span class="hljs-title function_">makeUnstackedElement</span>(domElement);
canvasSpecs.<span class="hljs-property">baseMatchesCanvasDimensions</span> = <span class="hljs-literal">true</span>;
canvasSpecs.<span class="hljs-property">checkForResize</span> = <span class="hljs-literal">true</span>;
<span class="hljs-keyword">let</span> myCanvas = (includeCanvas) ? myElement.<span class="hljs-title function_">addCanvas</span>(canvasSpecs) : <span class="hljs-literal">false</span>;
animationHooks.<span class="hljs-property">name</span> = <span class="hljs-string">`<span class="hljs-subst">${myElement.name}</span>-animation`</span>;
<span class="hljs-keyword">if</span> (myCanvas) {
<span class="hljs-keyword">if</span> (!animationHooks.<span class="hljs-property">afterClear</span>) animationHooks.<span class="hljs-property">afterClear</span> = <span class="hljs-function">() =></span> myElement.<span class="hljs-title function_">updateCanvas</span>();
animationHooks.<span class="hljs-property">target</span> = myCanvas;
}
<span class="hljs-keyword">else</span> animationHooks.<span class="hljs-property">noTarget</span> = <span class="hljs-literal">true</span>;
<span class="hljs-keyword">let</span> myAnimation = <span class="hljs-title function_">makeRender</span>(animationHooks);
<span class="hljs-keyword">let</span> myObserver = <span class="hljs-title function_">makeAnimationObserver</span>(myAnimation, myElement, observerSpecs);
<span class="hljs-keyword">let</span> <span class="hljs-title function_">destroy</span> = (<span class="hljs-params"></span>) => {
<span class="hljs-title function_">myObserver</span>();
myAnimation.<span class="hljs-title function_">kill</span>();
<span class="hljs-keyword">if</span> (myCanvas) myCanvas.<span class="hljs-title function_">demolish</span>();
myElement.<span class="hljs-title function_">demolish</span>(<span class="hljs-literal">true</span>);
};
<span class="hljs-keyword">return</span> {
<span class="hljs-attr">element</span>: myElement,
<span class="hljs-attr">canvas</span>: myCanvas,
<span class="hljs-attr">animation</span>: myAnimation,
<span class="hljs-attr">demolish</span>: destroy,
};
};</pre></div></div>
</li>
<li id="section-8">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-8">§</a>
</div>
<p>TODO - documentation</p>
</div>
<div class="content"><div class='highlight'><pre><span class="hljs-keyword">export</span> {
makeSnippet,
};</pre></div></div>
</li>
</ul>
</div>
</body>
</html>