wassname/phaser-plugin-isometric
1
0
Fork 0
mirror of https://github.com/wassname/phaser-plugin-isometric.git synced 2026-08-25 11:22:47 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
6bc0073df7ee69ef5a64bb3dfbdc6da5dfb22f60
phaser-plugin-isometric/doc/Phaser.Plugin.Isometric.Point3.html
T

6705 lines
86 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Phaser Isometric Class: Point3</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: Point3</h1>
<section>
<header>
<h2>
<span class="ancestors"><a href="Phaser.Plugin.Isometric.html">.Isometric</a>.</span>
Point3
</h2>
<div class="class-description"><p>The Point3 object represents a location in a three-dimensional coordinate system,
where x and y represent the horizontal axes and z represents the vertical axis.
The following code creates a point at (0,0,0):
<code>var myPoint = new Phaser.Plugin.Isometric.Point3();</code></p></div>
</header>
<article>
<div class="container-overview">
<dt>
<h4 class="name" id="Point3"><span class="type-signature"></span>new Point3<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Point3.js.html">Point3.js</a>,
<a href="Point3.js.html#sunlight-1-line-1">line 1</a>
</li>
</ul>
</dd>
</dl>
</dd>
</div>
<h3 class="subsection-title">Members</h3>
<dl>
<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 value of the point.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Point3.js.html">Point3.js</a>,
<a href="Point3.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 value of the point.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Point3.js.html">Point3.js</a>,
<a href="Point3.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 value of the point.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Point3.js.html">Point3.js</a>,
<a href="Point3.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="add"><span class="type-signature"></span>add<span class="signature">(x, y, z)</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>Adds the given x, y and z values to this Point3.</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 value to add to Point3.x.</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 value to add to Point3.y.</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 value to add to Point3.z.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Point3.js.html">Point3.js</a>,
<a href="Point3.js.html#sunlight-1-line-119">line 119</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>This Point3 object. Useful for chaining method calls.</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="copyFrom"><span class="type-signature"></span>copyFrom<span class="signature">(source)</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>Copies the x, y and z properties from any given object to this Point3.</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="Point3.js.html">Point3.js</a>,
<a href="Point3.js.html#sunlight-1-line-40">line 40</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>This Point3 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="copyTo"><span class="type-signature"></span>copyTo<span class="signature">(dest)</span><span class="type-signature"> &rarr; {Object}</span></h4>
</dt>
<dd>
<div class="description">
<p>Copies the x, y and z properties from this Point3 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="Point3.js.html">Point3.js</a>,
<a href="Point3.js.html#sunlight-1-line-53">line 53</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The dest object.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Object</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="divide"><span class="type-signature"></span>divide<span class="signature">(x, y, z)</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>Divides Point3.x, Point3.y and Point3.z by the given x, y and z 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 value to divide Point3.x by.</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 value to divide Point3.y by.</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 value to divide Point3.z by.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Point3.js.html">Point3.js</a>,
<a href="Point3.js.html#sunlight-1-line-174">line 174</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>This Point3 object. Useful for chaining method calls.</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="equals"><span class="type-signature"></span>equals<span class="signature">(a)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
</dt>
<dd>
<div class="description">
<p>Determines whether the given object's x/y/z values are equal to this Point3 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.Point3.html">Phaser.Plugin.Isometric.Point3</a></span>
|
<span class="param-type">any</span>
</td>
<td class="description last"><p>The object to compare with this Point3.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Point3.js.html">Point3.js</a>,
<a href="Point3.js.html#sunlight-1-line-70">line 70</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>A value of true if the x and y points are equal, otherwise false.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="multiply"><span class="type-signature"></span>multiply<span class="signature">(x, y, z)</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>Multiplies Point3.x, Point3.y and Point3.z by the given x and y values. Sometimes known as <code>Scale</code>.</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 value to multiply Point3.x by.</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 value to multiply Point3.y by.</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 value to multiply Point3.z by.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Point3.js.html">Point3.js</a>,
<a href="Point3.js.html#sunlight-1-line-155">line 155</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>This Point3 object. Useful for chaining method calls.</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="set"><span class="type-signature"></span>set<span class="signature">(x, <span class="optional">y</span>, <span class="optional">z</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>Sets the x, y and z values of this Point3 object to the given values.
If you omit the y and z value then the x value will be applied to all three, for example:
<code>Point3.set(2)</code> is the same as <code>Point3.set(2, 2, 2)</code>
If however you set both x and y, but no z, the z value will be set to 0.</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>x</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The x value of this point.</p></td>
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>The y value of this point. If not given the x value will be used in its place.</p></td>
</tr>
<tr>
<td class="name"><code>z</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>The z value of this point. If not given and the y value is also not given, the x value will be used in its place.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Point3.js.html">Point3.js</a>,
<a href="Point3.js.html#sunlight-1-line-83">line 83</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>This Point3 object. Useful for chaining method calls.</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="setTo"><span class="type-signature"></span>setTo<span class="signature">(x, <span class="optional">y</span>, <span class="optional">z</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>Sets the x, y and z values of this Point3 object to the given values.
If you omit the y and z value then the x value will be applied to all three, for example:
<code>Point3.setTo(2)</code> is the same as <code>Point3.setTo(2, 2, 2)</code>
If however you set both x and y, but no z, the z value will be set to 0.</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>x</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The x value of this point.</p></td>
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>The y value of this point. If not given the x value will be used in its place.</p></td>
</tr>
<tr>
<td class="name"><code>z</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>The z value of this point. If not given and the y value is also not given, the x value will be used in its place.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Point3.js.html">Point3.js</a>,
<a href="Point3.js.html#sunlight-1-line-103">line 103</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>This Point3 object. Useful for chaining method calls.</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="subtract"><span class="type-signature"></span>subtract<span class="signature">(x, y, z)</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>Subtracts the given x, y and z values from this Point3.</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 value to subtract from Point3.x.</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 value to subtract from Point3.y.</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 value to subtract from Point3.z.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Point3.js.html">Point3.js</a>,
<a href="Point3.js.html#sunlight-1-line-136">line 136</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>This Point3 object. Useful for chaining method calls.</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="add"><span class="type-signature">&lt;static> </span>add<span class="signature">(a, b, <span class="optional">out</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>Adds the coordinates of two points together to create a new point.</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.Point3.html">Phaser.Plugin.Isometric.Point3</a></span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The first Point3 object.</p></td>
</tr>
<tr>
<td class="name"><code>b</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">
</td>
<td class="description last"><p>The second Point3 object.</p></td>
</tr>
<tr>
<td class="name"><code>out</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 to store the value in, if not supplied a new Point3 object will be created.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Point3.js.html">Point3.js</a>,
<a href="Point3.js.html#sunlight-1-line-196">line 196</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The new Point3 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="divide"><span class="type-signature">&lt;static> </span>divide<span class="signature">(a, b, <span class="optional">out</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>Divides the coordinates of two points to create a new point.</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.Point3.html">Phaser.Plugin.Isometric.Point3</a></span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The first Point3 object.</p></td>
</tr>
<tr>
<td class="name"><code>b</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">
</td>
<td class="description last"><p>The second Point3 object.</p></td>
</tr>
<tr>
<td class="name"><code>out</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 to store the value in, if not supplied a new Point3 object3 will be created.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Point3.js.html">Point3.js</a>,
<a href="Point3.js.html#sunlight-1-line-265">line 265</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The new Point3 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="equals"><span class="type-signature">&lt;static> </span>equals<span class="signature">(a, b)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
</dt>
<dd>
<div class="description">
<p>Determines whether the two given Point3 objects are equal. They are considered equal if they have the same x, y and z 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>a</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 first Point3 object.</p></td>
</tr>
<tr>
<td class="name"><code>b</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 second Point3 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="Point3.js.html">Point3.js</a>,
<a href="Point3.js.html#sunlight-1-line-288">line 288</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>A value of true if the Points3 are equal, otherwise false.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="multiply"><span class="type-signature">&lt;static> </span>multiply<span class="signature">(a, b, <span class="optional">out</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>Multiplies the coordinates of two points to create a new point.</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.Point3.html">Phaser.Plugin.Isometric.Point3</a></span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The first Point3 object.</p></td>
</tr>
<tr>
<td class="name"><code>b</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">
</td>
<td class="description last"><p>The second Point3 object.</p></td>
</tr>
<tr>
<td class="name"><code>out</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 to store the value in, if not supplied a new Point3 object will be created.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Point3.js.html">Point3.js</a>,
<a href="Point3.js.html#sunlight-1-line-242">line 242</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The new Point3 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="subtract"><span class="type-signature">&lt;static> </span>subtract<span class="signature">(a, b, <span class="optional">out</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>Subtracts the coordinates of two points to create a new point.</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.Point3.html">Phaser.Plugin.Isometric.Point3</a></span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The first Point3 object.</p></td>
</tr>
<tr>
<td class="name"><code>b</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">
</td>
<td class="description last"><p>The second Point3 object.</p></td>
</tr>
<tr>
<td class="name"><code>out</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 to store the value in, if not supplied a new Point3 object will be created.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Point3.js.html">Point3.js</a>,
<a href="Point3.js.html#sunlight-1-line-219">line 219</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The new Point3 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>
</dl>
</article>
</section>
<h1 class="page-title">Class: Point3</h1>
<section>
<header>
<h2>
<span class="ancestors"><a href="Phaser.Plugin.Isometric.html">.Isometric</a>.</span>
Point3
</h2>
</header>
<article>
<div class="container-overview">
<dt>
<h4 class="name" id="Point3"><span class="type-signature"></span>new Point3<span class="signature">(<span class="optional">x</span>, <span class="optional">y</span>, <span class="optional">z</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Creates a new Point3 object. If you pass no parameters a Point3 is created set to (0, 0, 0).</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</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="attributes">
&lt;optional><br>
</td>
<td class="default">
0
</td>
<td class="description last"><p>The horizontal X position of this Point.</p></td>
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
0
</td>
<td class="description last"><p>The horizontal Y position of this Point.</p></td>
</tr>
<tr>
<td class="name"><code>z</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
0
</td>
<td class="description last"><p>The vertical position of this Point.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Point3.js.html">Point3.js</a>,
<a href="Point3.js.html#sunlight-1-line-18">line 18</a>
</li>
</ul>
</dd>
</dl>
</dd>
</div>
<h3 class="subsection-title">Members</h3>
<dl>
<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 value of the point.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Point3.js.html">Point3.js</a>,
<a href="Point3.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 value of the point.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Point3.js.html">Point3.js</a>,
<a href="Point3.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 value of the point.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Point3.js.html">Point3.js</a>,
<a href="Point3.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="add"><span class="type-signature"></span>add<span class="signature">(x, y, z)</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>Adds the given x, y and z values to this Point3.</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 value to add to Point3.x.</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 value to add to Point3.y.</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 value to add to Point3.z.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Point3.js.html">Point3.js</a>,
<a href="Point3.js.html#sunlight-1-line-119">line 119</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>This Point3 object. Useful for chaining method calls.</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="copyFrom"><span class="type-signature"></span>copyFrom<span class="signature">(source)</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>Copies the x, y and z properties from any given object to this Point3.</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="Point3.js.html">Point3.js</a>,
<a href="Point3.js.html#sunlight-1-line-40">line 40</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>This Point3 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="copyTo"><span class="type-signature"></span>copyTo<span class="signature">(dest)</span><span class="type-signature"> &rarr; {Object}</span></h4>
</dt>
<dd>
<div class="description">
<p>Copies the x, y and z properties from this Point3 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="Point3.js.html">Point3.js</a>,
<a href="Point3.js.html#sunlight-1-line-53">line 53</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The dest object.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Object</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="divide"><span class="type-signature"></span>divide<span class="signature">(x, y, z)</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>Divides Point3.x, Point3.y and Point3.z by the given x, y and z 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 value to divide Point3.x by.</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 value to divide Point3.y by.</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 value to divide Point3.z by.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Point3.js.html">Point3.js</a>,
<a href="Point3.js.html#sunlight-1-line-174">line 174</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>This Point3 object. Useful for chaining method calls.</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="equals"><span class="type-signature"></span>equals<span class="signature">(a)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
</dt>
<dd>
<div class="description">
<p>Determines whether the given object's x/y/z values are equal to this Point3 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.Point3.html">Phaser.Plugin.Isometric.Point3</a></span>
|
<span class="param-type">any</span>
</td>
<td class="description last"><p>The object to compare with this Point3.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Point3.js.html">Point3.js</a>,
<a href="Point3.js.html#sunlight-1-line-70">line 70</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>A value of true if the x and y points are equal, otherwise false.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="multiply"><span class="type-signature"></span>multiply<span class="signature">(x, y, z)</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>Multiplies Point3.x, Point3.y and Point3.z by the given x and y values. Sometimes known as <code>Scale</code>.</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 value to multiply Point3.x by.</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 value to multiply Point3.y by.</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 value to multiply Point3.z by.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Point3.js.html">Point3.js</a>,
<a href="Point3.js.html#sunlight-1-line-155">line 155</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>This Point3 object. Useful for chaining method calls.</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="set"><span class="type-signature"></span>set<span class="signature">(x, <span class="optional">y</span>, <span class="optional">z</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>Sets the x, y and z values of this Point3 object to the given values.
If you omit the y and z value then the x value will be applied to all three, for example:
<code>Point3.set(2)</code> is the same as <code>Point3.set(2, 2, 2)</code>
If however you set both x and y, but no z, the z value will be set to 0.</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>x</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The x value of this point.</p></td>
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>The y value of this point. If not given the x value will be used in its place.</p></td>
</tr>
<tr>
<td class="name"><code>z</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>The z value of this point. If not given and the y value is also not given, the x value will be used in its place.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Point3.js.html">Point3.js</a>,
<a href="Point3.js.html#sunlight-1-line-83">line 83</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>This Point3 object. Useful for chaining method calls.</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="setTo"><span class="type-signature"></span>setTo<span class="signature">(x, <span class="optional">y</span>, <span class="optional">z</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>Sets the x, y and z values of this Point3 object to the given values.
If you omit the y and z value then the x value will be applied to all three, for example:
<code>Point3.setTo(2)</code> is the same as <code>Point3.setTo(2, 2, 2)</code>
If however you set both x and y, but no z, the z value will be set to 0.</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>x</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The x value of this point.</p></td>
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>The y value of this point. If not given the x value will be used in its place.</p></td>
</tr>
<tr>
<td class="name"><code>z</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>The z value of this point. If not given and the y value is also not given, the x value will be used in its place.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Point3.js.html">Point3.js</a>,
<a href="Point3.js.html#sunlight-1-line-103">line 103</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>This Point3 object. Useful for chaining method calls.</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="subtract"><span class="type-signature"></span>subtract<span class="signature">(x, y, z)</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>Subtracts the given x, y and z values from this Point3.</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 value to subtract from Point3.x.</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 value to subtract from Point3.y.</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 value to subtract from Point3.z.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Point3.js.html">Point3.js</a>,
<a href="Point3.js.html#sunlight-1-line-136">line 136</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>This Point3 object. Useful for chaining method calls.</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="add"><span class="type-signature">&lt;static> </span>add<span class="signature">(a, b, <span class="optional">out</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>Adds the coordinates of two points together to create a new point.</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.Point3.html">Phaser.Plugin.Isometric.Point3</a></span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The first Point3 object.</p></td>
</tr>
<tr>
<td class="name"><code>b</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">
</td>
<td class="description last"><p>The second Point3 object.</p></td>
</tr>
<tr>
<td class="name"><code>out</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 to store the value in, if not supplied a new Point3 object will be created.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Point3.js.html">Point3.js</a>,
<a href="Point3.js.html#sunlight-1-line-196">line 196</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The new Point3 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="divide"><span class="type-signature">&lt;static> </span>divide<span class="signature">(a, b, <span class="optional">out</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>Divides the coordinates of two points to create a new point.</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.Point3.html">Phaser.Plugin.Isometric.Point3</a></span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The first Point3 object.</p></td>
</tr>
<tr>
<td class="name"><code>b</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">
</td>
<td class="description last"><p>The second Point3 object.</p></td>
</tr>
<tr>
<td class="name"><code>out</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 to store the value in, if not supplied a new Point3 object3 will be created.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Point3.js.html">Point3.js</a>,
<a href="Point3.js.html#sunlight-1-line-265">line 265</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The new Point3 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="equals"><span class="type-signature">&lt;static> </span>equals<span class="signature">(a, b)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
</dt>
<dd>
<div class="description">
<p>Determines whether the two given Point3 objects are equal. They are considered equal if they have the same x, y and z 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>a</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 first Point3 object.</p></td>
</tr>
<tr>
<td class="name"><code>b</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 second Point3 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="Point3.js.html">Point3.js</a>,
<a href="Point3.js.html#sunlight-1-line-288">line 288</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>A value of true if the Points3 are equal, otherwise false.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="multiply"><span class="type-signature">&lt;static> </span>multiply<span class="signature">(a, b, <span class="optional">out</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>Multiplies the coordinates of two points to create a new point.</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.Point3.html">Phaser.Plugin.Isometric.Point3</a></span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The first Point3 object.</p></td>
</tr>
<tr>
<td class="name"><code>b</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">
</td>
<td class="description last"><p>The second Point3 object.</p></td>
</tr>
<tr>
<td class="name"><code>out</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 to store the value in, if not supplied a new Point3 object will be created.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Point3.js.html">Point3.js</a>,
<a href="Point3.js.html#sunlight-1-line-242">line 242</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The new Point3 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="subtract"><span class="type-signature">&lt;static> </span>subtract<span class="signature">(a, b, <span class="optional">out</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>Subtracts the coordinates of two points to create a new point.</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.Point3.html">Phaser.Plugin.Isometric.Point3</a></span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The first Point3 object.</p></td>
</tr>
<tr>
<td class="name"><code>b</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">
</td>
<td class="description last"><p>The second Point3 object.</p></td>
</tr>
<tr>
<td class="name"><code>out</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 to store the value in, if not supplied a new Point3 object will be created.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Point3.js.html">Point3.js</a>,
<a href="Point3.js.html#sunlight-1-line-219">line 219</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The new Point3 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>
</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