Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-12-29 22:43:08 +00:00
Code Issues Projects Releases Packages Wiki Activity
phaser/Docs/out/Phaser.Animation.Frame.html

2541 lines
33 KiB
HTML
Raw Normal View History

Working through building the docs.
2013-10-01 15:15:45 +00:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: Frame</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: Frame</h1>
<section>
<header>
<h2>
Frame
</h2>
<div class="class-description">Phaser.Animation.Frame</div>
</header>
<article>
<div class="container-overview">
<dt>
<h4 class="name" id="Frame"><span class="type-signature"></span>new Frame<span class="signature">(index, x, y, width, height, name, uuid)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
A Frame is a single frame of an animation and is part of a FrameData collection.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>index</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The index of this Frame within the FrameData set it is being added to.</td>
</tr>
<tr>
<td class="name"><code>x</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">X position of the frame within the texture image.</td>
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Y position of the frame within the texture image.</td>
</tr>
<tr>
<td class="name"><code>width</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Width of the frame within the texture image.</td>
</tr>
<tr>
<td class="name"><code>height</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Height of the frame within the texture image.</td>
</tr>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The name of the frame. In Texture Atlas data this is usually set to the filename.</td>
</tr>
<tr>
<td class="name"><code>uuid</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Internal UUID key.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
animation/Frame.js, line 21
</li></ul></dd>
</dl>
</dd>
</div>
<h3 class="subsection-title">Members</h3>
<dl>
<dt>
<h4 class="name" id="centerX"><span class="type-signature"></span>centerX<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props">
<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">Center X position within the image to cut from.</td>
</tr>
</tbody>
</table></dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
animation/Frame.js, line 61
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="centerY"><span class="type-signature"></span>centerY<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props">
<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">Center Y position within the image to cut from.</td>
</tr>
</tbody>
</table></dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
animation/Frame.js, line 66
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="distance"><span class="type-signature"></span>distance<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>distance</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The distance from the top left to the bottom-right of this Frame.</td>
</tr>
</tbody>
</table></dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
animation/Frame.js, line 71
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="height"><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">
<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">Height of the frame.</td>
</tr>
</tbody>
</table></dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
animation/Frame.js, line 46
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="index"><span class="type-signature"></span>index<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>index</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The index of this Frame within the FrameData set it is being added to.</td>
</tr>
</tbody>
</table></dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
animation/Frame.js, line 26
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="name"><span class="type-signature"></span>name<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Useful for Texture Atlas files (is set to the filename value).</td>
</tr>
</tbody>
</table></dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
animation/Frame.js, line 51
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="rotated"><span class="type-signature"></span>rotated<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>rotated</code></td>
<td class="type">
More docs and quick patch to stop the body.allowRotation messing things up.
2013-10-01 15:56:47 +00:00
<span class="param-type">boolean</span>
Working through building the docs.
2013-10-01 15:15:45 +00:00
</td>
<td class="description last">Rotated? (not yet implemented)</td>
</tr>
</tbody>
</table></dl>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>false</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
animation/Frame.js, line 77
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="rotationDirection"><span class="type-signature"></span>rotationDirection<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>rotationDirection</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Either 'cw' or 'ccw', rotation is always 90 degrees.</td>
</tr>
</tbody>
</table></dl>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>'cw'</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
animation/Frame.js, line 83
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="sourceSizeH"><span class="type-signature"></span>sourceSizeH<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>sourceSizeH</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Height of the original sprite.</td>
</tr>
</tbody>
</table></dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
animation/Frame.js, line 99
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="sourceSizeW"><span class="type-signature"></span>sourceSizeW<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>sourceSizeW</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Width of the original sprite.</td>
</tr>
</tbody>
</table></dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
animation/Frame.js, line 94
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="spriteSourceSizeH"><span class="type-signature"></span>spriteSourceSizeH<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>spriteSourceSizeH</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Height of the trimmed sprite.</td>
</tr>
</tbody>
</table></dl>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>0</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
animation/Frame.js, line 123
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="spriteSourceSizeW"><span class="type-signature"></span>spriteSourceSizeW<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>spriteSourceSizeW</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Width of the trimmed sprite.</td>
</tr>
</tbody>
</table></dl>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>0</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
animation/Frame.js, line 117
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="spriteSourceSizeX"><span class="type-signature"></span>spriteSourceSizeX<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>spriteSourceSizeX</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">X position of the trimmed sprite inside original sprite.</td>
</tr>
</tbody>
</table></dl>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>0</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
animation/Frame.js, line 105
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="spriteSourceSizeY"><span class="type-signature"></span>spriteSourceSizeY<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>spriteSourceSizeY</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Y position of the trimmed sprite inside original sprite.</td>
</tr>
</tbody>
</table></dl>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>0</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
animation/Frame.js, line 111
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="trimmed"><span class="type-signature"></span>trimmed<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>trimmed</code></td>
<td class="type">
More docs and quick patch to stop the body.allowRotation messing things up.
2013-10-01 15:56:47 +00:00
<span class="param-type">boolean</span>
Working through building the docs.
2013-10-01 15:15:45 +00:00
</td>
<td class="description last">Was it trimmed when packed?</td>
</tr>
</tbody>
</table></dl>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>false</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
animation/Frame.js, line 89
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="uuid"><span class="type-signature"></span>uuid<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>uuid</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">A link to the PIXI.TextureCache entry.</td>
</tr>
</tbody>
</table></dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
animation/Frame.js, line 56
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="width"><span class="type-signature"></span>width<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>width</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Width of the frame.</td>
</tr>
</tbody>
</table></dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
animation/Frame.js, line 41
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="x"><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">
<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">X position within the image to cut from.</td>
</tr>
</tbody>
</table></dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
animation/Frame.js, line 31
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="y"><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">
<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">Y position within the image to cut from.</td>
</tr>
</tbody>
</table></dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
animation/Frame.js, line 36
</li></ul></dd>
</dl>
</dd>
</dl>
More docs coming on.
2013-10-01 15:39:39 +00:00
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<h4 class="name" id="setTrim"><span class="type-signature">&lt;static> </span>setTrim<span class="signature">(trimmed, actualWidth, actualHeight, destX, destY, destWidth, destHeight)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
If the frame was trimmed when added to the Texture Atlas this records the trim and source data.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>trimmed</code></td>
<td class="type">
More docs and quick patch to stop the body.allowRotation messing things up.
2013-10-01 15:56:47 +00:00
<span class="param-type">boolean</span>
More docs coming on.
2013-10-01 15:39:39 +00:00
</td>
<td class="description last">If this frame was trimmed or not.</td>
</tr>
<tr>
<td class="name"><code>actualWidth</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The width of the frame before being trimmed.</td>
</tr>
<tr>
<td class="name"><code>actualHeight</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The height of the frame before being trimmed.</td>
</tr>
<tr>
<td class="name"><code>destX</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The destination X position of the trimmed frame for display.</td>
</tr>
<tr>
<td class="name"><code>destY</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The destination Y position of the trimmed frame for display.</td>
</tr>
<tr>
<td class="name"><code>destWidth</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The destination width of the trimmed frame for display.</td>
</tr>
<tr>
<td class="name"><code>destHeight</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The destination height of the trimmed frame for display.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
animation/Frame.js, line 129
</li></ul></dd>
</dl>
</dd>
</dl>
Working through building the docs.
2013-10-01 15:15:45 +00:00
</article>
</section>
</div>
<nav>
More docs and quick patch to stop the body.allowRotation messing things up.
2013-10-01 15:56:47 +00:00
<h2><a href="index.html">Index</a></h2><h3>Modules</h3><ul><li><a href="module-Phaser.html">Phaser</a></li><li><a href="Animation.html">Animation</a></li><li><a href="Camera.html">Camera</a></li><li><a href="Game.html">Game</a></li></ul><h3>Classes</h3><ul><li><a href="Phaser.Animation.Frame.html">Frame</a></li><li><a href="Phaser.Animation.FrameData.html">FrameData</a></li><li><a href="Phaser.Animation.Parser.html">Parser</a></li><li><a href="Phaser.AnimationManager.html">AnimationManager</a></li><li><a href="Phaser.Group.html">Group</a></li><li><a href="Animation-Phaser.Animation.html">Animation</a></li><li><a href="Camera-Phaser.Camera.html">Camera</a></li><li><a href="Game-Phaser.Game.html">Game</a></li></ul><h3>Namespaces</h3><ul><li><a href="Phaser.html">Phaser</a></li></ul>
Working through building the docs.
2013-10-01 15:15:45 +00:00
</nav>
<br clear="both">
<footer>
More docs and quick patch to stop the body.allowRotation messing things up.
2013-10-01 15:56:47 +00:00
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> on Tue Oct 01 2013 16:44:22 GMT+0100 (BST)
Working through building the docs.
2013-10-01 15:15:45 +00:00
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>
Reference in a new issue Copy permalink