Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@williamngan
williamngan committed Nov 13, 2017
1 parent cdb27b6 commit 9d29b9f
Show file tree
Hide file tree
Showing 43 changed files with 1,588 additions and 1,162 deletions.
3 changes: 1 addition & 2 deletions docs/assets/js/search.js
View file

Large diffs are not rendered by default.

152 changes: 76 additions & 76 deletions docs/classes/_bound_.bound.html
View file

Large diffs are not rendered by default.

106 changes: 53 additions & 53 deletions docs/classes/_canvas_.canvasform.html
View file

Large diffs are not rendered by default.

206 changes: 131 additions & 75 deletions docs/classes/_canvas_.canvasspace.html
View file

Large diffs are not rendered by default.

248 changes: 124 additions & 124 deletions docs/classes/_color_.color.html
View file

Large diffs are not rendered by default.

117 changes: 113 additions & 4 deletions docs/classes/_create_.create.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -91,9 +91,11 @@ <h2>Index</h2>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_create_.create.html#distributelinear" class="tsd-kind-icon">distribute<wbr>Linear</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_create_.create.html#distributerandom" class="tsd-kind-icon">distribute<wbr>Random</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_create_.create.html#gridcells" class="tsd-kind-icon">grid<wbr>Cells</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_create_.create.html#gridpts" class="tsd-kind-icon">grid<wbr>Pts</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_create_.create.html#noisepts" class="tsd-kind-icon">noise<wbr>Pts</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_create_.create.html#radialpts" class="tsd-kind-icon">radial<wbr>Pts</a></li>
</ul>
</section>
Expand All @@ -102,6 +104,43 @@ <h3>Methods</h3>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a name="distributelinear" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> distribute<wbr>Linear</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">distribute<wbr>Linear<span class="tsd-signature-symbol">(</span>line<span class="tsd-signature-symbol">: </span><a href="../modules/_pt_.html#grouplike" class="tsd-signature-type">GroupLike</a>, count<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_pt_.group.html" class="tsd-signature-type">Group</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/williamngan/pts/blob/cdb27b6/src/Create.ts#L42">Create.ts:42</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Create a set of points that distribute evenly on a line</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>line: <a href="../modules/_pt_.html#grouplike" class="tsd-signature-type">GroupLike</a></h5>
<div class="tsd-comment tsd-typography">
<p>a Group representing a line</p>
</div>
</li>
<li>
<h5>count: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>number of points to create</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_pt_.group.html" class="tsd-signature-type">Group</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a name="distributerandom" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> distribute<wbr>Random</h3>
Expand All @@ -112,7 +151,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> distribute<wbr>Random</h3
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/williamngan/pts/blob/84b2446/src/Create.ts#L22">Create.ts:22</a></li>
<li>Defined in <a href="https://github.com/williamngan/pts/blob/cdb27b6/src/Create.ts#L25">Create.ts:25</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -155,7 +194,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> grid<wbr>Cells</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/williamngan/pts/blob/84b2446/src/Create.ts#L63">Create.ts:63</a></li>
<li>Defined in <a href="https://github.com/williamngan/pts/blob/cdb27b6/src/Create.ts#L79">Create.ts:79</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -199,7 +238,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> grid<wbr>Pts</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/williamngan/pts/blob/84b2446/src/Create.ts#L42">Create.ts:42</a></li>
<li>Defined in <a href="https://github.com/williamngan/pts/blob/cdb27b6/src/Create.ts#L58">Create.ts:58</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -239,6 +278,61 @@ <h4 class="tsd-returns-title">Returns <a href="_pt_.group.html" class="tsd-signa
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a name="noisepts" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> noise<wbr>Pts</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">noise<wbr>Pts<span class="tsd-signature-symbol">(</span>pts<span class="tsd-signature-symbol">: </span><a href="../modules/_pt_.html#grouplike" class="tsd-signature-type">GroupLike</a>, dx<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, dy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, rows<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, columns<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_pt_.group.html" class="tsd-signature-type">Group</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/williamngan/pts/blob/cdb27b6/src/Create.ts#L119">Create.ts:119</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Given a group of Pts, return a new group of <code>Noise</code> Pts.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>pts: <a href="../modules/_pt_.html#grouplike" class="tsd-signature-type">GroupLike</a></h5>
<div class="tsd-comment tsd-typography">
<p>a Group or an array of Pts</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> dx: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> =&nbsp;0.01</span></h5>
<div class="tsd-comment tsd-typography">
<p>small increment value in x dimension</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> dy: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> =&nbsp;0.01</span></h5>
<div class="tsd-comment tsd-typography">
<p>small increment value in y dimension</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> rows: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> =&nbsp;0</span></h5>
<div class="tsd-comment tsd-typography">
<p>Optional row count to generate 2D noise</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> columns: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> =&nbsp;0</span></h5>
<div class="tsd-comment tsd-typography">
<p>Optional column count to generate 2D noise</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_pt_.group.html" class="tsd-signature-type">Group</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a name="radialpts" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> radial<wbr>Pts</h3>
Expand All @@ -249,7 +343,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> radial<wbr>Pts</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/williamngan/pts/blob/84b2446/src/Create.ts#L85">Create.ts:85</a></li>
<li>Defined in <a href="https://github.com/williamngan/pts/blob/cdb27b6/src/Create.ts#L101">Create.ts:101</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -341,6 +435,9 @@ <h4 class="tsd-returns-title">Returns <a href="_pt_.group.html" class="tsd-signa
<li class="current tsd-kind-class tsd-parent-kind-external-module">
<a href="_create_.create.html" class="tsd-kind-icon">Create</a>
<ul>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="_create_.create.html#distributelinear" class="tsd-kind-icon">distribute<wbr>Linear</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="_create_.create.html#distributerandom" class="tsd-kind-icon">distribute<wbr>Random</a>
</li>
Expand All @@ -350,13 +447,25 @@ <h4 class="tsd-returns-title">Returns <a href="_pt_.group.html" class="tsd-signa
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="_create_.create.html#gridpts" class="tsd-kind-icon">grid<wbr>Pts</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="_create_.create.html#noisepts" class="tsd-kind-icon">noise<wbr>Pts</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="_create_.create.html#radialpts" class="tsd-kind-icon">radial<wbr>Pts</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-class tsd-parent-kind-external-module">
<a href="_create_.noise.html" class="tsd-kind-icon">Noise</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../modules/_create_.html#grad3" class="tsd-kind-icon">grad3</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../modules/_create_.html#permtable" class="tsd-kind-icon">perm<wbr>Table</a>
</li>
</ul>
</nav>
</div>
Expand Down
Loading

0 comments on commit 9d29b9f

Please sign in to comment.