Class: DuOCOLimb

DuOCOLimb

A limb contained in an OCO Doc.

new DuOCOLimb(limb, side, location, type)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 15453
Creates a new OCO Limb.
Name Type Default Description
limb DuOCO.Limb DuOCO.Limb.CUSTOM optional A Predefined limb
side DuOCO.Side DuOCO.Side.NONE optional The side of the limb
location DuOCO.Location DuOCO.Location.NONE optional The location of the limb
type DuOCO.LimbType DuOCO.LimbType.CUSTOM optional The type of the limb

Members

staticDuOCOLimb.limbDuOCO.Limb

The predefined limb

staticDuOCOLimb.limbsArray.<DuOCOLimb>

The limbs/ Armatures

staticDuOCOLimb.locationDuOCO.Location

The location of the limb

staticDuOCOLimb.locationArray.<DuOCOBone>

The bones of the limb

staticDuOCOLimb.sideDuOCO.Side

The sided of the limb

staticDuOCOLimb.typeDuOCO.LimbType

The type of the limb

Methods

armatureFromLayers(doc, name, layers){DuOCOBone}

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 32402
Creates a new chain of bones located on the layer anchor points.
Name Type Description
doc DuOCODoc The doc containing the limb.
name string The name of the bones (will increment if needed)
layers Array.<Layer> | LayerCollection The layers
Returns:
Type Description
DuOCOBone The root bone of the new chain

armatureFromPath(doc, name, pathProp){DuOCOBone}

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 32195
Creates a new chain of bones located on the vertices of the path.
Name Type Description
doc DuOCODoc The doc containing the limb.
name string The name of the bones (will increment if needed)
pathProp PropertyGroup | DuAEProperty The path property (either an "ADBE Vector Shape - Group" or an "ADBE Mask Atom")
Returns:
Type Description
DuOCOBone The root bone of the new chain

armatureFromPuppetPins(doc, name, pins){DuOCOBone}

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 32307
Creates a new chain of bones located on the puppet pins.
Name Type Description
doc DuOCODoc The doc containing the limb.
name string The name of the bones (will increment if needed)
pins Array.<Property> | Array.<DuAEProperty> The puppet pins
Returns:
Type Description
DuOCOBone The root bone of the new chain

bounds(){Array.<float>}

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 15496
Gets the boundaries of the limb
Returns:
Type Description
Array.<float> [left, top, right, bottom]

moveArmatureToLayers(doc, layers)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 32356
Moves the armature of the limb to the layers.
Name Type Description
doc DuOCODoc The doc containing the limb.
layers Array.<Layer> | LayerCollection The layers

moveArmatureToPath(doc, pathProp)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 32236
Moves the armature of the limb to the vertices of the path.
Name Type Description
doc DuOCODoc The doc containing the limb.
pathProp PropertyGroup | DuAEProperty The path property (either an "ADBE Vector Shape - Group" or an "ADBE Mask Atom")

moveArmatureToPuppetPins(doc, pins)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 32268
Moves the armature of the limb to the puppet pins.
Name Type Description
doc DuOCODoc The doc containing the limb.
pins Array.<Property> | Array.<DuAEProperty> The puppet pins

newArmature(name, num, length){DuOCOBone}

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 15508
Creates a new chain of bones and adds it to the limb.
Name Type Default Description
name string The name of the bones (will increment if needed)
num int 2 optional The number of bones in the chain
length float 100.0 optional The length in centimeters
Returns:
Type Description
DuOCOBone The root bone.

toComp(doc, comp, parentLayer, limbId){Array.<Layer>}

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 32171
Creates the limb and armatures in the comp
Name Type Default Description
doc DuOCODoc The doc containing the limb.
comp CompItem DuAEProject.getActiveComp() optional The composition to use.
parentLayer Layer null optional The parent layer of the bone.
limbId int optional A Unique identifier for this armature. If omitted, a new one will be assigned.
Returns:
Type Description
Array.<Layer> The new layers