-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathanimation_Animations.js.html
More file actions
443 lines (385 loc) · 19.3 KB
/
animation_Animations.js.html
File metadata and controls
443 lines (385 loc) · 19.3 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
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Source: animation/Animations.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/Animations.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>//------------------------------------------------------------------------------
// Constructor scope
//------------------------------------------------------------------------------
/**
* Creates a new instance of the Animations class.
*
* @constructor
*
* @param {rune.display.Sprite} target The Sprite object to which the animation is linked.
*
* @class
* @classdesc
*
* The Animations class represents a subsystem for managing keyframe-based
* animation within a Sprite object.
*/
rune.animation.Animations = function(target) {
//--------------------------------------------------------------------------
// Private properties
//--------------------------------------------------------------------------
/**
* Current animation.
*
* @type {rune.animation.Animation}
* @private
*/
this.m_animation = null;
/**
* List of available animations.
*
* @type {Array.<rune.animation.Animation>}
* @private
*/
this.m_animations = [];
/**
* Frame data that describes which part of the Sprite object's texture
* data is to be used.
*
* @type {rune.geom.Rectangle}
* @private
*/
this.m_frame = new rune.geom.Rectangle(0, 0, target['canvas']['width'], target['canvas']['height']);
/**
* Atlas index.
*
* @type {number}
* @private
*/
this.m_atlasIndex = 0;
/**
* Target Sprite object.
*
* @type {rune.display.Sprite}
* @private
*/
this.m_target = target;
};
//------------------------------------------------------------------------------
// Public prototype getter and setter methods
//------------------------------------------------------------------------------
/**
* Current animation. If this reference is null, no animation has been added.
*
* @member {rune.animation.Animation} current
* @memberof rune.animation.Animations
* @instance
* @readonly
*/
Object.defineProperty(rune.animation.Animations.prototype, "current", {
/**
* @this rune.animation.Animations
* @ignore
*/
get : function() {
return this.m_animation;
}
});
/**
* Frame data. This is information that describes which part of the Sprite
* object's texture data is to be used for the current animation's current
* frame. This reference is primarily intended for internal use, but may be
* used for specific purposes.
*
* @member {rune.geom.Rectangle} frame
* @memberof rune.animation.Animations
* @instance
* @readonly
*/
Object.defineProperty(rune.animation.Animations.prototype, "frame", {
/**
* @this rune.animation.Animations
* @ignore
*/
get : function() {
return this.m_frame;
}
});
//------------------------------------------------------------------------------
// Public prototype methods (API)
//------------------------------------------------------------------------------
/**
* Adds an animation. An animation needs to use a unique ID (name) to be added.
* If an animation with the same name already exists, the new animation will
* not be added.
*
* @param {rune.animation.Animation} animation Animation to be added.
*
* @throws {TypeError} If incorrect data type is used.
*
* @returns {boolean}
*/
rune.animation.Animations.prototype.add = function(animation) {
if (animation instanceof rune.animation.Animation) {
if (this.find(animation['name']) == null) {
if (this.m_animations.push(animation) === 1) {
this.m_animation = this.m_animations[0];
}
return true;
}
return false;
} else throw new TypeError();
};
/**
* Removes all animations.
*
* @returns {undefined}
*/
rune.animation.Animations.prototype.clear = function() {
this.m_animation = null;
while (this.m_animations.length) {
this.m_animations[0].dispose();
this.m_animations[0] = null;
this.m_animations.splice(0, 1);
}
};
/**
* Creates a new animation. After an animation is created, it is automatically
* added to the animation system.
*
* @param {string} name The name of the animation.
* @param {Array.<number>} frames Frame sequence.
* @param {number} framerate Playback speed specified in frames per second.
* @param {boolean} looped Whether or not to loop the animation sequence.
*
* @returns {boolean}
*/
rune.animation.Animations.prototype.create = function(name, frames, framerate, looped) {
var animation = new rune.animation.Animation(
name.toLowerCase(),
frames,
framerate,
looped
);
return this.add(animation);
};
/**
* Search for an animation in the animation system by its name. If no animation
* is found, null is returned.
*
* @param {string} name The name of the animation requested.
*
* @returns {rune.animation.Animation}
*/
rune.animation.Animations.prototype.find = function(name) {
var i = this.m_animations.length;
while (i--) {
if (this.m_animations[i]['name'] == name) {
return this.m_animations[i];
}
}
return null;
};
/**
* Changes the animation sequence and goes to a specific frame in that sequence.
*
* @param {string} name Requested animation.
* @param {number} frame Frame to go to.
*
* @returns {undefined}
*/
rune.animation.Animations.prototype.goto = function(name, frame) {
if (this.m_animation != null && this.m_animation['name'] != name) {
this.m_animation = this.find(name);
if (this.m_animation != null) {
this.m_animation.goto(frame);
}
}
};
/**
* Switches animation sequence and goes to a specific frame in that sequence
* and resumes playback from there.
*
* @param {string} name Requested animation.
* @param {number} frame Frame to go to.
*
* @returns {undefined}
*/
rune.animation.Animations.prototype.gotoAndPlay = function(name, frame) {
this.goto(name, frame);
if (this.m_animation != null) {
this.m_animation.play();
}
};
/**
* Changes the animation sequence and goes to a specific frame in that sequence
* and stops playback on that frame.
*
* @param {string} name Requested animation.
* @param {number} frame Frame to go to.
*
* @returns {undefined}
*/
rune.animation.Animations.prototype.gotoAndStop = function(name, frame) {
this.goto(name, frame);
if (this.m_animation != null) {
this.m_animation.stop();
}
};
/**
* Goes to the next frame in the current animation sequence.
*
* @returns {undefined}
*/
rune.animation.Animations.prototype.gotoNextFrame = function() {
if (this.m_animation != null) {
this.m_animation.gotoNextFrame();
}
};
/**
* Goes to the previous frame in the current animation sequence.
*
* @returns {undefined}
*/
rune.animation.Animations.prototype.gotoPreviousFrame = function() {
if (this.m_animation != null) {
this.m_animation.gotoPreviousFrame();
}
};
/**
* Goes to a random frame in the current animation sequence.
*
* @returns {undefined}
*/
rune.animation.Animations.prototype.gotoRandomFrame = function() {
if (this.m_animation != null) {
this.m_animation.gotoRandomFrame();
}
};
/**
* Plays the current animation sequence. If the animation is stopped, playback
* resumes from the previous position. If the animation is already playing,
* playback continues.
*
* @returns {undefined}
*/
rune.animation.Animations.prototype.play = function() {
if (this.m_animation != null) {
this.m_animation.play();
}
};
/**
* Removes an animation.
*
* @param {string} name Animation to remove.
*
* @returns {boolean}
*/
rune.animation.Animations.prototype.remove = function(name) {
var i = this.m_animations.length;
while (i--) {
if (this.m_animations[i]['name'].toLowerCase() == name.toLowerCase()) {
if (this.m_animation == this.m_animations[i]) {
this.m_animation = null;
}
this.m_animations.splice(i, 1)[0].dispose();
return true;
}
}
return false;
};
/**
* Stops playback of current animation sequence.
*
* @returns {undefined}
*/
rune.animation.Animations.prototype.stop = function() {
if (this.m_animation != null) {
this.m_animation.stop();
}
};
//------------------------------------------------------------------------------
// Public prototype methods (ENGINE)
//------------------------------------------------------------------------------
/**
* Clears memory allocated by this instance.
*
* @returns {undefined}
* @ignore
*/
rune.animation.Animations.prototype.dispose = function() {
this.m_target = null;
this.m_frame = null;
this.clear();
};
/**
* Updates the animation system.
*
* @param {number} step Current time step.
*
* @returns {undefined}
* @ignore
*/
rune.animation.Animations.prototype.update = function(step) {
this.m_updateAnimation(step);
this.m_updateFrame(step);
};
//------------------------------------------------------------------------------
// Private prototype methods
//------------------------------------------------------------------------------
/**
* Updates current animation.
*
* @param {number} step Current time step.
*
* @returns {undefined}
* @private
*/
rune.animation.Animations.prototype.m_updateAnimation = function(step) {
if (this.m_animation != null) {
this.m_animation.update(step);
}
};
/**
* Updates which frame to display in the animation sequence.
*
* @param {number} step Current time step.
*
* @returns {undefined}
* @private
* @suppress {accessControls}
*/
rune.animation.Animations.prototype.m_updateFrame = function(step) {
if (this.m_animation != null && this.m_animation['atlasIndex'] != this.m_atlasIndex) {
this.m_atlasIndex = this.m_animation['atlasIndex'];
this.m_frame.x = this.m_frame.width * this.m_atlasIndex;
this.m_frame.y = 0;
while (this.m_frame.x + this.m_frame.width > this.m_target["texture"]["width"]) {
this.m_frame.y += this.m_frame.height;
this.m_frame.x -= this.m_target["texture"]["width"];
}
this.m_target.breakCache();
}
};</code></pre>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="rune.html">rune</a></li><li><a href="rune.animation.html">animation</a></li><li><a href="rune.camera.html">camera</a></li><li><a href="rune.color.html">color</a></li><li><a href="rune.console.html">console</a></li><li><a href="rune.data.html">data</a></li><li><a href="rune.debug.html">debug</a></li><li><a href="rune.display.html">display</a></li><li><a href="rune.geom.html">geom</a></li><li><a href="rune.input.html">input</a></li><li><a href="rune.media.html">media</a></li><li><a href="rune.net.html">net</a></li><li><a href="rune.particle.html">particle</a></li><li><a href="rune.physics.html">physics</a></li><li><a href="rune.resource.html">resource</a></li><li><a href="rune.scene.html">scene</a></li><li><a href="rune.state.html">state</a></li><li><a href="rune.system.html">system</a></li><li><a href="rune.text.html">text</a></li><li><a href="rune.tilemap.html">tilemap</a></li><li><a href="rune.timer.html">timer</a></li><li><a href="rune.tween.html">tween</a></li><li><a href="rune.ui.html">ui</a></li><li><a href="rune.util.html">util</a></li></ul><h3>Classes</h3><ul><li><a href="rune.animation.Animation.html">Animation</a></li><li><a href="rune.animation.Animations.html">Animations</a></li><li><a href="rune.animation.AnimationScripts.html">AnimationScripts</a></li><li><a href="rune.camera.Camera.html">Camera</a></li><li><a href="rune.camera.CameraFade.html">CameraFade</a></li><li><a href="rune.camera.CameraFlash.html">CameraFlash</a></li><li><a href="rune.camera.Cameras.html">Cameras</a></li><li><a href="rune.camera.CameraShake.html">CameraShake</a></li><li><a href="rune.camera.CameraTargets.html">CameraTargets</a></li><li><a href="rune.camera.CameraTint.html">CameraTint</a></li><li><a href="rune.camera.CameraTintTween.html">CameraTintTween</a></li><li><a href="rune.camera.CameraViewport.html">CameraViewport</a></li><li><a href="rune.color.Color24.html">Color24</a></li><li><a href="rune.color.Color32.html">Color32</a></li><li><a href="rune.color.ColorComponent.html">ColorComponent</a></li><li><a href="rune.console.Console.html">Console</a></li><li><a href="rune.console.ConsoleCommand.html">ConsoleCommand</a></li><li><a href="rune.console.ConsoleCommands.html">ConsoleCommands</a></li><li><a href="rune.console.ConsoleCursor.html">ConsoleCursor</a></li><li><a href="rune.console.ConsoleHistory.html">ConsoleHistory</a></li><li><a href="rune.console.ConsoleInput.html">ConsoleInput</a></li><li><a href="rune.console.ConsoleManager.html">ConsoleManager</a></li><li><a href="rune.console.ConsoleOutput.html">ConsoleOutput</a></li><li><a href="rune.data.Highscores.html">Highscores</a></li><li><a href="rune.data.Loader.html">Loader</a></li><li><a href="rune.data.LoaderDebug.html">LoaderDebug</a></li><li><a href="rune.data.Logo.html">Logo</a></li><li><a href="rune.data.Requests.html">Requests</a></li><li><a href="rune.debug.Debugger.html">Debugger</a></li><li><a href="rune.debug.Framerate.html">Framerate</a></li><li><a href="rune.debug.Histogram.html">Histogram</a></li><li><a href="rune.debug.Master.html">Master</a></li><li><a href="rune.debug.Memory.html">Memory</a></li><li><a href="rune.debug.Music.html">Music</a></li><li><a href="rune.debug.Render.html">Render</a></li><li><a href="rune.debug.Sound.html">Sound</a></li><li><a href="rune.debug.Update.html">Update</a></li><li><a href="rune.display.Artboard.html">Artboard</a></li><li><a href="rune.display.Canvas.html">Canvas</a></li><li><a href="rune.display.DisplayGroup.html">DisplayGroup</a></li><li><a href="rune.display.DisplayGroups.html">DisplayGroups</a></li><li><a href="rune.display.DisplayObject.html">DisplayObject</a></li><li><a href="rune.display.DisplayObjectContainer.html">DisplayObjectContainer</a></li><li><a href="rune.display.Flicker.html">Flicker</a></li><li><a href="rune.display.Frame.html">Frame</a></li><li><a href="rune.display.Graphic.html">Graphic</a></li><li><a href="rune.display.Graphics.html">Graphics</a></li><li><a href="rune.display.Hitbox.html">Hitbox</a></li><li><a href="rune.display.InteractiveObject.html">InteractiveObject</a></li><li><a href="rune.display.Quadtree.html">Quadtree</a></li><li><a href="rune.display.RepeatedGraphic.html">RepeatedGraphic</a></li><li><a href="rune.display.Screen.html">Screen</a></li><li><a href="rune.display.Sprite.html">Sprite</a></li><li><a href="rune.display.Stage.html">Stage</a></li><li><a href="rune.display.Texture.html">Texture</a></li><li><a href="rune.geom.Point.html">Point</a></li><li><a href="rune.geom.Rectangle.html">Rectangle</a></li><li><a href="rune.geom.Vector2D.html">Vector2D</a></li><li><a href="rune.input.Gamepad.html">Gamepad</a></li><li><a href="rune.input.Gamepads.html">Gamepads</a></li><li><a href="rune.input.GamepadsOptions.html">GamepadsOptions</a></li><li><a href="rune.input.Inputs.html">Inputs</a></li><li><a href="rune.input.Keyboard.html">Keyboard</a></li><li><a href="rune.input.KeyboardKey.html">KeyboardKey</a></li><li><a href="rune.input.KeyboardOptions.html">KeyboardOptions</a></li><li><a href="rune.media.Sound.html">Sound</a></li><li><a href="rune.media.SoundChannel.html">SoundChannel</a></li><li><a href="rune.media.Sounds.html">Sounds</a></li><li><a href="rune.net.URLLoader.html">URLLoader</a></li><li><a href="rune.net.URLRequest.html">URLRequest</a></li><li><a href="rune.net.URLResponse.html">URLResponse</a></li><li><a href="rune.particle.Emitter.html">Emitter</a></li><li><a href="rune.particle.EmitterOptions.html">EmitterOptions</a></li><li><a href="rune.particle.Particle.html">Particle</a></li><li><a href="rune.physics.Space.html">Space</a></li><li><a href="rune.physics.Velocity.html">Velocity</a></li><li><a href="rune.resource.Request.html">Request</a></li><li><a href="rune.resource.Requester.html">Requester</a></li><li><a href="rune.resource.RequesterOptions.html">RequesterOptions</a></li><li><a href="rune.resource.Requests.html">Requests</a></li><li><a href="rune.resource.Resource.html">Resource</a></li><li><a href="rune.resource.Resources.html">Resources</a></li><li><a href="rune.scene.Scene.html">Scene</a></li><li><a href="rune.scene.Scenes.html">Scenes</a></li><li><a href="rune.state.State.html">State</a></li><li><a href="rune.state.States.html">States</a></li><li><a href="rune.system.Application.html">Application</a></li><li><a href="rune.system.Config.html">Config</a></li><li><a href="rune.system.Time.html">Time</a></li><li><a href="rune.text.BitmapField.html">BitmapField</a></li><li><a href="rune.text.BitmapFormat.html">BitmapFormat</a></li><li><a href="rune.tilemap.Block.html">Block</a></li><li><a href="rune.tilemap.Tile.html">Tile</a></li><li><a href="rune.tilemap.Tilemap.html">Tilemap</a></li><li><a href="rune.tilemap.TilemapLayer.html">TilemapLayer</a></li><li><a href="rune.timer.Timer.html">Timer</a></li><li><a href="rune.timer.TimerOptions.html">TimerOptions</a></li><li><a href="rune.timer.Timers.html">Timers</a></li><li><a href="rune.tween.Circular.html">Circular</a></li><li><a href="rune.tween.Cubic.html">Cubic</a></li><li><a href="rune.tween.Expo.html">Expo</a></li><li><a href="rune.tween.Linear.html">Linear</a></li><li><a href="rune.tween.Quad.html">Quad</a></li><li><a href="rune.tween.Quart.html">Quart</a></li><li><a href="rune.tween.Quint.html">Quint</a></li><li><a href="rune.tween.Sine.html">Sine</a></li><li><a href="rune.tween.Tween.html">Tween</a></li><li><a href="rune.tween.Tweens.html">Tweens</a></li><li><a href="rune.tween.TweenValue.html">TweenValue</a></li><li><a href="rune.ui.Counter.html">Counter</a></li><li><a href="rune.ui.CounterDigit.html">CounterDigit</a></li><li><a href="rune.ui.Progressbar.html">Progressbar</a></li><li><a href="rune.ui.VTList.html">VTList</a></li><li><a href="rune.ui.VTListElement.html">VTListElement</a></li><li><a href="rune.ui.VTMenu.html">VTMenu</a></li><li><a href="rune.ui.VTMenuPointer.html">VTMenuPointer</a></li><li><a href="rune.util.Executable.html">Executable</a></li><li><a href="rune.util.Filter.html">Filter</a></li><li><a href="rune.util.Math.html">Math</a></li><li><a href="rune.util.Palette.html">Palette</a></li><li><a href="rune.util.Path.html">Path</a></li><li><a href="rune.util.Paths.html">Paths</a></li><li><a href="rune.util.Stack.html">Stack</a></li><li><a href="rune.util.URL.html">URL</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Tue Apr 01 2025 09:55:09 GMT+0200 (Central European Summer Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>