wassname/phaser-plugin-isometric
1
0
Fork 0
mirror of https://github.com/wassname/phaser-plugin-isometric.git synced 2026-08-27 12:20:52 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
6bc0073df7ee69ef5a64bb3dfbdc6da5dfb22f60
phaser-plugin-isometric/doc/Phaser.Plugin.Isometric.Cube.html
T

5389 lines
66 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Phaser Isometric Class: Cube</title>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
<link type="text/css" rel="stylesheet" href="styles/site.cerulean.css">
</head>
<body>
<div class="container-fluid">
<div class="navbar navbar-fixed-top navbar-inverse">
<div class="navbar-inner">
<a class="brand" href="index.html">Phaser Isometric</a>
<ul class="nav">
<li class="dropdown">
<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li>
<a href="Phaser.Plugin.Isometric.html">Phaser.Plugin.Isometric</a>
</li>
<li>
<a href="Phaser.Plugin.Isometric.Arcade.html">Phaser.Plugin.Isometric.Arcade</a>
</li>
<li>
<a href="Phaser.Plugin.Isometric.Body.html">Phaser.Plugin.Isometric.Body</a>
</li>
<li>
<a href="Phaser.Plugin.Isometric.Cube.html">Phaser.Plugin.Isometric.Cube</a>
</li>
<li>
<a href="Phaser.Plugin.Isometric.IsoSprite.html">Phaser.Plugin.Isometric.IsoSprite</a>
</li>
<li>
<a href="Phaser.Plugin.Isometric.Octree.html">Phaser.Plugin.Isometric.Octree</a>
</li>
<li>
<a href="Phaser.Plugin.Isometric.Point3.html">Phaser.Plugin.Isometric.Point3</a>
</li>
<li>
<a href="Phaser.Plugin.Isometric.Projector.html">Phaser.Plugin.Isometric.Projector</a>
</li>
</ul>
</li>
</ul>
</div>
</div>
<div class="row-fluid">
<div class="span8">
<div id="main">
<h1 class="page-title">Class: Cube</h1>
<section>
<header>
<h2>
<span class="ancestors"><a href="Phaser.Plugin.Isometric.html">.Isometric</a>.</span>
Cube
</h2>
<div class="class-description"><p>Phaser.Plugin.Isometric.Cube</p></div>
</header>
<article>
<div class="container-overview">
<dt>
<h4 class="name" id="Cube"><span class="type-signature"></span>new Cube<span class="signature">(x, y, z, widthX, widthY, height)</span><span class="type-signature"> &rarr; {<a href="Phaser.Plugin.Isometric.Cube.html">Phaser.Plugin.Isometric.Cube</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Creates a new Cube object with the bottom-back corner specified by the x, y and z parameters, with the specified breadth (widthX), depth (widthY) and height parameters. If you call this function without parameters, a Cube with x, y, z, breadth, depth and height properties set to 0 is created.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>x</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The x coordinate of the bottom-back corner of the Cube.</p></td>
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The y coordinate of the bottom-back corner of the Cube.</p></td>
</tr>
<tr>
<td class="name"><code>z</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The z coordinate of the bottom-back corner of the Cube.</p></td>
</tr>
<tr>
<td class="name"><code>widthX</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The X axis width (breadth) of the Cube. Should always be either zero or a positive value.</p></td>
</tr>
<tr>
<td class="name"><code>widthY</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The Y axis width (depth) of the Cube. Should always be either zero or a positive value.</p></td>
</tr>
<tr>
<td class="name"><code>height</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The Z axis height of the Cube. Should always be either zero or a positive value.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Cube.js.html">Cube.js</a>,
<a href="Cube.js.html#sunlight-1-line-14">line 14</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>This Cube object.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Phaser.Plugin.Isometric.Cube.html">Phaser.Plugin.Isometric.Cube</a></span>
</dd>
</dl>
</dd>
</div>
<h3 class="subsection-title">Members</h3>
<dl>
<dt class="name" id="backX">
<h4><span class="type-signature"></span>backX<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>The x coordinate of the back of the Cube. Changing the backX property of a Cube object has no effect on the y, z, widthY and height properties. However it does affect the widthX property, whereas changing the x value does not affect the width property.</p>
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>backX</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The x coordinate of the left of the Cube.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Cube.js.html">Cube.js</a>,
<a href="Cube.js.html#sunlight-1-line-279">line 279</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="backY">
<h4><span class="type-signature"></span>backY<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>The y coordinate of the back of the Cube. Changing the backY property of a Cube object has no effect on the x, z, widthX and height properties. However it does affect the widthY property, whereas changing the y value does not affect the width property.</p>
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>backY</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The x coordinate of the left of the Cube.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Cube.js.html">Cube.js</a>,
<a href="Cube.js.html#sunlight-1-line-301">line 301</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="bottom">
<h4><span class="type-signature"></span>bottom<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>The z coordinate of the bottom of the Cube. Changing the bottom property of a Cube object has no effect on the x, y, widthX and widthY properties.
However it does affect the height property, whereas changing the z value does not affect the height property.</p>
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>bottom</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The z coordinate of the bottom of the Cube.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Cube.js.html">Cube.js</a>,
<a href="Cube.js.html#sunlight-1-line-235">line 235</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="centerX">
<h4><span class="type-signature"></span>centerX<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>The x coordinate of the center of the Cube.</p>
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>centerX</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The x coordinate of the center of the Cube.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Cube.js.html">Cube.js</a>,
<a href="Cube.js.html#sunlight-1-line-379">line 379</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="centerY">
<h4><span class="type-signature"></span>centerY<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>The y coordinate of the center of the Cube.</p>
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>centerY</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The y coordinate of the center of the Cube.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Cube.js.html">Cube.js</a>,
<a href="Cube.js.html#sunlight-1-line-394">line 394</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="centerZ">
<h4><span class="type-signature"></span>centerZ<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>The z coordinate of the center of the Cube.</p>
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>centerZ</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The z coordinate of the center of the Cube.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Cube.js.html">Cube.js</a>,
<a href="Cube.js.html#sunlight-1-line-409">line 409</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="empty">
<h4><span class="type-signature"></span>empty<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Determines whether or not this Cube object is empty. A Cube object is empty if its widthX, widthY or height is less than or equal to 0.
If set to true then all of the Cube properties are set to 0.</p>
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>empty</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"><p>Gets or sets the Cube's empty state.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Cube.js.html">Cube.js</a>,
<a href="Cube.js.html#sunlight-1-line-472">line 472</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="frontX">
<h4><span class="type-signature"></span>frontX<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>The sum of the x and widthX properties. Changing the frontX property of a Cube object has no effect on the x, y, z, widthY and height properties, however it does affect the widthX property.</p>
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>frontX</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The sum of the x and widthX properties.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Cube.js.html">Cube.js</a>,
<a href="Cube.js.html#sunlight-1-line-323">line 323</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="frontY">
<h4><span class="type-signature"></span>frontY<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>The sum of the y and widthY properties. Changing the frontY property of a Cube object has no effect on the x, y, z, widthX and height properties, however it does affect the widthY property.</p>
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>frontY</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The sum of the y and widthY properties.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Cube.js.html">Cube.js</a>,
<a href="Cube.js.html#sunlight-1-line-344">line 344</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="halfHeight">
<h4><span class="type-signature">&lt;readonly> </span>halfHeight<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>halfHeight</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>Half of the height of the Cube.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Cube.js.html">Cube.js</a>,
<a href="Cube.js.html#sunlight-1-line-222">line 222</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="halfWidthX">
<h4><span class="type-signature">&lt;readonly> </span>halfWidthX<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>halfWidthX</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>Half of the widthX of the Cube.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Cube.js.html">Cube.js</a>,
<a href="Cube.js.html#sunlight-1-line-196">line 196</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="halfWidthY">
<h4><span class="type-signature">&lt;readonly> </span>halfWidthY<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>halfWidthY</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>Half of the widthY of the Cube.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Cube.js.html">Cube.js</a>,
<a href="Cube.js.html#sunlight-1-line-209">line 209</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="height">
<h4><span class="type-signature"></span>height<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>height</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The Z axis height of the Cube. This value should never be set to a negative.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Cube.js.html">Cube.js</a>,
<a href="Cube.js.html#sunlight-1-line-51">line 51</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="randomX">
<h4><span class="type-signature"></span>randomX<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>A random value between the frontX and backX values (inclusive) of the Cube.</p>
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>randomX</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>A random value between the frontX and backX values (inclusive) of the Cube.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Cube.js.html">Cube.js</a>,
<a href="Cube.js.html#sunlight-1-line-424">line 424</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="randomY">
<h4><span class="type-signature"></span>randomY<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>A random value between the frontY and backY values (inclusive) of the Cube.</p>
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>randomY</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>A random value between the frontY and backY values (inclusive) of the Cube.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Cube.js.html">Cube.js</a>,
<a href="Cube.js.html#sunlight-1-line-440">line 440</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="randomZ">
<h4><span class="type-signature"></span>randomZ<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>A random value between the bottom and top values (inclusive) of the Cube.</p>
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>randomZ</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>A random value between the bottom and top values (inclusive) of the Cube.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Cube.js.html">Cube.js</a>,
<a href="Cube.js.html#sunlight-1-line-456">line 456</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="top">
<h4><span class="type-signature"></span>top<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>The sum of the z and height properties. Changing the top property of a Cube object has no effect on the x, y, z, widthX and widthY properties, but does change the height property.</p>
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>top</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The sum of the z and height properties.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Cube.js.html">Cube.js</a>,
<a href="Cube.js.html#sunlight-1-line-258">line 258</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="volume">
<h4><span class="type-signature">&lt;readonly> </span>volume<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>The volume of the Cube derived from widthX <em> widthY </em> height.</p>
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>volume</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The volume of the Cube derived from widthX <em> widthY </em> height.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Cube.js.html">Cube.js</a>,
<a href="Cube.js.html#sunlight-1-line-365">line 365</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="widthX">
<h4><span class="type-signature"></span>widthX<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>widthX</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The X axis width (breadth) of the Cube. This value should never be set to a negative.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Cube.js.html">Cube.js</a>,
<a href="Cube.js.html#sunlight-1-line-41">line 41</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="widthY">
<h4><span class="type-signature"></span>widthY<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>widthY</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The Y axis width (depth) of the Cube. This value should never be set to a negative.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Cube.js.html">Cube.js</a>,
<a href="Cube.js.html#sunlight-1-line-46">line 46</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="x">
<h4><span class="type-signature"></span>x<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>x</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The x coordinate of the bottom-back corner of the Cube.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Cube.js.html">Cube.js</a>,
<a href="Cube.js.html#sunlight-1-line-26">line 26</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="y">
<h4><span class="type-signature"></span>y<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The y coordinate of the bottom-back corner of the Cube.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Cube.js.html">Cube.js</a>,
<a href="Cube.js.html#sunlight-1-line-31">line 31</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="z">
<h4><span class="type-signature"></span>z<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>z</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The z coordinate of the bottom-back corner of the Cube.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Cube.js.html">Cube.js</a>,
<a href="Cube.js.html#sunlight-1-line-36">line 36</a>
</li>
</ul>
</dd>
</dl>
</dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<h4 class="name" id="clone"><span class="type-signature">&lt;static> </span>clone<span class="signature">(a, <span class="optional">output</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Plugin.Isometric.Cube.html">Phaser.Plugin.Isometric.Cube</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Returns a new Cube object with the same values for the x, y, z, widthX, widthY, and height properties as the original Cube object.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>a</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Plugin.Isometric.Cube.html">Phaser.Plugin.Isometric.Cube</a></span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The Cube object.</p></td>
</tr>
<tr>
<td class="name"><code>output</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Plugin.Isometric.Cube.html">Phaser.Plugin.Isometric.Cube</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>Optional Cube object. If given the values will be set into the object, otherwise a brand new Cube object will be created and returned.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Cube.js.html">Cube.js</a>,
<a href="Cube.js.html#sunlight-1-line-511">line 511</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Phaser.Plugin.Isometric.Cube.html">Phaser.Plugin.Isometric.Cube</a></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="contains"><span class="type-signature">&lt;static> </span>contains<span class="signature">(a, x, y, z)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
</dt>
<dd>
<div class="description">
<p>Determines whether the specified coordinates are contained within the region defined by this Cube object.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>a</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Plugin.Isometric.Cube.html">Phaser.Plugin.Isometric.Cube</a></span>
</td>
<td class="description last"><p>The Cube object.</p></td>
</tr>
<tr>
<td class="name"><code>x</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The x coordinate of the point to test.</p></td>
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The y coordinate of the point to test.</p></td>
</tr>
<tr>
<td class="name"><code>z</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The z coordinate of the point to test.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Cube.js.html">Cube.js</a>,
<a href="Cube.js.html#sunlight-1-line-528">line 528</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>A value of true if the Cube object contains the specified point; otherwise false.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="containsCube"><span class="type-signature">&lt;static> </span>containsCube<span class="signature">(a, b)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
</dt>
<dd>
<div class="description">
<p>Determines whether the first Cube object is fully contained within the second Cube object.
A Cube object is said to contain another if the second Cube object falls entirely within the boundaries of the first.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>a</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Plugin.Isometric.Cube.html">Phaser.Plugin.Isometric.Cube</a></span>
</td>
<td class="description last"><p>The first Cube object.</p></td>
</tr>
<tr>
<td class="name"><code>b</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Plugin.Isometric.Cube.html">Phaser.Plugin.Isometric.Cube</a></span>
</td>
<td class="description last"><p>The second Cube object.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Cube.js.html">Cube.js</a>,
<a href="Cube.js.html#sunlight-1-line-556">line 556</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>A value of true if the Cube object contains the specified point; otherwise false.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="containsPoint3"><span class="type-signature">&lt;static> </span>containsPoint3<span class="signature">(a, point3)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
</dt>
<dd>
<div class="description">
<p>Determines whether the specified point is contained within the cubic region defined by this Cube object. This method is similar to the Cube.contains() method, except that it takes a Point3 object as a parameter.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>a</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Plugin.Isometric.Cube.html">Phaser.Plugin.Isometric.Cube</a></span>
</td>
<td class="description last"><p>The Cube object.</p></td>
</tr>
<tr>
<td class="name"><code>point3</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Plugin.Isometric.Point3.html">Phaser.Plugin.Isometric.Point3</a></span>
</td>
<td class="description last"><p>The Point3 object being checked. Can be Point3 or any object with .x, .y and .z values.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Cube.js.html">Cube.js</a>,
<a href="Cube.js.html#sunlight-1-line-545">line 545</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>A value of true if the Cube object contains the specified point; otherwise false.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="intersects"><span class="type-signature">&lt;static> </span>intersects<span class="signature">(a, b)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
</dt>
<dd>
<div class="description">
<p>Determines whether the two Cubes intersect with each other.
This method checks the x, y, z, widthX, widthY, and height properties of the Cubes.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>a</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Plugin.Isometric.Cube.html">Phaser.Plugin.Isometric.Cube</a></span>
</td>
<td class="description last"><p>The first Cube object.</p></td>
</tr>
<tr>
<td class="name"><code>b</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Plugin.Isometric.Cube.html">Phaser.Plugin.Isometric.Cube</a></span>
</td>
<td class="description last"><p>The second Cube object.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Cube.js.html">Cube.js</a>,
<a href="Cube.js.html#sunlight-1-line-575">line 575</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>A value of true if the specified object intersects with this Cube object; otherwise false.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="size"><span class="type-signature">&lt;static> </span>size<span class="signature">(a, <span class="optional">output</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Plugin.Isometric.Point3.html">Phaser.Plugin.Isometric.Point3</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>The size of the Cube object, expressed as a Point3 object with the values of the widthX, widthY and height properties.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>a</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Plugin.Isometric.Cube.html">Phaser.Plugin.Isometric.Cube</a></span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The Cube object.</p></td>
</tr>
<tr>
<td class="name"><code>output</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Plugin.Isometric.Point3.html">Phaser.Plugin.Isometric.Point3</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>Optional Point3 object. If given the values will be set into the object, otherwise a brand new Point3 object will be created and returned.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Cube.js.html">Cube.js</a>,
<a href="Cube.js.html#sunlight-1-line-494">line 494</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The size of the Cube object</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Phaser.Plugin.Isometric.Point3.html">Phaser.Plugin.Isometric.Point3</a></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="clone"><span class="type-signature"></span>clone<span class="signature">(<span class="optional">output</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Plugin.Isometric.Cube.html">Phaser.Plugin.Isometric.Cube</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Returns a new Cube object with the same values for the x, y, z, widthX, widthY and height properties as the original Cube object.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>output</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Plugin.Isometric.Cube.html">Phaser.Plugin.Isometric.Cube</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>Optional Cube object. If given the values will be set into the object, otherwise a brand new Cube object will be created and returned.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Cube.js.html">Cube.js</a>,
<a href="Cube.js.html#sunlight-1-line-139">line 139</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Phaser.Plugin.Isometric.Cube.html">Phaser.Plugin.Isometric.Cube</a></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="copyFrom"><span class="type-signature"></span>copyFrom<span class="signature">(source)</span><span class="type-signature"> &rarr; {<a href="Phaser.Plugin.Isometric.Cube.html">Phaser.Plugin.Isometric.Cube</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Copies the x, y, z, widthX, widthY and height properties from any given object to this Cube.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>source</code></td>
<td class="type">
<span class="param-type">any</span>
</td>
<td class="description last"><p>The object to copy from.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Cube.js.html">Cube.js</a>,
<a href="Cube.js.html#sunlight-1-line-96">line 96</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>This Cube object.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Phaser.Plugin.Isometric.Cube.html">Phaser.Plugin.Isometric.Cube</a></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="copyTo"><span class="type-signature"></span>copyTo<span class="signature">(dest)</span><span class="type-signature"> &rarr; {<a href="Phaser.Plugin.Isometric.Cube.html">Phaser.Plugin.Isometric.Cube</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Copies the x, y, z, widthX, widthY and height properties from this Cube to any given object.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>dest</code></td>
<td class="type">
<span class="param-type">any</span>
</td>
<td class="description last"><p>The object to copy to.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Cube.js.html">Cube.js</a>,
<a href="Cube.js.html#sunlight-1-line-108">line 108</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>This Cube object.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Phaser.Plugin.Isometric.Cube.html">Phaser.Plugin.Isometric.Cube</a></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getCorners"><span class="type-signature"></span>getCorners<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;<a href="Phaser.Plugin.Isometric.Point3.html">Phaser.Plugin.Isometric.Point3</a>>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Updates and returns an Array of eight Point3 objects containing the corners of this Cube.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Cube.js.html">Cube.js</a>,
<a href="Cube.js.html#sunlight-1-line-164">line 164</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The corners of this Cube expressed as an Array of eight Point3 objects.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.&lt;<a href="Phaser.Plugin.Isometric.Point3.html">Phaser.Plugin.Isometric.Point3</a>></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="intersects"><span class="type-signature"></span>intersects<span class="signature">(b)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
</dt>
<dd>
<div class="description">
<p>Determines whether the two Cubes intersect with each other.
This method checks the x, y, z, widthX, widthY, and height properties of the Cubes.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>b</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Plugin.Isometric.Cube.html">Phaser.Plugin.Isometric.Cube</a></span>
</td>
<td class="description last"><p>The second Cube object.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Cube.js.html">Cube.js</a>,
<a href="Cube.js.html#sunlight-1-line-151">line 151</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>A value of true if the specified object intersects with this Cube object; otherwise false.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="setTo"><span class="type-signature"></span>setTo<span class="signature">(x, y, z, widthX, widthY, height)</span><span class="type-signature"> &rarr; {<a href="Phaser.Plugin.Isometric.Cube.html">Phaser.Plugin.Isometric.Cube</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Sets the members of Cube to the specified values.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>x</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The x coordinate of the bottom-back corner of the Cube.</p></td>
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The y coordinate of the bottom-back corner of the Cube.</p></td>
</tr>
<tr>
<td class="name"><code>z</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The z coordinate of the bottom-back corner of the Cube.</p></td>
</tr>
<tr>
<td class="name"><code>widthX</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The X axis width (breadth) of the Cube. This value should never be set to a negative.</p></td>
</tr>
<tr>
<td class="name"><code>widthY</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The Y axis width (depth) of the Cube. This value should never be set to a negative.</p></td>
</tr>
<tr>
<td class="name"><code>height</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The Z axis height of the Cube. This value should never be set to a negative.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Cube.js.html">Cube.js</a>,
<a href="Cube.js.html#sunlight-1-line-72">line 72</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>This Cube object</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Phaser.Plugin.Isometric.Cube.html">Phaser.Plugin.Isometric.Cube</a></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="size"><span class="type-signature"></span>size<span class="signature">(<span class="optional">output</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Plugin.Isometric.Point3.html">Phaser.Plugin.Isometric.Point3</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>The size of the Cube object, expressed as a Point3 object with the values of the widthX, widthY and height properties.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>output</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Plugin.Isometric.Point3.html">Phaser.Plugin.Isometric.Point3</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>Optional Point3 object. If given the values will be set into the object, otherwise a brand new Point3 object will be created and returned.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Cube.js.html">Cube.js</a>,
<a href="Cube.js.html#sunlight-1-line-127">line 127</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The size of the Cube object.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Phaser.Plugin.Isometric.Point3.html">Phaser.Plugin.Isometric.Point3</a></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="toString"><span class="type-signature"></span>toString<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
</dt>
<dd>
<div class="description">
<p>Returns a string representation of this object.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Cube.js.html">Cube.js</a>,
<a href="Cube.js.html#sunlight-1-line-184">line 184</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>A string representation of the instance.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
</dd>
</dl>
</article>
</section>
</div>
<div class="clearfix"></div>
<footer>
<span class="copyright">
Copyright © 2014 Lewis Lane - Rotates.org
</span>
<br />
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a>
on Wed Aug 6th 2014 using the <a
href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>
<div class="span3">
<div id="toc"></div>
</div>
<br clear="both">
</div>
</div>
<!--<script src="scripts/sunlight.js"></script>-->
<script src="scripts/docstrap.lib.js"></script>
<script src="scripts/bootstrap-dropdown.js"></script>
<script src="scripts/toc.js"></script>
<script>
$( function () {
$( "[id*='$']" ).each( function () {
var $this = $( this );
$this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
} );
$( "#toc" ).toc( {
anchorName : function ( i, heading, prefix ) {
return $( heading ).attr( "id" ) || ( prefix + i );
},
selectors : "h1,h2,h3,h4",
showAndHide : false,
scrollTo : "100px"
} );
$( "#toc>ul" ).addClass( "nav nav-pills nav-stacked" );
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
$( '.dropdown-toggle' ).dropdown();
// $( ".tutorial-section pre, .readme-section pre" ).addClass( "sunlight-highlight-javascript" ).addClass( "linenums" );
$( ".tutorial-section pre, .readme-section pre" ).each( function () {
var $this = $( this );
var example = $this.find( "code" );
exampleText = example.html();
var lang = /{@lang (.*?)}/.exec( exampleText );
if ( lang && lang[1] ) {
exampleText = exampleText.replace( lang[0], "" );
example.html( exampleText );
lang = lang[1];
} else {
lang = "javascript";
}
if ( lang ) {
$this
.addClass( "sunlight-highlight-" + lang )
.addClass( "linenums" )
.html( example.html() );
}
} );
Sunlight.highlightAll( {
lineNumbers : true,
showMenu : true,
enableDoclinks : true
} );
} );
</script>
<!--Navigation and Symbol Display-->
<!--Google Analytics-->
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink