aboutsummaryrefslogtreecommitdiffstats
path: root/docs/util.html
blob: 24b153f4bc7c949dc2a5a81b9e7756c494789b49 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
<!DOCTYPE html>  <html> <head>   <title>util.coffee</title>   <meta http-equiv="content-type" content="text/html; charset=UTF-8">   <link rel="stylesheet" media="all" href="docco.css" /> </head> <body>   <div id="container">     <div id="background"></div>            <div id="jump_to">         Jump To &hellip;         <div id="jump_wrapper">           <div id="jump_page">                                           <a class="source" href="blackwhite.html">                 blackwhite.coffee               </a>                                           <a class="source" href="brightnesscontrast.html">                 brightnesscontrast.coffee               </a>                                           <a class="source" href="colorbalance.html">                 colorbalance.coffee               </a>                                           <a class="source" href="curves.html">                 curves.coffee               </a>                                           <a class="source" href="exposure.html">                 exposure.coffee               </a>                                           <a class="source" href="gradient.html">                 gradient.coffee               </a>                                           <a class="source" href="huesaturation.html">                 huesaturation.coffee               </a>                                           <a class="source" href="invert.html">                 invert.coffee               </a>                                           <a class="source" href="layereffect.html">                 layereffect.coffee               </a>                                           <a class="source" href="levels.html">                 levels.coffee               </a>                                           <a class="source" href="pattern.html">                 pattern.coffee               </a>                                           <a class="source" href="photofilter.html">                 photofilter.coffee               </a>                                           <a class="source" href="posterize.html">                 posterize.coffee               </a>                                           <a class="source" href="selectivecolor.html">                 selectivecolor.coffee               </a>                                           <a class="source" href="solidcolor.html">                 solidcolor.coffee               </a>                                           <a class="source" href="threshold.html">                 threshold.coffee               </a>                                           <a class="source" href="typetool.html">                 typetool.coffee               </a>                                           <a class="source" href="vibrance.html">                 vibrance.coffee               </a>                                           <a class="source" href="log.html">                 log.coffee               </a>                                           <a class="source" href="psd.html">                 psd.coffee               </a>                                           <a class="source" href="psdassert.html">                 psdassert.coffee               </a>                                           <a class="source" href="psdchannelimage.html">                 psdchannelimage.coffee               </a>                                           <a class="source" href="psdcolor.html">                 psdcolor.coffee               </a>                                           <a class="source" href="psddescriptor.html">                 psddescriptor.coffee               </a>                                           <a class="source" href="psdfile.html">                 psdfile.coffee               </a>                                           <a class="source" href="psdheader.html">                 psdheader.coffee               </a>                                           <a class="source" href="psdimage.html">                 psdimage.coffee               </a>                                           <a class="source" href="psdlayer.html">                 psdlayer.coffee               </a>                                           <a class="source" href="psdlayermask.html">                 psdlayermask.coffee               </a>                                           <a class="source" href="psdresource.html">                 psdresource.coffee               </a>                                           <a class="source" href="util.html">                 util.coffee               </a>                        </div>         </div>       </div>          <table cellpadding="0" cellspacing="0">       <thead>         <tr>           <th class="docs">             <h1>               util.coffee             </h1>           </th>           <th class="code">           </th>         </tr>       </thead>       <tbody>                               <tr id="section-1">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-1">&#182;</a>               </div>               <p>"Static" utility functions</p>             </td>             <td class="code">               <div class="highlight"><pre><span class="k">class</span> <span class="nx">Util</span>
  <span class="vi">@pad2: </span><span class="nf">(i) -&gt;</span> <span class="nb">Math</span><span class="p">.</span><span class="nx">floor</span><span class="p">((</span><span class="nx">i</span> <span class="o">+</span> <span class="mi">1</span><span class="p">)</span> <span class="o">/</span> <span class="mi">2</span><span class="p">)</span> <span class="o">*</span> <span class="mi">2</span>
  <span class="vi">@pad4: </span><span class="nf">(i) -&gt;</span> <span class="nx">i</span> <span class="o">-</span> <span class="p">(</span><span class="nx">i</span> <span class="o">%</span> <span class="mi">4</span><span class="p">)</span> <span class="o">+</span> <span class="mi">3</span>

  <span class="vi">@toUInt16: </span><span class="nf">(b1, b2) -&gt;</span> <span class="p">(</span><span class="nx">b1</span> <span class="o">&lt;&lt;</span> <span class="mi">8</span><span class="p">)</span> <span class="o">|</span> <span class="nx">b2</span>
  <span class="vi">@toInt16: </span><span class="nf">(b1, b2) -&gt;</span>
    <span class="nv">val = </span><span class="nx">@toUInt16</span><span class="p">(</span><span class="nx">b1</span><span class="p">,</span> <span class="nx">b2</span><span class="p">)</span>
    <span class="k">if</span> <span class="nx">val</span> <span class="o">&gt;=</span> <span class="mh">0x8000</span> <span class="k">then</span> <span class="nx">val</span> <span class="o">-</span> <span class="mh">0x10000</span> <span class="k">else</span> <span class="nx">val</span></pre></div>             </td>           </tr>                               <tr id="section-2">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-2">&#182;</a>               </div>               <p>Round a number to a specific number of significant figures.</p>             </td>             <td class="code">               <div class="highlight"><pre>  <span class="vi">@round: </span><span class="nf">(num, sigFig = 2) -&gt;</span>
    <span class="k">return</span> <span class="nb">Math</span><span class="p">.</span><span class="nx">round</span><span class="p">(</span><span class="nx">num</span><span class="p">)</span> <span class="k">if</span> <span class="nx">sigFig</span> <span class="o">is</span> <span class="mi">0</span>
    <span class="nv">mult = </span><span class="nb">Math</span><span class="p">.</span><span class="nx">pow</span><span class="p">(</span><span class="mi">10</span><span class="p">,</span> <span class="nx">sigFig</span><span class="p">)</span>
    <span class="nb">Math</span><span class="p">.</span><span class="nx">round</span><span class="p">(</span><span class="nx">num</span> <span class="o">*</span> <span class="nx">mult</span><span class="p">)</span> <span class="o">/</span> <span class="nx">mult</span></pre></div>             </td>           </tr>                               <tr id="section-3">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-3">&#182;</a>               </div>               <p>Clamp a number between a maximum and minimum value.</p>             </td>             <td class="code">               <div class="highlight"><pre>  <span class="vi">@clamp: </span><span class="nf">(num, min = Number.MIN_VALUE, max = Number.MAX_VALUE) -&gt;</span>
    <span class="k">if</span> <span class="k">typeof</span> <span class="nx">num</span> <span class="o">is</span> <span class="s2">&quot;object&quot;</span> <span class="o">and</span> <span class="nx">num</span><span class="p">.</span><span class="nx">length</span><span class="o">?</span>
      <span class="nx">num</span><span class="p">[</span><span class="nx">i</span><span class="p">]</span> <span class="o">=</span> <span class="nb">Math</span><span class="p">.</span><span class="nx">max</span><span class="p">(</span><span class="nb">Math</span><span class="p">.</span><span class="nx">min</span><span class="p">(</span><span class="nx">val</span><span class="p">,</span> <span class="nx">max</span><span class="p">),</span> <span class="nx">min</span><span class="p">)</span> <span class="k">for</span> <span class="nx">val</span><span class="p">,</span> <span class="nx">i</span> <span class="k">in</span> <span class="nx">num</span>
    <span class="k">else</span> <span class="k">if</span> <span class="k">typeof</span> <span class="nx">num</span> <span class="o">is</span> <span class="s2">&quot;object&quot;</span>
      <span class="nx">num</span><span class="p">[</span><span class="nx">i</span><span class="p">]</span> <span class="o">=</span> <span class="nb">Math</span><span class="p">.</span><span class="nx">max</span><span class="p">(</span> <span class="nb">Math</span><span class="p">.</span><span class="nx">min</span><span class="p">(</span><span class="nx">val</span><span class="p">,</span> <span class="nx">max</span><span class="p">),</span> <span class="nx">min</span> <span class="p">)</span> <span class="k">for</span> <span class="nx">own</span> <span class="nx">i</span><span class="p">,</span> <span class="nx">val</span> <span class="k">of</span> <span class="nx">num</span>
    <span class="k">else</span>
      <span class="nv">num = </span><span class="nb">Math</span><span class="p">.</span><span class="nx">max</span><span class="p">(</span><span class="nb">Math</span><span class="p">.</span><span class="nx">min</span><span class="p">(</span><span class="nx">num</span><span class="p">,</span> <span class="nx">max</span><span class="p">),</span> <span class="nx">min</span><span class="p">)</span>

    <span class="nx">num</span></pre></div>             </td>           </tr>                               <tr id="section-4">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-4">&#182;</a>               </div>               <p>Contributed by https://github.com/jrus</p>             </td>             <td class="code">               <div class="highlight"><pre>  <span class="vi">@decodeMacroman = </span><span class="nx">do</span> <span class="o">-&gt;</span>
    <span class="nv">high_chars_unicode = </span><span class="s1">&#39;&#39;&#39;</span>
