Namespace: Rig

Duik. Rig

(Auto)Rigging tools.

Methods

staticDuik.Rig.arm(layers, parentSpine, customControllers){Array.<Layer>} D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 43567

Rigs an arm/front leg.

Name	Type	Description
`layers`	Array.<Layer> \| DuList.<Layer>	optional The layers to rig
`parentSpine`	Object	optional An object with two Arrays: bones and controllers.
`customControllers`	Array.<Layer> \| DuList.<Layer>	optional Existing custom controllers to use

Returns:

Type	Description
Array.<Layer>	The controllers of the tail

staticDuik.Rig.auto(bakeBones, bakeEnvelops, bakeNoodles, tailMode, longChainMode, layers){Array.<Layer>} D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 42482

The auto-rig for everything

Name	Type	Default	Description
`bakeBones`	Boolean	true	optional Whether to bake bones
`bakeEnvelops`	Boolean	true	optional Whether to bake envelops
`bakeNoodles`	Boolean	true	optional Whether to remove deactivated noodles
`tailMode`	Boolean	Duik.Constraint.IKType.FK	optional Set to true if you prefer using Bézier IK than FK with overlap for tails and other chains consisting of more than 3 layers.
`longChainMode`	Duik.Constraint.IKType	Duik.Constraint.IKType.ONE_TWO	optional The type of IK to use with custom 3-layer chains.
`layers`	Array.<Layer> \| DuList.<Layer>		optional The layers to rig

Returns:

Type	Description
Array.<Layer>	The controllers which are used in the rig

staticDuik.Rig.fin(layers, parentSpine, customControllers){Array.<Layer>} D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 44056

Rigs a fin.

Name	Type	Description
`layers`	Array.<Layer> \| DuList.<Layer>	optional The layers to rig
`parentSpine`	Object	optional An object with two Arrays: bones and controllers.
`customControllers`	Array.<Layer> \| DuList.<Layer>	optional Existing custom controllers to use

Returns:

Type	Description
Array.<Layer>	The controllers of the tail

staticDuik.Rig.fishSpine(layers, fishIK, customControllers){Object} D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 44249

Rigs the spine of a fish (head + tail).

Name	Type	Default	Description
`layers`	Array.<Layer> \| DuList.<Layer>		optional The layers to rig
`fishIK`	Boolean	false	optional Set to true if you prefer using Bézier IK than FK with overlap for tails and other chains consisting of more than 3 layers.
`customControllers`	Array.<Layer> \| DuList.<Layer>		optional Existing custom controllers to use

Returns:

Type	Description
Object	An object with two Arrays: bones and controllers.

staticDuik.Rig.getSpineAttach(location, spineBones){Layer|null} D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 43526

Returns the bone from the spine bones the closest to the location, where child bones at that location can be attached

Name	Type	Description
`location`	Array.<float>	The location where to attach bones, in comp coordinates
`spineBones`	Array.<Layer>	The bones of the spine, sorted from root (hips) to tip

Returns:

Type	Description
Layer \| null	The corresponding spine bone or null if the list of spine bones is empty

staticDuik.Rig.hair(layers, parentSpine, customControllers) D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 44931

Rigs hair strands

Name	Type	Description
`layers`	Array.<Layer> \| DuList.<Layer>	optional The layers to rig
`parentSpine`	Object	optional An object with two Arrays: bones and controllers.
`customControllers`	Array.<Layer> \| DuList.<Layer>	optional Existing custom controllers to use

staticDuik.Rig.leg(layers, parentSpine, customControllers){Array.<Layer>} D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 43094

Rigs a leg.

Name	Type	Description
`layers`	Array.<Layer> \| DuList.<Layer>	optional The layers to rig
`parentSpine`	Object	optional An object with two Arrays: bones and controllers.
`customControllers`	Array.<Layer> \| DuList.<Layer>	optional Existing custom controllers to use

Returns:

Type	Description
Array.<Layer>	The controllers of the tail

staticDuik.Rig.shoulder(shoulder, ctrl) D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 43479

Rigs a shoulder (an FK and an auto-position effect)

Name	Type	Description
`shoulder`	Layer	The shoulder bone
`ctrl`	Layer	The controller

staticDuik.Rig.spine(layers, customControllers){Object} D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 42627

Rigs a spine.

Name	Type	Description
`layers`	Array.<Layer> \| DuList.<Layer>	optional The layers to rig
`customControllers`	Array.<Layer> \| DuList.<Layer>	optional Existing custom controllers to use

Returns:

Type	Description
Object	An object with two Arrays: bones and controllers.

staticDuik.Rig.tail(layers, tailMode, parentSpine, customControllers){Array.<Layer>} D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 42939

Rigs a tail.

Name	Type	Default	Description
`layers`	Array.<Layer> \| DuList.<Layer>		optional The layers to rig
`tailMode`	Boolean	Duik.Constraint.IKType.FK	optional Set to true if you prefer using Bézier IK than FK with overlap for tails and other chains consisting of more than 3 layers.
`parentSpine`	Object		optional An object with two Arrays: bones and controllers.
`customControllers`	Array.<Layer> \| DuList.<Layer>		optional Existing custom controllers to use

Returns:

Type	Description
Array.<Layer>	The controller(s) of the tail

staticDuik.Rig.wing(layers, parentSpine, customControllers) D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 44437

Rigs a wing with feathers

Name	Type	Description
`layers`	Array.<Layer> \| DuList.<Layer>	optional The layers to rig
`parentSpine`	Object	optional An object with two Arrays: bones and controllers.
`customControllers`	Array.<Layer> \| DuList.<Layer>	optional Existing custom controllers to use