From b3c757f44a6431541074e60f38b25798d71c71f3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rune=20Gangs=C3=B8?= Date: Thu, 27 Jul 2017 18:57:34 +0200 Subject: [PATCH] 0.3.0 --- docs/aeq.Comp.html | 773 +++++++++++++++++- docs/aeq.Key.html | 4 +- docs/aeq.Layer.html | 4 +- docs/aeq.Property_.html | 4 +- docs/aeq.app.html | 4 +- docs/aeq.arrayEx.html | 110 ++- docs/aeq.command.html | 4 +- docs/aeq.comp_.html | 773 +----------------- docs/aeq.file.html | 12 +- docs/aeq.html | 272 +++++- docs/aeq.layer_.html | 6 +- docs/aeq.project.html | 47 +- docs/aeq.property.html | 4 +- docs/aeq.renderqueue.html | 4 +- docs/aeq.settings.html | 4 +- docs/aeq.snippet.html | 4 +- docs/aeq.ui.Container.html | 4 +- docs/aeq.ui.Window.html | 4 +- docs/aeq.ui.html | 4 +- docs/assert.js.html | 4 +- docs/attr.js.html | 19 +- docs/dom.js.html | 78 +- docs/forEach.js.html | 4 +- docs/global.html | 164 +++- docs/index.html | 4 +- docs/main.js.html | 6 +- docs/misc_error.js.html | 4 +- docs/misc_modifiers.js.html | 4 +- docs/misc_resourceFiles.js.html | 4 +- docs/misc_system.js.html | 4 +- docs/misc_undoGroup.js.html | 4 +- docs/misc_valueInObject.js.html | 4 +- docs/modules_app.js.html | 4 +- docs/modules_command.js.html | 4 +- docs/modules_comp.js.html | 4 +- docs/modules_file.js.html | 96 ++- docs/modules_layer.js.html | 4 +- docs/modules_project.js.html | 44 +- docs/modules_property.js.html | 4 +- docs/modules_renderqueue.js.html | 4 +- docs/modules_settings.js.html | 4 +- docs/modules_snippet.js.html | 4 +- docs/objects_array.js.html | 14 +- docs/objects_comp.js.html | 4 +- docs/objects_key.js.html | 4 +- docs/objects_layer.js.html | 4 +- docs/objects_property.js.html | 4 +- docs/select.js.html | 4 +- ...al-Add motion blur to animated layers.html | 4 +- docs/types.js.html | 4 +- docs/ui_container.js.html | 4 +- docs/ui_main.js.html | 4 +- docs/ui_window.js.html | 4 +- lib/main.js | 2 +- package.json | 2 +- 55 files changed, 1573 insertions(+), 1001 deletions(-) diff --git a/docs/aeq.Comp.html b/docs/aeq.Comp.html index 6cdd22d..0b8e91a 100644 --- a/docs/aeq.Comp.html +++ b/docs/aeq.Comp.html @@ -2,7 +2,7 @@ - Comp - Documentation + comp - Documentation @@ -22,12 +22,12 @@
-

Comp

+

comp

@@ -42,7 +42,7 @@

Comp

aeq. - Comp + comp

@@ -53,9 +53,581 @@

+
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +

Module dealing with comp objects.

+ + + + +

+ + + + + + + + + + + + + + +

Methods

+ + + + + + +

(static) create(folderopt, optionsopt) → {CompItem}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Creates a comp with the given settings

+
+ + + + + + + + + +
Examples
+ +

Create a comp in the project root, with name "Example", + and a duration of 10 seconds. And use default values for the + other options

+ +
var comp = aeq.comp.create({
+    name: 'Example',
+    duration: 10
+})
+ +

Create comp in a folder, with name "Example"

+ +
var comp = aeq.comp.create(compFolder, {
+    name: "Example"
+})
+ +

Create a comp with all default values

+ +
var comp = aeq.comp.create()
+ + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
folder + + +FolderItem +| + +object + + + + + + <optional>
+ + + + + +
+ + app.project + +

The folder to place the + comp inside in the project panel. If not provided, this argument + will be used as the options parameter.

options + + +object + + + + + + <optional>
+ + + + + +
+ +

Comp settings:

+
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
name + + +string + + + + + + <optional>
+ + + + + +
+ + Comp + +

The name of the comp.

width + + +number + + + + + + <optional>
+ + + + + +
+ + 1920 + +

Comp width, in pixels.

height + + +number + + + + + + <optional>
+ + + + + +
+ + 1080 + +

Comp height, in pixels.

pixelAspect + + +number + + + + + + <optional>
+ + + + + +
+ + 1 + +

Comp pixel aspect ratio.

duration + + +number + + + + + + <optional>
+ + + + + +
+ + 1 + +

Comp duration, in seconds.

frameRate + + +number + + + + + + <optional>
+ + + + + +
+ + 24 + +

Comp frame rate.

+ +
+ + + + + + + + + + + + + + +
Returns:
+ + +
+

The created comp item.

+
+ + + +
+
+ Type +
+
+ +CompItem + + +
+
+ + + + + + + -

new Comp(comp) → {aeq.Comp}

+

(static) getCompInQueue(comp, queuedOnlyopt) → {Array.<RenderQueueItem>}

@@ -67,7 +639,7 @@

new CompSource:
@@ -107,7 +679,7 @@

new Comp -

Converts a CompItem into an aeq.Comp object

+

Gets the RenderQueueItems that references a given comp.

@@ -118,6 +690,14 @@

new CompExample

+ +

Get all `RenderQueueItem`s that references + the comp.

+ +
var RQItems = aeq.comp.getCompInQueue( comp, false )
+ +
Parameters:
@@ -133,8 +713,12 @@
Parameters:
Type + Attributes + + Default + Description @@ -158,10 +742,62 @@
Parameters:
+ + + + + + + + + + + + + + + +

The comp to find in the Render Queue.

+ + + + + + + queuedOnly + + + + + +boolean + + + + + + + + + <optional>
+ + + + + + + + + + true + + + -

CompItem to turn into aeq.Comp object

+

Only get RenderQueueItems that + are queued.

@@ -185,7 +821,8 @@
Returns:
-

aeq.Comp object of CompItem

+

The RenderQueueItems that references + the comp

@@ -196,7 +833,7 @@
Returns:
-aeq.Comp +Array.<RenderQueueItem>
@@ -205,30 +842,12 @@
Returns:
- - - - - - - - - - - - - - - - -

Methods

- -

forEachLayer(callback)

+

(static) isInQueue(comp) → {boolean}

@@ -240,7 +859,7 @@

forEachLa
Source:
@@ -280,7 +899,8 @@

forEachLa
-

Runs a function on each layer in aeq.Comp object

+

Check if a comp is in the Render Queue, regardless of it being +queued or not.

@@ -318,13 +938,13 @@

Parameters:
- callback + comp -function +CompItem @@ -334,7 +954,7 @@
Parameters:
-

Function to run on each layer in aeq.Comp object

+

The comp to find in the queue.

@@ -354,6 +974,28 @@
Parameters:
+
Returns:
+ + +
+

True if comp is in the queue.

+
+ + + +
+
+ Type +
+
+ +boolean + + +
+
+ + @@ -361,7 +1003,7 @@
Parameters:
-

get() → {CompItem}

+

(static) isQueued(comp) → {boolean}

@@ -373,7 +1015,7 @@

getSource:
@@ -413,7 +1055,7 @@

get -

Get the original object

+

Check if a comp is in the Render Queue and queued.

@@ -426,6 +1068,55 @@

get + + + + Name + + + Type + + + + + + Description + + + + + + + + + comp + + + + + +CompItem + + + + + + + + + +

The comp to find the queue.

+ + + + + + + @@ -441,6 +1132,10 @@

get +

True if the comp is queued.

