Duik.structures

Duik Structures
Read the Duik User Guide > Structures for more information about each method.
#include 'Duik16_structures_functions.jsxinc'

Members

static functions

All the structure methods stored as objects which can be parsed easily, for example to automatically build a ui with a button for each method.
Properties:
Name Type Description
name string A display name for the method
fn string The source script to eval

Methods

static arm(typeopt, shoulderopt, humerusopt, radiusopt, handopt, frontClawsopt, forceLinkopt)

Creates a structure for an arm/front leg.
Parameters:
Name Type Attributes Default Description
type DuAEF.Duik.Autorig.AnimalTypes <optional>
DuAEF.Duik.Autorig.AnimalTypes.PLANTIGRADE One of DuAEF.Duik.Autorig.AnimalTypes.PLANTIGRADE, DuAEF.Duik.Autorig.AnimalTypes.DIGITIGRADE, DuAEF.Duik.Autorig.AnimalTypes.UNGULATE. See the DuAEF Reference
shoulder boolean <optional>
true Wether to add a structure element for the shouder
humerus boolean <optional>
true Wether to add a structure element for the humerus
radius boolean <optional>
true Wether to add a structure element for the radius
hand boolean <optional>
true Wether to add a structure element for the hand
frontClaws boolean <optional>
false Wether to add a structure element for the front claws. True by default if the structure is not for a Plantigrade.
forceLink boolean <optional>
false Wether link the selected layers/properties to the new structures

static custom(numopt, nameopt, forceLinkopt, randomColoropt)

Creates custom structures.
Parameters:
Name Type Attributes Default Description
num int <optional>
3 The number of structure elements
name string <optional>
'Structure' The name of the Structure
forceLink boolean <optional>
false Wether link the selected layers/properties to the new structures
randomColor boolean <optional>
false Wether pick a random color for the new Structure

static duplicate()

Duplicates selected structures.

static edit()

Toggles edit mode.

static leg(typeopt, femuropt, tibiaopt, footopt, frontClawsopt, forceLinkopt)

Creates a structure for an arm/back leg.
Parameters:
Name Type Attributes Default Description
type DuAEF.Duik.Autorig.AnimalTypes <optional>
DuAEF.Duik.Autorig.AnimalTypes.PLANTIGRADE One of DuAEF.Duik.Autorig.AnimalTypes.PLANTIGRADE, DuAEF.Duik.Autorig.AnimalTypes.DIGITIGRADE, DuAEF.Duik.Autorig.AnimalTypes.UNGULATE. See the DuAEF Reference
femur boolean <optional>
true Wether to add a structure element for the femur
tibia boolean <optional>
true Wether to add a structure element for the tibia
foot boolean <optional>
true Wether to add a structure element for the foot
frontClaws boolean <optional>
false Wether to add a structure element for the back claws. True by default if the structure is not for a Plantigrade.
forceLink boolean <optional>
false Wether link the selected layers/properties to the new structures

static mammal(typeopt, numSpineopt, numNeckopt, headopt, shoulderopt, humerusopt, radiusopt, handopt, frontClawsopt, femuropt, tibiaopt, footopt, backClawsopt) → {Array}

Creates a structure for a mammal
Parameters:
Name Type Attributes Default Description
type DuAEF.Duik.Autorig.AnimalTypes <optional>
DuAEF.Duik.Autorig.AnimalTypes.PLANTIGRADE One of DuAEF.Duik.Autorig.AnimalTypes.PLANTIGRADE, DuAEF.Duik.Autorig.AnimalTypes.DIGITIGRADE, DuAEF.Duik.Autorig.AnimalTypes.UNGULATE. See the DuAEF Reference
numSpine int <optional>
2 The number of structure elements for the spine
numNeck int <optional>
1 The number of structure elements for the neck
head boolean <optional>
true Wether to add a structure element for a head
shoulder boolean <optional>
true Wether to add a structure element for shouders
humerus boolean <optional>
true Wether to add a structure element for humerus
radius boolean <optional>
true Wether to add a structure element for radius
hand boolean <optional>
true Wether to add a structure element for hands
frontClaws boolean <optional>
false Wether to add a structure element for frontClaws. True by default if the structure is not for a Plantigrade.
femur boolean <optional>
true Wether to add a structure element for femurs
tibia boolean <optional>
true Wether to add a structure element for tibias
foot boolean <optional>
true Wether to add a structure element for feet
backClaws boolean <optional>
false Wether to add a structure element for backClaws. True by default if the structure is not for a Plantigrade.
Returns:
Array - An array containing two arrays: the first one is the list of Structure objects created (see the DuAEF Reference), the second one is the list of the new layers.

static select()

Selects all structures.

static show(invertopt)

Shows/Hides all structures.
Parameters:
Name Type Attributes Default Description
invert boolean <optional>
false Wether invert the structure visibility instead of showing/hiding all

static spine(numSpineopt, numNeckopt, headopt, forceLinkopt)

Creates a structure for a spine, neck and head.
Parameters:
Name Type Attributes Default Description
numSpine int <optional>
2 The number of structure elements for the spine
numNeck int <optional>
1 The number of structure elements for the neck
head boolean <optional>
true Wether to add a structure element for a head
forceLink boolean <optional>
false Wether link the selected layers/properties to the new structures

static tail(numTailopt, forceLinkopt)

Creates a structure for a tail.
Parameters:
Name Type Attributes Default Description
numTail int <optional>
3 The number of structure elements for the tail
forceLink boolean <optional>
false Wether link the selected layers/properties to the new structures