Classes

"FuzzyLogic"

DuAEF.DuExpression.Library."FuzzyLogic"

"Matrix"

DuAEF.DuExpression.Library."Matrix"

Members

static "inverseLogisitic"

DuAEF.jsxinc, line 36584

The inverse logistic function (inverse sigmoid)
Note that for performance reasons with expressions, even if the parameters of the function are documented with optional/default values, you MUST provide ALL the arguments when using them. * @function

static "isSpatial"

DuAEF.jsxinc, line 36749

Checks if a property is spatial

Methods

static "addNoise"(val, quantity)

DuAEF.jsxinc, line 36800

Adds some noise to a value.
You may use seedRandom() before using this function as it will influence the generated noise. A timeless noise can be achieved with seedRandom(index,true) for example.

Parameters:

Name	Type	Description
val	number | Array.<number>	The value to add noise to.
quantity	float	The quantity of noise. A percentage. 100 means the value can range from (val * 0) to (val * 2).

Examples

seedRandom(index, true) // a timeless noise
addNoise(value, 50 ); // the property value will have noise between (value * 0.5) and (value * 1.5) which won't vary through time.

seedRandom(index, false);
addNoise(value, 33 ); // the noise will change at each frame, varying between (value * .66) and (value * 1.33)

static "bezierInterpolation"(t, tMinopt, tMaxopt, value1opt, value2opt, bezierPointsopt) → {number}

DuAEF.jsxinc, line 36405

Interpolates a value with a bezier curve.
This method can replace linear() and ease() with a custom b�zier interpolation.

Parameters:

Name	Type	Attributes	Default	Description
t	number			The value to interpolate
tMin	number	<optional>	0	The minimum value of the initial range
tMax	number	<optional>	1	The maximum value of the initial range
value1	number	<optional>	0	The minimum value of the interpolated result
value2	number	<optional>	1	The maximum value of the interpolated result
bezierPoints	Array.<number>	<optional>	[0.33,0.0,0.66,1.0]	an Array of 4 coordinates wihtin the [0.0, 1.0] range which describes the B�zier interpolation. The default mimics the native ease() function [ outTangentX, outTangentY, inTangentX, inTangentY ]

Returns:

number - the value.

static "checkDuikEffect"(fx, duikMatchName) → {boolean}

DuAEF.jsxinc, line 36658

Checks the type of a pseudo-effect used by Duik.
This is a workaround for the missing matchName in expressions.
Pseudo-Effects used by Duik start with a hidden property which name is the same as the matchName of the effect itself (without the 'Pseudo/' part).

Parameters:

Name	Type	Description
fx	Property	The effect to check
duikMatchName	string	The matchName of a pseudo-effect used by Duik (without the 'Pseudo/' part)

Returns:

boolean - True when the property at propIndex is named propName

Example

if ( checkEffect(thisLayer.effect(1), "DUIK parentConstraint2") ) { "This is the second version of the parent constraint by Duik" }
else { "Who knows what this is?" }

static "checkEffect"(fx, propIndex, propName) → {boolean}

DuAEF.jsxinc, line 36686

Checks the type of an effect.
This is a workaround for the missing matchName in expressions.
It checks if the given effect has a specific property at a specific index.

Parameters:

Name	Type	Description
fx	Property	The effect to check
propIndex	int	The index of the property
propName	string	The expected name of the property. Be careful with the internationalization of After Effects...

Returns:

boolean - True when the property at propIndex is named propName

Example

if ( checkEffect(thisLayer.effect(1), 1, "Blur") ) { "The first effect is a blur!" }
else { "Who knows what this is?" }

static "dishineritRotation"(lopt) → {float}

DuAEF.jsxinc, line 36828

Removes the ancestors rotation from the rotation of a layer. This is very useful to make a layer keep its orientation without being influenced by its parents.
Note that for performance reasons with expressions, even if the parameters of the function are documented with optional/default values, you MUST provide ALL the arguments when using them.

Parameters:

Name	Type	Attributes	Default	Description
l	Layer	<optional>	thisLayer	The layer

Requires:

• module:sign

Returns:

float - The new rotation value, in degrees.

Examples

//in a rotation property, just include the function and use:
dishineritRotation();
//the layer will now keep its own orientation.

//you can also combine the result with something else
var result = dishineritRotation();
result + wiggle(5,20);

static "dishineritScale"(lopt) → {Array.<float>}

DuAEF.jsxinc, line 36858

