DuAEF.Duik.Autorig

Autorig

Members

static, readonly AnimalTypes :int

The types of animals which can be rigged
Properties:
Name Type Description
PLANTIGRADE int
DIGITIGRADE int
UNGULATE int

static, readonly Elements :string

The elements handled by the Autorig
Properties:
Name Type Description
SHOULDER string
SHOULDER_BLADE string
CLAVICLE string
HUMERUS string
ARM string
FOREARM string
RADIUS string
ULNA string
HAND string
FINGERS string
FRONT_CLAWS string
FRONT_HEEL string
PALM string
ARM_TIP string
FEMUR string
THIGH string
TIBIA string
CALF string
FOOT string
REAR_CLAWS string
TOES string
CLAWS string
HEEL string
LEG_TIP string
TIPTOE string
HIPS string
SPINE string
NECK string
HEAD string
SPINE_TIP string
TAIL string
TAIL_TIP string

static, readonly Limbs :string

The limbs handled by the Autorig
Properties:
Name Type Description
ARM string
FRONT_LEG string
LEG string
BACK_LEG string
REAR_LEG string
SPINE string
TAIL string

Methods

static checkLayerTags(layers) → {Array.<Layer>}

Checks if all the layers have autorig tags and are ready to be rigged
Parameters:
Name Type Description
layers Array.<Layer> The layers to check
Returns:
Array.<Layer> - The layers not tagged

static detectCharacterSide(controllers)

Tries to detect and adds a "side" effect (or set the existing one) specifying if the limbs are on the right or on the left.
This method will search for hand and foot controllers in a set of controllers.
Parameters:
Name Type Description
controllers Array.<Controller> | Array.<Layer> The controllers

static detectLimbSide(handCtrl1opt, handCtrl2opt, footCtrl1opt, footCtrl2opt)

Tries to detect and adds a "side" effect (or set the existing one) specifying if the limbs are on the right or on the left.
You must at least provide two hands or two feet for the function to be able to detect the side.
Parameters:
Name Type Attributes Description
handCtrl1 Controller | Layer <optional>
The first hand controller
handCtrl2 Controller | Layer <optional>
The second hand controller
footCtrl1 Controller | Layer <optional>
The first foot controller
footCtrl2 Controller | Layer <optional>
The second foot controller

static isLeft(controller) → {bool}

Checks if the controller is on the left.
Adds a "Side" effect if needed on the layer.
Parameters:
Name Type Description
controller Controller | Layer The controller
Returns:
bool - True if the controller is on the left.

static isRight(controller) → {bool}

Checks if the controller is on the right.
Adds a "Side" effect if needed on the layer.
Parameters:
Name Type Description
controller Controller | Layer The controller
Returns:
bool - True if the controller is on the right.

static rig(layers, longChainTypeopt, threeAsOneAndTwoopt) → {Array.<Controller>}

Rigs the layers according to the tags found
Parameters:
Name Type Attributes Default Description
layers Array.<Layer> The layers to rig
longChainType DuAEF.Duik.Rigging.chainTypes <optional>
DuAEF.Duik.Rigging.chainTypes.FK True to use an IK to rig tails, false will create FK Controls
threeAsOneAndTwo boolean <optional>
true when rigging three layers, true to rig using a one-layer IK followed by a two-layer IK instead of a three-mayer IK
Returns:
Array.<Controller> - The controllers created (empty if the layers can not be rigged)

static setLeft(controller)

Sets the controller to be on the left.
Adds a "Side" effect if needed on the layer.
Parameters:
Name Type Description
controller Controller | Layer The controller

static setRight(controller)

Sets the controller to be on the right.
Adds a "Side" effect if needed on the layer.
Parameters:
Name Type Description
controller Controller | Layer The controller

static setSide(controller, isRight)

Sets the controller side.
Adds a "Side" effect if needed on the layer.
Parameters:
Name Type Description
controller Controller | Layer The controller
isRight bool True to set to right, false to set to left

static tagArm(shoulderopt, humerusopt, radiusopt, handopt, clawsopt, palmopt, tipopt, typeopt, leftopt)

Tags the layers to make them ready to be used by the autorig
Parameters:
Name Type Attributes Default Description
shoulder Layer <optional>
the layer for the shoulder
humerus Layer <optional>
the layer for the humerus
radius Layer <optional>
the layer for the radius
hand Layer <optional>
the layer for the hand
claws Layer <optional>
the layer for the claws/fingers
palm Layer <optional>
the layer for the palm/heel
tip Layer <optional>
the layer for the tip
type DuAEF.Duik.Autorig.AnimalTypes <optional>
DuAEF.Duik.Autorig.AnimalTypes.PLANTIGRADE the type of animal
left bool <optional>
true which arm is it (left or right)

static tagLeg(femuropt, tibiaopt, footopt, toesopt, heelopt, tipopt, typeopt, leftopt)

Tags the layers to make them ready to be used by the autorig
Parameters:
Name Type Attributes Default Description
femur Layer <optional>
the layer for the femur
tibia Layer <optional>
the layer for the tibia
foot Layer <optional>
the layer for the foot
toes Layer <optional>
the layer for the toes
heel Layer <optional>
the layer for the heel
tip Layer <optional>
the layer for the tipl
type DuAEF.Duik.Autorig.AnimalTypes <optional>
DuAEF.Duik.Autorig.AnimalTypes.PLANTIGRADE the type of animal
left bool <optional>
true which leg is it (left or right)

static tagSpine(hipsopt, spineopt, neckopt, headopt, tipopt)

Tags the layers to make them ready to be used by the autorig
Parameters:
Name Type Attributes Description
hips Layer <optional>
the layer for the hips
spine Array.<Layer> <optional>
the layers for the spine
neck Array.<Layer> <optional>
the layers for the neck
head Layer <optional>
the layer for the head
tip Layer <optional>
the layer for the tip

static tagTail(tailopt, tipopt)

Tags the layers to make them ready to be used by the autorig
Parameters:
Name Type Attributes Description
tail Array.<Layer> <optional>
the layers for the neck
tip Layer <optional>
the layer for the tip