+ +
@@ -449,7 +1144,7 @@
Returns:
-CompItem +boolean
@@ -476,7 +1171,7 @@
Returns:

- Documentation generated by JSDoc 3.4.3 on Wed Jun 21 2017 00:37:52 GMT+0200 (CEST) using the docdash theme. + Documentation generated by JSDoc 3.4.3 on Thu Jul 27 2017 18:57:34 GMT+0200 (CEST) using the docdash theme.
diff --git a/docs/aeq.Key.html b/docs/aeq.Key.html index fb5ecb3..c3a3bb9 100644 --- a/docs/aeq.Key.html +++ b/docs/aeq.Key.html @@ -22,7 +22,7 @@
@@ -1767,7 +1767,7 @@
Returns:

- Documentation generated by JSDoc 3.4.3 on Wed Jun 21 2017 00:37:52 GMT+0200 (CEST) using the docdash theme. + Documentation generated by JSDoc 3.4.3 on Thu Jul 27 2017 18:57:34 GMT+0200 (CEST) using the docdash theme.
diff --git a/docs/aeq.Layer.html b/docs/aeq.Layer.html index ed55c39..f91d0d4 100644 --- a/docs/aeq.Layer.html +++ b/docs/aeq.Layer.html @@ -22,7 +22,7 @@
@@ -919,7 +919,7 @@
Parameters:

- Documentation generated by JSDoc 3.4.3 on Wed Jun 21 2017 00:37:52 GMT+0200 (CEST) using the docdash theme. + Documentation generated by JSDoc 3.4.3 on Thu Jul 27 2017 18:57:34 GMT+0200 (CEST) using the docdash theme.
diff --git a/docs/aeq.Property_.html b/docs/aeq.Property_.html index c4b0394..6277b29 100644 --- a/docs/aeq.Property_.html +++ b/docs/aeq.Property_.html @@ -22,7 +22,7 @@
@@ -2520,7 +2520,7 @@
Returns:

- Documentation generated by JSDoc 3.4.3 on Wed Jun 21 2017 00:37:52 GMT+0200 (CEST) using the docdash theme. + Documentation generated by JSDoc 3.4.3 on Thu Jul 27 2017 18:57:34 GMT+0200 (CEST) using the docdash theme.
diff --git a/docs/aeq.app.html b/docs/aeq.app.html index a2876cf..730ec30 100644 --- a/docs/aeq.app.html +++ b/docs/aeq.app.html @@ -22,7 +22,7 @@
@@ -1208,7 +1208,7 @@
Returns:

- Documentation generated by JSDoc 3.4.3 on Wed Jun 21 2017 00:37:52 GMT+0200 (CEST) using the docdash theme. + Documentation generated by JSDoc 3.4.3 on Thu Jul 27 2017 18:57:34 GMT+0200 (CEST) using the docdash theme.
diff --git a/docs/aeq.arrayEx.html b/docs/aeq.arrayEx.html index 16d53c4..5cd3743 100644 --- a/docs/aeq.arrayEx.html +++ b/docs/aeq.arrayEx.html @@ -22,7 +22,7 @@
@@ -207,7 +207,7 @@

Methods

-

(static) attr() → {type}

+

(static) attr(attributeName, newValueopt) → {Any}

@@ -219,7 +219,7 @@

(static) attrSource:
@@ -266,8 +266,8 @@

(static) attr -

Checks the arguments length to determine to get or set -and it needs an object to get or set attributes to.

+

Sets or gets an attribute value for all objects in the array. When getting a +value, it only returns the valure from the first object.

@@ -280,6 +280,99 @@

(static) attrParameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
attributeName + + +string + + + + + + + + + +

The name of the attribute to get or set.

newValue + + +Any + + + + + + <optional>
+ + + + + +

The value to set. If not given, will only get + the value of the first object.

+ + @@ -296,7 +389,8 @@
Returns:
-

[description]

+

when getting, the value of the attribute. + When setting, undefined.

@@ -307,7 +401,7 @@
Returns:
-type +Any
@@ -1912,7 +2006,7 @@
Returns:

- Documentation generated by JSDoc 3.4.3 on Wed Jun 21 2017 00:37:52 GMT+0200 (CEST) using the docdash theme. + Documentation generated by JSDoc 3.4.3 on Thu Jul 27 2017 18:57:34 GMT+0200 (CEST) using the docdash theme.
diff --git a/docs/aeq.command.html b/docs/aeq.command.html index 70acfaf..4d574c3 100644 --- a/docs/aeq.command.html +++ b/docs/aeq.command.html @@ -22,7 +22,7 @@
@@ -990,7 +990,7 @@
Returns:

- Documentation generated by JSDoc 3.4.3 on Wed Jun 21 2017 00:37:52 GMT+0200 (CEST) using the docdash theme. + Documentation generated by JSDoc 3.4.3 on Thu Jul 27 2017 18:57:34 GMT+0200 (CEST) using the docdash theme.
diff --git a/docs/aeq.comp_.html b/docs/aeq.comp_.html index ca8fd91..5f43098 100644 --- a/docs/aeq.comp_.html +++ b/docs/aeq.comp_.html @@ -2,7 +2,7 @@ - comp - Documentation + Comp - Documentation @@ -22,12 +22,12 @@
-

comp

+

Comp

@@ -42,7 +42,7 @@

comp

aeq. - comp + Comp

@@ -53,581 +53,9 @@

-
- - -
Source:
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - -

Module dealing with comp objects.

- - - - -

- - - - - - - - - - - - - - -

Methods

- - - - - - -

(static) create(folderopt, optionsopt) → {CompItem}

- - - - - - -
- - -
Source:
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - -
-

Creates a comp with the given settings

-
- - - - - - - - - -
Examples
- -

Create a comp in the project root, with name "Example", - and a duration of 10 seconds. And use default values for the - other options

- -
var comp = aeq.comp.create({
-    name: 'Example',
-    duration: 10
-})
- -

Create comp in a folder, with name "Example"

- -
var comp = aeq.comp.create(compFolder, {
-    name: "Example"
-})
- -

Create a comp with all default values

- -
var comp = aeq.comp.create()
- - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeAttributesDefaultDescription
folder - - -FolderItem -| - -object - - - - - - <optional>
- - - - - -
- - app.project - -

The folder to place the - comp inside in the project panel. If not provided, this argument - will be used as the options parameter.

options - - -object - - - - - - <optional>
- - - - - -
- -

Comp settings:

-
Properties
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeAttributesDefaultDescription
name - - -string - - - - - - <optional>
- - - - - -
- - Comp - -

The name of the comp.

width - - -number - - - - - - <optional>
- - - - - -
- - 1920 - -

Comp width, in pixels.

height - - -number - - - - - - <optional>
- - - - - -
- - 1080 - -

Comp height, in pixels.

pixelAspect - - -number - - - - - - <optional>
- - - - - -
- - 1 - -

Comp pixel aspect ratio.

duration - - -number - - - - - - <optional>
- - - - - -
- - 1 - -

Comp duration, in seconds.

frameRate - - -number - - - - - - <optional>
- - - - - -
- - 24 - -

Comp frame rate.

- -
- - - - - - - - - - - - - - -
Returns:
- - -
-

The created comp item.

-
- - - -
-
- Type -
-
- -CompItem - - -
-
- - - - - - - -

(static) getCompInQueue(comp, queuedOnlyopt) → {Array.<RenderQueueItem>}

+

new Comp(comp) → {aeq.Comp}

@@ -639,7 +67,7 @@

(static) Source:
@@ -679,7 +107,7 @@

(static) -

Gets the RenderQueueItems that references a given comp.

+

Converts a CompItem into an aeq.Comp object

@@ -690,14 +118,6 @@

(static) Example

- -

Get all `RenderQueueItem`s that references - the comp.