Removes the ancestors scale from the scale of a layer. This is very useful to make a layer keep its scale without being influenced by its parents.
Note that for performance reasons with expressions, even if the parameters of the function are documented with optional/default values, you MUST provide ALL the arguments when using them.

Parameters:

Name	Type	Attributes	Default	Description
l	Layer	<optional>	thisLayer	The layer

Returns:

Array.<float> - The new scale value, in percent.

Examples

//in a rotation property, just include the function and use:
dishineritScale();
//the layer will now keep its own scale.

//you can also combine the result with something else
var result = dishineritScale();
result + wiggle(5,20);

static "fromGroupToLayer"(point) → {Array.<number>}

DuAEF.jsxinc, line 36889

Converts the point coordinates from the current group in the shape layer to the Layer.
Use toWorld and toComp with the result if you need te coordinates in the world or the comp.

Parameters:

Name	Type	Description
point	Array.<number>	The 2D coordinates of the point in the current group.

Requires:

• module:Matrix
• module:getGroupTransformMatrix

Returns:

Array.<number> - The 2D coordinates of the point in the Layer.

static "fromLayerToGroup"(point) → {Array.<number>}

DuAEF.jsxinc, line 36906

Converts the point coordinates from Layer to the current group in the shape layer.
Use fromWorld or fromComp first if you need to convert from the world or composition coordinates, and pass the result to this function.

Parameters:

Name	Type	Description
point	Array.<number>	The 2D coordinates of the point in the Layer.

Requires:

• module:Matrix
• module:getGroupTransformMatrix

Returns:

Array.<number> - The 2D coordinates of the point in the current group.

static "gaussian"(value, minopt, maxopt, centeropt, fwhmopt) → {Number}

DuAEF.jsxinc, line 36534

The gaussian function
Note that for performance reasons with expressions, even if the parameters of the function are documented with optional/default values, you MUST provide ALL the arguments when using them.

Parameters:

Name	Type	Attributes	Default	Description
value	Number			The variable
min	Number	<optional>	0	The minimum return value
max	Number	<optional>	1	The maximum return value
center	Number	<optional>	0	The center of the peak
fwhm	Number	<optional>	1	The full width at half maximum of the curve

Returns:

Number - The result

static "gaussianInterpolation"(t, tMinopt, tMaxopt, value1opt, value2opt, rateopt) → {number}

DuAEF.jsxinc, line 36446

Interpolates a value with a gaussian function.
This method can replace linear() and ease() with a gaussian interpolation.
Note that for performance reasons with expressions, even if the parameters of the function are documented with optional/default values, you MUST provide ALL the arguments when using them.

Parameters:

Name	Type	Attributes	Default	Description
t	number			The value to interpolate
tMin	number	<optional>	0	The minimum value of the initial range
tMax	number	<optional>	1	The maximum value of the initial range
value1	number	<optional>	0	The minimum value of the interpolated result
value2	number	<optional>	1	The maximum value of the interpolated result
rate	number	<optional>	0	The raising speed in the range [-1.0, 1.0].

Returns:

number - the value.

static "getCompScale"(lopt, topt) → {number}

DuAEF.jsxinc, line 36922

Gets the "real" scale of a layer, resulting to its scale property, the scale of its parents, and it's location in Z-space if it's 3D.
Note that for performance reasons with expressions, even if the parameters of the function are documented with optional/default values, you MUST provide ALL the arguments when using them.

Parameters:

Name	Type	Attributes	Default	Description
l	Layer	<optional>	thisLayer	The layer
t	number	<optional>	time	The time when to get the scale

Returns:

number - The scale ratio. This is not a percent, 1.0 is 100%.

static "getEffectLayer"(fx, ind) → {Layer|null}

DuAEF.jsxinc, line 36708

Gets a layer from a layer property in an effect, without generating an error if "None" is selected with the Legacy expression engine.

Parameters:

Name	Type	Description
fx	Property	The effect
ind	int | string	The index or the name of the property

Returns:

Layer | null - The layer, or null if set to "None"

static "getGroupTransformMatrix"(propopt) → {Matrix}

DuAEF.jsxinc, line 36942

Gets the transformation Matrix for the current group in a shape layer, including the transformation from the ancestor groups
Note that for performance reasons with expressions, even if the parameters of the function are documented with optional/default values, you MUST provide ALL the arguments when using them.

Parameters:

Name	Type	Attributes	Default	Description
prop	Property	<optional>	thisProperty	The property from which to get the matrix

Requires:

• module:isLayer
• module:Matrix

Returns:

Matrix - The 2D Transform Matrix.

