Namespace: Animation

Duik. Animation

The animator's toolkit.

Methods

staticDuik.Animation.addContinuousKey(animatedProps, selectedLayers)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 49121
Adds a Continuous key to the properties at current time
Name Type Default Description
animatedProps Bool true optional Set to false to add a key to all selected properties, instead of all animated properties.
selectedLayers Bool true optional Set to false to add a key to all layers instead of just the selection.

staticDuik.Animation.addEaseInKey(animatedProps, selectedLayers)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 48983
Adds an Ease In key to the properties at current time
Name Type Default Description
animatedProps Bool true optional Set to false to add a key to all selected properties, instead of all animated properties.
selectedLayers Bool true optional Set to false to add a key to all layers instead of just the selection.

staticDuik.Animation.addEaseOutKey(animatedProps, selectedLayers)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 49029
Adds an Ease Out key to the properties at current time
Name Type Default Description
animatedProps Bool true optional Set to false to add a key to all selected properties, instead of all animated properties.
selectedLayers Bool true optional Set to false to add a key to all layers instead of just the selection.

staticDuik.Animation.addEasyEaseKey(animatedProps, selectedLayers)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 49075
Adds an Easy Ease key to the properties at current time
Name Type Default Description
animatedProps Bool true optional Set to false to add a key to all selected properties, instead of all animated properties.
selectedLayers Bool true optional Set to false to add a key to all layers instead of just the selection.

staticDuik.Animation.addHoldKey(animatedProps, selectedLayers)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 49167
Adds a Hold key to the properties at current time
Name Type Default Description
animatedProps Bool true optional Set to false to add a key to all selected properties, instead of all animated properties.
selectedLayers Bool true optional Set to false to add a key to all layers instead of just the selection.

staticDuik.Animation.addLinearKey(animatedProps, selectedLayers)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 48937
Adds a linear key to the properties at current time
Name Type Default Description
animatedProps Bool true optional Set to false to add a key to all selected properties, instead of all animated properties.
selectedLayers Bool true optional Set to false to add a key to all layers instead of just the selection.

staticDuik.Animation.addRovingKey(animatedProps, selectedLayers)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 48891
Adds a roving key to the properties at current time
Name Type Default Description
animatedProps Bool true optional Set to false to add a key to all selected properties, instead of all animated properties.
selectedLayers Bool true optional Set to false to add a key to all layers instead of just the selection.

staticDuik.Animation.celOnionSkin(enabled, frames, exposure, inOpacity, outOpacity)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 49508
(De)activates or updates the onion skin of a Duik cel animation comp.
Name Type Default Description
enabled Boolean true optional If omitted, will try to get it from the existing cels.
frames int 5 optional The duration (in frames) of the onion skin. If omitted, will try to get it from the existing cels.
exposure int 2 optional The animation exposure. If omitted, will try to get it from the existing cels.
inOpacity float 50 optional The in opacity. If omitted, will try to get it from the existing cels.
outOpacity float 50 optional The out opacity. If omitted, will try to get it from the existing cels.

staticDuik.Animation.copy(comp){Array.<DuAELayerAnimation>}

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 48397
Copies the currently selected keyframes, which can then be pasted with Duik.Animation.paste.
Name Type Default Description
comp CompItem DuAEProject.getActiveComp optional The composition
Returns:
Type Description
Array.<DuAELayerAnimation> The list of animations which have been copied.

staticDuik.Animation.cut(comp){Array.<DuAELayerAnimation>}

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 48425
Cuts the currently selected keyframes, which can then be pasted with Duik.Animation.paste.
Name Type Default Description
comp CompItem DuAEProject.getActiveComp optional The composition
Returns:
Type Description
Array.<DuAELayerAnimation> The list of animations which have been copied.

staticDuik.Animation.fixSpatialInterpolation()

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 49303
Sets the selected keyframes spatial interpolation to linear

staticDuik.Animation.freezePose(animatedProps, selectedLayers, useNextPose)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 49461
Freezes the pose; copies the previous keyframe to the current time.
Name Type Default Description
animatedProps Bool true optional Set to false to add a key to all selected properties, instead of all animated properties.
selectedLayers Bool true optional Set to false to add a key to all layers instead of just the selection.
useNextPose Bool false optional If true, will freeze the next pose instead of the previous one (copies the next keyframe to the current time).

staticDuik.Animation.interpolator(props, effect){PropertyGroup}

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 48473
Control the selected keyframes with advanced but easy-to-use keyframe interpolation driven by an effect.
Name Type Description
props Array.<PropertyBase> | DuList.<PropertyBase> | PropertyBase optional The properties to interpolate. The selected properties in the active comp if omitted.
effect PropertyGroup optional The pseudo effect to use if it already exists.
Returns:
Type Description
PropertyGroup The pseudo-effect

staticDuik.Animation.newCel(createNewLayer)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 49708
Creates a new cel for a Duik cel animation
Name Type Default Description
createNewLayer Boolean false optional Set to true to create the cel on a new layer

staticDuik.Animation.nextCel(exposure)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 49772
Goes to the next frame in a Duik cel animation
Name Type Default Description
exposure int 2 optional The animation exposure

staticDuik.Animation.paste(comp, replace, offset, reverse, matchNames)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 48461
Pastes the animation previously copied by Duik.Animation.copy to the selected properties.
Name Type Default Description
comp CompItem optional The composition.
replace Boolean false optional Whether to completely erase and replace the current animation
offset Boolean false optional Whether to offset the animation from the current value
reverse Boolean false optional Whether to reverse the animation
matchNames Array.<string> [] optional A filter to apply only on specific property types