- -
var RQItems = aeq.comp.getCompInQueue( comp, false )
- -
Parameters:
@@ -713,12 +133,8 @@
Parameters:
Type - Attributes - - Default - Description @@ -742,62 +158,10 @@
Parameters:
- - - - - - - - - - - - - - - -

The comp to find in the Render Queue.

- - - - - - - queuedOnly - - - - - -boolean - - - - - - - - - <optional>
- - - - - - - - - - true - - - -

Only get RenderQueueItems that - are queued.

+

CompItem to turn into aeq.Comp object

@@ -821,8 +185,7 @@
Returns:
-

The RenderQueueItems that references - the comp

+

aeq.Comp object of CompItem

@@ -833,7 +196,7 @@
Returns:
-Array.<RenderQueueItem> +aeq.Comp
@@ -842,12 +205,30 @@
Returns:
+ +
+ + + + + + + + + + + + + + +

Methods

+ -

(static) isInQueue(comp) → {boolean}

+

forEachLayer(callback)

@@ -859,7 +240,7 @@

(static) is
Source:
@@ -899,8 +280,7 @@

(static) is
-

Check if a comp is in the Render Queue, regardless of it being -queued or not.

+

Runs a function on each layer in aeq.Comp object

@@ -938,13 +318,13 @@

Parameters:
- comp + callback -CompItem +function @@ -954,7 +334,7 @@
Parameters:
-

The comp to find in the queue.

+

Function to run on each layer in aeq.Comp object

@@ -974,28 +354,6 @@
Parameters:
-
Returns:
- - -
-

True if comp is in the queue.

-
- - - -
-
- Type -
-
- -boolean - - -
-
- - @@ -1003,7 +361,7 @@
Returns:
-

(static) isQueued(comp) → {boolean}

+

get() → {CompItem}

@@ -1015,7 +373,7 @@

(static) isQ
Source:
@@ -1055,7 +413,7 @@

(static) isQ
-

Check if a comp is in the Render Queue and queued.

+

Get the original object

@@ -1068,55 +426,6 @@

(static) isQ -

Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
comp - - -CompItem - - - -

The comp to find the queue.

- - @@ -1132,10 +441,6 @@
Parameters:
Returns:
-
-

True if the comp is queued.

-
-
@@ -1144,7 +449,7 @@
Returns:
-boolean +CompItem
@@ -1171,7 +476,7 @@
Returns:

- Documentation generated by JSDoc 3.4.3 on Wed Jun 21 2017 00:37:52 GMT+0200 (CEST) using the docdash theme. + Documentation generated by JSDoc 3.4.3 on Thu Jul 27 2017 18:57:34 GMT+0200 (CEST) using the docdash theme.
diff --git a/docs/aeq.file.html b/docs/aeq.file.html index 34f21e3..25af37c 100644 --- a/docs/aeq.file.html +++ b/docs/aeq.file.html @@ -22,7 +22,7 @@
@@ -213,7 +213,7 @@

(static)
Source:
@@ -529,7 +529,7 @@

(static) getF
Source:
@@ -690,7 +690,7 @@

(static) get
Source:
@@ -909,7 +909,7 @@

(static) ge
Source:
@@ -1823,7 +1823,7 @@

Returns:

- Documentation generated by JSDoc 3.4.3 on Wed Jun 21 2017 00:37:52 GMT+0200 (CEST) using the docdash theme. + Documentation generated by JSDoc 3.4.3 on Thu Jul 27 2017 18:57:34 GMT+0200 (CEST) using the docdash theme.
diff --git a/docs/aeq.html b/docs/aeq.html index ea43713..5b298f6 100644 --- a/docs/aeq.html +++ b/docs/aeq.html @@ -22,7 +22,7 @@
@@ -111,7 +111,7 @@

Classes

arrayEx
-
Comp
+
Comp
Key
@@ -143,7 +143,7 @@

Namespaces

command
-
comp
+
comp
file
@@ -1400,7 +1400,7 @@
Returns:
-

(static) attr(array, attributeName, newValue) → {Any}

+

(static) attr(array, attributeName, newValueopt) → {Any|undefined}

@@ -1412,7 +1412,7 @@

(static) attrSource:
@@ -1442,6 +1442,13 @@

(static) attrSee: +
+ +
@@ -1452,7 +1459,8 @@

(static) attr -

[description]

+

Sets or gets an attribute value for all objects in an array. When getting a +value, it only returns the valure from the first object.

@@ -1478,6 +1486,8 @@
Parameters:
Type + Attributes + @@ -1496,17 +1506,26 @@
Parameters:
-array +Array.<Any> + + + + + + -

[description]

+ + +

The array of objects to get or set attribute + values of.

@@ -1526,10 +1545,18 @@
Parameters:
+ + + + + + + + -

[description]

+

The name of the attribute to get or set.

@@ -1549,10 +1576,21 @@
Parameters:
+ + + <optional>
+ + + + + -

[description]

+ + +

The value to set. If not given, will only get + the value of the first object.

@@ -1576,7 +1614,8 @@
Returns:
-

[description]

+

When getting, the value of the attribute. + When setting, undefined.

@@ -1588,6 +1627,9 @@
Returns:
Any +| + +undefined
@@ -4283,7 +4325,7 @@

(static) Source:
@@ -4457,7 +4499,7 @@

(static) Source:
@@ -4544,7 +4586,7 @@

