The index number of the property in it's property group
A 1D, positive speed value equal to the speed at which the property is changing at the default time. This element can be used only for spatial properties.
The temporal velocity value at the current time. For spatial properties, such as Position, it returns the tangent vector value. The result is the same dimension as the property.
Creates a path object from a set of points and tangents.
An array of number pair arrays representing x,y coordinates of the path points. The array length must be at least 1, and can be of any greater length.
An array containing number pair arrays representing the [x,y]
offset coordinates of the tangent handles to the path points. Required unless no parameters are passed (i.e., createPath()
). The array length must be the same as points, or you can pass an empty array ([]
), which will assume the same length as points and [0,0]
for all tangents.
See inTangents
Retrieves the path's in tangent point array
The time at which to sample the path
Whether a path is closed (the last point connected to the first)
Loops a segment of time that is measured from the first keyframe on the layer forward toward the Out point of the layer. The loop plays from the In point of the layer.
"cycle"
: (default) Repeats the specified segment.
"pingpong"
: Repeats the specified segment, alternating between forward and backward.
"offset"
: Repeats the specified segment, but offsets each cycle by the difference in the value of the property at the start and end of the segment, multiplied by the number of times the segment has looped.
"continue"
: Does not repeat the specified segment, but continues to animate a property based on the velocity at the first or last keyframe.
determines what segment is looped: The segment looped is the portion of the layer from the first keyframe to the numKeyframes+1 keyframe. The default value of 0 means that all keyframes loop
Loops a segment of time that is measured from the first keyframe on the layer forward toward the Out point of the layer. The loop plays from the In point of the layer.
"cycle"
: (default) Repeats the specified segment.
"pingpong"
: Repeats the specified segment, alternating between forward and backward.
"offset"
: Repeats the specified segment, but offsets each cycle by the difference in the value of the property at the start and end of the segment, multiplied by the number of times the segment has looped.
"continue"
: Does not repeat the specified segment, but continues to animate a property based on the velocity at the first or last keyframe.
The number of composition seconds in a segment to loop; the specified range is measured from the first keyframe
Loops a segment of time that is measured from the last keyframe on the layer back toward the In point of the layer. The loop plays until the Out point of the layer.
"cycle"
: (default) Repeats the specified segment.
"pingpong"
: Repeats the specified segment, alternating between forward and backward.
"offset"
: Repeats the specified segment, but offsets each cycle by the difference in the value of the property at the start and end of the segment, multiplied by the number of times the segment has looped.
"continue"
: Does not repeat the specified segment, but continues to animate a property based on the velocity at the first or last keyframe.
determines what segment is looped: The segment looped is the portion of the layer from the last keyframe to the thisProperty.numKeys - numKeyframes
keyframe. The default value of 0 means that all keyframes loop
Loops a segment of time that is measured from the last keyframe on the layer back toward the In point of the layer. The loop plays until the Out point of the layer.
"cycle"
: (default) Repeats the specified segment.
"pingpong"
: Repeats the specified segment, alternating between forward and backward.
"offset"
: Repeats the specified segment, but offsets each cycle by the difference in the value of the property at the start and end of the segment, multiplied by the number of times the segment has looped.
"continue"
: Does not repeat the specified segment, but continues to animate a property based on the velocity at the first or last keyframe.
The number of composition seconds in a segment to loop; the specified range is measured from the last keyframe backwards.
Get the calculated x,y coordinates of the normal for an arbitrary point along a path.
How far along the path to get the point, between 0 and 1.
The time at which to sample the path
Retrieves the path's out tangent point array
The time at which to sample the path
Get the x,y coordinates of an arbitrary point along a path.
How far along the path to get the point, between 0 and 1.
The time at which to sample the path
Retrieves the points array for a path
The time at which to sample the path
The number of levels in the property hierarchy to ascend, e.g. countUp = 1
will return the parent PropertyGroup
.
The group of properties (PropertyGroup
object) relative to the property of which the expression is written
Smooths the property values over time, converting large, brief deviations in the value to smaller, more evenly distributed deviations. This smoothing is accomplished by applying a box filter to the value of the property at the specified time.
The range of time (in seconds) over which the filter is averaged.
The number of discrete samples evenly spaced over time; use a larger value for greater smoothness (but decreased performance). Generally, youâ€™ll want samples to be an odd number so that the value at the current time is included in the average.
The composition time in seconds to get the speed at
A 1D, positive speed value equal to the speed at which the property is changing at the specified time. This element can be used only for spatial properties.
Get the calculated x,y coordinates of the outgoing tangent handle for an arbitrary point along a path.
How far along the path to get the point, between 0 and 1.
The time at which to sample the path
Samples the property value at a time which is wiggled
The rate at which the value changes in wiggles per second
How much the value should change, in units of the original property value (e.g. 1
by 100% of the original value)
How much detail the wiggle has, which is driven by the number of "octaves" of noise to multiply together. Higher values will have more detail
The amount the given amplitude is multiplied by for each octave, which controls the falloff of the upper harmonics ("octaves").
The time at which the value is sampled for use within the wiggle
Returns the value for the property at the specified time
THe composition time in seconds to get the value at
The composition time in seconds to get the velocity at
The temporal velocity value at the specified time. For spatial properties, such as Position, it returns the tangent vector value. The result is the same dimension as the property.
Modifies the property value randomly over time.
The rate at which the value changes in wiggles per second
How much the value should change, in units of the original property value (e.g. 1
by 100% of the original value)
How much detail the wiggle has, which is driven by the number of "octaves" of noise to multiply together. Higher values will have more detail
The amount the given amplitude is multiplied by for each octave, which controls the falloff of the upper harmonics ("octaves").
The time at which the value is sampled for use within the wiggle
Generated using TypeDoc
The number of keyframes on the property