static "getLayerCompPos"(topt, lopt) → {Array.<number>}

DuAEF.jsxinc, line 36976

Gets the comp position (2D Projection in the comp) of a layer.
Note that for performance reasons with expressions, even if the parameters of the function are documented with optional/default values, you MUST provide ALL the arguments when using them.

Parameters:

Name	Type	Attributes	Default	Description
t	number	<optional>	time	Time from when to get the position
l	Layer	<optional>	thisLayer	The layer

Returns:

Array.<number> - The comp position

static "getLayerWorldPos"(topt, lopt) → {Array.<number>}

DuAEF.jsxinc, line 36991

Gets the world position of a layer.
Note that for performance reasons with expressions, even if the parameters of the function are documented with optional/default values, you MUST provide ALL the arguments when using them.

Parameters:

Name	Type	Attributes	Default	Description
t	number	<optional>	time	Time from when to get the position
l	Layer	<optional>	thisLayer	The layer

Returns:

Array.<number> - The world position

static "getLayerWorldSpeed"(topt, lopt) → {number}

DuAEF.jsxinc, line 37006

Gets the world instant speed of a layer.

Parameters:

Name	Type	Attributes	Default	Description
t	number	<optional>	time	The time when to get the velocity
l	Layer	<optional>	thisLayer	The layer

Requires:

• module:getLayerWorldVelocity

Returns:

number - A positive number. The speed.

static "getLayerWorldVelocity"(topt, lopt) → {Array.<number>}

DuAEF.jsxinc, line 37022

Gets the world instant velocity of a layer.
Note that for performance reasons with expressions, even if the parameters of the function are documented with optional/default values, you MUST provide ALL the arguments when using them.

Parameters:

Name	Type	Attributes	Default	Description
t	number	<optional>	time	The time when to get the velocity
l	Layer	<optional>	thisLayer	The layer

Requires:

• module:getLayerWorldPos

Returns:

Array.<number> - The velocity.

static "getNextKey"(topt) → {Key|null}

DuAEF.jsxinc, line 36480

Gets the key immediately after the given time
Note that for performance reasons with expressions, even if the parameters of the function are documented with optional/default values, you MUST provide ALL the arguments when using them.

Parameters:

Name	Type	Attributes	Default	Description
t	number	<optional>	time	Time at which to get the key

Returns:

Key | null - The key, or null if there's no key before.

static "getOrientation"(l) → {float}

DuAEF.jsxinc, line 37035

Gets the world orientation of a (2D) layer.

Parameters:

Name	Type	Description
l	Layer	The layer to get the orientation from

Returns:

float - The orientation, in degrees.

static "getOrientationAtTime"(l, topt) → {float}

DuAEF.jsxinc, line 37081

Gets the world orientation of a (2D) layer at a specific time.
Note that for performance reasons with expressions, even if the parameters of the function are documented with optional/default values, you MUST provide ALL the arguments when using them.

Parameters:

Name	Type	Attributes	Default	Description
l	Layer			The layer to get the orientation from
t	float	<optional>	time	The time at which to get the orientation

Returns:

float - The orientation, in degrees.

static "getPrevKey"(topt) → {Key|null}

DuAEF.jsxinc, line 36498

Gets the key immediately before the given time
Note that for performance reasons with expressions, even if the parameters of the function are documented with optional/default values, you MUST provide ALL the arguments when using them.

Parameters:

Name	Type	Attributes	Default	Description
t	number	<optional>	time	Time at which to get the key

Returns:

Key | null - The key, or null if there's no key before.

static "getPropWorldSpeed"(topt, propopt) → {Array.<number>}

DuAEF.jsxinc, line 37102

Gets the world speed of a property.

Parameters:

Name	Type	Attributes	Default	Description
t	number	<optional>	time	Time from when to get the position
prop	Layer	<optional>	thisProperty	The property

Requires:

• module:getPropWorldVelocity

Returns:

Array.<number> - The world speed

static "getPropWorldValue"(topt, propopt) → {Array.<number>}

DuAEF.jsxinc, line 37119

Gets the world coordinates of a property.
Note that for performance reasons with expressions, even if the parameters of the function are documented with optional/default values, you MUST provide ALL the arguments when using them.

Parameters:

Name	Type	Attributes	Default	Description
t	number	<optional>	time	Time from when to get the position
prop	Layer	<optional>	thisProperty	The property

Requires:

• module:getLayerWorldPos
• module:isPosition

Returns:

Array.<number> - The world coordinates

static "getPropWorldVelocity"(topt, propopt) → {Array.<number>}

