docs/Function.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: Function</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: Function</h1>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>Function<span class="signature">(options)</span><span class="type-signature"></span></h2>
</header>
<article>
<div class="container-overview">
<h4 class="name" id="Function"><span class="type-signature"></span>new Function<span class="signature">(options)</span><span class="type-signature"></span></h4>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type"><a href="global.html#Options">Options</a></span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="api_OpenSCADFunction.js.html">api/OpenSCADFunction.js</a>, <a href="api_OpenSCADFunction.js.html#line7">line 7</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="output"><span class="type-signature"></span>output<span class="type-signature"> :string</span></h4>
<div class="description">
The extracted output from execution of the .scad file.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="api_OpenSCADFunction.js.html">api/OpenSCADFunction.js</a>, <a href="api_OpenSCADFunction.js.html#line13">line 13</a>
</li></ul></dd>
</dl>
<h4 class="name" id="type"><span class="type-signature"></span>type<span class="type-signature"> :Type</span></h4>
<div class="description">
The detected type of the value retrieved from the OpenSCAD function.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Type</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="api_OpenSCADFunction.js.html">api/OpenSCADFunction.js</a>, <a href="api_OpenSCADFunction.js.html#line18">line 18</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="isBoolean"><span class="type-signature"></span>isBoolean<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4>
<div class="description">
Returns true if this type is of type <a href="global.html#OpenSCADBoolean">OpenSCADBoolean</a>.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="api_OpenSCADFunction.js.html">api/OpenSCADFunction.js</a>, <a href="api_OpenSCADFunction.js.html#line30">line 30</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
True if this type is of type <a href="global.html#OpenSCADBoolean">OpenSCADBoolean</a>.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
<h4 class="name" id="isInf"><span class="type-signature"></span>isInf<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4>
<div class="description">
Returns true if this type is of type <a href="global.html#OpenSCADInfinity">OpenSCADInfinity</a>.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="api_OpenSCADFunction.js.html">api/OpenSCADFunction.js</a>, <a href="api_OpenSCADFunction.js.html#line38">line 38</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
True if this type is of type <a href="global.html#OpenSCADInfinity">OpenSCADInfinity</a>.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
<h4 class="name" id="isNan"><span class="type-signature"></span>isNan<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4>
<div class="description">
Returns true if this type is of type <a href="global.html#OpenSCADNaN">OpenSCADNaN</a>.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="api_OpenSCADFunction.js.html">api/OpenSCADFunction.js</a>, <a href="api_OpenSCADFunction.js.html#line46">line 46</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
True if this type is of type <a href="global.html#OpenSCADNaN">OpenSCADNaN</a>.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
<h4 class="name" id="isNumber"><span class="type-signature"></span>isNumber<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4>
<div class="description">
Returns true if this type is of type <a href="global.html#OpenSCADNumber">OpenSCADNumber</a>.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="api_OpenSCADFunction.js.html">api/OpenSCADFunction.js</a>, <a href="api_OpenSCADFunction.js.html#line54">line 54</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
True if this type is of type <a href="global.html#OpenSCADNumber">OpenSCADNumber</a>.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
<h4 class="name" id="isRange"><span class="type-signature"></span>isRange<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4>
<div class="description">
Returns true if this type is of type <a href="global.html#OpenSCADRange">OpenSCADRange</a>.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="api_OpenSCADFunction.js.html">api/OpenSCADFunction.js</a>, <a href="api_OpenSCADFunction.js.html#line62">line 62</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
True if this type is of type <a href="global.html#OpenSCADBoolean">OpenSCADBoolean</a>.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
<h4 class="name" id="isString"><span class="type-signature"></span>isString<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4>
<div class="description">
Returns true if this type is of type <a href="global.html#OpenSCADString">OpenSCADString</a>.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="api_OpenSCADFunction.js.html">api/OpenSCADFunction.js</a>, <a href="api_OpenSCADFunction.js.html#line70">line 70</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
True if this type is of type <a href="global.html#OpenSCADString">OpenSCADString</a>.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
<h4 class="name" id="isUndef"><span class="type-signature"></span>isUndef<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4>
<div class="description">
Returns true if this type is of type <a href="global.html#OpenSCADUndefined">OpenSCADUndefined</a>.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="api_OpenSCADFunction.js.html">api/OpenSCADFunction.js</a>, <a href="api_OpenSCADFunction.js.html#line78">line 78</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
True if this type is of type <a href="global.html#OpenSCADUndefined">OpenSCADUndefined</a>.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
<h4 class="name" id="isVector"><span class="type-signature"></span>isVector<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4>
<div class="description">
Returns true if this type is of type <a href="global.html#OpenSCADVector">OpenSCADVector</a>.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="api_OpenSCADFunction.js.html">api/OpenSCADFunction.js</a>, <a href="api_OpenSCADFunction.js.html#line86">line 86</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
True if this type is of type <a href="global.html#OpenSCADVector">OpenSCADVector</a>.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Function.html">Function</a></li><li><a href="ThreeDModule.html">ThreeDModule</a></li><li><a href="TwoDModule.html">TwoDModule</a></li></ul><h3><a href="global.html">Global</a></h3>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>