staticDuik.Animation.previousCel(exposure)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 49754
Goes to the previous frame in a Duik cel animation
Name Type Default Description
exposure int 2 optional The animation exposure

staticDuik.Animation.selectKeyframes(comp, selectedLayers, controllersOnly, range, propertyMatchNames)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 48315
Selects the keyframes in the comp
Name Type Default Description
comp CompItem DuAEProject.getActiveComp optional The composition
selectedLayers Boolean false optional Set to true to get the keyframes only on the selected layers instead of all the layers.
controllersOnly Boolean true optional Set to false to get the keyframes from all types of layers instead of just the controllers.
range Array.<float> optional The time range to select the keyframes, [in, out]. If omitted, will use the work area of the composition.
propertyMatchNames Array.<string> [] optional The list of matchnames to select only keyframes of a specific type. If empty, will select all types of keyframes.

staticDuik.Animation.sequenceKeys(duration, reverse, interpolation)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 49915
Sequences selected keyframes.
Name Type Default Description
duration int 24 optional The transition duration, in frames
reverse Bool false optional Set to true to reverse the order.
interpolation function DuInterpolation.linear optional An interpolation function, taking 4 arguments in the form i(value, min, max, targetMin, targetMax)

staticDuik.Animation.sequenceLayers(duration, moveLayers, useInPoints, reverse, interpolation)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 49866
Sequences selected layers.
Name Type Default Description
duration int 24 optional The transition duration, in frames
moveLayers Bool true optional If set to false, the layer are not moved, and the in or out points are changed instead (layers are "cut")
useInPoints Bool true optional If moveLayers is false, setting this to false changes the out points instead of the in points (cuts the end instead of the start).
reverse Bool false optional Set to true to reverse the order.
interpolation function DuInterpolation.linear optional An interpolation function, taking 4 arguments in the form i(value, min, max, targetMin, targetMax)

staticDuik.Animation.setContinuous()

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 49146
Sets the selected keyframes to continuous

staticDuik.Animation.setEase(easeIn, easeOut)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 49212
Sets the ease values on the selected keyframes
Name Type Description
easeIn float The in ease
easeOut float The out ease

staticDuik.Animation.setEaseIn()

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 49008
Sets the selected keyframes to ease in

staticDuik.Animation.setEaseOut()

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 49054
Sets the selected keyframes to ease out

staticDuik.Animation.setEasyEase()

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 49100
Sets the selected keyframes to easy ease

staticDuik.Animation.setHold()

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 49192
Sets the selected keyframes to hold

staticDuik.Animation.setLinear()

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 48962
Sets the selected keyframes to linear

staticDuik.Animation.setRoving()

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 48916
Sets the selected keyframes to roving

staticDuik.Animation.setSpatialBezier()

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 49295
Sets the selected keyframes spatial interpolation to linear

staticDuik.Animation.setSpatialBezierIn()

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 49279
Sets the selected keyframes spatial interpolation to linear

staticDuik.Animation.setSpatialBezierOut()

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 49287
Sets the selected keyframes spatial interpolation to linear

staticDuik.Animation.setSpatialInterpolation()

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 49250
Sets the selected keyframes spatial interpolation

staticDuik.Animation.setSpatialLinear()

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 49271
Sets the selected keyframes spatial interpolation to linear

staticDuik.Animation.setVelocity(vIn, vOut)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 49232
Sets the velocity values on the selected keyframes
Name Type Description
vIn float The in velocity
vOut float The out velocity

staticDuik.Animation.snapFK(ctrls)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 50197
Snaps the FK to the IK values.
Name Type Description
ctrls Array.<Layer> | DuList.<Layer> optional The controllers to snap.

staticDuik.Animation.snapIK(ctrls)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 50106
Snaps the IK to the FK values.
Name Type Description
ctrls Array.<Layer> | DuList.<Layer> optional The controllers to snap.

staticDuik.Animation.snapKeys()

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 49789
Snaps selected (or all) keyframes to the closest frames if they're in between.

staticDuik.Animation.splitKeys(duration, alignment)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 49377
Splits the selected keyframes into couple of keyframes with the same values
Name Type Default Description
duration int 2 optional The number of frames between the two keyframes.
alignment DuAE.TimeAlignment DuAE.TimeAlignment.CENTER optional How to align the new keyframes according to the current time.

staticDuik.Animation.switchIKFK(ctrls, addKeyframes)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 50253
Switches between IK and FK.
Name Type Default Description
ctrls Array.<Layer> | DuList.<Layer> optional The controllers to switch.
addKeyframes bool true optional Whether to add keyframes on FK and IK properties to keep the switch at the current frame.

staticDuik.Animation.syncKeys()

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 49826
Syncs the selected keyframes; moves them to the current time.< br /> If multiple keyframes are selected for the same property, they're offset to the current time, keeping the animation.

staticDuik.Animation.tween(tweenRatio, animatedProps, selectedLayers)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 49324
Adds a key to the properties at current time, tweening according to the previous and next keyframe
Name Type Default Description
tweenRatio float 0.5 optional The value ratio for tweening: 0.0 is the value of the previous key, 1.0 is the value of the next key. Note that this value can be < 0 and > 1.0 if you wish.
animatedProps Bool true optional Set to false to add a key to all selected properties, instead of all animated properties.
selectedLayers Bool true optional Set to false to add a key to all layers instead of just the selection.

staticDuik.Animation.xSheet(autoCompute)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 49967
Adjusts the exposure of the animation.
Name Type Default Description
autoCompute Bool false optional (Try to) auto-compute the best values..