-
Notifications
You must be signed in to change notification settings - Fork 7
/
modules_snippet.js.html
245 lines (208 loc) · 30 KB
/
modules_snippet.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
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>modules/snippet.js - Documentation</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.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
</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>
<nav>
<h2><a href="index.html">Home</a></h2><h3>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>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>Tutorials</h3><ul><li><a href="tutorial-Add motion blur to animated layers.html">Add motion blur to animated layers</a></li></ul><h3>Global</h3><ul><li><a href="global.html#aeq1">aeq</a></li><li><a href="global.html#getItemsDeep">getItemsDeep</a></li></ul>
</nav>
<div id="main">
<h1 class="page-title">modules/snippet.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>var aeq = (function (aeq) {
/**
* @namespace snippet
* @memberof aeq
* @type {object}
*/
aeq.snippet = aeq.extend({}, {
toString: function() {
return "[object aeq.snippet]";
},
// Function for extending the object using objects
extend: aeq.extend,
/**
* Gets the active comp and alerts the user if no comp is open. It then
* creates an undo group and executes a callback function with the comp as
* the first argument.
* @function activeComp
* @memberof aeq.snippet
* @param {String} undoGroup Name of the undo group
* @param {function} callback Function to execute that gets the active comp
* as the first argument
* @return {Boolean|Any} `false` if the function is not executed
* because no comp was selected. Else the value the `callback`
* function returns is returned.
*/
activeComp: function(undoGroup, callback) {
var comp = getCompWithAlert();
if (comp === null) return false;
return aeq.createUndoGroup(undoGroup, callback, [comp]);
},
/**
* Gets the selected layers in the active comp and alerts the user if no comp
* is open, or if no layer is selected. It then creates an undo group and
* executes a callback function with the layers as the first argument, and the
* comp as the second argument.
* @memberof aeq.snippet
* @param {String} undoGroup Name of the undo group
* @param {function} callback Function to execute that gets the selected
* layers as the first argument, and the comp as the second argument.
* @return {Boolean|Any} `false` if the function is not executed because
* no comp or layer was selected. Else the value the `callback` function
* returns is returned.
*/
selectedLayers: function(undoGroup, callback) {
var comp = getCompWithAlert();
if (comp === null) return false;
var layers = getSelectedLayersWithAlert(comp)
if (layers === null) return false;
layers = aeq.arrayEx(layers);
return aeq.createUndoGroup(undoGroup, callback, [layers, comp]);
},
/**
* Gets the selected layers or all layers if no layers are selected, in the
* active comp. Alerts the user if no comp is open. It then creates an undo
* group and executes a callback function with the layers as the first
* argument, and the comp as the second argument.
* @memberof aeq.snippet
* @param {String} undoGroup Name of the undo group.
* @param {function} callback Function to execute that gets the selected
* layers in an ArrayEx as the first argument, and the comp as the second
* argument.
* @return {Boolean|Any} `false` if the function is not executed because
* no comp was open. Else the value the `callback` function is returned.
*/
selectedLayersOrAll: function(undoGroup, callback) {
var comp = getCompWithAlert();
if (comp === null) return false;
var layers = aeq.getSelectedLayersOrAll(comp);
layers = aeq.arrayEx(layers);
return aeq.createUndoGroup(undoGroup, callback, [layers, comp]);
},
/**
* Gets the selected properties in the active comp and alerts the user if no
* comp is open, or if no property is selected. It then creates an undo group
* and executes a callback function with the properties as the first argument,
* and the comp as the second argument.
* @memberof aeq.snippet
* @param {String} undoGroup Name of the undo group
* @param {function} callback Function to execute that gets the selected
* properties in an ArrayEx as the first argument, and the comp as the second
* argument.
* @return {Boolean|Any} `false` if the function is not executed.
* because no comp or property was selected. Else the value the `callback`
* function is returned.
*/
selectedProperties: function(undoGroup, callback) {
var comp = getCompWithAlert();
if (comp === null) return false;
var props = getSelectedPropertiesWithAlert(comp)
if (props === null) return false;
props = aeq.arrayEx(props);
return aeq.createUndoGroup(undoGroup, callback, [props, comp]);
},
/**
* Loops through the selected layers in the active comp. Alerts the user if no
* comp is open, or no layer is selected. It then creates an undo group
* and executes a callback function for each of the layers.
* @memberof aeq.snippet
* @param {String} undoGroup Name of the undo group.
* @param {forEachArrayCallback} callback Function to execute for each layer.
* @return {Boolean|ArrayEx} `false` if the function is not executed because
* no comp was open or no layer selected. Else the layers array is
* returned.
*/
forEachSelectedLayer: function(undoGroup, callback) {
return aeq.snippet.selectedLayers(undoGroup, function(layers) {
layers.forEach(callback);
return layers;
})
},
/**
* Loops through the selected layers or all layers if no layers are selected, in the
* active comp. Alerts the user if no comp is open. It then creates an undo group
* and executes a callback function for each of the layers.
* @memberof aeq.snippet
* @param {String} undoGroup Name of the undo group
* @param {forEachArrayCallback} callback Function to execute for each layer.
* @return {Boolean|ArrayEx} `false` if the function is not executed
* because no comp was open. Else
* the layers array are returned.
*/
forEachSelectedLayerOrAll: function(undoGroup, callback) {
return aeq.snippet.selectedLayersOrAll(undoGroup, function(layers) {
layers.forEach(callback);
return layers;
})
},
/**
* Loops through the selected properties in the active comp. Alerts the user if no
* comp is open, or no properties is selected. It then creates an undo group
* and executes a callback function for each of the properties.
* @memberof aeq.snippet
* @param {String} undoGroup Name of the undo group
* @param {forEachArrayCallback} callback Function to execute for each property.
* @return {Boolean|ArrayEx} `false` if the function is not executed
* because no comp was open or no layer
* selected. Else the property array
* is returned.
*/
forEachSelectedProperty: function(undoGroup, callback) {
return aeq.snippet.selectedProperties(undoGroup, function(props) {
props.forEach(callback);
return props;
})
},
});
function getCompWithAlert() {
var comp = aeq.getActiveComp();
if ( comp === null ) {
alert( "No Comp selected" );
}
return comp;
}
function getSelectedLayersWithAlert(comp) {
if ( comp.selectedLayers.length === 0 ) {
alert( "No layers selected" );
return null;
}
return comp.selectedLayers;
}
function getSelectedPropertiesWithAlert(comp) {
if ( comp.selectedProperties.length === 0 ) {
alert( "No properties selected" );
return null;
}
return comp.selectedProperties;
}
// Function aliases
return aeq;
}(aeq || {}));
</code></pre>
</article>
</section>
</div>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Thu Jul 27 2017 18:57:34 GMT+0200 (CEST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>
<script>prettyPrint();</script>
<script src="scripts/linenumber.js"></script>
</body>
</html>