Namespace: Pin

Duik. Pin

Pin related tools.

Members

static,readonlyDuik.Pin.Typeint

The shapes/type/icon of the pins
Properties:
Name Type Default Description
PIN int 1
VERTEX int 2
TANGENT int 3
BEND_PIN int 4
ADVANCED_PIN int 5
STANDARD int 6

Methods

staticDuik.Pin.add(prop, tangents){Array.<ShapeLayer>}

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 33377
Links the property to a pin. This will automatically detect the type of the property to create the corresponding pins.
Name Type Default Description
prop Property | DuAEProperty The property
tangents Boolean true optional True to create pins for the tangents if prop is a Shape
Returns:
Type Description
Array.<ShapeLayer> The pins created.

staticDuik.Pin.addPins(prop, tangents){Array.<ShapeLayer>}

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 33435
Links the spatial child properties to pins
Name Type Default Description
prop PropertyGroup | DuAEProperty The property
tangents Boolean true optional True to create pins for the tangents if prop is a Shape
Returns:
Type Description
Array.<ShapeLayer> The pins created.

staticDuik.Pin.addPuppetPin(prop){ShapeLayer}

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 33472
Adds a pin on a puppet pin
Name Type Description
prop PropertyGroup The puppet pin
Returns:
Type Description
ShapeLayer The new pin.

staticDuik.Pin.color(layer){DuColor}

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

staticDuik.Pin.create(comp, type){ShapeLayer}

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 33229
Creates a stand alone pin in the comp
Name Type Default Description
comp CompItem DuAEProject.getActiveComp() optional The containing composition
type Duik.Pin.Type Duik.Pin.Type.PIN optional The type
Returns:
Type Description
ShapeLayer The pin

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

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 34098
Gets the pins 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.Pin.getByName(comp, name, selectedOnly){Layer|null}

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 33747
Gets a Pin layer in the comp or the selection.
Name Type Default Description
comp CompItem The composition where to get the bones
name string A name filter
selectedOnly Boolean false optional Selected layers only
Returns:
Type Description
Layer | null The pin layer.

staticDuik.Pin.linkPathToLayers(pathProp, layers)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 33972
Links the path to the given layers.
Name Type Description
pathProp PropertyGroup | DuAEProperty The path property (either an "ADBE Vector Shape - Group" or an "ADBE Mask Atom")
layers Array.<Layer> The layers to link

staticDuik.Pin.linkPositionToPin(prop, boneLayer, keepOffset){PropertyGroup}

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 34025
Links a spatial property to a layer
Name Type Default Description
prop Property | DuAEProperty The property to link
boneLayer Layer The parent layer
keepOffset bool true optional True to not move the parent layer to the position of the property
Returns:
Type Description
PropertyGroup The effect created to link the bone.

staticDuik.Pin.linkPuppetPinsToLayers(pins, layers)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 33999
Links the puppet pins to the given layers.
Name Type Description
pins Array.<Property> | Array.<DuAEProperty> The path property (either an "ADBE FreePin3 PosPin Atom" or an "ADBE FreePin3 PosPin Position")
layers Array.<Layer> The layers to link

staticDuik.Pin.rigPath(prop, tangents, createPinLayers){Array.<DuAEProperty>}

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 33778
Links the path to bones
Works with After Effects CC2018 (15.0) and newer only
Name Type Default Description
prop Property | DuAEProperty The path property
tangents bool true optional True to create bones for the tangents
createPinLayers bool true optional True to create layers, false to only create a controller effect
Returns:
Type Description
Array.<DuAEProperty> The pin effects created.

staticDuik.Pin.setCharacterName(characterName, layer)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 34221
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.Pin.setColor(color, layers){DuColor}

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 34130
Sets the color of the pin layers
Name Type Default Description
color DuColor The color
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.Pin.setLimbName(limbName, layer)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 34232
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.Pin.setLocation(side, layers)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 34210
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.Pin.setSide(side, layers)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 34199
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.Pin.setSize(size, layer)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 34175
Sets the size of the pin 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.Pin.size(layer){float}

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