docs/TwoDModule.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: TwoDModule</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: TwoDModule</h1>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>TwoDModule<span class="signature">(options)</span><span class="type-signature"></span></h2>
</header>
<article>
<div class="container-overview">
<h4 class="name" id="TwoDModule"><span class="type-signature"></span>new TwoDModule<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_TwoDModule.js.html">api/TwoDModule.js</a>, <a href="api_TwoDModule.js.html#line18">line 18</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="height"><span class="type-signature"></span>height<span class="type-signature"> :number</span></h4>
<div class="description">
The height of the model.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="api_TwoDModule.js.html">api/TwoDModule.js</a>, <a href="api_TwoDModule.js.html#line51">line 51</a>
</li></ul></dd>
</dl>
<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_TwoDModule.js.html">api/TwoDModule.js</a>, <a href="api_TwoDModule.js.html#line25">line 25</a>
</li></ul></dd>
</dl>
<h4 class="name" id="vertices"><span class="type-signature"></span>vertices<span class="type-signature"> :Array.<<a href="global.html#Vertex">Vertex</a>></span></h4>
<div class="description">
A list of 2D vertices returned from the .scad file execution.
</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_TwoDModule.js.html">api/TwoDModule.js</a>, <a href="api_TwoDModule.js.html#line44">line 44</a>
</li></ul></dd>
</dl>
<h4 class="name" id="width"><span class="type-signature"></span>width<span class="type-signature"> :number</span></h4>
<div class="description">
The width of the model.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="api_TwoDModule.js.html">api/TwoDModule.js</a>, <a href="api_TwoDModule.js.html#line57">line 57</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="isWithinBoundingBox"><span class="type-signature"></span>isWithinBoundingBox<span class="signature">(boundingBox)</span><span class="type-signature"> → {boolean}</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>boundingBox</code></td>
<td class="type">
<span class="param-type"><a href="global.html#BoundingBox">BoundingBox</a></span>
</td>
<td class="description last">The 2D box which the model should fit inside. It is considered 'within' if any coordinate is equal to, or within the box.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="api_TwoDModule.js.html">api/TwoDModule.js</a>, <a href="api_TwoDModule.js.html#line31">line 31</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
True if the model fits within the bounding box.
</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>