-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathbase_Tickable.js.html
More file actions
634 lines (530 loc) · 22.4 KB
/
base_Tickable.js.html
File metadata and controls
634 lines (530 loc) · 22.4 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
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
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Source: base/Tickable.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/Tickable.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/>.
*/
/**
* A class that is extended by any wick object that ticks.
*/
Wick.Tickable = class extends Wick.Base {
/**
* Debugging feature. Logs errors as they happen
*/
static get LOG_ERRORS () {
return false;
}
/**
* Returns a list of all possible events for this object.
* @return {string[]} Array of all possible scripts.
*/
static get possibleScripts () {
return [
'default',
'mouseenter',
'mousedown',
'mousepressed',
'mousereleased',
'mouseleave',
'mousehover',
'mousedrag',
'mouseclick',
'keypressed',
'keyreleased',
'keydown',
'load',
'update',
'unload',
];
}
/**
* Create a new tickable object.
*/
constructor (args) {
if(!args) args = {};
super(args);
this._onscreen = false;
this._onscreenLastTick = false;
this._mouseState = 'out';
this._lastMouseState = 'out';
this._isClickTarget = false;
this._scripts = [];
this.cursor = 'default';
this.addScript('default', '');
this._onEventFns = {};
this._cachedScripts = {};
}
_deserialize (data) {
super._deserialize(data);
this._onscreen = false;
this._onscreenLastTick = false;
this._mouseState = 'out';
this._lastMouseState = 'out';
this._scripts = JSON.parse(JSON.stringify(data.scripts));
this.cursor = data.cursor;
this._onEventFns = {};
this._cachedScripts = {};
}
_serialize (args) {
var data = super._serialize(args);
data.scripts = JSON.parse(JSON.stringify(this._scripts));
data.cursor = this.cursor;
return data;
}
get classname () {
return 'Tickable';
}
/**
* The scripts on this object.
* @type {object[]}
*/
get scripts () {
return this._scripts;
}
/**
* Checks if this object has a non-empty script.
* @type {boolean}
*/
get hasContentfulScripts () {
var hasContentfulScripts = false;
this._scripts.forEach(script => {
if(hasContentfulScripts) return;
if(script.src !== '') {
hasContentfulScripts = true;
}
})
return hasContentfulScripts;
}
/**
* Check if this object is currently visible in the project, based on its parent.
* @type {boolean}
*/
get onScreen () {
if(!this.parent) return false;
return this.parent.onScreen;
}
/**
* Add a function to be called when an event happens.
* @param {string} name - The name of the event to attach the function to.
* @param {function} fn - The function to call when the given event happens.
*/
onEvent (name, fn) {
if(Wick.Tickable.possibleScripts.indexOf(name) === -1) {
console.warn("onEvent: " + name + " is not a valid event name.");
return;
}
this.addEventFn(name, fn);
}
/**
* Attach a function to a given event.
* @param {string} name - the name of the event to attach a function to.
* @param {function} fn - the function to attach
*/
addEventFn (name, fn) {
this.getEventFns(name).push(fn);
}
/**
* Gets all functions attached to an event with a given name.
* @param {string} - The name of the event
*/
getEventFns (name) {
if(!this._onEventFns[name]) {
this._onEventFns[name] = [];
}
return this._onEventFns[name];
}
/**
* Check if an object can have scripts attached to it. Helpful when iterating through a lot of different wick objects that may or may not be tickables. Always returns true.
* @type {boolean}
*/
get isScriptable () {
return true;
}
/**
* Add a new script to an object.
* @param {string} name - The name of the event that will trigger the script. See Wick.Tickable.possibleScripts
* @param {string} src - The source code of the new script.
*/
addScript (name, src) {
if(Wick.Tickable.possibleScripts.indexOf(name) === -1) console.error(name + ' is not a valid script!');
if(this.hasScript(name)) {
this.updateScript(name, src);
return;
}
this._scripts.push({
name: name,
src: '',
});
// Sort scripts by where they appear in the possibleScripts list
var possibleScripts = Wick.Tickable.possibleScripts;
this._scripts.sort((a,b) => {
return possibleScripts.indexOf(a.name) - possibleScripts.indexOf(b.name);
});
if(src) {
this.updateScript(name, src);
}
}
/**
* Get the script of this object that is triggered when the given event name happens.
* @param {string} name - The name of the event. See Wick.Tickable.possibleScripts
* @returns {object} the script with the given name. Can be null if the object doesn't have that script.
*/
getScript (name) {
if(Wick.Tickable.possibleScripts.indexOf(name) === -1) console.error(name + ' is not a valid script!');
return this._scripts.find(script => {
return script.name === name;
});
}
/**
* Returns a list of script names which are not currently in use for this object.
* @return {string[]} Available script names.
*/
getAvailableScripts () {
return Wick.Tickable.possibleScripts.filter(script => !this.hasScript(script));
}
/**
* Check if the object has a script with the given event name.
* @param {string} name - The name of the event. See Wick.Tickable.possibleScripts
* @returns {boolean} True if the script with the given name exists
*/
hasScript (name) {
return this.getScript(name) !== undefined;
}
/**
* Check if the object has a non-empty script with a given name.
* @param {string} name - The name of the event. See Wick.Tickable.possibleScripts
* @returns {boolean} True if the script with the given name has code
*/
scriptIsContentful (name) {
if(!this.hasScript(name)) {
return false;
}
var script = this.getScript(name);
return script.src.trim() !== '';
}
/**
* Changes the source of the script with the given event name.
* @param {string} name - The name of the event that will trigger the script. See Wick.Tickable.possibleScripts
* @param {string} src - The source code of the script.
*/
updateScript (name, src) {
this.getScript(name).src = src;
delete this._cachedScripts[name];
}
/**
* Remove the script that corresponds to a given event name.
* @param {string} name - The name of the event. See Wick.Tickable.possibleScripts
*/
removeScript (name) {
this._scripts = this._scripts.filter(script => {
return script.name !== name;
});
}
/**
* Schedule a script to run at the end of the tick.
* @param {string} name - The name of the script to run. See Tickable.possibleScripts
* @param {Object} parameters - An object consisting of key,value pairs which correspond to parameters to pass to the script.
*/
scheduleScript (name, parameters) {
if(!this.project) return;
this.project.scheduleScript(this.uuid, name, parameters);
}
/**
* Run the script with the corresponding event name.
* @param {string} name - The name of the event. See Wick.Tickable.possibleScripts
* @param {Object} parameters - An object containing key,value pairs of parameters to send to the script.
* @returns {object} object containing error info if an error happened. Returns null if there was no error (script ran successfully)
*/
runScript (name, parameters) {
if(!Wick.Tickable.possibleScripts.indexOf(name) === -1) {
console.error(name + ' is not a valid script!');
}
// Don't run scripts if this object is the focus
// (this makes it so preview play will always play, even if the parent Clip of the timeline has a stop script)
if(this.project && this.project.focus === this) {
return null;
}
// Run functions attached using onEvent
var eventFnError = null;
this.getEventFns(name).forEach(eventFn => {
if(eventFnError) return;
eventFnError = this._runFunction(eventFn, name, parameters);
});
if(eventFnError) {
this.project.error = eventFnError;
return;
}
// Run function inside tab
if(this.scriptIsContentful(name)) {
var script = this.getScript(name);
var fn = this._cachedScripts[name] || this._evalScript(name, script.src);
if(!(fn instanceof Function)) {
return fn; // error
}
this._cachedScripts[name] = fn;
var error = this._runFunction(fn, name, parameters);
if(error) {
this.project.error = error;
return;
}
}
}
/**
* The tick routine to be called when the object ticks.
* @returns {object} - An object with information about the result from ticking. Null if no errors occured, and the script ran successfully.
*/
tick () {
// Update named child references
this._attachChildClipReferences();
// Update onScreen flags.
this._onscreenLastTick = this._onscreen;
this._onscreen = this.onScreen;
// Update mouse states.
this._lastMouseState = this._mouseState;
if(this.project && this.project.objectIsMouseTarget(this)) {
if(this.project.isMouseDown) {
this._mouseState = 'down';
} else {
this._mouseState = 'over';
}
} else {
this._mouseState = 'out';
}
// Call tick event function that corresponds to state.
if(!this._onscreen && !this._onscreenLastTick) {
this._onInactive();
} else if (this._onscreen && !this._onscreenLastTick) {
this._onActivated();
} else if (this._onscreen && this._onscreenLastTick) {
this._onActive();
} else if (!this._onscreen && this._onscreenLastTick) {
this._onDeactivated();
}
}
_onInactive () {
// Do nothing.
}
_onActivated () {
this.scheduleScript('default');
this.scheduleScript('load');
}
_onActive () {
this.scheduleScript('update');
var current = this._mouseState;
var last = this._lastMouseState;
// Mouse enter
if(last === 'out' && current !== 'out') {
this.scheduleScript('mouseenter');
}
// Mouse down
if(current === 'down') {
this.scheduleScript('mousedown');
}
// Mouse pressed
if(last === 'over' && current === 'down') {
this._isClickTarget = true;
this.scheduleScript('mousepressed');
}
// Mouse click
if(last === 'down' && current === 'over' && this._isClickTarget) {
this.scheduleScript('mouseclick');
}
// Mouse released
if(last === 'down' && current === 'over') {
this._isClickTarget = false;
this.scheduleScript('mousereleased');
}
// Mouse leave
if(last !== 'out' && current === 'out') {
this.scheduleScript('mouseleave');
}
// Mouse hover
if(current === 'over') {
this.scheduleScript('mousehover');
}
// Mouse drag
if(last === 'down' && current === 'down') {
this.scheduleScript('mousedrag');
}
// Key down
this.project.keysDown.forEach(key => {
this.project.currentKey = key;
this.scheduleScript('keydown', {key: key});
});
// Key press
this.project.keysJustPressed.forEach(key => {
this.project.currentKey = key;
this.scheduleScript('keypressed', {key: key});
});
// Key released
this.project.keysJustReleased.forEach(key => {
this.project.currentKey = key;
this.scheduleScript('keyreleased', {key: key});
});
}
_onDeactivated () {
this._isClickTarget = false;
this.scheduleScript('unload');
}
_evalScript (name, src) {
var fn = null;
// Check for syntax/parsing errors
try {
esprima.parseScript(src);
} catch (e) {
this.project.error = this._generateEsprimaErrorInfo(e, name);
return;
}
// Attempt to create valid function...
try {
fn = new Function([], src);
} catch (e) {
// This should almost never be thrown unless there is an attempt to use syntax
// that the syntax checker (esprima) does not understand.
this.project.error = this._generateErrorInfo(e, name);
return;
}
return fn;
}
/**
* _runFunction runs an event function while passing in necessary global and local parameters.
* @param {string} fn - Function to run.
* @param {string} name - Name of the event function being run (i.e. keyDown)
* @param {Object} parameters - An object of key,value pairs to be passed as parameters to the function.
*/
_runFunction (fn, name, parameters) {
var error = null;
// Attach API methods
var globalAPI = new GlobalAPI(this);
var otherObjects = this.parentClip ? this.parentClip.activeNamedChildren : [];
var apiMembers = globalAPI.apiMembers.concat(otherObjects.map(otherObject => {
return {
name: otherObject.identifier,
fn: otherObject,
}
}));
// Add in parameters, if necessary.
if (parameters) {
Object.keys(parameters).forEach(parameter => {
apiMembers.push({
name: parameter,
fn: parameters[parameter],
})
});
}
apiMembers.forEach(apiMember => {
window[apiMember.name] = apiMember.fn;
});
// These are currently hacked in here for performance reasons...
var project = this.project;
var root = project && project.root;
window.project = root;
if(project) {
window.project.resolution = {x: project.width, y: project.height};
window.project.framerate = project.framerate;
window.project.backgroundColor = project.backgroundColor;
}
window.root = root;
window.parent = this.parentClip;
window.parentObject = this.parentObject;
// Run the function
var thisScope = this instanceof Wick.Frame ? this.parentClip : this;
try {
fn.bind(thisScope)();
} catch (e) {
// Catch runtime errors
error = this._generateErrorInfo(e, name);
}
// These are currently hacked in here for performance reasons...
delete window.project;
delete window.root;
delete window.parent;
delete window.parentObject;
// Detatch API methods
apiMembers.forEach(apiMember => {
delete window[apiMember.name];
});
return error;
}
_generateErrorInfo (error, name) {
if(Wick.Tickable.LOG_ERRORS) console.log(error);
return {
name: name !== undefined ? name : '',
lineNumber: this._generateLineNumberFromStackTrace(error.stack),
message: error.message,
uuid: this.isClone ? this.sourceClipUUID : this.uuid,
}
}
_generateEsprimaErrorInfo (error, name) {
if(Wick.Tickable.LOG_ERRORS) console.log(error);
return {
name: name !== undefined ? name : '',
lineNumber: error.lineNumber,
message: error.description,
uuid: this.uuid,
}
}
_generateLineNumberFromStackTrace (trace) {
var lineNumber = null;
trace.split('\n').forEach(line => {
if(lineNumber !== null) return;
var split = line.split(':');
var lineString = split[split.length-2];
var lineInt = parseInt(lineString);
if(!isNaN(lineInt)) {
lineNumber = lineInt - 2;
lineNumber = lineInt;
lineNumber = lineNumber - 2;
}
});
return lineNumber;
}
_attachChildClipReferences () {
// Implemented by Wick.Clip and Wick.Frame.
}
}
</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>