Namespace: Bone

Duik. Bone

Bone and armatures related tools.

Methods

staticDuik.Bone.arm(characterName, type, side, shoulder, arm, forearm, hand, claws, location, forceLink)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 34266
Creates a new arm.
Name Type Default Description
characterName string optional The name of the character
type DuOCO.LimbType DuOCO.LimbType.HOMINOID optional The type of limb
side DuOCO.Side DuOCO.Side.LEFT optional The side
shoulder Boolean false optional Whether to create a shoulder
arm Boolean true optional Whether to create an arm / humerus
forearm Boolean true optional Whether to create a forearm
hand Boolean true optional Whether to create a hand
claws Boolean false optional Whether to add claws
location Boolean DuOCO.Location.FRONT optional The location of the arm
forceLink boolean false optional whether link the selected layers/properties to the new armature

staticDuik.Bone.autoParent(layers, bones)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 35113
Automatically (tries to) links the artwork layers to their corresponding bones.
Finds the bones using the anchor point coordinates of the artworks.
Name Type Description
layers Array.<Layer> | DuList.<Layer> | LayerCollection optional The artwork layers. If bones is omitted, it may also contain the bones.
bones Array.<Layer> | DuList.<Layer> | LayerCollection optional The bones to parent to. If omitted, will try to find them in layers, or in the comp if there's no bone in layers.

staticDuik.Bone.bake(bakeBones, bakeEnvelop, bakeNoodles, layers)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 35001
Bakes the appearance of the selected bones to improve performance by removing appearance-only expressions and effects.
Name Type Default Description
bakeBones Boolean true optional Set to false to keep the bone display
bakeEnvelop Boolean true optional Set to false to keep the envelop settings
bakeNoodles Boolean true optional Set to false to keep all noodles even if they're hidden
layers Array.<Layer> | DuList.<Layer> | Layer optional The layers to bake; will use selected layers from the current comp if omitted.

staticDuik.Bone.color(layer){DuColor}

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 35219
Checks the color of the bone layer
Name Type Default Description
layer Layer DuAEComp.getActiveLayer optional The layer. If omitted, will check the first selected bone of the current comp
Returns:
Type Description
DuColor

staticDuik.Bone.customLimb(num, name, characterName, side, location, forceLink)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 34457
Creates a custom limb.
Name Type Default Description
num int 2 optional The number of bones in case nothing is selected in the comp. Otherwize, a bone is created for each selected path vertex/puppet pin/layer.
name string 'Limb' optional The name of the limb
characterName string optional The name of the character
side DuOCO.Side DuOCO.Side.NONE optional The side of the limb
location DuOCO.Location DuOCO.Location.NONE optional The location of the limb
forceLink boolean false optional whether to link the selected layers/properties to the new armature

staticDuik.Bone.duplicate(comp){Array.<Layer>}

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 34842
Duplicates the selected bones, updates the hierarchy and display
Name Type Default Description
comp CompItem DuAEProject.getActiveComp() optional The comp
Returns:
Type Description
Array.<Layer> The new bones

staticDuik.Bone.envelopSize(layer){float}

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 35287
Checks the size of the envelop of the bone layer
Name Type Default Description
layer Layer DuAEComp.getActiveLayer optional The layer. If omitted, will check the first selected bone of the current comp
Returns:
Type Description
float

staticDuik.Bone.fin(characterName, side, fishbones, forceLink)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 34729
Creates a new fin.
Name Type Default Description
characterName string optional The name of the character
side DuOCO.Side DuOCO.Side.LEFT optional The side
fishbones int true optional Number of fishbones to create
forceLink boolean false optional whether link the selected layers/properties to the new armature

staticDuik.Bone.fishSpine(characterName, head, spine, forceLink)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 34765
Creates a new fish spine.
Name Type Default Description
characterName string optional The name of the character
head Boolean true optional Whether to create a head
spine int 3 optional Number of spine bones
forceLink boolean false optional whether link the selected layers/properties to the new armature

staticDuik.Bone.get(selectedOnly, comp){Array.<ShapeLayer>}

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 35187
Gets the bones in the comp
Name Type Default Description
selectedOnly Boolean true optional Whether to get only the selected layers or all of them
comp CompItem DuAEProject.getActiveComp() optional The comp
Returns:
Type Description
Array.<ShapeLayer> The bones

staticDuik.Bone.hair(characterName, num, forceLink)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 34618
Creates a new hair strand.
Name Type Default Description
characterName string optional The name of the character
num int 3 optional Number of hair bones
forceLink boolean false optional whether link the selected layers/properties to the new armature

staticDuik.Bone.leg(characterName, type, side, thigh, calf, foot, claws, location, forceLink)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 34504
Creates a new arm.
Name Type Default Description
characterName string optional The name of the character
type DuOCO.LimbType DuOCO.LimbType.HOMINOID optional The type of limb
side DuOCO.Side DuOCO.Side.LEFT optional The side
thigh Boolean true optional Whether to create a thigh
calf Boolean true optional Whether to create a calf
foot Boolean true optional Whether to create a foot
claws Boolean false optional Whether to add claws
location Boolean DuOCO.Location.BACK optional The location of the leg
forceLink boolean false optional whether link the selected layers/properties to the new armature

