Methods
aeq(selector, contextopt) → {ArrayEx|aeq.Comp|aeq.Layer|aeq.Property}
Gets objects by looking at a string and finding objects in After
Effects matching the description. The context is used to
determine a starting point for where the function starts looking
for elements.
If an Array
, CompItem
, Layer
, or Property
is given, the object will be
converted to the corresponding aequery object: aeq.ArrayEx
, aeq.Comp
,
aeq.Layer
, aeq.Property
.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
selector |
aeq.SelectorString | Array | CompItem | Layer | Property | A string containing a selector expression, or an object to be converted to aeq type object. |
|
context |
CompItem | FolderItem | Layer | PropertyGroup | Array |
<optional> |
The object to start looking from |
Returns:
The found After Effects objects, or the converted AEQuery object
- Type
- ArrayEx | aeq.Comp | aeq.Layer | aeq.Property
getItemsDeep(folder, returnArrayEx) → {aeq.arrayEx}
Returns an aeq.arrayEx
with all items in a folder, and items in
subfolders.
Parameters:
Name | Type | Description |
---|---|---|
folder |
FolderItem | The folder to flatten. |
returnArrayEx |
Boolean | Included so we can skip the converting to arrayEx when recursing. It is not meant to be used outside of this function. |
Returns:
ArrayEx with Item objects.
- Type
- aeq.arrayEx
setOrGetDefault(value, defaultVal) → {Any}
- Source:
Used for setting the default value in functions. Returns the first argument
is not undefined, else it returns defaultVal
.
If defaultval
is a function, the function will run and its value returned.
Example
function getCustomGreeting() {
return prompt( 'Enter your greeting!', 'Hello World!' )
}
function say( greeting ) {
a = aeq.setOrGetDefault( greeting, getCustomGreeting )
alert( a )
}
Parameters:
Name | Type | Description |
---|---|---|
value |
Any | The value to check |
defaultVal |
Any | The value to use if |
Returns:
value
if it is not undefined
, else defaultVal
- Type
- Any
Type Definitions
forEachArrayCallback(element, index, array)
Is executed for each element in an array
Parameters:
Name | Type | Description |
---|---|---|
element |
Any | The current element in the array |
index |
Integer | The index of the current element in the array |
array |
Array | The array being looped through |
forEachObjectCallback(element, index, array)
Is executed for key-value pair in an object
Parameters:
Name | Type | Description |
---|---|---|
element |
Any | The current key in the object |
index |
Integer | The value of the current key |
array |
Array | The object being looped through |
InterpolationType
- Source:
Properties:
Name | Type | Description |
---|---|---|
inType |
KeyframeInterpolationType | Interpolation for keyIn |
outType |
KeyframeInterpolationType | Interpolation for keyOut |
Interpolation type object
Type:
- object
KeyframeEase
- Source:
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
xTemporalEase |
number | ||
yTemporalEase |
number | ||
zTemporalEase |
number |
<optional> |
Type:
- Array.<number>
KeyframeInterpolationType
- Source:
Properties:
Name | Type | Description |
---|---|---|
LINEAR |
6612 | |
BEZIER |
6613 | |
HOLD |
6614 |
Type:
- object
KeyframeSpatialTangent
- Source:
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
xSpatialTangent |
number | ||
ySpatialTangent |
number | ||
zSpatialTangent |
number |
<optional> |
Type:
- Array.<number>
SpatialTangent
- Source:
Properties:
Name | Type | Description |
---|---|---|
inTangent |
KeyframeSpatialTangent | Tangent for keyIn |
outTangent |
KeyframeSpatialTangent | Tangent for keyOut |
SpatialTangent type object
Type:
- object
TemporalEase
- Source:
Properties:
Name | Type | Description |
---|---|---|
inTemporalEase |
KeyframeEase | TemporalEase for keyIn |
outTemporalEase |
KeyframeEase | TemporalEase for keyOut |
TemporalEase type object
Type:
- object