-
Notifications
You must be signed in to change notification settings - Fork 0
/
base_Timeline.js.html
520 lines (442 loc) · 18.3 KB
/
base_Timeline.js.html
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
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Source: base/Timeline.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: base/Timeline.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>/*
* Copyright 2020 WICKLETS LLC
*
* This file is part of Wick Engine.
*
* Wick Engine is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Wick Engine is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Wick Engine. If not, see <https://www.gnu.org/licenses/>.
*/
/**
* Class representing a Wick Timeline.
*/
Wick.Timeline = class extends Wick.Base {
/**
* Create a timeline.
*/
constructor (args) {
super(args);
this._playheadPosition = 1;
this._activeLayerIndex = 0;
this._playing = true;
this._forceNextFrame = null;
this._fillGapsMethod = "auto_extend";
}
_serialize (args) {
var data = super._serialize(args);
data.playheadPosition = this._playheadPosition;
data.activeLayerIndex = this._activeLayerIndex;
return data;
}
_deserialize (data) {
super._deserialize(data);
this._playheadPosition = data.playheadPosition;
this._activeLayerIndex = data.activeLayerIndex;
this._playing = true;
this._forceNextFrame = null;
}
get classname () {
return 'Timeline';
}
/**
* The layers that belong to this timeline.
* @type {Wick.Layer}
*/
get layers () {
return this.getChildren('Layer');
}
/**
* The position of the playhead. Determines which frames are visible.
* @type {number}
*/
get playheadPosition () {
return this._playheadPosition;
}
set playheadPosition (playheadPosition) {
// Automatically clear selection when any playhead in the project moves
if(this.project && this._playheadPosition !== playheadPosition && this.parentClip.isFocus) {
this.project.selection.clear('Canvas');
}
this._playheadPosition = playheadPosition;
if(this._playheadPosition < 1) {
this._playheadPosition = 1;
}
// Automatically apply tween transforms on child frames when playhead moves
this.activeFrames.forEach(frame => {
frame.applyTweenTransforms();
frame.updateClipTimelinesForAnimationType();
});
}
/**
* The index of the active layer. Determines which frame to draw onto.
* @type {number}
*/
get activeLayerIndex () {
return this._activeLayerIndex;
}
set activeLayerIndex (activeLayerIndex) {
this._activeLayerIndex = activeLayerIndex;
}
/**
* The total length of the timeline.
* @type {number}
*/
get length () {
var length = 0;
this.layers.forEach(function (layer) {
var layerLength = layer.length;
if(layerLength > length) {
length = layerLength;
}
});
return length;
}
/**
* The active layer.
* @type {Wick.Layer}
*/
get activeLayer () {
return this.layers[this.activeLayerIndex];
}
/**
* The active frames, determined by the playhead position.
* @type {Wick.Frame[]}
*/
get activeFrames () {
var frames = [];
this.layers.forEach(layer => {
var layerFrame = layer.activeFrame;
if(layerFrame) {
frames.push(layerFrame);
}
});
return frames;
}
/**
* The active frame, determined by the playhead position.
* @type {Wick.Frame}
*/
get activeFrame () {
return this.activeLayer && this.activeLayer.activeFrame;
}
/**
* All frames inside the timeline.
* @type {Wick.Frame[]}
*/
get frames () {
var frames = [];
this.layers.forEach(layer => {
layer.frames.forEach(frame => {
frames.push(frame);
});
});
return frames;
}
/**
* All clips inside the timeline.
* @type {Wick.Clip[]}
*/
get clips () {
var clips = [];
this.frames.forEach(frame => {
clips = clips.concat(frame.clips);
});
return clips;
}
/**
* Finds the frame with a given name.
* @type {Wick.Frame|null}
*/
getFrameByName (name) {
return this.frames.find(frame => {
return frame.name === name;
}) || null;
}
/**
* Add a frame to one of the layers on this timeline. If there is no layer where the frame wants to go, the frame will not be added.
* @param {Wick.Frame} frame - the frame to add
*/
addFrame (frame) {
if(frame.originalLayerIndex >= this.layers.length) return;
if(frame.originalLayerIndex === -1) {
this.activeLayer.addFrame(frame);
} else {
this.layers[frame.originalLayerIndex].addFrame(frame);
}
}
/**
* Adds a layer to the timeline.
* @param {Wick.Layer} layer - The layer to add.
*/
addLayer (layer) {
this.addChild(layer);
if(!layer.name) {
if(this.layers.length > 1) {
layer.name = "Layer " + this.layers.length;
} else {
layer.name = "Layer";
}
}
}
/**
* Adds a tween to a frame on this timeline.
* @param {Wick.Tween} tween - the tween to add.
*/
addTween (tween) {
if(tween.originalLayerIndex >= this.layers.length) return;
if(tween.originalLayerIndex === -1) {
this.activeLayer.addTween(tween);
} else {
this.layers[tween.originalLayerIndex].addTween(tween);
}
}
/**
* Remmoves a layer from the timeline.
* @param {Wick.Layer} layer - The layer to remove.
*/
removeLayer (layer) {
// You can't remove the last layer.
if(this.layers.length <= 1) {
return;
}
// Activate the layer below the removed layer if we removed the active layer.
if(this.activeLayerIndex === this.layers.length - 1) {
this.activeLayerIndex--;
}
this.removeChild(layer);
}
/**
* Moves a layer to a different position, inserting it before/after other layers if needed.
* @param {Wick.Layer} layer - The layer to add.
* @param {number} index - the new position to move the layer to.
*/
moveLayer (layer, index) {
var layers = this.getChildren('Layer');
layers.splice(layers.indexOf(layer), 1);
layers.splice(index, 0, layer);
}
/**
* Gets the frames at the given playhead position.
* @param {number} playheadPosition - the playhead position to search.
* @returns {Wick.Frame[]} The frames at the playhead position.
*/
getFramesAtPlayheadPosition (playheadPosition) {
var frames = [];
this.layers.forEach(layer => {
var frame = layer.getFrameAtPlayheadPosition(playheadPosition);
if(frame) frames.push(frame);
});
return frames;
}
/**
* Get all frames in this timeline.
* @param {boolean} recursive - If set to true, will also include the children of all child timelines.
*/
getAllFrames (recursive) {
var allFrames = [];
this.layers.forEach(layer => {
allFrames = allFrames.concat(layer.frames);
if(recursive) {
layer.frames.forEach(frame => {
frame.clips.forEach(clip => {
allFrames = allFrames.concat(clip.timeline.getAllFrames(recursive));
});
});
}
});
return allFrames;
}
/**
* Gets all frames in the layer that are between the two given playhead positions and layer indices.
* @param {number} playheadPositionStart - The start of the horizontal range to search
* @param {number} playheadPositionEnd - The end of the horizontal range to search
* @param {number} layerIndexStart - The start of the vertical range to search
* @param {number} layerIndexEnd - The end of the vertical range to search
* @return {Wick.Frame[]} The frames in the given range.
*/
getFramesInRange (playheadPositionStart, playheadPositionEnd, layerIndexStart, layerIndexEnd) {
var framesInRange = [];
this.layers.filter(layer => {
return layer.index >= layerIndexStart
&& layer.index <= layerIndexEnd;
}).forEach(layer => {
framesInRange = framesInRange.concat(layer.getFramesInRange(playheadPositionStart, playheadPositionEnd));
})
return framesInRange;
}
/**
* Advances the timeline one frame forwards. Loops back to beginning if the end is reached.
*/
advance () {
if(this._forceNextFrame) {
this.playheadPosition = this._forceNextFrame;
this._forceNextFrame = null;
} else if(this._playing) {
this.playheadPosition ++;
if(this.playheadPosition > this.length) {
this.playheadPosition = 1;
}
}
}
/**
* Makes the timeline advance automatically during ticks.
*/
play () {
this._playing = true;
}
/**
* Stops the timeline from advancing during ticks.
*/
stop () {
this._playing = false;
}
/**
* Stops the timeline and moves to a given frame number or name.
* @param {string|number} frame - A playhead position or name of a frame to move to.
*/
gotoAndStop (frame) {
this.stop();
this.gotoFrame(frame);
}
/**
* Plays the timeline and moves to a given frame number or name.
* @param {string|number} frame - A playhead position or name of a frame to move to.
*/
gotoAndPlay (frame) {
this.play();
this.gotoFrame(frame);
}
/**
* Moves the timeline forward one frame. Loops back to 1 if gotoNextFrame moves the playhead past the past frame.
*/
gotoNextFrame () {
// Loop back to beginning if gotoNextFrame goes past the last frame
var nextFramePlayheadPosition = this.playheadPosition + 1;
if(nextFramePlayheadPosition > this.length) {
nextFramePlayheadPosition = 1;
}
this.gotoFrame(nextFramePlayheadPosition);
}
/**
* Moves the timeline backwards one frame. Loops to the last frame if gotoPrevFrame moves the playhead before the first frame.
*/
gotoPrevFrame () {
var prevFramePlayheadPosition = this.playheadPosition - 1;
if(prevFramePlayheadPosition <= 0) {
prevFramePlayheadPosition = this.length;
}
this.gotoFrame(prevFramePlayheadPosition);
}
/**
* Moves the playhead to a given frame number or name.
* @param {string|number} frame - A playhead position or name of a frame to move to.
*/
gotoFrame (frame) {
if(typeof frame === 'string') {
var namedFrame = this.frames.find(seekframe => {
return seekframe.identifier === frame && !seekframe.onScreen;
});
if(namedFrame) {
this._forceNextFrame = namedFrame.start;
}
} else if (typeof frame === 'number') {
this._forceNextFrame = frame;
} else {
throw new Error('gotoFrame: Invalid argument: ' + frame);
}
}
/**
* The method to use to fill gaps in-beteen frames. Options: "blank_frames" or "auto_extend" (see Wick.Layer.resolveGaps)
* @type {string}
*/
get fillGapsMethod () {
return this._fillGapsMethod;
}
set fillGapsMethod (fillGapsMethod) {
if(fillGapsMethod === 'blank_frames' || fillGapsMethod === 'auto_extend') {
this._fillGapsMethod = fillGapsMethod;
} else {
console.warn('Warning: Invalid fillGapsMethod: ' + fillGapsMethod);
console.warn('Valid fillGapsMethod: "blank_frames", "auto_extend"');
}
}
/**
* Check if frame gap fixing should be deferred until later. Read only.
* @type {boolean}
*/
get waitToFillFrameGaps () {
return this._waitToFillFrameGaps;
}
/**
* Disables frame gap filling until resolveFrameGaps is called again.
*/
deferFrameGapResolve () {
this._waitToFillFrameGaps = true;
}
/**
* Fill in all gaps between frames in all layers in this timeline.
* @param {Wick.Frame[]} newOrModifiedFrames - The frames that should not be affected by the gap fill by being extended or shrunk.
*/
resolveFrameGaps (newOrModifiedFrames) {
if(!newOrModifiedFrames) newOrModifiedFrames = [];
this._waitToFillFrameGaps = false;
this.layers.forEach(layer => {
layer.resolveGaps(newOrModifiedFrames.filter(frame => {
return frame.parentLayer === layer;
}));
});
}
/**
* Prevents frames from overlapping each other by removing pieces of frames that are touching.
* @param {Wick.Frame[]} newOrModifiedFrames - the frames that should take precedence when determining which frames should get "eaten".
*/
resolveFrameOverlap (frames) {
this.layers.forEach(layer => {
layer.resolveOverlap(frames.filter(frame => {
return frame.parentLayer === layer;
}));
});
}
}
</code></pre>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BuiltinAssets.html">BuiltinAssets</a></li><li><a href="GlobalAPI.html">GlobalAPI</a></li><li><a href="paper.SelectionGUI.html">SelectionGUI</a></li><li><a href="paper-paper.Selection.html">Selection</a></li><li><a href="SelectionWidget.html">SelectionWidget</a></li><li><a href="Wick.AutoSave.html">AutoSave</a></li><li><a href="Wick.Base.html">Base</a></li><li><a href="Wick.Button.html">Button</a></li><li><a href="Wick.Clip.html">Clip</a></li><li><a href="Wick.Clipboard.html">Clipboard</a></li><li><a href="Wick.FileCache.html">FileCache</a></li><li><a href="Wick.Frame.html">Frame</a></li><li><a href="Wick.GUIElement.Project.html">Project</a></li><li><a href="Wick.GUIElement.Timeline.html">Timeline</a></li><li><a href="Wick.GUIElement-Wick.GUIElement.Breadcrumbs.html">Breadcrumbs</a></li><li><a href="Wick.GUIElement-Wick.GUIElement.Button.html">Button</a></li><li><a href="Wick.History.html">History</a></li><li><a href="Wick.HTMLExport.html">HTMLExport</a></li><li><a href="Wick.HTMLPreview.html">HTMLPreview</a></li><li><a href="Wick.ImageSequence.html">ImageSequence</a></li><li><a href="Wick.Layer.html">Layer</a></li><li><a href="Wick.Path.html">Path</a></li><li><a href="Wick.Project.html">Project</a></li><li><a href="Wick.Selection.html">Selection</a></li><li><a href="Wick.Tickable.html">Tickable</a></li><li><a href="Wick.Timeline.html">Timeline</a></li><li><a href="Wick.Tools-Wick.Tools.Brush.html">Brush</a></li><li><a href="Wick.Tools-Wick.Tools.Cursor.html">Cursor</a></li><li><a href="Wick.Tools-Wick.Tools.Ellipse.html">Ellipse</a></li><li><a href="Wick.Tools-Wick.Tools.Eraser.html">Eraser</a></li><li><a href="Wick.Tools-Wick.Tools.Eyedropper.html">Eyedropper</a></li><li><a href="Wick.Tools-Wick.Tools.FillBucket.html">FillBucket</a></li><li><a href="Wick.Tools-Wick.Tools.Interact.html">Interact</a></li><li><a href="Wick.Tools-Wick.Tools.Line.html">Line</a></li><li><a href="Wick.Tools-Wick.Tools.None.html">None</a></li><li><a href="Wick.Tools-Wick.Tools.Pan.html">Pan</a></li><li><a href="Wick.Tools-Wick.Tools.Pencil.html">Pencil</a></li><li><a href="Wick.Tools-Wick.Tools.Rectangle.html">Rectangle</a></li><li><a href="Wick.Tools-Wick.Tools.Text.html">Text</a></li><li><a href="Wick.Tools-Wick.Tools.Zoom.html">Zoom</a></li><li><a href="Wick.Transformation.html">Transformation</a></li><li><a href="Wick.Tween.html">Tween</a></li><li><a href="Wick.View-Wick.View.Clip.html">Clip</a></li><li><a href="Wick.View-Wick.View.Frame.html">Frame</a></li><li><a href="Wick.View-Wick.View.Path.html">Path</a></li><li><a href="Wick.View-Wick.View.Selection.html">Selection</a></li><li><a href="Wick.WickFile.html">WickFile</a></li><li><a href="Wick.WickObjectFile.html">WickObjectFile</a></li><li><a href="Wick.ZIPExport.html">ZIPExport</a></li><li><a href="WickObjectCache.html">WickObjectCache</a></li><li><a href="Wick-Wick.Asset.html">Asset</a></li><li><a href="Wick-Wick.AudioTrack.html">AudioTrack</a></li><li><a href="Wick-Wick.ClipAsset.html">ClipAsset</a></li><li><a href="Wick-Wick.Color.html">Color</a></li><li><a href="Wick-Wick.FileAsset.html">FileAsset</a></li><li><a href="Wick-Wick.FontAsset.html">FontAsset</a></li><li><a href="Wick-Wick.GIFAsset.html">GIFAsset</a></li><li><a href="Wick-Wick.GUIElement.html">GUIElement</a></li><li><a href="Wick-Wick.ImageAsset.html">ImageAsset</a></li><li><a href="Wick-Wick.SoundAsset.html">SoundAsset</a></li><li><a href="Wick-Wick.SVGAsset.html">SVGAsset</a></li><li><a href="Wick-Wick.Tool.html">Tool</a></li><li><a href="Wick-Wick.ToolSettings.html">ToolSettings</a></li><li><a href="Wick-Wick.View.html">View</a></li></ul><h3>Global</h3><ul><li><a href="global.html#type">type</a></li><li><a href="global.html#Wick">Wick</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.4</a> on Fri Apr 24 2020 15:26:13 GMT-0400 (Eastern Daylight Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>