-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathanimation_loader.js.html
More file actions
226 lines (199 loc) · 8.12 KB
/
animation_loader.js.html
File metadata and controls
226 lines (199 loc) · 8.12 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Source: animation_loader.js</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">Source: animation_loader.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>"use strict";
var buffer = require("./buffer");
var Animation = require("./animation");
function makeFrame(img, frameWidth, f) {
return buffer.makeBuffer(frameWidth, img.height, function(ctx) {
var sx = f * frameWidth;
ctx.drawImage(img, sx, 0, frameWidth, img.height, 0, 0, frameWidth, img.height);
});
}
function makeAnimation(img, numFrames, time) {
var a = new Animation();
var frameWidth = img.width / numFrames |0;
for (var f = 0; f < numFrames; f++) {
a.add(makeFrame(img, frameWidth, f), time);
}
return a;
}
function loadImageFromManifest(imageLoader, name, info) {
if (info.strip !== undefined) {
imageLoader.load(name, info.strip);
} else if (info.prefix !== undefined) {
for (var i = 1; i <= info.frames; i++) {
var number = "" + i;
if (info.padNumberTo > 1) {
while (number.length < info.padNumberTo) {
number = "0" + number;
}
}
name = info.prefix + number + info.suffix;
imageLoader.load(name + i, name);
}
}
}
function loadImagesFromManifest(imageLoader, manifest) {
for (var key in manifest) {
if (manifest.hasOwnProperty(key)) {
var info = manifest[key];
loadImageFromManifest(imageLoader, key, info);
}
}
}
function makeAnimationFromManifest(images, key, manifestEntry) {
var animation;
if (manifestEntry.strip !== undefined) {
var strip = images.get(key);
animation = makeAnimation(strip, manifestEntry.frames, manifestEntry.msPerFrame);
} else if (manifestEntry.prefix !== undefined) {
animation = new Animation();
for (var i = 1; i <= manifestEntry.frames; i++) {
var frame = images.get(key + i);
animation.add(frame, manifestEntry.msPerFrame);
}
}
if (manifestEntry.repeatAt !== undefined) {
animation.repeatAt = manifestEntry.repeatAt;
}
if (manifestEntry.flip === "horizontal") {
animation.flipHorizontally();
}
if (manifestEntry.flip === "vertical") {
animation.flipVertically();
}
if (manifestEntry.rotate === "cw") {
animation.rotateClockwise();
}
if (manifestEntry.rotate === "180") {
animation.rotateClockwise().rotateClockwise();
}
if (manifestEntry.rotate === "ccw") {
animation.rotateCounterclockwise();
}
animation.name = key;
return animation;
}
function generateAnimationsFromManifest(images, manifest) {
var animations = {};
for (var key in manifest) {
if (manifest.hasOwnProperty(key)) {
var info = manifest[key];
animations[key] = makeAnimationFromManifest(images, key, info);
}
}
return animations;
}
/**
* Loads and constructs {@link Animation}s from a manifest. An instance of AnimationLoader is available as {@link Splat.Game#animations}.
* @constructor
* @param {ImageLoader} imageLoader The ImageLoader used to fetch all {@link external:image}s.
* @param {object} manifest The list of {@link Animation}s to build.
* @example
var manifest = {
"player-left": { // The Animation's name
"strip": "img/player-left.png", // The path to a sprite-strip. A sprite strip is multiple frames side-by-side horizontally in a single image.
"frames": 4, // The number of frames in the Animation
"msPerFrame": 100 // How many milliseconds to display each frame
},
"player-right": {
"strip": "img/player-left.png", // Re-use the left sprite-strip
"frames": 4,
"msPerFrame": 100,
"flip": "horizontal" // Flip the animation horizontally so we can use the left image for the right.
},
"item": { // Create an animation from individual images named "img/item/[0000-0009].png"
"prefix": "img/item/", // Image filename prefix
"suffix": ".png", // Image filename suffix
"padNumberTo": 4, // Number part of image is 4 characters long.
"frames": 10, // Load 10 separate image files [0-9].
"msPerFrame": 100,
"repeatAt": 5, // Loop the animation back at frame 5.
"rotate": "cw" // Rotate the animation clockwise.
}
};
var imageLoader = new Splat.ImageLoader();
var animationLoader = new Splat.AnimationLoader(imageLoader, manifest);
*/
function AnimationLoader(imageLoader, manifest) {
/**
* The ImageLoader used to fetch all {@link external:image}s.
* @member {ImageLoader}
*/
this.imageLoader = imageLoader;
/**
* The list of {@link Animation} metadata.
* @member {object}
*/
this.manifest = manifest;
loadImagesFromManifest(imageLoader, manifest);
}
/**
* Test if all {@link Animation}s are loaded.
* @returns {boolean}
*/
AnimationLoader.prototype.allLoaded = function() {
if (this.loaded) {
return true;
}
var loaded = this.imageLoader.allLoaded();
if (loaded) {
this.animations = generateAnimationsFromManifest(this.imageLoader, this.manifest);
this.loaded = true;
}
return loaded;
};
/**
* Load a single {@link Animation}.
* @param {string} name The name to store the {@link Animation} under. This name will be used to retrieve the Animation from {@link AnimationLoader#get}.
* @param {object} info A single-animation portion of {@link AnimationLoader#manifest}.
*/
AnimationLoader.prototype.load = function(name, info) {
this.manifest[name] = info;
this.loaded = false;
loadImageFromManifest(this.imageLoader, name, info);
};
/**
* Fetch a loaded {@link Animation}.
* @param {string} name The name used to identify the {@link Animation} in the {@link AnimationLoader#manifest}.
* @returns {Animation}
*/
AnimationLoader.prototype.get = function(name) {
var anim = this.animations[name];
if (anim === undefined) {
console.error("Unknown animation: " + name);
}
return anim;
};
module.exports = AnimationLoader;
</code></pre>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-buffer.html">buffer</a></li><li><a href="module-KeyMap.html">KeyMap</a></li></ul><h3>Externals</h3><ul><li><a href="external-AudioContext.html">AudioContext</a></li><li><a href="external-canvas.html">canvas</a></li><li><a href="external-CanvasRenderingContext2D.html">CanvasRenderingContext2D</a></li><li><a href="external-image.html">image</a></li></ul><h3>Classes</h3><ul><li><a href="Accelerometer.html">Accelerometer</a></li><li><a href="Animation.html">Animation</a></li><li><a href="AnimationLoader.html">AnimationLoader</a></li><li><a href="FontLoader.html">FontLoader</a></li><li><a href="ImageLoader.html">ImageLoader</a></li><li><a href="Keyboard.html">Keyboard</a></li><li><a href="Mouse.html">Mouse</a></li><li><a href="SceneManager.html">SceneManager</a></li><li><a href="SoundLoader.html">SoundLoader</a></li><li><a href="Splat.AnimatedEntity.html">AnimatedEntity</a></li><li><a href="Splat.AStar.html">AStar</a></li><li><a href="Splat.BinaryHeap.html">BinaryHeap</a></li><li><a href="Splat.Camera.html">Camera</a></li><li><a href="Splat.Entity.html">Entity</a></li><li><a href="Splat.EntityBoxCamera.html">EntityBoxCamera</a></li><li><a href="Splat.Game.html">Game</a></li><li><a href="Splat.math.Random.html">Random</a></li><li><a href="Splat.NinePatch.html">NinePatch</a></li><li><a href="Splat.Scene.html">Scene</a></li><li><a href="Splat.Timer.html">Timer</a></li></ul><h3>Namespaces</h3><ul><li><a href="Splat.html">Splat</a></li><li><a href="Splat.ads.html">ads</a></li><li><a href="Splat.leaderboards.html">leaderboards</a></li><li><a href="Splat.math.html">math</a></li><li><a href="Splat.saveData.html">saveData</a></li></ul><h3><a href="global.html">Global</a></h3>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Thu Sep 17 2015 23:22:42 GMT-0400 (EDT)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>