DuAEF.Duik.Automation

Automations

Namespaces

Randomize

Methods

static autoWalk(controllers, compopt)

Create a procedural walk cycle on the controllers.
This methods automatically detects the limbs, the sides, etc.
Parameters:
Name Type Attributes Description
controllers Array.<Controller> | Array.<Layer> The controllers
comp CompItem <optional>
The comp where to add the walk cycle
Adds a blink effect on the property
Parameters:
Name Type Description
prop PropertyInfo The property to rig

static createEffectorController(compopt) → {ShapeLayer}

Creates the effector controller layer
Parameters:
Name Type Attributes Default Description
comp CompItem <optional>
DuAEF.DuAE.Project.getActiveComp The composition where to create the controller
Returns:
ShapeLayer - The controller

static effector(prop, effectopt, ctrlLayeropt) → {object}

Links a property to an effector controller
Parameters:
Name Type Attributes Description
prop PropertyInfo The property to rig
effect PropertyGroup | null <optional>
A Layer expression control used to link to the effector. Will be created on the layer if not provided
ctrlLayer ShapeLayer | null <optional>
The effector layer. will be created if not provided
Returns:
object - A custom object with two attributes:
- effectorLayer: the effector layer - effect: the layer expression control on the rigged layer used to link to the effector

static list(prop)

Adds a list on a property
Parameters:
Name Type Description
prop PropertyInfo | Property The Property

static loop(prop, effectopt, loopInTypeopt, loopOutTypeopt)

Loops the property
Parameters:
Name Type Attributes Default Description
prop Property | PropertyInfo The property.
effect PropertyGroup | null <optional>
A looper effect already created by Duik to use as a controller for this looper
loopInType DuAEF.DuAE.LoopTypes <optional>
DuAEF.DuAE.LoopTypes.CYCLE The type of loopIn
loopOutType DuAEF.DuAE.LoopTypes <optional>
DuAEF.DuAE.LoopTypes.CYCLE The type of loopOut

static mapEffector(prop, texture, effectopt) → {PropertyGroup}

Links a property to a texture layer
Parameters:
Name Type Attributes Description
prop PropertyInfo The property to rig
texture AVLayer The texture layer.
effect PropertyGroup | null <optional>
A Layer expression control used to link to the effector. Will be created on the layer if not provided
Returns:
PropertyGroup - The layer expression control added on the layer.

static moveAway(layer)

Adds a move away effect on the layer
Parameters:
Name Type Description
layer Layer The layer to rig

static paintRig(layer)

Rigs the paint effects found on the layer to animate all the strokes as if there was only one
Parameters:
Name Type Description
layer Layer The layer to rig

static spring(prop)

Adds a spring effect on the property
Parameters:
Name Type Description
prop PropertyInfo The property to rig
Deprecated:
  • since Duik 16.2. Use DuAEF.Duik.Animation.kleaner instead, which includes an auto follow-through.

static swing(prop)

Adds a swing to a property
Parameters:
Name Type Description
prop PropertyInfo The property.

static walk(controllers, headCtrlopt, neckCtrlopt, bodyCtrlopt, hipsCtrlopt, rHandCtrlopt, lHandCtrlopt, rFootCtrlopt, lFootCtrlopt, compopt)

Create a procedural walk cycle.
Parameters:
Name Type Attributes Default Description
controllers Array.<Controller> | Array.<Layer> The controllers
headCtrl Controller | Layer | null <optional>
null The head controller
neckCtrl Controller | Layer | null <optional>
null The neck/shoulders controller
bodyCtrl Controller | Layer | null <optional>
null The body controller
hipsCtrl Controller | Layer | null <optional>
null The hips controller
rHandCtrl Controller | Layer | null <optional>
null The right hand controller
lHandCtrl Controller | Layer | null <optional>
null The left hand controller
rFootCtrl Controller | Layer | null <optional>
null The right foot controller
lFootCtrl Controller | Layer | null <optional>
null The left foot controller
comp CompItem <optional>
The comp where to add the walk cycle

static wheel(layer, radiusopt)

Automates the rotation of a layer as a wheel
Parameters:
Name Type Attributes Description
layer Layer The layer.
radius int <optional>
The radius of the wheel, in pixels. Will be auto-detected if possible

static wiggle(prop, separateDimensionsopt, effectopt) → {PropertyGroup}

Adds a wiggle to a property
Parameters:
Name Type Attributes Description
prop PropertyInfo The property.
separateDimensions boolean <optional>
Set to true to separate the dimensions (to adjust amplitude and frequency) if the property is multi-dimensionnal.
effect PropertyGroup | null <optional>
A wiggle effect already created by Duik to use as a controller for this wiggle
Returns:
PropertyGroup - The effect created (or provided)