Namespace

Bone

Duik.Bone

Bone and armatures related tools.

View Source DuAEF_Duik_api.jsxinc, line 35589

Methods

# static arm(characterNameopt, typeopt, sideopt, shoulderopt, armopt, forearmopt, handopt, clawsopt, locationopt, forceLinkopt)

Creates a new arm.
Parameters:
Name Type Attributes Default Description
characterName string <optional>
The name of the character
type DuOCO.LimbType <optional>
DuOCO.LimbType.HOMINOID The type of limb
side DuOCO.Side <optional>
DuOCO.Side.LEFT The side
shoulder Boolean <optional>
false Whether to create a shoulder
arm Boolean <optional>
true Whether to create an arm / humerus
forearm Boolean <optional>
true Whether to create a forearm
hand Boolean <optional>
true Whether to create a hand
claws Boolean <optional>
false Whether to add claws
location Boolean <optional>
DuOCO.Location.FRONT The location of the arm
forceLink boolean <optional>
false whether link the selected layers/properties to the new armature

View Source DuAEF_Duik_api.jsxinc, line 35610

# static autoParent(layersopt, bonesopt)

Automatically (tries to) links the artwork layers to their corresponding bones.
Finds the bones using the anchor point coordinates of the artworks.
Parameters:
Name Type Attributes 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.

View Source DuAEF_Duik_api.jsxinc, line 36457

# static bake(bakeBonesopt, bakeEnvelopopt, bakeNoodlesopt, layersopt)

Bakes the appearance of the selected bones to improve performance by removing appearance-only expressions and effects.
Parameters:
Name Type Attributes Default Description
bakeBones Boolean <optional>
true Set to false to keep the bone display
bakeEnvelop Boolean <optional>
true Set to false to keep the envelop settings
bakeNoodles Boolean <optional>
true 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.

View Source DuAEF_Duik_api.jsxinc, line 36345

# static color(layeropt) → {DuColor}

Checks the color of the bone layer
Parameters:
Name Type Attributes Default Description
layer Layer <optional>
DuAEComp.getActiveLayer The layer. If omitted, will check the first selected bone of the current comp

View Source DuAEF_Duik_api.jsxinc, line 36563

DuColor

# static customLimb(numopt, nameopt, characterNameopt, sideopt, locationopt, forceLinkopt)

Creates a custom limb.
Parameters:
Name Type Attributes Default Description
num int <optional>
2 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 <optional>
'Limb' The name of the limb
characterName string <optional>
The name of the character
side DuOCO.Side <optional>
DuOCO.Side.NONE The side of the limb
location DuOCO.Location <optional>
DuOCO.Location.NONE The location of the limb
forceLink boolean <optional>
false whether to link the selected layers/properties to the new armature

View Source DuAEF_Duik_api.jsxinc, line 35801

# static duplicate(compopt) → {Array.<Layer>}

Duplicates the selected bones, updates the hierarchy and display
Parameters:
Name Type Attributes Default Description
comp CompItem <optional>
DuAEProject.getActiveComp() The comp

View Source DuAEF_Duik_api.jsxinc, line 36186

The new bones
Array.<Layer>

# static envelopSize(layeropt) → {float}

Checks the size of the envelop of the bone layer
Parameters:
Name Type Attributes Default Description
layer Layer <optional>
DuAEComp.getActiveLayer The layer. If omitted, will check the first selected bone of the current comp

View Source DuAEF_Duik_api.jsxinc, line 36631

float

# static fin(characterNameopt, sideopt, fishbonesopt, forceLinkopt)

Creates a new fin.
Parameters:
Name Type Attributes Default Description
characterName string <optional>
The name of the character
side DuOCO.Side <optional>
DuOCO.Side.LEFT The side
fishbones int <optional>
true Number of fishbones to create
forceLink boolean <optional>
false whether link the selected layers/properties to the new armature

View Source DuAEF_Duik_api.jsxinc, line 36073

# static fishSpine(characterNameopt, headopt, spineopt, forceLinkopt)