staticDuik.Bone.linkLayers(layers, boneLayers)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 34800
Parents the given layers to the given bones.
The two lists do not need to have the same number of layers, additionnal/missing layers will be ignored.
Name Type Description
layers Array.<Layer> | LayerCollection | DuList
boneLayers Array.<Layer> | LayerCollection | DuList

staticDuik.Bone.opacity(layer){DuColor}

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 35342
Checks the opacity of the bone layer
Name Type Default Description
layer Layer DuAEComp.getActiveLayer optional The layer. If omitted, will check the first selected bone of the current comp
Returns:
Type Description
DuColor

staticDuik.Bone.resetTransform(layer)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 35406
Resets the transformations (rotation and scale) of the bone to 0 and 100%
Name Type Description
layer Layer

staticDuik.Bone.select(comp)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 34819
Selects all the bones in the comp (and deselects any other layer)
Name Type Default Description
comp CompItem DuAEProject.getActiveComp() optional The comp

staticDuik.Bone.setCharacterName(characterName, layer)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 35385
Sets the character name of the bone layer
Name Type Default Description
characterName string The character name.
layer Layer DuAEComp.getSelectedLayers() optional The layers. If omitted, will use all selected layers in the comp

staticDuik.Bone.setColor(color, layers){DuColor}

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 35240
Sets the color of the bone layers
Name Type Default Description
color DuColor | null optional The color. If omitted or null, will assign a random color for each bone.
layers Layer | LayerCollection | Array.<Layer> | DuList.<Layer> DuAEComp.getSelectedLayers() optional The layers. If omitted, will use all selected layers in the comp
Returns:
Type Description
DuColor

staticDuik.Bone.setLimbName(limbName, layer)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 35396
Sets the limb name of the bone layer
Name Type Default Description
limbName string The limb name.
layer Layer DuAEComp.getSelectedLayers() optional The layers. If omitted, will use all selected layers in the comp

staticDuik.Bone.setLocation(side, layers)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 35208
Sets the location of the layer
Name Type Default Description
side DuOCO.Side The side
layers Array.<Layer> DuAEComp.getSelectedLayers() optional The layers. If omitted, will use all selected layers in the comp

staticDuik.Bone.setOpacity(opacity, layer)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 35362
Sets the opacity of the bone layer
Name Type Default Description
opacity float The opacity in %.
layer Layer DuAEComp.getSelectedLayers() optional The layers. If omitted, will use all selected layers in the comp

staticDuik.Bone.setSide(side, layers)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 35197
Sets the side of the layer
Name Type Default Description
side DuOCO.Side The side
layers Array.<Layer> DuAEComp.getSelectedLayers() optional The layer. If omitted, will use all selected layers in the comp

staticDuik.Bone.setSize(size, layer)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 35319
Sets the size of the bone layer
Name Type Default Description
size float The size in %.
layer Layer DuAEComp.getSelectedLayers() optional The layers. If omitted, will use all selected layers in the comp

staticDuik.Bone.size(layer){float}

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 35267
Checks the size of the bone layer
Name Type Default Description
layer Layer DuAEComp.getActiveLayer optional The layer. If omitted, will check the first selected bone of the current comp
Returns:
Type Description
float

staticDuik.Bone.snakeSpine(characterName, head, spine, forceLink)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 34695
Creates a new snake / worm spine.
Name Type Default Description
characterName string optional The name of the character
head Boolean true optional Whether to create a head
spine int 5 optional Number of spine bones
forceLink boolean false optional whether link the selected layers/properties to the new armature

staticDuik.Bone.spine(characterName, head, neck, spine, hips, forceLink)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 34547
Creates a new spine.
Name Type Default Description
characterName string optional The name of the character
head Boolean true optional Whether to create a head
neck int 1 optional Number of neck bones
spine int 2 optional Number of spine bones
hips Boolean true optional Whether to create hips
forceLink boolean false optional whether link the selected layers/properties to the new armature

staticDuik.Bone.tail(characterName, num, forceLink)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 34584
Creates a new tail.
Name Type Default Description
characterName string optional The name of the character
num int 3 optional Number of tail bones
forceLink boolean false optional whether link the selected layers/properties to the new armature

staticDuik.Bone.toggleVisibility(comp, notSelectedOnly)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 34830
Show/hides all the bones
Name Type Default Description
comp CompItem DuAEProject.getActiveComp() optional The comp
notSelectedOnly bool false optional Hides only the bones which are not selected
D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 34972
Toggles the edit mode on selected bones
Name Type Default Description
comp CompItem DuAEProject.getActiveComp() optional The comp

staticDuik.Bone.wing(characterName, side, arm, forearm, hand, feathers, forceLink)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 34656
Creates a new wing.
Name Type Default Description
characterName string optional The name of the character
side DuOCO.Side DuOCO.Side.LEFT optional The side
arm Boolean true optional Whether to create an arm / humerus
forearm Boolean true optional Whether to create a forearm
hand Boolean true optional Whether to create a hand
feathers int 5 optional Number of feathers
forceLink boolean false optional whether link the selected layers/properties to the new armature