(static
Source:
@@ -4813,7 +4855,7 @@

(static) getC
Source:
@@ -4900,7 +4942,7 @@

(static) Source:
@@ -5047,7 +5089,7 @@
Returns:
-

(static) getCompositions() → {aeq.arrayEx}

+

(static) getCompositions(folderopt, deepopt) → {aeq.arrayEx}

@@ -5059,7 +5101,7 @@

(static) Source:
@@ -5099,7 +5141,7 @@

(static) -

Gets all the CompItems in the project

+

Gets all the CompItems in the project. Or all CompItems in the given folder.

@@ -5112,6 +5154,114 @@

(static) Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
folder + + +FolderItem + + + + + + <optional>
+ + + + + +
+ + app.project + +

The folder to get comps from.

deep + + +boolean + + + + + + <optional>
+ + + + + +
+ + true + +

Go through subfolders looking for comps.

+ + @@ -5165,7 +5315,7 @@

(static) get
Source:
@@ -5252,7 +5402,7 @@

(static) g
Source:
@@ -5410,7 +5560,7 @@

(static) Source:
@@ -5569,7 +5719,7 @@

(static) Source:
@@ -5728,7 +5878,7 @@

(static) Source:
@@ -5871,7 +6021,7 @@
Returns:
-

(static) getItems(folderopt) → {aeq.arrayEx}

+

(static) getItems(folderopt, deepopt) → {aeq.arrayEx}

@@ -5883,7 +6033,7 @@

(static) get
Source:
@@ -6001,6 +6151,46 @@

Parameters:
+ + + + deep + + + + + +boolean + + + + + + + + + <optional>
+ + + + + + + + + + + + true + + + + +

When true, gets items from + subfolders as well.

+ + + @@ -6058,7 +6248,7 @@

(static) getK
Source:
@@ -6218,7 +6408,7 @@

(static) ge
Source:
@@ -6378,7 +6568,7 @@

(static) Source:
@@ -6658,7 +6848,7 @@

(static) Source:
@@ -6906,7 +7096,7 @@

(static)
Source:
@@ -7158,7 +7348,7 @@

(static) <
Source:
@@ -7326,7 +7516,7 @@

(stat
Source:
@@ -7495,7 +7685,7 @@

(stat
Source:
@@ -7582,7 +7772,7 @@

(stati
Source:
@@ -7755,7 +7945,7 @@

(static) Source:
@@ -12986,7 +13176,7 @@

(static)
Source:
@@ -13449,7 +13639,7 @@

(static) rea
Source:
@@ -14217,7 +14407,7 @@

(static) Source:
@@ -14569,7 +14759,7 @@

(static) wr
Source:
@@ -15390,7 +15580,7 @@

Examples

- Documentation generated by JSDoc 3.4.3 on Wed Jun 21 2017 00:37:52 GMT+0200 (CEST) using the docdash theme. + Documentation generated by JSDoc 3.4.3 on Thu Jul 27 2017 18:57:34 GMT+0200 (CEST) using the docdash theme.
diff --git a/docs/aeq.layer_.html b/docs/aeq.layer_.html index cbabf9f..9aa06b7 100644 --- a/docs/aeq.layer_.html +++ b/docs/aeq.layer_.html @@ -22,7 +22,7 @@
@@ -673,7 +673,7 @@
Parameters:
CompItem | -aeq.Comp +aeq.Comp @@ -1494,7 +1494,7 @@
Returns:

- Documentation generated by JSDoc 3.4.3 on Wed Jun 21 2017 00:37:52 GMT+0200 (CEST) using the docdash theme. + Documentation generated by JSDoc 3.4.3 on Thu Jul 27 2017 18:57:34 GMT+0200 (CEST) using the docdash theme.
diff --git a/docs/aeq.project.html b/docs/aeq.project.html index 0140445..3cbb142 100644 --- a/docs/aeq.project.html +++ b/docs/aeq.project.html @@ -22,7 +22,7 @@
@@ -124,7 +124,7 @@

Methods

-

(static) findFolder(name, parentFolderopt) → {FolderItem}

+

(static) findFolder(name, parentFolderopt) → {FolderItem|null}

@@ -136,7 +136,7 @@

(static) f
Source:
@@ -176,7 +176,7 @@

(static) f
-

Find folder by name in target folder, or root

+

Find folder by name in target folder.

@@ -246,7 +246,7 @@

Parameters:
-

Folder name to find

+

Folder name to find.

@@ -288,7 +288,7 @@
Parameters:
-

Folder to search in by name or item, or root if undefined

+

Folder to search in by name or item, or root if undefined.

@@ -312,7 +312,7 @@
Returns:
-

ArrayEx of folder items

+

FolderItem with the name. Or null if not found.

@@ -324,6 +324,9 @@
Returns:
FolderItem +| + +null
@@ -349,7 +352,7 @@

(static) ge
Source:
@@ -568,7 +571,7 @@

(static) Source:
@@ -746,7 +749,7 @@

(static) g
Source:
@@ -1030,7 +1033,7 @@

(static) <
Source:
@@ -1246,7 +1249,7 @@

(static) Source:
@@ -1458,7 +1461,7 @@

(static)
Source:
@@ -1564,7 +1567,7 @@

(static) i
Source:
@@ -1887,7 +1890,7 @@

(static)
Source:
@@ -2190,7 +2193,7 @@

(static) Source:
@@ -2391,7 +2394,7 @@

(static) Source:
@@ -2550,7 +2553,7 @@

(static) qu
Source:
@@ -2656,7 +2659,7 @@

(static)
Source:
@@ -2765,7 +2768,7 @@

(static) saveSource:
@@ -2932,7 +2935,7 @@

(static) Source:
@@ -3200,7 +3203,7 @@
Returns:

- Documentation generated by JSDoc 3.4.3 on Wed Jun 21 2017 00:37:52 GMT+0200 (CEST) using the docdash theme. + Documentation generated by JSDoc 3.4.3 on Thu Jul 27 2017 18:57:34 GMT+0200 (CEST) using the docdash theme.
diff --git a/docs/aeq.property.html b/docs/aeq.property.html index b887734..a37708b 100644 --- a/docs/aeq.property.html +++ b/docs/aeq.property.html @@ -22,7 +22,7 @@
@@ -639,7 +639,7 @@
Returns:

- Documentation generated by JSDoc 3.4.3 on Wed Jun 21 2017 00:37:52 GMT+0200 (CEST) using the docdash theme. + Documentation generated by JSDoc 3.4.3 on Thu Jul 27 2017 18:57:34 GMT+0200 (CEST) using the docdash theme.
diff --git a/docs/aeq.renderqueue.html b/docs/aeq.renderqueue.html index 51a8500..f7032c7 100644 --- a/docs/aeq.renderqueue.html +++ b/docs/aeq.renderqueue.html @@ -22,7 +22,7 @@
@@ -1655,7 +1655,7 @@

(static)
- Documentation generated by JSDoc 3.4.3 on Wed Jun 21 2017 00:37:52 GMT+0200 (CEST) using the docdash theme. + Documentation generated by JSDoc 3.4.3 on Thu Jul 27 2017 18:57:34 GMT+0200 (CEST) using the docdash theme.
diff --git a/docs/aeq.settings.html b/docs/aeq.settings.html index f46d0aa..88aef73 100644 --- a/docs/aeq.settings.html +++ b/docs/aeq.settings.html @@ -22,7 +22,7 @@
@@ -2070,7 +2070,7 @@
Returns:

- Documentation generated by JSDoc 3.4.3 on Wed Jun 21 2017 00:37:52 GMT+0200 (CEST) using the docdash theme. + Documentation generated by JSDoc 3.4.3 on Thu Jul 27 2017 18:57:34 GMT+0200 (CEST) using the docdash theme.
diff --git a/docs/aeq.snippet.html b/docs/aeq.snippet.html index 878a348..d902476 100644 --- a/docs/aeq.snippet.html +++ b/docs/aeq.snippet.html @@ -22,7 +22,7 @@
@@ -1439,7 +1439,7 @@
Returns:

- Documentation generated by JSDoc 3.4.3 on Wed Jun 21 2017 00:37:52 GMT+0200 (CEST) using the docdash theme. + Documentation generated by JSDoc 3.4.3 on Thu Jul 27 2017 18:57:34 GMT+0200 (CEST) using the docdash theme.
diff --git a/docs/aeq.ui.Container.html b/docs/aeq.ui.Container.html index 18dd606..0895994 100644 --- a/docs/aeq.ui.Container.html +++ b/docs/aeq.ui.Container.html @@ -22,7 +22,7 @@
@@ -4207,7 +4207,7 @@
Returns:

- Documentation generated by JSDoc 3.4.3 on Wed Jun 21 2017 00:37:52 GMT+0200 (CEST) using the docdash theme. + Documentation generated by JSDoc 3.4.3 on Thu Jul 27 2017 18:57:34 GMT+0200 (CEST) using the docdash theme.
diff --git a/docs/aeq.ui.Window.html b/docs/aeq.ui.Window.html index 4282755..5bdd06a 100644 --- a/docs/aeq.ui.Window.html +++ b/docs/aeq.ui.Window.html @@ -22,7 +22,7 @@
@@ -714,7 +714,7 @@
Returns:

- Documentation generated by JSDoc 3.4.3 on Wed Jun 21 2017 00:37:52 GMT+0200 (CEST) using the docdash theme. + Documentation generated by JSDoc 3.4.3 on Thu Jul 27 2017 18:57:34 GMT+0200 (CEST) using the docdash theme.
diff --git a/docs/aeq.ui.html b/docs/aeq.ui.html index 5f107a5..62bb38c 100644 --- a/docs/aeq.ui.html +++ b/docs/aeq.ui.html @@ -22,7 +22,7 @@
@@ -1027,7 +1027,7 @@
Returns:

- Documentation generated by JSDoc 3.4.3 on Wed Jun 21 2017 00:37:52 GMT+0200 (CEST) using the docdash theme. + Documentation generated by JSDoc 3.4.3 on Thu Jul 27 2017 18:57:34 GMT+0200 (CEST) using the docdash theme.
diff --git a/docs/assert.js.html b/docs/assert.js.html index 8e1c437..40fbb32 100644 --- a/docs/assert.js.html +++ b/docs/assert.js.html @@ -22,7 +22,7 @@
@@ -145,7 +145,7 @@

assert.js


- Documentation generated by JSDoc 3.4.3 on Wed Jun 21 2017 00:37:52 GMT+0200 (CEST) using the docdash theme. + Documentation generated by JSDoc 3.4.3 on Thu Jul 27 2017 18:57:34 GMT+0200 (CEST) using the docdash theme.
diff --git a/docs/attr.js.html b/docs/attr.js.html index 63b6fae..5e731d8 100644 --- a/docs/attr.js.html +++ b/docs/attr.js.html @@ -22,7 +22,7 @@
@@ -40,13 +40,18 @@

attr.js

var aeq = (function (aeq) {
 
 /**
- * [description]
+ * Sets or gets an attribute value for all objects in an array. When getting a
+ * value, it only returns the valure from the first object.
  * @memberof aeq
+ * @see aeq.arrayEx.attr
  * @method
- * @param  {array} array         [description]
- * @param  {string} attributeName [description]
- * @param  {Any} newValue      [description]
- * @return {Any}               [description]
+ * @param  {Any[]}  array         The array of objects to get or set attribute
+ *                                values of.
+ * @param  {string} attributeName The name of the attribute to get or set.
+ * @param  {Any}    [newValue]    The value to set. If not given, will only get
+ *                                the value of the first object.
+ * @return {Any|undefined}        When getting, the value of the attribute.
+ *                                When setting, `undefined`.
  */
 aeq.attr = function(array, attributeName, newValue) {
 	var i, il;
@@ -120,7 +125,7 @@ 

attr.js


- Documentation generated by JSDoc 3.4.3 on Wed Jun 21 2017 00:37:52 GMT+0200 (CEST) using the docdash theme. + Documentation generated by JSDoc 3.4.3 on Thu Jul 27 2017 18:57:34 GMT+0200 (CEST) using the docdash theme.
diff --git a/docs/dom.js.html b/docs/dom.js.html index 63f02bb..56ba07e 100644 --- a/docs/dom.js.html +++ b/docs/dom.js.html @@ -22,7 +22,7 @@
@@ -44,15 +44,57 @@

dom.js

* Gets all the item in a folder or project. * @method * @memberof aeq - * @memberof aeq * @param {FolderItem} [folder=app.project] The Folder to get items from. - * @return {aeq.arrayEx} Array of Item objects + * @param {boolean} [deep=true] When `true`, gets items from + * subfolders as well. + * @return {aeq.arrayEx} Array of Item objects */ - getItems: function( folder ) { - folder = aeq.project.getFolder(folder) || app.project; - var items = aeq.normalizeCollection( folder.items ); + getItems: function(folder, deep) { + // If no arguments are given, just return all items in project. + if (folder === undefined) { + return aeq.normalizeCollection(app.project.items); + } + + deep = setDefault(deep, true); + folder = aeq.project.getFolder(folder); + if (folder === null) { + return aeq.arrayEx(); + } + + if (deep) { + return aeq.getItemsDeep(folder); + } - return aeq.arrayEx( items ); + return aeq.normalizeCollection(folder.items); + }, + + /** + * Returns an {@link aeq.arrayEx} with all items in a folder, and items in + * subfolders. + * @method + * @param {FolderItem} folder The folder to flatten. + * @return {aeq.arrayEx} ArrayEx with Item objects. + */ + getItemsDeep: function(folder, returnArrayEx) { + // The returnArrayEx param is so we can skip the converting to arrayEx when + // recursing. It is not meant to be used outside of this function. + var item, + items = [], + len = folder.items.length; + + for (var i=1; i <= len; i++) { + item = folder.items[i]; + if (aeq.isFolderItem(item)) { + // Add all items in subfolder to the `items` array. + items.push.apply(items, aeq.getItemsDeep(item, false)); + } + items.push(item); + } + // Skip converting to arrayEx when function is called by it self. + if (returnArrayEx === false) { + return items; + } + return aeq.arrayEx(items); }, /** @@ -75,24 +117,16 @@

dom.js

}, /** - * Gets all the CompItems in the project + * Gets all the CompItems in the project. Or all CompItems in the given folder. * @method * @memberof aeq + * @param {FolderItem} [folder=app.project] The folder to get comps from. + * @param {boolean} [deep=true] Go through subfolders looking for comps. * @return {aeq.arrayEx} Array of CompItems */ - getCompositions: function () { - var arr = []; - var len = app.project.items.length; - - for (var i=1; i <= len; i++) - { - var item = app.project.item(i); - - if (aeq.isComp(item)) - arr.push(item); - } - - return aeq.arrayEx(arr); + getCompositions: function(folder, deep) { + var items = aeq.getItems(folder, deep) + return items.filter( aeq.isComp ) }, /** @@ -501,7 +535,7 @@

dom.js


- Documentation generated by JSDoc 3.4.3 on Wed Jun 21 2017 00:37:52 GMT+0200 (CEST) using the docdash theme. + Documentation generated by JSDoc 3.4.3 on Thu Jul 27 2017 18:57:34 GMT+0200 (CEST) using the docdash theme.
diff --git a/docs/forEach.js.html b/docs/forEach.js.html index 43df2f4..8c5285b 100644 --- a/docs/forEach.js.html +++ b/docs/forEach.js.html @@ -22,7 +22,7 @@
@@ -270,7 +270,7 @@

forEach.js


- Documentation generated by JSDoc 3.4.3 on Wed Jun 21 2017 00:37:52 GMT+0200 (CEST) using the docdash theme. + Documentation generated by JSDoc 3.4.3 on Thu Jul 27 2017 18:57:34 GMT+0200 (CEST) using the docdash theme.
diff --git a/docs/global.html b/docs/global.html index 2028ff4..292b433 100644 --- a/docs/global.html +++ b/docs/global.html @@ -22,7 +22,7 @@
@@ -115,7 +115,7 @@

Methods

-

aeq(selector, contextopt) → {ArrayEx|aeq.Comp|aeq.Layer|aeq.Property}

+

aeq(selector, contextopt) → {ArrayEx|aeq.Comp|aeq.Layer|aeq.Property}

@@ -335,7 +335,7 @@
Returns:
ArrayEx | -aeq.Comp +aeq.Comp | aeq.Layer @@ -351,6 +351,162 @@
Returns:
+ + + + +

getItemsDeep(folder) → {aeq.arrayEx}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Returns an aeq.arrayEx with all items in a folder, and items in +subfolders.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
folder + + +FolderItem + + + +

The folder to flatten.

+ + + + + + + + + + + + + + +
Returns:
+ + +
+

ArrayEx with Item objects.

+
+ + + +
+
+ Type +
+
+ +aeq.arrayEx + + +
+
+ + + + + @@ -1719,7 +1875,7 @@
Type:

- Documentation generated by JSDoc 3.4.3 on Wed Jun 21 2017 00:37:52 GMT+0200 (CEST) using the docdash theme. + Documentation generated by JSDoc 3.4.3 on Thu Jul 27 2017 18:57:34 GMT+0200 (CEST) using the docdash theme.
diff --git a/docs/index.html b/docs/index.html index a4afe2d..800a104 100644 --- a/docs/index.html +++ b/docs/index.html @@ -22,7 +22,7 @@
@@ -88,7 +88,7 @@

Development

Make sure you have node

- Documentation generated by JSDoc 3.4.3 on Wed Jun 21 2017 00:37:52 GMT+0200 (CEST) using the docdash theme. + Documentation generated by JSDoc 3.4.3 on Thu Jul 27 2017 18:57:34 GMT+0200 (CEST) using the docdash theme.
diff --git a/docs/main.js.html b/docs/main.js.html index 45f9a1a..4f1f201 100644 --- a/docs/main.js.html +++ b/docs/main.js.html @@ -22,7 +22,7 @@
@@ -103,7 +103,7 @@

main.js

return result; }; -aeq.version = "0.2.1" +aeq.version = "0.3.0" aeq.thisObj = this; @@ -317,7 +317,7 @@

main.js


- Documentation generated by JSDoc 3.4.3 on Wed Jun 21 2017 00:37:52 GMT+0200 (CEST) using the docdash theme. + Documentation generated by JSDoc 3.4.3 on Thu Jul 27 2017 18:57:34 GMT+0200 (CEST) using the docdash theme.
diff --git a/docs/misc_error.js.html b/docs/misc_error.js.html index a1abf00..2c90f60 100644 --- a/docs/misc_error.js.html +++ b/docs/misc_error.js.html @@ -22,7 +22,7 @@
@@ -77,7 +77,7 @@

misc/error.js


- Documentation generated by JSDoc 3.4.3 on Wed Jun 21 2017 00:37:52 GMT+0200 (CEST) using the docdash theme. + Documentation generated by JSDoc 3.4.3 on Thu Jul 27 2017 18:57:34 GMT+0200 (CEST) using the docdash theme.
diff --git a/docs/misc_modifiers.js.html b/docs/misc_modifiers.js.html index 705325e..007ef99 100644 --- a/docs/misc_modifiers.js.html +++ b/docs/misc_modifiers.js.html @@ -22,7 +22,7 @@
@@ -68,7 +68,7 @@

misc/modifiers.js


- Documentation generated by JSDoc 3.4.3 on Wed Jun 21 2017 00:37:52 GMT+0200 (CEST) using the docdash theme. + Documentation generated by JSDoc 3.4.3 on Thu Jul 27 2017 18:57:34 GMT+0200 (CEST) using the docdash theme.
diff --git a/docs/misc_resourceFiles.js.html b/docs/misc_resourceFiles.js.html index c1f46d8..16d5fed 100644 --- a/docs/misc_resourceFiles.js.html +++ b/docs/misc_resourceFiles.js.html @@ -22,7 +22,7 @@
@@ -127,7 +127,7 @@

misc/resourceFiles.js


- Documentation generated by JSDoc 3.4.3 on Wed Jun 21 2017 00:37:52 GMT+0200 (CEST) using the docdash theme. + Documentation generated by JSDoc 3.4.3 on Thu Jul 27 2017 18:57:34 GMT+0200 (CEST) using the docdash theme.
diff --git a/docs/misc_system.js.html b/docs/misc_system.js.html index 66659d6..eb3e4ea 100644 --- a/docs/misc_system.js.html +++ b/docs/misc_system.js.html @@ -22,7 +22,7 @@
@@ -80,7 +80,7 @@

misc/system.js


- Documentation generated by JSDoc 3.4.3 on Wed Jun 21 2017 00:37:52 GMT+0200 (CEST) using the docdash theme. + Documentation generated by JSDoc 3.4.3 on Thu Jul 27 2017 18:57:34 GMT+0200 (CEST) using the docdash theme.
diff --git a/docs/misc_undoGroup.js.html b/docs/misc_undoGroup.js.html index 84f4b4e..d816251 100644 --- a/docs/misc_undoGroup.js.html +++ b/docs/misc_undoGroup.js.html @@ -22,7 +22,7 @@
@@ -77,7 +77,7 @@

misc/undoGroup.js


- Documentation generated by JSDoc 3.4.3 on Wed Jun 21 2017 00:37:52 GMT+0200 (CEST) using the docdash theme. + Documentation generated by JSDoc 3.4.3 on Thu Jul 27 2017 18:57:34 GMT+0200 (CEST) using the docdash theme.
diff --git a/docs/misc_valueInObject.js.html b/docs/misc_valueInObject.js.html index b754cde..c58058c 100644 --- a/docs/misc_valueInObject.js.html +++ b/docs/misc_valueInObject.js.html @@ -22,7 +22,7 @@
@@ -87,7 +87,7 @@

misc/valueInObject.js


- Documentation generated by JSDoc 3.4.3 on Wed Jun 21 2017 00:37:52 GMT+0200 (CEST) using the docdash theme. + Documentation generated by JSDoc 3.4.3 on Thu Jul 27 2017 18:57:34 GMT+0200 (CEST) using the docdash theme.
diff --git a/docs/modules_app.js.html b/docs/modules_app.js.html index f91edef..b5117fb 100644 --- a/docs/modules_app.js.html +++ b/docs/modules_app.js.html @@ -22,7 +22,7 @@
@@ -212,7 +212,7 @@

modules/app.js


- Documentation generated by JSDoc 3.4.3 on Wed Jun 21 2017 00:37:52 GMT+0200 (CEST) using the docdash theme. + Documentation generated by JSDoc 3.4.3 on Thu Jul 27 2017 18:57:34 GMT+0200 (CEST) using the docdash theme.
diff --git a/docs/modules_command.js.html b/docs/modules_command.js.html index 7e7e25f..d0e4e32 100644 --- a/docs/modules_command.js.html +++ b/docs/modules_command.js.html @@ -22,7 +22,7 @@
@@ -172,7 +172,7 @@

modules/command.js


- Documentation generated by JSDoc 3.4.3 on Wed Jun 21 2017 00:37:52 GMT+0200 (CEST) using the docdash theme. + Documentation generated by JSDoc 3.4.3 on Thu Jul 27 2017 18:57:34 GMT+0200 (CEST) using the docdash theme.
diff --git a/docs/modules_comp.js.html b/docs/modules_comp.js.html index 98b53d3..b9736a7 100644 --- a/docs/modules_comp.js.html +++ b/docs/modules_comp.js.html @@ -22,7 +22,7 @@
@@ -190,7 +190,7 @@

modules/comp.js


- Documentation generated by JSDoc 3.4.3 on Wed Jun 21 2017 00:37:52 GMT+0200 (CEST) using the docdash theme. + Documentation generated by JSDoc 3.4.3 on Thu Jul 27 2017 18:57:34 GMT+0200 (CEST) using the docdash theme.
diff --git a/docs/modules_file.js.html b/docs/modules_file.js.html index a42caae..da8bf97 100644 --- a/docs/modules_file.js.html +++ b/docs/modules_file.js.html @@ -22,7 +22,7 @@
@@ -187,6 +187,18 @@

modules/file.js

return filePathStr.substr(0, filePathStr.lastIndexOf('.')); }, + /** + * Takes a file path or a file object, and returns a file object + * allows functions to be flexible in whether they take a path vs file + * @method + * @memberof aeq + * @param {File|string} filePath String path to a file, or file object + * @return {File} Resolved file object + */ + getFileObject: function(filePath) { + return aeq.isFile(filePath) ? filePath : new File(filePath); + }, + /** * Gets target file by path or file object, or null if doesn't exist * @method @@ -224,6 +236,18 @@

modules/file.js

return aeq.arrayEx(files); }, + /** + * Takes a folder path or a folder object, and returns a folder object + * allows functions to be flexible in whether they take a path vs folder + * @method + * @memberof aeq + * @param {Folder|string} folderPath String path to a folder, or folder object + * @return {Folder} Resolved folder object + */ + getFolderObject: function(folderPath) { + return aeq.isFolder(folderPath) ? folderPath : new Folder(folderPath); + }, + /** * Returns a folder, or null if it doesn't exist * @method @@ -255,13 +279,81 @@

modules/file.js

return folder; }, + + /** + * Returns the contents of a specified file + * @method + * @memberof aeq + * @param {File|string} filePath Path or file to read + * @param {string} [encoding=UTF-8] Encoding method + * @return {string|null} Contents of the file, or null if file doesn't exist + */ + readFile: function(filePath, encoding) { + var file = aeq.getFileObject(filePath), + contents; + + encoding = setDefault(encoding, "UTF-8"); + + if (file.exists) { + if (File.isEncodingAvailable(encoding)) + file.encoding = encoding; + + file.open(); + contents = file.read(); + file.close(); + return contents; + } + return null; + }, + + /** + * Writes data to a file, returns file + * @method + * @memberof aeq + * @param {File|string} filePath Path or file to write to + * @param {string} contents Data to write to the file + * @param {object} [options] Options for writing file. + * @param {boolean} [options.overwrite=false] `true` if file should be overwritten if exists. + * @param {string} [options.encoding="UTF-8"] Encoding method. + * @return {File|null} New file, or null if file was not written + * correctly or file exits and overwrite = false + */ + writeFile: function(filePath, contents, options) { + var file = aeq.getFileObject(filePath); + options = aeq.setDefault(options, {}); + + if (file.exists && options.overwrite === false) { + return null + } + + if (!file.exists) { + aeq.file.ensureFolderExists(file.path); + } + + if (!aeq.isNullOrUndefined(options.encoding) && File.isEncodingAvailable(options.encoding)) { + file.encoding = options.encoding; + } + + file.open("w"); + var success = file.write(contents); + file.close(); + + if (success) + return file; + + return null; + } }); // Function aliases aeq.pathSeparatorSymbol = aeq.file.pathSeparatorSymbol; +aeq.getFileObject = aeq.file.getFileObject; +aeq.getFolderObject = aeq.file.getFolderObject; aeq.getFile = aeq.file.get = aeq.file.getFile; aeq.getFiles = aeq.file.getFiles; aeq.getFolder = aeq.file.getFolder; +aeq.readFile = aeq.file.readFile; +aeq.writeFile = aeq.file.writeFile; return aeq; }(aeq || {})); @@ -277,7 +369,7 @@

modules/file.js


- Documentation generated by JSDoc 3.4.3 on Wed Jun 21 2017 00:37:52 GMT+0200 (CEST) using the docdash theme. + Documentation generated by JSDoc 3.4.3 on Thu Jul 27 2017 18:57:34 GMT+0200 (CEST) using the docdash theme.
diff --git a/docs/modules_layer.js.html b/docs/modules_layer.js.html index fb34339..00ff02d 100644 --- a/docs/modules_layer.js.html +++ b/docs/modules_layer.js.html @@ -22,7 +22,7 @@
@@ -156,7 +156,7 @@

modules/layer.js


- Documentation generated by JSDoc 3.4.3 on Wed Jun 21 2017 00:37:52 GMT+0200 (CEST) using the docdash theme. + Documentation generated by JSDoc 3.4.3 on Thu Jul 27 2017 18:57:34 GMT+0200 (CEST) using the docdash theme.
diff --git a/docs/modules_project.js.html b/docs/modules_project.js.html index b2acc88..4c49b28 100644 --- a/docs/modules_project.js.html +++ b/docs/modules_project.js.html @@ -22,7 +22,7 @@
@@ -61,9 +61,7 @@

modules/project.js

getFootage: function(){ var items = aeq.getItems(); - return aeq.filter(items, function(item){ - return aeq.isFootageItem(item); - }); + return aeq.filter(items, aeq.isFootageItem); }, /** @@ -76,18 +74,16 @@

modules/project.js

getFolders: function(parentFolder){ var folders = aeq.getItems(parentFolder); - return folders.filter(function(item){ - return aeq.isFolderItem(item); - }); + return folders.filter(aeq.isFolderItem); }, /** - * Find folder by name in target folder, or root + * Find folder by name in target folder. * @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 + * @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|null} FolderItem with the name. Or `null` if not found. */ findFolder: function(name, parentFolder){ var folders = aeq.project.getFolders(parentFolder); @@ -95,8 +91,10 @@

modules/project.js

var folder = aeq.filter(folders, function(folder) { return folder.name == name; }); - - return folder[0]; + if (folder.length) { + return folder[0]; + } + return null; }, /** @@ -108,11 +106,13 @@

modules/project.js

* @return {FolderItem|null} Target folder item, or null */ getFolder: function(folder, parentFolder){ - if (aeq.isFolderItem(folder)) + if (aeq.isFolderItem(folder)) { return folder; + } - if (aeq.isString(folder)) + if (aeq.isString(folder)) { return aeq.project.findFolder(folder, parentFolder); + } return null; }, @@ -124,9 +124,7 @@

modules/project.js

* @return {FolderItem[]} ArrayEx of all selected folder items */ getSelectedFolders: function(){ - return aeq.filter(app.project.selection, function(item){ - return aeq.isFolderItem(item); - }); + return aeq.filter(app.project.selection, aeq.isFolderItem); }, /** @@ -136,9 +134,7 @@

modules/project.js

* @return {CompItem[]} ArrayEx of all selected comp items */ getSelectedComps: function(){ - return aeq.filter(app.project.selection, function(item){ - return aeq.isComp(item); - }); + return aeq.filter(app.project.selection, aeq.isComp); }, /** @@ -148,9 +144,7 @@

modules/project.js

* @return {Item[]} ArrayEx of all selected footage items */ getSelectedFootage: function(){ - return aeq.filter(app.project.selection, function(item){ - return aeq.isFootageItem(item); - }); + return aeq.filter(app.project.selection, aeq.isFootageItem); }, /** @@ -385,7 +379,7 @@

modules/project.js


- Documentation generated by JSDoc 3.4.3 on Wed Jun 21 2017 00:37:52 GMT+0200 (CEST) using the docdash theme. + Documentation generated by JSDoc 3.4.3 on Thu Jul 27 2017 18:57:34 GMT+0200 (CEST) using the docdash theme.
diff --git a/docs/modules_property.js.html b/docs/modules_property.js.html index a620338..589ffd6 100644 --- a/docs/modules_property.js.html +++ b/docs/modules_property.js.html @@ -22,7 +22,7 @@
@@ -135,7 +135,7 @@

modules/property.js


- Documentation generated by JSDoc 3.4.3 on Wed Jun 21 2017 00:37:52 GMT+0200 (CEST) using the docdash theme. + Documentation generated by JSDoc 3.4.3 on Thu Jul 27 2017 18:57:34 GMT+0200 (CEST) using the docdash theme.
diff --git a/docs/modules_renderqueue.js.html b/docs/modules_renderqueue.js.html index 8264402..a6ed48c 100644 --- a/docs/modules_renderqueue.js.html +++ b/docs/modules_renderqueue.js.html @@ -22,7 +22,7 @@
@@ -263,7 +263,7 @@

modules/renderqueue.js


- Documentation generated by JSDoc 3.4.3 on Wed Jun 21 2017 00:37:52 GMT+0200 (CEST) using the docdash theme. + Documentation generated by JSDoc 3.4.3 on Thu Jul 27 2017 18:57:34 GMT+0200 (CEST) using the docdash theme.
diff --git a/docs/modules_settings.js.html b/docs/modules_settings.js.html index e069a46..5f9f1c9 100644 --- a/docs/modules_settings.js.html +++ b/docs/modules_settings.js.html @@ -22,7 +22,7 @@
@@ -232,7 +232,7 @@

modules/settings.js


- Documentation generated by JSDoc 3.4.3 on Wed Jun 21 2017 00:37:52 GMT+0200 (CEST) using the docdash theme. + Documentation generated by JSDoc 3.4.3 on Thu Jul 27 2017 18:57:34 GMT+0200 (CEST) using the docdash theme.
diff --git a/docs/modules_snippet.js.html b/docs/modules_snippet.js.html index 268146d..7329c0b 100644 --- a/docs/modules_snippet.js.html +++ b/docs/modules_snippet.js.html @@ -22,7 +22,7 @@
@@ -236,7 +236,7 @@

modules/snippet.js


- Documentation generated by JSDoc 3.4.3 on Wed Jun 21 2017 00:37:52 GMT+0200 (CEST) using the docdash theme. + Documentation generated by JSDoc 3.4.3 on Thu Jul 27 2017 18:57:34 GMT+0200 (CEST) using the docdash theme.
diff --git a/docs/objects_array.js.html b/docs/objects_array.js.html index 7f4f92f..d8ce8d9 100644 --- a/docs/objects_array.js.html +++ b/docs/objects_array.js.html @@ -22,7 +22,7 @@
@@ -300,11 +300,15 @@

objects/array.js

}, /** - * Checks the arguments length to determine to get or set - * and it needs an object to get or set attributes to. + * Sets or gets an attribute value for all objects in the array. When getting a + * value, it only returns the valure from the first object. * @method * @memberof aeq.arrayEx - * @return {type} [description] + * @param {string} attributeName The name of the attribute to get or set. + * @param {Any} [newValue] The value to set. If not given, will only get + * the value of the first object. + * @return {Any} when getting, the value of the attribute. + * When setting, `undefined`. * @see aeq.attr */ attr: function() { @@ -328,7 +332,7 @@

objects/array.js


- Documentation generated by JSDoc 3.4.3 on Wed Jun 21 2017 00:37:52 GMT+0200 (CEST) using the docdash theme. + Documentation generated by JSDoc 3.4.3 on Thu Jul 27 2017 18:57:34 GMT+0200 (CEST) using the docdash theme.
diff --git a/docs/objects_comp.js.html b/docs/objects_comp.js.html index d9314c8..01d0b73 100644 --- a/docs/objects_comp.js.html +++ b/docs/objects_comp.js.html @@ -22,7 +22,7 @@
@@ -105,7 +105,7 @@

objects/comp.js


- Documentation generated by JSDoc 3.4.3 on Wed Jun 21 2017 00:37:52 GMT+0200 (CEST) using the docdash theme. + Documentation generated by JSDoc 3.4.3 on Thu Jul 27 2017 18:57:34 GMT+0200 (CEST) using the docdash theme.
diff --git a/docs/objects_key.js.html b/docs/objects_key.js.html index d04b2e2..7b98775 100644 --- a/docs/objects_key.js.html +++ b/docs/objects_key.js.html @@ -22,7 +22,7 @@
@@ -483,7 +483,7 @@

objects/key.js


- Documentation generated by JSDoc 3.4.3 on Wed Jun 21 2017 00:37:52 GMT+0200 (CEST) using the docdash theme. + Documentation generated by JSDoc 3.4.3 on Thu Jul 27 2017 18:57:34 GMT+0200 (CEST) using the docdash theme.
diff --git a/docs/objects_layer.js.html b/docs/objects_layer.js.html index 02a6fcc..ffd5520 100644 --- a/docs/objects_layer.js.html +++ b/docs/objects_layer.js.html @@ -22,7 +22,7 @@
@@ -363,7 +363,7 @@

objects/layer.js


- Documentation generated by JSDoc 3.4.3 on Wed Jun 21 2017 00:37:52 GMT+0200 (CEST) using the docdash theme. + Documentation generated by JSDoc 3.4.3 on Thu Jul 27 2017 18:57:34 GMT+0200 (CEST) using the docdash theme.
diff --git a/docs/objects_property.js.html b/docs/objects_property.js.html index 7ff8080..33bc4b3 100644 --- a/docs/objects_property.js.html +++ b/docs/objects_property.js.html @@ -22,7 +22,7 @@
@@ -341,7 +341,7 @@

objects/property.js


- Documentation generated by JSDoc 3.4.3 on Wed Jun 21 2017 00:37:52 GMT+0200 (CEST) using the docdash theme. + Documentation generated by JSDoc 3.4.3 on Thu Jul 27 2017 18:57:34 GMT+0200 (CEST) using the docdash theme.
diff --git a/docs/select.js.html b/docs/select.js.html index a174703..056688e 100644 --- a/docs/select.js.html +++ b/docs/select.js.html @@ -22,7 +22,7 @@
@@ -317,7 +317,7 @@

select.js


- Documentation generated by JSDoc 3.4.3 on Wed Jun 21 2017 00:37:52 GMT+0200 (CEST) using the docdash theme. + Documentation generated by JSDoc 3.4.3 on Thu Jul 27 2017 18:57:34 GMT+0200 (CEST) using the docdash theme.
diff --git a/docs/tutorial-Add motion blur to animated layers.html b/docs/tutorial-Add motion blur to animated layers.html index 34de664..b6033d0 100644 --- a/docs/tutorial-Add motion blur to animated layers.html +++ b/docs/tutorial-Add motion blur to animated layers.html @@ -22,7 +22,7 @@
@@ -113,7 +113,7 @@

Add motion blur to animated layers

The goal of this script is to turn

- Documentation generated by JSDoc 3.4.3 on Wed Jun 21 2017 00:37:52 GMT+0200 (CEST) using the docdash theme. + Documentation generated by JSDoc 3.4.3 on Thu Jul 27 2017 18:57:34 GMT+0200 (CEST) using the docdash theme.
diff --git a/docs/types.js.html b/docs/types.js.html index 60365b8..5e249f1 100644 --- a/docs/types.js.html +++ b/docs/types.js.html @@ -22,7 +22,7 @@
@@ -457,7 +457,7 @@

types.js


- Documentation generated by JSDoc 3.4.3 on Wed Jun 21 2017 00:37:52 GMT+0200 (CEST) using the docdash theme. + Documentation generated by JSDoc 3.4.3 on Thu Jul 27 2017 18:57:34 GMT+0200 (CEST) using the docdash theme.
diff --git a/docs/ui_container.js.html b/docs/ui_container.js.html index 440aa16..701b95f 100644 --- a/docs/ui_container.js.html +++ b/docs/ui_container.js.html @@ -22,7 +22,7 @@
@@ -507,7 +507,7 @@

ui/container.js


- Documentation generated by JSDoc 3.4.3 on Wed Jun 21 2017 00:37:52 GMT+0200 (CEST) using the docdash theme. + Documentation generated by JSDoc 3.4.3 on Thu Jul 27 2017 18:57:34 GMT+0200 (CEST) using the docdash theme.
diff --git a/docs/ui_main.js.html b/docs/ui_main.js.html index 45a3abb..07333d8 100644 --- a/docs/ui_main.js.html +++ b/docs/ui_main.js.html @@ -22,7 +22,7 @@
@@ -139,7 +139,7 @@

ui/main.js


- Documentation generated by JSDoc 3.4.3 on Wed Jun 21 2017 00:37:52 GMT+0200 (CEST) using the docdash theme. + Documentation generated by JSDoc 3.4.3 on Thu Jul 27 2017 18:57:34 GMT+0200 (CEST) using the docdash theme.
diff --git a/docs/ui_window.js.html b/docs/ui_window.js.html index 32d84d3..9595fdf 100644 --- a/docs/ui_window.js.html +++ b/docs/ui_window.js.html @@ -22,7 +22,7 @@
@@ -115,7 +115,7 @@

ui/window.js


- Documentation generated by JSDoc 3.4.3 on Wed Jun 21 2017 00:37:52 GMT+0200 (CEST) using the docdash theme. + Documentation generated by JSDoc 3.4.3 on Thu Jul 27 2017 18:57:34 GMT+0200 (CEST) using the docdash theme.
diff --git a/lib/main.js b/lib/main.js index 6db771d..2bdb400 100644 --- a/lib/main.js +++ b/lib/main.js @@ -64,7 +64,7 @@ var aeq = function(selector, context) { return result; }; -aeq.version = "0.2.1" +aeq.version = "0.3.0" aeq.thisObj = this; diff --git a/package.json b/package.json index d263a8d..deaee67 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "aequery", - "version": "0.2.1", + "version": "0.3.0", "description": "General purpose after effects scripting library", "main": "dist/aequery.js", "scripts": {