-
Notifications
You must be signed in to change notification settings - Fork 7
/
modules_project.js.html
418 lines (337 loc) · 32.4 KB
/
modules_project.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
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>modules/project.js</title>
<link type="text/css" rel="stylesheet" href="github.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
<link type="text/css" rel="stylesheet" href="custom.css">
<script src="scripts/highlight.js"></script>
<script src="scripts/linenumber.js"></script>
<script>hljs && hljs.initHighlightingOnLoad();</script>
</head>
<body>
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
</label>
<label for="nav-trigger" class="overlay"></label>
<div class="page">
<header class="page-header">
<h1 class="project-name">
<a href="/">aequery</a>
</h1>
<h2 class="project-tagline">
General purpose after effects scripting library
</h2>
<h2 class="project-version">
0.2.0
</h2>
</header>
<div class="page-contents">
<nav class="sidebar">
<h2 class="home"><a href="index.html">Home</a></h2><h3 data-name="Classes">Classes</h3><ul><li><a href="aeq.arrayEx.html">arrayEx</a><ul class='methods'><li data-type='method'><a href="aeq.arrayEx.html#.attr">attr</a></li><li data-type='method'><a href="aeq.arrayEx.html#.exists">exists</a></li><li data-type='method'><a href="aeq.arrayEx.html#.filter">filter</a></li><li data-type='method'><a href="aeq.arrayEx.html#.find">find</a></li><li data-type='method'><a href="aeq.arrayEx.html#.first">first</a></li><li data-type='method'><a href="aeq.arrayEx.html#.forEach">forEach</a></li><li data-type='method'><a href="aeq.arrayEx.html#.indexOf">indexOf</a></li><li data-type='method'><a href="aeq.arrayEx.html#.insertAt">insertAt</a></li><li data-type='method'><a href="aeq.arrayEx.html#.isTrueForAll">isTrueForAll</a></li><li data-type='method'><a href="aeq.arrayEx.html#.map">map</a></li><li data-type='method'><a href="aeq.arrayEx.html#.select">select</a></li></ul></li><li><a href="aeq.Comp.html">Comp</a><ul class='methods'><li data-type='method'><a href="aeq.Comp.html#forEachLayer">forEachLayer</a></li><li data-type='method'><a href="aeq.Comp.html#get">get</a></li></ul></li><li><a href="aeq.Key.html">Key</a><ul class='methods'><li data-type='method'><a href="aeq.Key.html#copyTo">copyTo</a></li><li data-type='method'><a href="aeq.Key.html#getKeyinfo">getKeyinfo</a></li><li data-type='method'><a href="aeq.Key.html#getTime">getTime</a></li><li data-type='method'><a href="aeq.Key.html#interpolationType">interpolationType</a></li><li data-type='method'><a href="aeq.Key.html#moveTo">moveTo</a></li><li data-type='method'><a href="aeq.Key.html#remove">remove</a></li><li data-type='method'><a href="aeq.Key.html#spatialTangent">spatialTangent</a></li><li data-type='method'><a href="aeq.Key.html#temporalEase">temporalEase</a></li><li data-type='method'><a href="aeq.Key.html#time">time</a></li><li data-type='method'><a href="aeq.Key.html#valueTypeIs">valueTypeIs</a></li></ul></li><li><a href="aeq.Layer_.html">Layer</a><ul class='methods'><li data-type='method'><a href="aeq.Layer_.html#addEffect">addEffect</a></li><li data-type='method'><a href="aeq.Layer_.html#allChildren">allChildren</a></li><li data-type='method'><a href="aeq.Layer_.html#children">children</a></li><li data-type='method'><a href="aeq.Layer_.html#copyToComp">copyToComp</a></li><li data-type='method'><a href="aeq.Layer_.html#forEachEffect">forEachEffect</a></li><li data-type='method'><a href="aeq.Layer_.html#get">get</a></li><li data-type='method'><a href="aeq.Layer_.html#parent">parent</a></li><li data-type='method'><a href="aeq.Layer_.html#parents">parents</a></li><li data-type='method'><a href="aeq.Layer_.html#relatedLayers">relatedLayers</a></li><li data-type='method'><a href="aeq.Layer_.html#removeParent">removeParent</a></li></ul></li><li><a href="aeq.Property_.html">Property</a><ul class='methods'><li data-type='method'><a href="aeq.Property_.html#addKey">addKey</a></li><li data-type='method'><a href="aeq.Property_.html#expression">expression</a></li><li data-type='method'><a href="aeq.Property_.html#forEachKey">forEachKey</a></li><li data-type='method'><a href="aeq.Property_.html#get">get</a></li><li data-type='method'><a href="aeq.Property_.html#key">key</a></li><li data-type='method'><a href="aeq.Property_.html#maxValue">maxValue</a></li><li data-type='method'><a href="aeq.Property_.html#minValue">minValue</a></li><li data-type='method'><a href="aeq.Property_.html#nearestKeyIndex">nearestKeyIndex</a></li><li data-type='method'><a href="aeq.Property_.html#removeKey">removeKey</a></li><li data-type='method'><a href="aeq.Property_.html#selectedKeys">selectedKeys</a></li><li data-type='method'><a href="aeq.Property_.html#separationDimension">separationDimension</a></li><li data-type='method'><a href="aeq.Property_.html#separationFollower">separationFollower</a></li><li data-type='method'><a href="aeq.Property_.html#separationLeader">separationLeader</a></li><li data-type='method'><a href="aeq.Property_.html#value">value</a></li><li data-type='method'><a href="aeq.Property_.html#valueAtTime">valueAtTime</a></li><li data-type='method'><a href="aeq.Property_.html#valuesAtTimes">valuesAtTimes</a></li></ul></li><li><a href="aeq.ui.Container.html">ui.Container</a><ul class='methods'><li data-type='method'><a href="aeq.ui.Container.html#.addButton">addButton</a></li><li data-type='method'><a href="aeq.ui.Container.html#.addCheckbox">addCheckbox</a></li><li data-type='method'><a href="aeq.ui.Container.html#.addDropdownList">addDropdownList</a></li><li data-type='method'><a href="aeq.ui.Container.html#.addEditText">addEditText</a></li><li data-type='method'><a href="aeq.ui.Container.html#.addGroup">addGroup</a></li><li data-type='method'><a href="aeq.ui.Container.html#.addIconButton">addIconButton</a></li><li data-type='method'><a href="aeq.ui.Container.html#.addImage">addImage</a></li><li data-type='method'><a href="aeq.ui.Container.html#.addListBox">addListBox</a></li><li data-type='method'><a href="aeq.ui.Container.html#.addPanel">addPanel</a></li><li data-type='method'><a href="aeq.ui.Container.html#.addProgressbar">addProgressbar</a></li><li data-type='method'><a href="aeq.ui.Container.html#.addRadioButton">addRadioButton</a></li><li data-type='method'><a href="aeq.ui.Container.html#.addScrollbar">addScrollbar</a></li><li data-type='method'><a href="aeq.ui.Container.html#.addSlider">addSlider</a></li><li data-type='method'><a href="aeq.ui.Container.html#.addStaticText">addStaticText</a></li><li data-type='method'><a href="aeq.ui.Container.html#.addTab">addTab</a></li><li data-type='method'><a href="aeq.ui.Container.html#.addTabbedPanel">addTabbedPanel</a></li><li data-type='method'><a href="aeq.ui.Container.html#.addTreeView">addTreeView</a></li><li data-type='method'><a href="aeq.ui.Container.html#.get">get</a></li><li data-type='method'><a href="aeq.ui.Container.html#.remove">remove</a></li><li data-type='method'><a href="aeq.ui.Container.html#.removeAll">removeAll</a></li><li data-type='method'><a href="aeq.ui.Container.html#.removeChildren">removeChildren</a></li><li data-type='method'><a href="aeq.ui.Container.html#.set">set</a></li><li data-type='method'><a href="aeq.ui.Container.html#.update">update</a></li></ul></li><li><a href="aeq.ui.Window.html">ui.Window</a><ul class='methods'><li data-type='method'><a href="aeq.ui.Window.html#.ui.Window#close">ui.Window#close</a></li><li data-type='method'><a href="aeq.ui.Window.html#.ui.Window#hide">ui.Window#hide</a></li><li data-type='method'><a href="aeq.ui.Window.html#.ui.Window#layout">ui.Window#layout</a></li><li data-type='method'><a href="aeq.ui.Window.html#.ui.Window#show">ui.Window#show</a></li></ul></li></ul><h3 data-name="Namespaces">Namespaces</h3><ul><li><a href="aeq.html">aeq</a><ul class='methods'><li data-type='method'><a href="aeq.html#.assertIsEmpty">assertIsEmpty</a></li><li data-type='method'><a href="aeq.html#.assertIsFalse">assertIsFalse</a></li><li data-type='method'><a href="aeq.html#.assertIsNotEmpty">assertIsNotEmpty</a></li><li data-type='method'><a href="aeq.html#.assertIsNotNull">assertIsNotNull</a></li><li data-type='method'><a href="aeq.html#.assertIsNull">assertIsNull</a></li><li data-type='method'><a href="aeq.html#.assertIsTrue">assertIsTrue</a></li><li data-type='method'><a href="aeq.html#.attr">attr</a></li><li data-type='method'><a href="aeq.html#.createResourceFiles">createResourceFiles</a></li><li data-type='method'><a href="aeq.html#.createUndoGroup">createUndoGroup</a></li><li data-type='method'><a href="aeq.html#.error">error</a></li><li data-type='method'><a href="aeq.html#.extend">extend</a></li><li data-type='method'><a href="aeq.html#.filter">filter</a></li><li data-type='method'><a href="aeq.html#.forEach">forEach</a></li><li data-type='method'><a href="aeq.html#.forEachComp">forEachComp</a></li><li data-type='method'><a href="aeq.html#.forEachComposition">forEachComposition</a></li><li data-type='method'><a href="aeq.html#.forEachEffect">forEachEffect</a></li><li data-type='method'><a href="aeq.html#.forEachItem">forEachItem</a></li><li data-type='method'><a href="aeq.html#.forEachLayer">forEachLayer</a></li><li data-type='method'><a href="aeq.html#.forEachOM">forEachOM</a></li><li data-type='method'><a href="aeq.html#.forEachOutputModule">forEachOutputModule</a></li><li data-type='method'><a href="aeq.html#.forEachProp">forEachProp</a></li><li data-type='method'><a href="aeq.html#.forEachProperty">forEachProperty</a></li><li data-type='method'><a href="aeq.html#.forEachRenderQueueItem">forEachRenderQueueItem</a></li><li data-type='method'><a href="aeq.html#.forEachRQItem">forEachRQItem</a></li><li data-type='method'><a href="aeq.html#.framesToTime">framesToTime</a></li><li data-type='method'><a href="aeq.html#.getActiveComp">getActiveComp</a></li><li data-type='method'><a href="aeq.html#.getActiveComposition">getActiveComposition</a></li><li data-type='method'><a href="aeq.html#.getBinaryString">getBinaryString</a></li><li data-type='method'><a href="aeq.html#.getComp">getComp</a></li><li data-type='method'><a href="aeq.html#.getComposition">getComposition</a></li><li data-type='method'><a href="aeq.html#.getCompositions">getCompositions</a></li><li data-type='method'><a href="aeq.html#.getComps">getComps</a></li><li data-type='method'><a href="aeq.html#.getEffects">getEffects</a></li><li data-type='method'><a href="aeq.html#.getFileObject">getFileObject</a></li><li data-type='method'><a href="aeq.html#.getFolderObject">getFolderObject</a></li><li data-type='method'><a href="aeq.html#.getItemInComps">getItemInComps</a></li><li data-type='method'><a href="aeq.html#.getItems">getItems</a></li><li data-type='method'><a href="aeq.html#.getKeys">getKeys</a></li><li data-type='method'><a href="aeq.html#.getLayers">getLayers</a></li><li data-type='method'><a href="aeq.html#.getMarkerGroup">getMarkerGroup</a></li><li data-type='method'><a href="aeq.html#.getModifiers">getModifiers</a></li><li data-type='method'><a href="aeq.html#.getProperties">getProperties</a></li><li data-type='method'><a href="aeq.html#.getPropertyChildren">getPropertyChildren</a></li><li data-type='method'><a href="aeq.html#.getSelectedLayers">getSelectedLayers</a></li><li data-type='method'><a href="aeq.html#.getSelectedLayersOrAll">getSelectedLayersOrAll</a></li><li data-type='method'><a href="aeq.html#.getSelectedOrAllLayers">getSelectedOrAllLayers</a></li><li data-type='method'><a href="aeq.html#.getSelectedProperties">getSelectedProperties</a></li><li data-type='method'><a href="aeq.html#.getSelectedProps">getSelectedProps</a></li><li data-type='method'><a href="aeq.html#.getSystemInfo">getSystemInfo</a></li><li data-type='method'><a href="aeq.html#.isAeq">isAeq</a></li><li data-type='method'><a href="aeq.html#.isApp">isApp</a></li><li data-type='method'><a href="aeq.html#.isArr">isArr</a></li><li data-type='method'><a href="aeq.html#.isArray">isArray</a></li><li data-type='method'><a href="aeq.html#.isAVLayer">isAVLayer</a></li><li data-type='method'><a href="aeq.html#.isBool">isBool</a></li><li data-type='method'><a href="aeq.html#.isBoolean">isBoolean</a></li><li data-type='method'><a href="aeq.html#.isCamera">isCamera</a></li><li data-type='method'><a href="aeq.html#.isCameraLayer">isCameraLayer</a></li><li data-type='method'><a href="aeq.html#.isComp">isComp</a></li><li data-type='method'><a href="aeq.html#.isComposition">isComposition</a></li><li data-type='method'><a href="aeq.html#.isDir">isDir</a></li><li data-type='method'><a href="aeq.html#.isEmpty">isEmpty</a></li><li data-type='method'><a href="aeq.html#.isFile">isFile</a></li><li data-type='method'><a href="aeq.html#.isFolder">isFolder</a></li><li data-type='method'><a href="aeq.html#.isFolderItem">isFolderItem</a></li><li data-type='method'><a href="aeq.html#.isFootageItem">isFootageItem</a></li><li data-type='method'><a href="aeq.html#.isFunc">isFunc</a></li><li data-type='method'><a href="aeq.html#.isFunction">isFunction</a></li><li data-type='method'><a href="aeq.html#.isLayer">isLayer</a></li><li data-type='method'><a href="aeq.html#.isLight">isLight</a></li><li data-type='method'><a href="aeq.html#.isLightLayer">isLightLayer</a></li><li data-type='method'><a href="aeq.html#.isNullOrUndefined">isNullOrUndefined</a></li><li data-type='method'><a href="aeq.html#.isNum">isNum</a></li><li data-type='method'><a href="aeq.html#.isNumber">isNumber</a></li><li data-type='method'><a href="aeq.html#.isObj">isObj</a></li><li data-type='method'><a href="aeq.html#.isObject">isObject</a></li><li data-type='method'><a href="aeq.html#.isPanel">isPanel</a></li><li data-type='method'><a href="aeq.html#.isPlainObject">isPlainObject</a></li><li data-type='method'><a href="aeq.html#.isPrecomp">isPrecomp</a></li><li data-type='method'><a href="aeq.html#.isProp">isProp</a></li><li data-type='method'><a href="aeq.html#.isProperty">isProperty</a></li><li data-type='method'><a href="aeq.html#.isPropertyGroup">isPropertyGroup</a></li><li data-type='method'><a href="aeq.html#.isShapeLayer">isShapeLayer</a></li><li data-type='method'><a href="aeq.html#.isStr">isStr</a></li><li data-type='method'><a href="aeq.html#.isString">isString</a></li><li data-type='method'><a href="aeq.html#.isTextLayer">isTextLayer</a></li><li data-type='method'><a href="aeq.html#.isWindow">isWindow</a></li><li data-type='method'><a href="aeq.html#.normalizeCollection">normalizeCollection</a></li><li data-type='method'><a href="aeq.html#.pasteKey">pasteKey</a></li><li data-type='method'><a href="aeq.html#.propertyType">propertyType</a></li><li data-type='method'><a href="aeq.html#.readFile">readFile</a></li><li data-type='method'><a href="aeq.html#.reflect">reflect</a></li><li data-type='method'><a href="aeq.html#.select">select</a></li><li data-type='method'><a href="aeq.html#.setDefault">setDefault</a></li><li data-type='method'><a href="aeq.html#.timeToFrames">timeToFrames</a></li><li data-type='method'><a href="aeq.html#.valueInObject">valueInObject</a></li><li data-type='method'><a href="aeq.html#.writeFile">writeFile</a></li></ul></li><li><a href="aeq.app.html">app</a><ul class='methods'><li data-type='method'><a href="aeq.app.html#.ensureSecurityPrefEnabled">ensureSecurityPrefEnabled</a></li><li data-type='method'><a href="aeq.app.html#.getAEP">getAEP</a></li><li data-type='method'><a href="aeq.app.html#.getAEPDir">getAEPDir</a></li><li data-type='method'><a href="aeq.app.html#.getAEPName">getAEPName</a></li><li data-type='method'><a href="aeq.app.html#.getPresetsPaths">getPresetsPaths</a></li><li data-type='method'><a href="aeq.app.html#.getScriptFile">getScriptFile</a></li><li data-type='method'><a href="aeq.app.html#.getUserDataFolder">getUserDataFolder</a></li><li data-type='method'><a href="aeq.app.html#.open">open</a></li><li data-type='method'><a href="aeq.app.html#.securityPrefEnabled">securityPrefEnabled</a></li></ul></li><li><a href="aeq.command.html">command</a><ul class='methods'><li data-type='method'><a href="aeq.command.html#.call">call</a></li><li data-type='method'><a href="aeq.command.html#.copyToClipboard">copyToClipboard</a></li><li data-type='method'><a href="aeq.command.html#.openURL">openURL</a></li><li data-type='method'><a href="aeq.command.html#.revealFile">revealFile</a></li></ul></li><li><a href="aeq.comp_.html">comp</a><ul class='methods'><li data-type='method'><a href="aeq.comp_.html#.create">create</a></li><li data-type='method'><a href="aeq.comp_.html#.getCompInQueue">getCompInQueue</a></li><li data-type='method'><a href="aeq.comp_.html#.isInQueue">isInQueue</a></li><li data-type='method'><a href="aeq.comp_.html#.isQueued">isQueued</a></li></ul></li><li><a href="aeq.file.html">file</a><ul class='methods'><li data-type='method'><a href="aeq.file.html#.ensureFolderExists">ensureFolderExists</a></li><li data-type='method'><a href="aeq.file.html#.getExtension">getExtension</a></li><li data-type='method'><a href="aeq.file.html#.getFile">getFile</a></li><li data-type='method'><a href="aeq.file.html#.getFiles">getFiles</a></li><li data-type='method'><a href="aeq.file.html#.getFolder">getFolder</a></li><li data-type='method'><a href="aeq.file.html#.joinPath">joinPath</a></li><li data-type='method'><a href="aeq.file.html#.normalizePath">normalizePath</a></li><li data-type='method'><a href="aeq.file.html#.normalizePathArray">normalizePathArray</a></li><li data-type='method'><a href="aeq.file.html#.pathIsAbsolute">pathIsAbsolute</a></li><li data-type='method'><a href="aeq.file.html#.stripExtension">stripExtension</a></li></ul></li><li><a href="aeq.layer.html">layer</a><ul class='methods'><li data-type='method'><a href="aeq.layer.html#.allChildren">allChildren</a></li><li data-type='method'><a href="aeq.layer.html#.children">children</a></li><li data-type='method'><a href="aeq.layer.html#.parents">parents</a></li><li data-type='method'><a href="aeq.layer.html#.relatedLayers">relatedLayers</a></li><li data-type='method'><a href="aeq.layer.html#.setLayerToggles">setLayerToggles</a></li></ul></li><li><a href="aeq.project.html">project</a><ul class='methods'><li data-type='method'><a href="aeq.project.html#.findFolder">findFolder</a></li><li data-type='method'><a href="aeq.project.html#.getFolder">getFolder</a></li><li data-type='method'><a href="aeq.project.html#.getFolderOrRoot">getFolderOrRoot</a></li><li data-type='method'><a href="aeq.project.html#.getFolders">getFolders</a></li><li data-type='method'><a href="aeq.project.html#.getFootage">getFootage</a></li><li data-type='method'><a href="aeq.project.html#.getOrCreateFolder">getOrCreateFolder</a></li><li data-type='method'><a href="aeq.project.html#.getSelectedComps">getSelectedComps</a></li><li data-type='method'><a href="aeq.project.html#.getSelectedFolders">getSelectedFolders</a></li><li data-type='method'><a href="aeq.project.html#.getSelectedFootage">getSelectedFootage</a></li><li data-type='method'><a href="aeq.project.html#.importFile">importFile</a></li><li data-type='method'><a href="aeq.project.html#.importFiles">importFiles</a></li><li data-type='method'><a href="aeq.project.html#.importSequence">importSequence</a></li><li data-type='method'><a href="aeq.project.html#.moveToFolder">moveToFolder</a></li><li data-type='method'><a href="aeq.project.html#.quickSave">quickSave</a></li><li data-type='method'><a href="aeq.project.html#.reduceToQueuedComps">reduceToQueuedComps</a></li><li data-type='method'><a href="aeq.project.html#.save">save</a></li><li data-type='method'><a href="aeq.project.html#.simpleImportFile">simpleImportFile</a></li></ul></li><li><a href="aeq.property.html">property</a><ul class='methods'><li data-type='method'><a href="aeq.property.html#.getLayer">getLayer</a></li><li data-type='method'><a href="aeq.property.html#.type">type</a></li><li data-type='method'><a href="aeq.property.html#.valueType">valueType</a></li></ul></li><li><a href="aeq.renderqueue.html">renderqueue</a><ul class='methods'><li data-type='method'><a href="aeq.renderqueue.html#.clear">clear</a></li><li data-type='method'><a href="aeq.renderqueue.html#.ensureRenderPathExists">ensureRenderPathExists</a></li><li data-type='method'><a href="aeq.renderqueue.html#.getQueuedComps">getQueuedComps</a></li><li data-type='method'><a href="aeq.renderqueue.html#.getQueuedItems">getQueuedItems</a></li><li data-type='method'><a href="aeq.renderqueue.html#.getRQComps">getRQComps</a></li><li data-type='method'><a href="aeq.renderqueue.html#.getRQItems">getRQItems</a></li><li data-type='method'><a href="aeq.renderqueue.html#.getSettings">getSettings</a></li><li data-type='method'><a href="aeq.renderqueue.html#.isQueued">isQueued</a></li><li data-type='method'><a href="aeq.renderqueue.html#.omTemplateExists">omTemplateExists</a></li><li data-type='method'><a href="aeq.renderqueue.html#.queue">queue</a></li><li data-type='method'><a href="aeq.renderqueue.html#.rqTemplateExists">rqTemplateExists</a></li><li data-type='method'><a href="aeq.renderqueue.html#.unqueue_all">unqueue_all</a></li></ul></li><li><a href="aeq.settings.html">settings</a><ul class='methods'><li data-type='method'><a href="aeq.settings.html#.get">get</a></li><li data-type='method'><a href="aeq.settings.html#.getAsArray">getAsArray</a></li><li data-type='method'><a href="aeq.settings.html#.getAsBool">getAsBool</a></li><li data-type='method'><a href="aeq.settings.html#.getAsFloat">getAsFloat</a></li><li data-type='method'><a href="aeq.settings.html#.getAsInt">getAsInt</a></li><li data-type='method'><a href="aeq.settings.html#.have">have</a></li><li data-type='method'><a href="aeq.settings.html#.initSetting">initSetting</a></li><li data-type='method'><a href="aeq.settings.html#.save">save</a></li><li data-type='method'><a href="aeq.settings.html#.setting">setting</a></li><li data-type='method'><a href="aeq.settings.html#.unpack">unpack</a></li></ul></li><li><a href="aeq.snippet.html">snippet</a><ul class='methods'><li data-type='method'><a href="aeq.snippet.html#.activeComp">activeComp</a></li><li data-type='method'><a href="aeq.snippet.html#.forEachSelectedLayer">forEachSelectedLayer</a></li><li data-type='method'><a href="aeq.snippet.html#.forEachSelectedLayerOrAll">forEachSelectedLayerOrAll</a></li><li data-type='method'><a href="aeq.snippet.html#.forEachSelectedProperty">forEachSelectedProperty</a></li><li data-type='method'><a href="aeq.snippet.html#.selectedLayers">selectedLayers</a></li><li data-type='method'><a href="aeq.snippet.html#.selectedLayersOrAll">selectedLayersOrAll</a></li><li data-type='method'><a href="aeq.snippet.html#.selectedProperties">selectedProperties</a></li></ul></li><li><a href="aeq.ui.html">ui</a><ul class='methods'><li data-type='method'><a href="aeq.ui.html#.ui.createDialog">ui.createDialog</a></li><li data-type='method'><a href="aeq.ui.html#.ui.createMainWindow">ui.createMainWindow</a></li><li data-type='method'><a href="aeq.ui.html#.ui.createWindow">ui.createWindow</a></li><li data-type='method'><a href="aeq.ui.html#.ui.ready">ui.ready</a></li><li data-type='method'><a href="aeq.ui.html#.ui.set">ui.set</a></li></ul></li></ul><h3>global</h3><ul><li><a href="global.html#aeq1">aeq</a></li></ul>
</nav>
<div id="main">
<h1 class="page-title">modules/project.js</h1>
<section>
<article>
<pre class="source linenums"><code class="hljs js">var aeq = (function (aeq) {
/**
* [project description]
* @namespace aeq.project
* @memberof aeq
* @type {Object}
*/
aeq.project = aeq.extend({}, {
toString: function() {
return "[object aeq.project]";
},
// Function for extending the object using objects
extend: aeq.extend,
/**
* Gets all footage items in project
* @method
* @memberof aeq.project
* @return {Item[]} ArrayEx of project footage items
*/
getFootage: function(){
var items = aeq.getItems();
return aeq.filter(items, function(item){
return aeq.isFootageItem(item);
});
},
/**
* Gets all folders within target folder, or root
* @method
* @memberof aeq.project
* @param {FolderItem|string} [parentFolder=app.project.root] Folder to search in by name or item, or root if undefined
* @return {FolderItem[]} ArrayEx of folder items
*/
getFolders: function(parentFolder){
var folders = aeq.getItems(parentFolder);
return folders.filter(function(item){
return aeq.isFolderItem(item);
});
},
/**
* Find folder by name in target folder, or root
* @method
* @memberof aeq.project
* @param {string} name Folder name to find
* @param {FolderItem|string} [parentFolder=app.project.root] Folder to search in by name or item, or root if undefined
* @return {FolderItem} ArrayEx of folder items
*/
findFolder: function(name, parentFolder){
var folders = aeq.project.getFolders(parentFolder);
var folder = aeq.filter(folders, function(folder) {
return folder.name == name;
});
return folder[0];
},
/**
* Gets folder item, or null if can't find
* @method
* @memberof aeq.project
* @param {FolderItem|string} folder Folder to get by name or item, or root if undefined
* @param {FolderItem|string} [parentFolder=app.project.root] Parent folder to search in by name or item, or root if undefined
* @return {FolderItem|null} Target folder item, or null
*/
getFolder: function(folder, parentFolder){
if (aeq.isFolderItem(folder))
return folder;
if (aeq.isString(folder))
return aeq.project.findFolder(folder, parentFolder);
return null;
},
/**
* Gets all folder items that are selected
* @method
* @memberof aeq.project
* @return {FolderItem[]} ArrayEx of all selected folder items
*/
getSelectedFolders: function(){
return aeq.filter(app.project.selection, function(item){
return aeq.isFolderItem(item);
});
},
/**
* Gets all comp items that are selected
* @method
* @memberof aeq.project
* @return {CompItem[]} ArrayEx of all selected comp items
*/
getSelectedComps: function(){
return aeq.filter(app.project.selection, function(item){
return aeq.isComp(item);
});
},
/**
* Gets all footage items that are selected
* @method
* @memberof aeq.project
* @return {Item[]} ArrayEx of all selected footage items
*/
getSelectedFootage: function(){
return aeq.filter(app.project.selection, function(item){
return aeq.isFootageItem(item);
});
},
/**
* Gets folder item, or creates it if can't find
* @method
* @memberof aeq.project
* @param {FolderItem|string} folder Folder to get by name or item, or root if undefined
* @param {FolderItem|string} [parentFolder=app.project.root] Parent folder to search in by name or item, or root if undefined
* @return {FolderItem} Target folder item
*/
getOrCreateFolder : function(folder, parentFolder){
if (aeq.isNullOrUndefined(parentFolder))
parentFolder = app.project.rootFolder;
else
parentFolder = aeq.project.getOrCreateFolder(parentFolder)
var foundFolder = aeq.project.getFolder(folder, parentFolder);
if (aeq.isNullOrUndefined(foundFolder))
return parentFolder.items.addFolder(folder);
return foundFolder;
},
/**
* Gets folder item, or root if undefined
* @method
* @memberof aeq.project
* @param {FolderItem|string} [folder=app.project.root] Folder to get by name or item, or root if undefined
* @return {FolderItem} Target folder item
*/
getFolderOrRoot : function (folder) {
folder = aeq.project.getFolder(folder);
if (aeq.isNullOrUndefined(folder))
return app.project.rootFolder;
return folder;
},
/**
* Saves current AEP to target path, or prompts user if no path
* @method
* @memberof aeq.project
* @param {string} [path] Path to save AEP to
* @return {File} File object of AEP
*/
save: function(path) {
if (!path)
return app.project.save();
var file = aeq.getFileObject(path);
if (file.exists)
if (!confirm("File exists! Overwrite?"))
return null;
return app.project.save(file);
},
/**
* Saves current AEP to current path
* @method
* @memberof aeq.project
* @return {File} File object of AEP
*/
quickSave: function() {
var file = aeq.app.getAEP();
return app.project.save(file);
},
/**
* Imports a file into After Effects.
* @method
* @memberof aeq.project
* @param {string|File} file The file to import.
* @param {string|FolderItem} [folder=app.project] The folder where the
* imported item will be placed.
* @param {object} [options] options for importOptions.
* @param {boolean} [options.sequence=false] `true` if file should import as sequence.
* @return {Item} The imported item
*/
importFile: function(file, folder, options) {
var proj = app.project,
newItem;
var newFile = aeq.getFile(file);
if (!aeq.isFile(newFile))
throw new Error( file + " is not a valid file!" );
if ( aeq.isNullOrUndefined( folder ) ) {
folder = app.project.rootFolder
} else {
folder = aeq.project.getOrCreateFolder( folder );
}
options = setDefault(options, {});
var iO = new ImportOptions(newFile);
if (options.sequence === true)
iO.sequence = true;
try {
newItem = proj.importFile(iO);
} catch (e) {
throw new Error( "Can't import file " + newFile.name + "\n" + String(e) );
}
if (newItem.duration * newItem.frameRate == 1)
newItem.replace(file);
newItem.parentFolder = folder;
newItem.selected = false;
return newItem;
},
/**
* Like {@link aeq.project.importFile}, but without the extra.
* @method
* @memberof aeq.project
* @param {File} file File object to import
* @param {object} [options] options for importOptions
* @param {boolean} [options.sequence=false] `true` if file should import as sequence
* @return {Item} The imported item
*/
simpleImportFile: function ( file, options ) {
var iO = new ImportOptions( file )
options = setDefault(options, {});
if (options.sequence === true)
iO.sequence = true;
try {
newItem = app.project.importFile(iO);
} catch (e) {
throw new Error( "Can't import file " + file.name + "\n" + String(e) );
}
return newItem
},
/**
* Imports a sequence by file object or path
* @method
* @memberof aeq.project
* @param {File|string} file File or path of sequence to import
* @param {FolderItem} [folder] Folder to import items to
* @return {Item} Imported sequence
*/
importSequence: function(file, folder) {
return aeq.importFile(file, folder, {sequence: true});
},
/**
* Imports array of files or paths to target folder
* @method
* @memberof aeq.project
* @param {File[]|string[]} fileArray Array of files or paths to import
* @param {FolderItem} [folder] Folder to import items to
* @param {object} [options] options for importOptions.
* @param {boolean} [options.sequence=false] `true` if file should import as sequence.
* @return {Items[]} ArrayEx of imported items
*/
importFiles: function(fileArray, folder, options) {
var importedItems = aeq.arrayEx();
aeq.forEach(fileArray, function(file) {
var item = aeq.importFile(file, folder, options);
importedItems.push(item);
});
return importedItems;
},
/**
* Moves item(s) to specified folder
* @method
* @memberof aeq.project
* @param {Item|Item[]} items Item or array of items
* @param {FolderItem} folder Folder to move item(s) to
*/
moveToFolder: function(items, folder) {
folder = aeq.project.getFolder(folder);
if (!aeq.isArray(items)) items = [items];
aeq.forEach(items, function (item) {
item.parentFolder = folder;
item.selected = false;
});
},
/**
* Reduces current project to only comps that are queued
* @method
* @memberof aeq.project
* @return {CompItem[]|null} Array of queued comps, or null
*/
reduceToQueuedComps: function() {
var queuedComps = aeq.renderqueue.getQueuedComps();
if (queuedComps.length === 0)
return null;
app.project.reduceProject(queuedComps);
return queuedComps;
}
});
// Function aliases
aeq.save = aeq.project.save;
aeq.quickSave = aeq.project.quickSave;
aeq.importFile = aeq.project.importFile;
aeq.importFiles = aeq.project.importFiles;
aeq.importSequence = aeq.project.importSequence;
return aeq;
}(aeq || {}));
</code></pre>
</article>
</section>
<script type="text/javascript">
hljs.lineNumbersBlock(d3.select('.source .hljs').node())
</script>
</div>
</div>
</div>
<br class="clear">
<footer>
<span>AEQuery</span> docs generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Jun 16 2017 using the <a href="https://github.com/mere/kitsune">Kitsune</a> theme.
</footer>
<script src="scripts/linenumber.js"></script>
</body>
</html>