<span class="s1">      \u00c4\u00c5\u00c7\u00c9\u00d1\u00d6\u00dc\u00e1</span>
<span class="s1">      \u00e0\u00e2\u00e4\u00e3\u00e5\u00e7\u00e9\u00e8</span>
<span class="s1">      \u00ea\u00eb\u00ed\u00ec\u00ee\u00ef\u00f1\u00f3</span>
<span class="s1">      \u00f2\u00f4\u00f6\u00f5\u00fa\u00f9\u00fb\u00fc</span>
<span class="s1">      \u2020\u00b0\u00a2\u00a3\u00a7\u2022\u00b6\u00df</span>
<span class="s1">      \u00ae\u00a9\u2122\u00b4\u00a8\u2260\u00c6\u00d8</span>
<span class="s1">      \u221e\u00b1\u2264\u2265\u00a5\u00b5\u2202\u2211</span>
<span class="s1">      \u220f\u03c0\u222b\u00aa\u00ba\u03a9\u00e6\u00f8</span>
<span class="s1">      \u00bf\u00a1\u00ac\u221a\u0192\u2248\u2206\u00ab</span>
<span class="s1">      \u00bb\u2026\u00a0\u00c0\u00c3\u00d5\u0152\u0153</span>
<span class="s1">      \u2013\u2014\u201c\u201d\u2018\u2019\u00f7\u25ca</span>
<span class="s1">      \u00ff\u0178\u2044\u20ac\u2039\u203a\ufb01\ufb02</span>
<span class="s1">      \u2021\u00b7\u201a\u201e\u2030\u00c2\u00ca\u00c1</span>
<span class="s1">      \u00cb\u00c8\u00cd\u00ce\u00cf\u00cc\u00d3\u00d4</span>
<span class="s1">      \uf8ff\u00d2\u00da\u00db\u00d9\u0131\u02c6\u02dc</span>
<span class="s1">      \u00af\u02d8\u02d9\u02da\u00b8\u02dd\u02db\u02c7</span>
<span class="s1">      &#39;&#39;&#39;</span><span class="p">.</span><span class="nx">replace</span> <span class="sr">/\n/g</span><span class="p">,</span> <span class="s1">&#39;&#39;</span>

    <span class="nf">(byte_array) -&gt;</span>
      <span class="nv">char_array = </span><span class="k">for</span> <span class="nx">byte</span><span class="p">,</span> <span class="nx">idx</span> <span class="k">in</span> <span class="nx">byte_array</span>
        <span class="k">if</span> <span class="nx">byte</span> <span class="o">&lt;</span> <span class="mh">0x80</span> <span class="k">then</span> <span class="nb">String</span><span class="p">.</span><span class="nx">fromCharCode</span> <span class="nx">byte</span>
        <span class="k">else</span> <span class="nx">high_chars_unicode</span><span class="p">.</span><span class="nx">charAt</span> <span class="nx">byte</span> <span class="o">-</span> <span class="mh">0x80</span>
      <span class="nx">char_array</span><span class="p">.</span><span class="nx">join</span> <span class="s1">&#39;&#39;</span>

</pre></div>             </td>           </tr>                </tbody>     </table>   </div> </body> </html>