DuAEF.jsxinc, line 37136

Gets the world velocity of a property.
Note that for performance reasons with expressions, even if the parameters of the function are documented with optional/default values, you MUST provide ALL the arguments when using them.

Parameters:

Name	Type	Attributes	Default	Description
t	number	<optional>	time	Time from when to get the position
prop	Layer	<optional>	thisProperty	The property

Requires:

• module:getPropWorldValue

Returns:

Array.<number> - The world velocity

static "getScale"(l) → {Array.<float>}

DuAEF.jsxinc, line 37149

Gets the world scale of a layer.

Parameters:

Name	Type	Description
l	Layer	The layer to get the scale from

Returns:

Array.<float> - The scale, in percent.

static "inverseGaussian"(v, minopt, maxopt, centeropt, fwhmopt) → {Array.<Number>}

DuAEF.jsxinc, line 36559

The inverse gaussian function
Note that for performance reasons with expressions, even if the parameters of the function are documented with optional/default values, you MUST provide ALL the arguments when using them.

Parameters:

Name	Type	Attributes	Default	Description
v	Number			The variable
min	Number	<optional>	0	The minimum return value of the corresponding gaussian function
max	Number	<optional>	1	The maximum return value of the corresponding gaussian function
center	Number	<optional>	0	The center of the peak of the corresponding gaussian function
fwhm	Number	<optional>	1	The full width at half maximum of the curve of the corresponding gaussian function

Returns:

Array.<Number> - The two possible results, the lower is the first in the list. If both are the same, it is the maximum

static "isAfterLastKey"() → {boolean}

DuAEF.jsxinc, line 36514

Checks if current time is after the time of the last key in the property

Returns:

boolean - true if time is > lastkey.time

static "isLayer"(prop) → {boolean}

DuAEF.jsxinc, line 36722

Checks if a property is a layer. Useful when traversing up the property tree to stop when getting the layer.

Parameters:

Name	Type	Description
prop	Property	The property to test

Returns:

boolean - true if the prop is a layer

static "isPosition"(propopt) → {boolean}

DuAEF.jsxinc, line 36737

Checks if a property is a transform.position property.
Note that for performance reasons with expressions, even if the parameters of the function are documented with optional/default values, you MUST provide ALL the arguments when using them.

Parameters:

Name	Type	Attributes	Default	Description
prop	Property	<optional>	thisProperty	The property

Returns:

boolean - true if the property is the transform.position property.

static "isStill"(topt, thresholdopt) → {boolean}

DuAEF.jsxinc, line 36767

Checks if the current property is animated at a given time.
Note that for performance reasons with expressions, even if the parameters of the function are documented with optional/default values, you MUST provide ALL the arguments when using them.

Parameters:

Name	Type	Attributes	Default	Description
t	number	<optional>	time	The time
threshold	number	<optional>	0.1	The speed under which the property is considered still.

Returns:

boolean - true if the property does not vary.

static "logisitic"(value, midValueopt, minopt, maxopt, rateopt) → {Number}

DuAEF.jsxinc, line 36604

The logistic function (sigmoid)
Note that for performance reasons with expressions, even if the parameters of the function are documented with optional/default values, you MUST provide ALL the arguments when using them.

Parameters:

Name	Type	Attributes	Default	Description
value	Number			The value
midValue	Number	<optional>	0	The midpoint value, at which the function returns max/2
min	Number	<optional>	0	The minimum return value
max	Number	<optional>	1	The maximum return value
rate	Number	<optional>	1	The logistic growth rate or steepness of the function

Returns:

Number - The result in the range [min, max] (excluding min and max)

static "mean"(values) → {Number}

DuAEF.jsxinc, line 36620

Returns the mean of a set of values

Parameters:

Name	Type	Description
values	Array.<Number>	The values

Returns:

Number - The mean

static "translatePointWithLayer"(l, pointopt, startTopt, endTopt) → {Array.<float>}

DuAEF.jsxinc, line 37368

Translates a point with a layer, as if it was parented to it.
Note that for performance reasons with expressions, even if the parameters of the function are documented with optional/default values, you MUST provide ALL the arguments when using them.

Parameters:

Name	Type	Attributes	Default	Description
l	Layer			The layer to get the translation from.
point	Array.<float>	<optional>	[0,0]	The [X,Y] point to translate (using world coordinates).
startT	float	<optional>	0	The start time of the translation
endT	float	<optional>	time	The end time of the translation

Returns:

Array.<float> - The coordinates of the translated point.