animation.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242
  1. <?xml version="1.0" encoding="utf-8" ?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  3. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  4. <!-- This file is generated by Nim. -->
  5. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  6. <head>
  7. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  8. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  9. <!-- Favicon -->
  10. <link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA=="/>
  11. <link rel="icon" type="image/png" sizes="32x32" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4QQQEwksSS9ZWwAAAk1JREFUWMPtll2ITVEUx39nn/O7Y5qR8f05wtCUUr6ZIS++8pEnkZInPImneaCQ5METNdOkeFBKUhMPRIkHKfEuUZSUlGlKPN2TrgfncpvmnntnmlEyq1Z7t89/rf9a6+y99oZxGZf/XeIq61EdtgKXgdXA0xrYAvBjOIF1AI9zvjcC74BSpndrJPkBWDScTF8Aa4E3wDlgHbASaANmVqlcCnwHvgDvgVfAJ+AikAAvgfVZwLnSVZHZaOuKoQi3ZOMi4NkYkpe1p4J7A8BpYAD49hfIy/oqG0+hLomiKP2L5L+1ubn5115S+3OAn4EnwBlgMzCjyt6ZAnQCJ4A7wOs88iRJHvw50HoujuPBoCKwHWiosy8MdfZnAdcHk8dxXFJ3VQbQlCTJvRBCGdRbD4M6uc5glpY3eAihpN5S5w12diSEcCCEcKUO4ljdr15T76ur1FDDLIQQ3qv71EdDOe3Kxj3leRXyk+pxdWnFWod6Wt2bY3de3aSuUHcPBVimHs7mK9WrmeOF6lR1o9qnzskh2ar2qm1qizpfXaPeVGdlmGN5pb09qMxz1Xb1kLqgzn1RyH7JUXW52lr5e/Kqi9qpto7V1atuUzfnARrV7jEib1T76gG2qxdGmXyiekkt1GswPTtek0aBfJp6YySGBfWg2tPQ0FAYgf1stUfdmdcjarbYJEniKIq6gY/Aw+zWHAC+p2labGpqiorFYgGYCEzN7oQdQClN07O1/EfDyGgC0ALMBdYAi4FyK+4H3gLPsxfR1zRNi+NP7nH5J+QntnXe5B5mpfQAAAAASUVORK5CYII=">
  12. <!-- Google fonts -->
  13. <link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
  14. <link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
  15. <!-- CSS -->
  16. <title>nodesnim/core/animation</title>
  17. <link rel="stylesheet" type="text/css" href="../../nimdoc.out.css">
  18. <script type="text/javascript" src="dochack.js"></script>
  19. <script type="text/javascript">
  20. function main() {
  21. var pragmaDots = document.getElementsByClassName("pragmadots");
  22. for (var i = 0; i < pragmaDots.length; i++) {
  23. pragmaDots[i].onclick = function(event) {
  24. // Hide tease
  25. event.target.parentNode.style.display = "none";
  26. // Show actual
  27. event.target.parentNode.nextElementSibling.style.display = "inline";
  28. }
  29. }
  30. const toggleSwitch = document.querySelector('.theme-switch input[type="checkbox"]');
  31. function switchTheme(e) {
  32. if (e.target.checked) {
  33. document.documentElement.setAttribute('data-theme', 'dark');
  34. localStorage.setItem('theme', 'dark');
  35. } else {
  36. document.documentElement.setAttribute('data-theme', 'light');
  37. localStorage.setItem('theme', 'light');
  38. }
  39. }
  40. toggleSwitch.addEventListener('change', switchTheme, false);
  41. if (window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches) {
  42. document.documentElement.setAttribute('data-theme', "dark");
  43. toggleSwitch.checked = true;
  44. } else if (window.matchMedia && window.matchMedia('(prefers-color-scheme: light)').matches) {
  45. document.documentElement.setAttribute('data-theme', "light");
  46. toggleSwitch.checked = false;
  47. } else {
  48. const currentTheme = localStorage.getItem('theme') ? localStorage.getItem('theme') : null;
  49. if (currentTheme) {
  50. document.documentElement.setAttribute('data-theme', currentTheme);
  51. if (currentTheme === 'dark') {
  52. toggleSwitch.checked = true;
  53. }
  54. }
  55. }
  56. }
  57. </script>
  58. </head>
  59. <body onload="main()">
  60. <div class="document" id="documentId">
  61. <div class="container">
  62. <h1 class="title">nodesnim/core/animation</h1>
  63. <div class="row">
  64. <div class="three columns">
  65. <div class="theme-switch-wrapper">
  66. <label class="theme-switch" for="checkbox">
  67. <input type="checkbox" id="checkbox" />
  68. <div class="slider round"></div>
  69. </label>
  70. &nbsp;&nbsp;&nbsp; <em>Dark Mode</em>
  71. </div>
  72. <div id="global-links">
  73. <ul class="simple">
  74. </ul>
  75. </div>
  76. <div id="searchInputDiv">
  77. Search: <input type="text" id="searchInput"
  78. onkeyup="search()" />
  79. </div>
  80. <div>
  81. Group by:
  82. <select onchange="groupBy(this.value)">
  83. <option value="section">Section</option>
  84. <option value="type">Type</option>
  85. </select>
  86. </div>
  87. <ul class="simple simple-toc" id="toc-list">
  88. <li>
  89. <a class="reference reference-toplevel" href="#7" id="57">Types</a>
  90. <ul class="simple simple-toc-section">
  91. <li><a class="reference" href="#AnimationObj"
  92. title="AnimationObj[T] = object
  93. frame*: int
  94. speed*, current*: float
  95. name*: string
  96. frames*: seq[T]"><wbr />Animation<wbr />Obj<span class="attachedType"></span></a></li>
  97. <li><a class="reference" href="#AnimationRef"
  98. title="AnimationRef[T] = ref AnimationObj[T]"><wbr />Animation<wbr />Ref<span class="attachedType"></span></a></li>
  99. <li><a class="reference" href="#AnimationArray"
  100. title="AnimationArray[T] = seq[AnimationRef[T]]"><wbr />Animation<wbr />Array<span class="attachedType"></span></a></li>
  101. </ul>
  102. </li>
  103. <li>
  104. <a class="reference reference-toplevel" href="#12" id="62">Procs</a>
  105. <ul class="simple simple-toc-section">
  106. <li><a class="reference" href="#Animation%2Cstring%2Cfloat"
  107. title="Animation[T](name: string; speed: float = 1.0&apos;f32): AnimationRef[T]"><wbr />Animation<span class="attachedType">AnimationRef</span></a></li>
  108. <li><a class="reference" href="#addFrame%2CAnimationRef%5BT%5D%2CT"
  109. title="addFrame[T](anim: AnimationRef[T]; frame: T)"><wbr />add<wbr />Frame<span class="attachedType">AnimationRef</span></a></li>
  110. <li><a class="reference" href="#%3D%3D%2CAnimationRef%5BT%5D%2CAnimationRef%5BT%5D"
  111. title="`==`[T](x, y: AnimationRef[T]): bool"><wbr />`==`<span class="attachedType">AnimationRef</span></a></li>
  112. <li><a class="reference" href="#%5B%5D%2CAnimationArray%5BT%5D%2Cstring"
  113. title="`[]`[T](arr: AnimationArray[T]; index: string): AnimationRef[T]"><wbr />`[]`<span class="attachedType">AnimationArray</span></a></li>
  114. <li><a class="reference" href="#contains%2CAnimationArray%5BT%5D%2CAnimationRef%5BT%5D"
  115. title="contains[T](arr: AnimationArray[T]; animation: AnimationRef[T]): bool"><wbr />contains<span class="attachedType">AnimationArray</span></a></li>
  116. <li><a class="reference" href="#contains%2CAnimationArray%5BT%5D%2Cstring"
  117. title="contains[T](arr: AnimationArray[T]; name: string): bool"><wbr />contains<span class="attachedType">AnimationArray</span></a></li>
  118. </ul>
  119. </li>
  120. </ul>
  121. </div>
  122. <div class="nine columns" id="content">
  123. <div id="tocRoot"></div>
  124. <p class="module-desc"></p>
  125. <div class="section" id="7">
  126. <h1><a class="toc-backref" href="#7">Types</a></h1>
  127. <dl class="item">
  128. <a id="AnimationObj"></a>
  129. <dt><pre><a href="animation.html#AnimationObj"><span class="Identifier">AnimationObj</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span> <span class="Other">=</span> <span class="Keyword">object</span>
  130. <span class="Identifier">frame</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">int</span>
  131. <span class="Identifier">speed</span><span class="Operator">*</span><span class="Other">,</span> <span class="Identifier">current</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">float</span>
  132. <span class="Identifier">name</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">string</span>
  133. <span class="Identifier">frames</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span>
  134. </pre></dt>
  135. <dd>
  136. </dd>
  137. <a id="AnimationRef"></a>
  138. <dt><pre><a href="animation.html#AnimationRef"><span class="Identifier">AnimationRef</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span> <span class="Other">=</span> <span class="Keyword">ref</span> <a href="animation.html#AnimationObj"><span class="Identifier">AnimationObj</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
  139. <dd>
  140. </dd>
  141. <a id="AnimationArray"></a>
  142. <dt><pre><a href="animation.html#AnimationArray"><span class="Identifier">AnimationArray</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span> <span class="Other">=</span> <span class="Identifier">seq</span><span class="Other">[</span><a href="animation.html#AnimationRef"><span class="Identifier">AnimationRef</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">]</span></pre></dt>
  143. <dd>
  144. </dd>
  145. </dl></div>
  146. <div class="section" id="12">
  147. <h1><a class="toc-backref" href="#12">Procs</a></h1>
  148. <dl class="item">
  149. <a id="Animation,string,float"></a>
  150. <dt><pre><span class="Keyword">proc</span> <a href="#Animation%2Cstring%2Cfloat"><span class="Identifier">Animation</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">name</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">speed</span><span class="Other">:</span> <span class="Identifier">float</span> <span class="Other">=</span> <span class="FloatNumber">1.0'f32</span><span class="Other">)</span><span class="Other">:</span> <a href="animation.html#AnimationRef"><span class="Identifier">AnimationRef</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
  151. <dd>
  152. <p>Creates a new Animation object.</p>
  153. <p>Arguments:</p>
  154. <ul class="simple"><li><tt class="docutils literal"><span class="pre">name</span></tt> is an animation name.</li>
  155. <li><tt class="docutils literal"><span class="pre">speed</span></tt> is an animation speed.</li>
  156. </ul>
  157. <p><strong class="examples_text">Examples:</strong></p>
  158. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">anim</span> <span class="Other">=</span> <span class="Identifier">Animation</span><span class="Other">[</span><span class="Identifier">int</span><span class="Other">]</span><span class="Other">(</span><span class="StringLit">&quot;animation&quot;</span><span class="Other">,</span> <span class="FloatNumber">10.0'f32</span><span class="Other">)</span></pre>
  159. </dd>
  160. <a id="addFrame,AnimationRef[T],T"></a>
  161. <dt><pre><span class="Keyword">proc</span> <a href="#addFrame%2CAnimationRef%5BT%5D%2CT"><span class="Identifier">addFrame</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">anim</span><span class="Other">:</span> <a href="animation.html#AnimationRef"><span class="Identifier">AnimationRef</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">frame</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span></pre></dt>
  162. <dd>
  163. Adds a new frame in the animation.
  164. </dd>
  165. <a id="==,AnimationRef[T],AnimationRef[T]"></a>
  166. <dt><pre><span class="Keyword">proc</span> <a href="#%3D%3D%2CAnimationRef%5BT%5D%2CAnimationRef%5BT%5D"><span class="Identifier">`==`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="animation.html#AnimationRef"><span class="Identifier">AnimationRef</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">bool</span></pre></dt>
  167. <dd>
  168. </dd>
  169. <a id="[],AnimationArray[T],string"></a>
  170. <dt><pre><span class="Keyword">proc</span> <a href="#%5B%5D%2CAnimationArray%5BT%5D%2Cstring"><span class="Identifier">`[]`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">arr</span><span class="Other">:</span> <a href="animation.html#AnimationArray"><span class="Identifier">AnimationArray</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">index</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <a href="animation.html#AnimationRef"><span class="Identifier">AnimationRef</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
  171. <dd>
  172. </dd>
  173. <a id="contains,AnimationArray[T],AnimationRef[T]"></a>
  174. <dt><pre><span class="Keyword">proc</span> <a href="#contains%2CAnimationArray%5BT%5D%2CAnimationRef%5BT%5D"><span class="Identifier">contains</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">arr</span><span class="Other">:</span> <a href="animation.html#AnimationArray"><span class="Identifier">AnimationArray</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">animation</span><span class="Other">:</span> <a href="animation.html#AnimationRef"><span class="Identifier">AnimationRef</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">bool</span></pre></dt>
  175. <dd>
  176. </dd>
  177. <a id="contains,AnimationArray[T],string"></a>
  178. <dt><pre><span class="Keyword">proc</span> <a href="#contains%2CAnimationArray%5BT%5D%2Cstring"><span class="Identifier">contains</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">arr</span><span class="Other">:</span> <a href="animation.html#AnimationArray"><span class="Identifier">AnimationArray</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">name</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">bool</span></pre></dt>
  179. <dd>
  180. </dd>
  181. </dl></div>
  182. </div>
  183. </div>
  184. <div class="row">
  185. <div class="twelve-columns footer">
  186. <span class="nim-sprite"></span>
  187. <br/>
  188. <small style="color: var(--hint);">Made with Nim. Generated: 2021-08-31 09:04:39 UTC</small>
  189. </div>
  190. </div>
  191. </div>
  192. </div>
  193. </body>
  194. </html>