Creates a new fish spine.
Parameters:
Name Type Attributes Default Description
characterName string <optional>
The name of the character
head Boolean <optional>
true Whether to create a head
spine int <optional>
3 Number of spine bones
forceLink boolean <optional>
false whether link the selected layers/properties to the new armature

View Source DuAEF_Duik_api.jsxinc, line 36109

# static get(selectedOnlyopt, compopt) → {Array.<ShapeLayer>}

Gets the bones in the comp
Parameters:
Name Type Attributes Default Description
selectedOnly Boolean <optional>
true Whether to get only the selected layers or all of them
comp CompItem <optional>
DuAEProject.getActiveComp() The comp

View Source DuAEF_Duik_api.jsxinc, line 36531

The bones
Array.<ShapeLayer>

# static hair(characterNameopt, numopt, forceLinkopt)

Creates a new hair strand.
Parameters:
Name Type Attributes Default Description
characterName string <optional>
The name of the character
num int <optional>
3 Number of hair bones
forceLink boolean <optional>
false whether link the selected layers/properties to the new armature

View Source DuAEF_Duik_api.jsxinc, line 35962

# static leg(characterNameopt, typeopt, sideopt, thighopt, calfopt, footopt, clawsopt, locationopt, forceLinkopt)

Creates a new arm.
Parameters:
Name Type Attributes Default Description
characterName string <optional>
The name of the character
type DuOCO.LimbType <optional>
DuOCO.LimbType.HOMINOID The type of limb
side DuOCO.Side <optional>
DuOCO.Side.LEFT The side
thigh Boolean <optional>
true Whether to create a thigh
calf Boolean <optional>
true Whether to create a calf
foot Boolean <optional>
true Whether to create a foot
claws Boolean <optional>
false Whether to add claws
location Boolean <optional>
DuOCO.Location.BACK The location of the leg
forceLink boolean <optional>
false whether link the selected layers/properties to the new armature

View Source DuAEF_Duik_api.jsxinc, line 35848

# static linkLayers(layers, boneLayers)

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.
Parameters:
Name Type Description
layers Array.<Layer> | LayerCollection | DuList
boneLayers Array.<Layer> | LayerCollection | DuList

View Source DuAEF_Duik_api.jsxinc, line 36144

# static opacity(layeropt) → {DuColor}

Checks the opacity of the bone layer
Parameters:
Name Type Attributes Default Description
layer Layer <optional>
DuAEComp.getActiveLayer The layer. If omitted, will check the first selected bone of the current comp

View Source DuAEF_Duik_api.jsxinc, line 36686

DuColor

# static resetTransform(layer)

Resets the transformations (rotation and scale) of the bone to 0 and 100%
Parameters:
Name Type Description
layer Layer

View Source DuAEF_Duik_api.jsxinc, line 36750

# static select(compopt)

Selects all the bones in the comp (and deselects any other layer)
Parameters:
Name Type Attributes Default Description
comp CompItem <optional>
DuAEProject.getActiveComp() The comp

View Source DuAEF_Duik_api.jsxinc, line 36163

# static setCharacterName(characterName, layeropt)

Sets the character name of the bone layer
Parameters:
Name Type Attributes Default Description
characterName string The character name.
layer Layer <optional>
DuAEComp.getSelectedLayers() The layers. If omitted, will use all selected layers in the comp

View Source DuAEF_Duik_api.jsxinc, line 36729

# static setColor(coloropt, layersopt) → {DuColor}

Sets the color of the bone layers
Parameters:
Name Type Attributes 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> <optional>
DuAEComp.getSelectedLayers() The layers. If omitted, will use all selected layers in the comp

View Source DuAEF_Duik_api.jsxinc, line 36584

DuColor

# static setLimbName(limbName, layeropt)

Sets the limb name of the bone layer
Parameters:
Name Type Attributes Default Description
limbName string The limb name.
layer Layer <optional>
DuAEComp.getSelectedLayers() The layers. If omitted, will use all selected layers in the comp

View Source DuAEF_Duik_api.jsxinc, line 36740

# static setLocation(side, layersopt)

