docs/global.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Global</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">Global</h1>
<section>
<header>
<h2></h2>
</header>
<article>
<div class="container-overview">
<dl class="details">
</dl>
</div>
<h3 class="subsection-title">Type Definitions</h3>
<h4 class="name" id="BoundingBox">BoundingBox</h4>
<div class="description">
A box in 2D/3D space.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">object</span>
</li>
</ul>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>min</code></td>
<td class="type">
<span class="param-type"><a href="global.html#Vertex">Vertex</a></span>
</td>
<td class="description last">A 2D/3D vertex which defines the 'minimum' co-ordinates. This is the corner of the box with the lowest x, y and optional z co-ordinate.</td>
</tr>
<tr>
<td class="name"><code>max</code></td>
<td class="type">
<span class="param-type"><a href="global.html#Vertex">Vertex</a></span>
</td>
<td class="description last">A 2D/3D vertex which defines the 'maximum' co-ordinates. This is the corner of the box with the highest x, y and optional z co-ordinate.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="api_AbstractModule.js.html">api/AbstractModule.js</a>, <a href="api_AbstractModule.js.html#line12">line 12</a>
</li></ul></dd>
</dl>
<h4 class="name" id="OpenSCADBoolean">OpenSCADBoolean</h4>
<div class="description">
Represents an OpenSCAD boolean. Equal to 'boolean'.
</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="types_Types.js.html">types/Types.js</a>, <a href="types_Types.js.html#line1">line 1</a>
</li></ul></dd>
</dl>
<h4 class="name" id="OpenSCADInfinity">OpenSCADInfinity</h4>
<div class="description">
Represents Infinity in OpenSCAD. Equal to 'inf'.
</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="types_Types.js.html">types/Types.js</a>, <a href="types_Types.js.html#line2">line 2</a>
</li></ul></dd>
</dl>
<h4 class="name" id="OpenSCADNaN">OpenSCADNaN</h4>
<div class="description">
Represents NaN (Not a Number) in OpenSCAD. Equal to 'nan'.
</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="types_Types.js.html">types/Types.js</a>, <a href="types_Types.js.html#line3">line 3</a>
</li></ul></dd>
</dl>
<h4 class="name" id="OpenSCADNumber">OpenSCADNumber</h4>
<div class="description">
Represents an OpenSCAD number. Equal to 'number'.
</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="types_Types.js.html">types/Types.js</a>, <a href="types_Types.js.html#line4">line 4</a>
</li></ul></dd>
</dl>
<h4 class="name" id="OpenSCADRange">OpenSCADRange</h4>
<div class="description">
Represents an OpenSCAD range. Equal to 'range'.
</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="types_Types.js.html">types/Types.js</a>, <a href="types_Types.js.html#line5">line 5</a>
</li></ul></dd>
</dl>
<h4 class="name" id="OpenSCADString">OpenSCADString</h4>
<div class="description">
Represents an OpenSCAD string. Equal to 'string'.
</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="types_Types.js.html">types/Types.js</a>, <a href="types_Types.js.html#line6">line 6</a>
</li></ul></dd>
</dl>
<h4 class="name" id="OpenSCADUndefined">OpenSCADUndefined</h4>
<div class="description">
Represents undef (undefined) in OpenSCAD. Equal to 'undefined'.
</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="types_Types.js.html">types/Types.js</a>, <a href="types_Types.js.html#line7">line 7</a>
</li></ul></dd>
</dl>
<h4 class="name" id="OpenSCADVector">OpenSCADVector</h4>
<div class="description">
Represents an OpenSCAD vector. Equal to 'vector'.
</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="types_Types.js.html">types/Types.js</a>, <a href="types_Types.js.html#line8">line 8</a>
</li></ul></dd>
</dl>
<h4 class="name" id="Options">Options</h4>
<div class="description">
Key/value pair of options to configure the execution of an OpenSCAD test.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">object</span>
</li>
</ul>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>openSCADDirectory</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">The prefix to prepend to all uses/includes.</td>
</tr>
<tr>
<td class="name"><code>use</code></td>
<td class="type">
<span class="param-type">Array.<String></span>
</td>
<td class="description last">List of .scad files to import as 'use'.</td>
</tr>
<tr>
<td class="name"><code>include</code></td>
<td class="type">
<span class="param-type">Array.<String></span>
</td>
<td class="description last">List of .scad files to import as 'include'.</td>
</tr>
<tr>
<td class="name"><code>setUpText</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">Any required OpenSCAD code to set up the test.</td>
</tr>
<tr>
<td class="name"><code>testText</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">The OpenSCAD code to be tested and asserted on.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="api_AbstractParent.js.html">api/AbstractParent.js</a>, <a href="api_AbstractParent.js.html#line17">line 17</a>
</li></ul></dd>
</dl>
<h4 class="name" id="Triangle">Triangle</h4>
<div class="description">
An array of three 3D vertices which describe a triangle. See <a href="https://en.wikipedia.org/wiki/Triangle_mesh">https://en.wikipedia.org/wiki/Triangle_mesh</a>.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.<<a href="global.html#Vertex">Vertex</a>></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="api_ThreeDModule.js.html">api/ThreeDModule.js</a>, <a href="api_ThreeDModule.js.html#line97">line 97</a>
</li></ul></dd>
</dl>
<h4 class="name" id="Types">Types</h4>
<div class="description">
A collection of the available OpenSCAD types.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">object</span>
</li>
</ul>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>BOOLEAN</code></td>
<td class="type">
<span class="param-type"><a href="global.html#OpenSCADBoolean">OpenSCADBoolean</a></span>
</td>
<td class="description last">See <a href="global.html#OpenSCADBoolean">OpenSCADBoolean</a>.</td>
</tr>
<tr>
<td class="name"><code>INF</code></td>
<td class="type">
<span class="param-type"><a href="global.html#OpenSCADInfinity">OpenSCADInfinity</a></span>
</td>
<td class="description last">See <a href="global.html#OpenSCADInfinity">OpenSCADInfinity</a>.</td>
</tr>
<tr>
<td class="name"><code>NAN</code></td>
<td class="type">
<span class="param-type"><a href="global.html#OpenSCADNaN">OpenSCADNaN</a></span>
</td>
<td class="description last">See <a href="global.html#OpenSCADNaN">OpenSCADNaN</a>.</td>
</tr>
<tr>
<td class="name"><code>NUMBER</code></td>
<td class="type">
<span class="param-type"><a href="global.html#OpenSCADNumber">OpenSCADNumber</a></span>
</td>
<td class="description last">See <a href="global.html#OpenSCADNumber">OpenSCADNumber</a>.</td>
</tr>
<tr>
<td class="name"><code>RANGE</code></td>
<td class="type">
<span class="param-type"><a href="global.html#OpenSCADRange">OpenSCADRange</a></span>
</td>
<td class="description last">See <a href="global.html#OpenSCADRange">OpenSCADRange</a>.</td>
</tr>
<tr>
<td class="name"><code>STRING</code></td>
<td class="type">
<span class="param-type"><a href="global.html#OpenSCADString">OpenSCADString</a></span>
</td>
<td class="description last">See <a href="global.html#OpenSCADString">OpenSCADString</a>.</td>
</tr>
<tr>
<td class="name"><code>UNDEF</code></td>
<td class="type">
<span class="param-type"><a href="global.html#OpenSCADUndefined">OpenSCADUndefined</a></span>
</td>
<td class="description last">See <a href="global.html#OpenSCADUndefined">OpenSCADUndefined</a>.</td>
</tr>
<tr>
<td class="name"><code>VECTOR</code></td>
<td class="type">
<span class="param-type"><a href="global.html#OpenSCADVector">OpenSCADVector</a></span>
</td>
<td class="description last">See <a href="global.html#OpenSCADVector">OpenSCADVector</a>.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="types_Types.js.html">types/Types.js</a>, <a href="types_Types.js.html#line10">line 10</a>
</li></ul></dd>
</dl>
<h4 class="name" id="UnitTestSCAD">UnitTestSCAD</h4>
<div class="description">
This is the top level object exposed when requiring UnitTestSCAD into a NodeJS script.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">object</span>
</li>
</ul>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>Function</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">Exposes the <a href="Function.html">Function</a> class for use. This should be used when testing an OpenSCAD function.</td>
</tr>
<tr>
<td class="name"><code>ThreeDModule</code></td>
<td class="type">
<span class="param-type"><a href="ThreeDModule.html">ThreeDModule</a></span>
</td>
<td class="description last">Exposes the <a href="ThreeDModule.html">ThreeDModule</a> class for use. This should be used when testing an OpenSCAD module which produces a 3D model.</td>
</tr>
<tr>
<td class="name"><code>TwoDModule</code></td>
<td class="type">
<span class="param-type"><a href="TwoDModule.html">TwoDModule</a></span>
</td>
<td class="description last">Exposes the <a href="TwoDModule.html">TwoDModule</a> class for use. This should be used when testing an OpenSCAD module which produces a 2D model.</td>
</tr>
<tr>
<td class="name"><code>Types</code></td>
<td class="type">
<span class="param-type"><a href="global.html#Types">Types</a></span>
</td>
<td class="description last">Exposes the <a href="global.html#Types">Types</a> object for use. This should be used when performing assertions on a <a href="Function.html">Function</a>.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line6">line 6</a>
</li></ul></dd>
</dl>
<h4 class="name" id="Vertex">Vertex</h4>
<div class="description">
A 2/3 length co-ordinate representing a point in 2D/3D space.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.<number></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="api_AbstractParent.js.html">api/AbstractParent.js</a>, <a href="api_AbstractParent.js.html#line26">line 26</a>
</li></ul></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>