mirror of
https://github.com/photonstorm/phaser
synced 2024-12-18 09:03:29 +00:00
523 lines
13 KiB
HTML
523 lines
13 KiB
HTML
<!DOCTYPE html>
|
|
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>Phaser Source: animation/FrameData.js</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</a>
|
|
<ul class="nav">
|
|
|
|
<li class="dropdown">
|
|
<a href="modules.list.html" class="dropdown-toggle" data-toggle="dropdown">Modules<b
|
|
class="caret"></b></a>
|
|
|
|
<ul class="dropdown-menu ">
|
|
|
|
<li>
|
|
<a href="module-Phaser.html">Phaser</a>
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
<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.Animation.html">Animation</a>
|
|
</li>
|
|
|
|
<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.Cache.html">Cache</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Camera.html">Camera</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Circle.html">Circle</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Game.html">Game</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Group.html">Group</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Input.html">Input</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.InputHandler.html">InputHandler</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Key.html">Key</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Keyboard.html">Keyboard</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.LinkedList.html">LinkedList</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Loader.html">Loader</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Loader.Parser.html">Parser</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Math.html">Math</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Mouse.html">Mouse</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.MSPointer.html">MSPointer</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Net.html">Net</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Particles.html">Particles</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Plugin.html">Plugin</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.PluginManager.html">PluginManager</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Point.html">Point</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Pointer.html">Pointer</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.QuadTree.html">QuadTree</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.RandomDataGenerator.html">RandomDataGenerator</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Rectangle.html">Rectangle</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Signal.html">Signal</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Stage.html">Stage</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.State.html">State</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.StateManager.html">StateManager</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Touch.html">Touch</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.World.html">World</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="SignalBinding.html">SignalBinding</a>
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="dropdown">
|
|
<a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b
|
|
class="caret"></b></a>
|
|
|
|
<ul class="dropdown-menu ">
|
|
|
|
<li>
|
|
<a href="global.html#maxParticles">maxParticles</a>
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="row-fluid">
|
|
|
|
|
|
<div class="span12">
|
|
|
|
<div id="main">
|
|
|
|
|
|
|
|
<h1 class="page-title">Source: animation/FrameData.js</h1>
|
|
|
|
<section>
|
|
<article>
|
|
<pre class="sunlight-highlight-javascript linenums">/**
|
|
* @author Richard Davey <rich@photonstorm.com>
|
|
* @copyright 2013 Photon Storm Ltd.
|
|
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
|
|
*/
|
|
|
|
/**
|
|
* FrameData is a container for Frame objects, which are the internal representation of animation data in Phaser.
|
|
*
|
|
* @class Phaser.Animation.FrameData
|
|
* @constructor
|
|
*/
|
|
Phaser.Animation.FrameData = function () {
|
|
|
|
/**
|
|
* @property {Array} _frames - Local array of frames.
|
|
* @private
|
|
*/
|
|
this._frames = [];
|
|
|
|
|
|
/**
|
|
* @property {Array} _frameNames - Local array of frame names for name to index conversions.
|
|
* @private
|
|
*/
|
|
this._frameNames = [];
|
|
|
|
};
|
|
|
|
Phaser.Animation.FrameData.prototype = {
|
|
|
|
/**
|
|
* Adds a new Frame to this FrameData collection. Typically called by the Animation.Parser and not directly.
|
|
*
|
|
* @method Phaser.Animation.FrameData#addFrame
|
|
* @param {Phaser.Animation.Frame} frame - The frame to add to this FrameData set.
|
|
* @return {Phaser.Animation.Frame} The frame that was just added.
|
|
*/
|
|
addFrame: function (frame) {
|
|
|
|
frame.index = this._frames.length;
|
|
|
|
this._frames.push(frame);
|
|
|
|
if (frame.name !== '')
|
|
{
|
|
this._frameNames[frame.name] = frame.index;
|
|
}
|
|
|
|
return frame;
|
|
|
|
},
|
|
|
|
/**
|
|
* Get a Frame by its numerical index.
|
|
*
|
|
* @method Phaser.Animation.FrameData#getFrame
|
|
* @param {number} index - The index of the frame you want to get.
|
|
* @return {Phaser.Animation.Frame} The frame, if found.
|
|
*/
|
|
getFrame: function (index) {
|
|
|
|
if (this._frames[index])
|
|
{
|
|
return this._frames[index];
|
|
}
|
|
|
|
return null;
|
|
|
|
},
|
|
|
|
/**
|
|
* Get a Frame by its frame name.
|
|
*
|
|
* @method Phaser.Animation.FrameData#getFrameByName
|
|
* @param {string} name - The name of the frame you want to get.
|
|
* @return {Phaser.Animation.Frame} The frame, if found.
|
|
*/
|
|
getFrameByName: function (name) {
|
|
|
|
if (typeof this._frameNames[name] === 'number')
|
|
{
|
|
return this._frames[this._frameNames[name]];
|
|
}
|
|
|
|
return null;
|
|
|
|
},
|
|
|
|
/**
|
|
* Check if there is a Frame with the given name.
|
|
*
|
|
* @method Phaser.Animation.FrameData#checkFrameName
|
|
* @param {string} name - The name of the frame you want to check.
|
|
* @return {boolean} True if the frame is found, otherwise false.
|
|
*/
|
|
checkFrameName: function (name) {
|
|
|
|
if (this._frameNames[name] == null)
|
|
{
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
|
|
},
|
|
|
|
/**
|
|
* Returns a range of frames based on the given start and end frame indexes and returns them in an Array.
|
|
*
|
|
* @method Phaser.Animation.FrameData#getFrameRange
|
|
* @param {number} start - The starting frame index.
|
|
* @param {number} end - The ending frame index.
|
|
* @param {Array} [output] - If given the results will be appended to the end of this array otherwise a new array will be created.
|
|
* @return {Array} An array of Frames between the start and end index values, or an empty array if none were found.
|
|
*/
|
|
getFrameRange: function (start, end, output) {
|
|
|
|
if (typeof output === "undefined") { output = []; }
|
|
|
|
for (var i = start; i <= end; i++)
|
|
{
|
|
output.push(this._frames[i]);
|
|
}
|
|
|
|
return output;
|
|
|
|
},
|
|
|
|
/**
|
|
* Returns all of the Frames in this FrameData set where the frame index is found in the input array.
|
|
* The frames are returned in the output array, or if none is provided in a new Array object.
|
|
*
|
|
* @method Phaser.Animation.FrameData#getFrames
|
|
* @param {Array} frames - An Array containing the indexes of the frames to retrieve. If the array is empty then all frames in the FrameData are returned.
|
|
* @param {boolean} [useNumericIndex=true] - Are the given frames using numeric indexes (default) or strings? (false)
|
|
* @param {Array} [output] - If given the results will be appended to the end of this array otherwise a new array will be created.
|
|
* @return {Array} An array of all Frames in this FrameData set matching the given names or IDs.
|
|
*/
|
|
getFrames: function (frames, useNumericIndex, output) {
|
|
|
|
if (typeof useNumericIndex === "undefined") { useNumericIndex = true; }
|
|
if (typeof output === "undefined") { output = []; }
|
|
|
|
if (typeof frames === "undefined" || frames.length == 0)
|
|
{
|
|
// No input array, so we loop through all frames
|
|
for (var i = 0; i < this._frames.length; i++)
|
|
{
|
|
// We only need the indexes
|
|
output.push(this._frames[i]);
|
|
}
|
|
}
|
|
else
|
|
{
|
|
// Input array given, loop through that instead
|
|
for (var i = 0, len = frames.length; i < len; i++)
|
|
{
|
|
// Does the input array contain names or indexes?
|
|
if (useNumericIndex)
|
|
{
|
|
// The actual frame
|
|
output.push(this.getFrame(frames[i]));
|
|
}
|
|
else
|
|
{
|
|
// The actual frame
|
|
output.push(this.getFrameByName(frames[i]));
|
|
}
|
|
}
|
|
}
|
|
|
|
return output;
|
|
|
|
},
|
|
|
|
/**
|
|
* Returns all of the Frame indexes in this FrameData set.
|
|
* The frames indexes are returned in the output array, or if none is provided in a new Array object.
|
|
*
|
|
* @method Phaser.Animation.FrameData#getFrameIndexes
|
|
* @param {Array} frames - An Array containing the indexes of the frames to retrieve. If the array is empty then all frames in the FrameData are returned.
|
|
* @param {boolean} [useNumericIndex=true] - Are the given frames using numeric indexes (default) or strings? (false)
|
|
* @param {Array} [output] - If given the results will be appended to the end of this array otherwise a new array will be created.
|
|
* @return {Array} An array of all Frame indexes matching the given names or IDs.
|
|
*/
|
|
getFrameIndexes: function (frames, useNumericIndex, output) {
|
|
|
|
if (typeof useNumericIndex === "undefined") { useNumericIndex = true; }
|
|
if (typeof output === "undefined") { output = []; }
|
|
|
|
if (typeof frames === "undefined" || frames.length == 0)
|
|
{
|
|
// No frames array, so we loop through all frames
|
|
for (var i = 0, len = this._frames.length; i < len; i++)
|
|
{
|
|
output.push(this._frames[i].index);
|
|
}
|
|
}
|
|
else
|
|
{
|
|
// Input array given, loop through that instead
|
|
for (var i = 0, len = frames.length; i < len; i++)
|
|
{
|
|
// Does the frames array contain names or indexes?
|
|
if (useNumericIndex)
|
|
{
|
|
output.push(frames[i]);
|
|
}
|
|
else
|
|
{
|
|
output.push(this.getFrameByName(frames[i]).index);
|
|
}
|
|
}
|
|
}
|
|
|
|
return output;
|
|
|
|
}
|
|
|
|
};
|
|
|
|
/**
|
|
* @name Phaser.Animation.FrameData#total
|
|
* @property {number} total - The total number of frames in this FrameData set.
|
|
* @readonly
|
|
*/
|
|
Object.defineProperty(Phaser.Animation.FrameData.prototype, "total", {
|
|
|
|
get: function () {
|
|
return this._frames.length;
|
|
}
|
|
|
|
});
|
|
</pre>
|
|
</article>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="clearfix"></div>
|
|
<footer>
|
|
|
|
|
|
<span class="copyright">
|
|
Phaser Copyright © 2012-2013 Photon Storm Ltd.
|
|
</span>
|
|
<br />
|
|
|
|
<span class="jsdoc-message">
|
|
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
|
|
on Wed Oct 02 2013 16:05:22 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
|
|
</span>
|
|
</footer>
|
|
</div>
|
|
|
|
|
|
<br clear="both">
|
|
</div>
|
|
|
|
</div>
|
|
<script src="scripts/sunlight.js"></script>
|
|
<script src="scripts/sunlight.javascript.js"></script>
|
|
<script src="scripts/sunlight-plugin.doclinks.js"></script>
|
|
<script src="scripts/sunlight-plugin.linenumbers.js"></script>
|
|
<script src="scripts/sunlight-plugin.menu.js"></script>
|
|
<script src="scripts/jquery.min.js"></script>
|
|
<script src="scripts/jquery.scrollTo.js"></script>
|
|
<script src="scripts/jquery.localScroll.js"></script>
|
|
<script src="scripts/bootstrap-dropdown.js"></script>
|
|
<script src="scripts/toc.js"></script>
|
|
|
|
|
|
<script> Sunlight.highlightAll({lineNumbers:true, showMenu: true, enableDoclinks :true}); </script>
|
|
|
|
<script>
|
|
$( function () {
|
|
$( "#toc" ).toc( {
|
|
selectors : "h1,h2,h3,h4",
|
|
showAndHide : false,
|
|
scrollTo : 60
|
|
} );
|
|
$( "#toc>ul" ).addClass( "nav nav-pills nav-stacked" );
|
|
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
|
|
|
|
} );
|
|
</script>
|
|
|
|
|
|
|
|
</body>
|
|
</html>
|