Sets the location of the layer
Parameters:
Name Type Attributes Default Description
side DuOCO.Side The side
layers Array.<Layer> <optional>
DuAEComp.getSelectedLayers() The layers. If omitted, will use all selected layers in the comp

View Source DuAEF_Duik_api.jsxinc, line 36552

# static setOpacity(opacity, layeropt)

Sets the opacity of the bone layer
Parameters:
Name Type Attributes Default Description
opacity float The opacity in %.
layer Layer <optional>
DuAEComp.getSelectedLayers() The layers. If omitted, will use all selected layers in the comp

View Source DuAEF_Duik_api.jsxinc, line 36706

# static setSide(side, layersopt)

Sets the side of the layer
Parameters:
Name Type Attributes Default Description
side DuOCO.Side The side
layers Array.<Layer> <optional>
DuAEComp.getSelectedLayers() The layer. If omitted, will use all selected layers in the comp

View Source DuAEF_Duik_api.jsxinc, line 36541

# static setSize(size, layeropt)

Sets the size of the bone layer
Parameters:
Name Type Attributes Default Description
size float The size in %.
layer Layer <optional>
DuAEComp.getSelectedLayers() The layers. If omitted, will use all selected layers in the comp

View Source DuAEF_Duik_api.jsxinc, line 36663

# static size(layeropt) → {float}

Checks the size of the bone layer
Parameters:
Name Type Attributes Default Description
layer Layer <optional>
DuAEComp.getActiveLayer The layer. If omitted, will check the first selected bone of the current comp

View Source DuAEF_Duik_api.jsxinc, line 36611

float

# static snakeSpine(characterNameopt, headopt, spineopt, forceLinkopt)

Creates a new snake / worm spine.
Parameters:
Name Type Attributes Default Description
characterName string <optional>
The name of the character
head Boolean <optional>
true Whether to create a head
spine int <optional>
5 Number of spine bones
forceLink boolean <optional>
false whether link the selected layers/properties to the new armature

View Source DuAEF_Duik_api.jsxinc, line 36039

# static spine(characterNameopt, headopt, neckopt, spineopt, hipsopt, forceLinkopt)

Creates a new spine.
Parameters:
Name Type Attributes Default Description
characterName string <optional>
The name of the character
head Boolean <optional>
true Whether to create a head
neck int <optional>
1 Number of neck bones
spine int <optional>
2 Number of spine bones
hips Boolean <optional>
true Whether to create hips
forceLink boolean <optional>
false whether link the selected layers/properties to the new armature

View Source DuAEF_Duik_api.jsxinc, line 35891

# static tail(characterNameopt, numopt, forceLinkopt)

Creates a new tail.
Parameters:
Name Type Attributes Default Description
characterName string <optional>
The name of the character
num int <optional>
3 Number of tail bones
forceLink boolean <optional>
false whether link the selected layers/properties to the new armature

View Source DuAEF_Duik_api.jsxinc, line 35928

# static toggleVisibility(compopt, notSelectedOnlyopt)

Show/hides all the bones
Parameters:
Name Type Attributes Default Description
comp CompItem <optional>
DuAEProject.getActiveComp() The comp
notSelectedOnly bool <optional>
false Hides only the bones which are not selected

View Source DuAEF_Duik_api.jsxinc, line 36174

Toggles the edit mode on selected bones
Parameters:
Name Type Attributes Default Description
comp CompItem <optional>
DuAEProject.getActiveComp() The comp

View Source DuAEF_Duik_api.jsxinc, line 36316

# static wing(characterNameopt, sideopt, armopt, forearmopt, handopt, feathersopt, forceLinkopt)

Creates a new wing.
Parameters:
Name Type Attributes Default Description
characterName string <optional>
The name of the character
side DuOCO.Side <optional>
DuOCO.Side.LEFT The side
arm Boolean <optional>
true Whether to create an arm / humerus
forearm Boolean <optional>
true Whether to create a forearm
hand Boolean <optional>
true Whether to create a hand
feathers int <optional>
5 Number of feathers
forceLink boolean <optional>
false whether link the selected layers/properties to the new armature

View Source DuAEF_Duik_api.jsxinc, line 36000