Pin related tools.
Members
int
# static readonly Type
The shapes/type/icon of the pins
Properties:
| Name | Type | Description |
|---|---|---|
PIN |
int
|
|
VERTEX |
int
|
|
TANGENT |
int
|
|
BEND_PIN |
int
|
|
ADVANCED_PIN |
int
|
|
STANDARD |
int
|
Methods
# static add(prop, tangentsopt) → {Array.<ShapeLayer>}
Links the property to a pin. This will automatically detect the type of the property to create the corresponding pins.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
prop |
Property
|
DuAEProperty
|
The property | ||
tangents |
Boolean
|
<optional> |
true | True to create pins for the tangents if prop is a Shape |
The pins created.
Array.<ShapeLayer>
# static addPins(prop, tangentsopt) → {Array.<ShapeLayer>}
Links the spatial child properties to pins
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
prop |
PropertyGroup
|
DuAEProperty
|
The property | ||
tangents |
Boolean
|
<optional> |
true | True to create pins for the tangents if prop is a Shape |
The pins created.
Array.<ShapeLayer>
# static addPuppetPin(prop) → {ShapeLayer}
Adds a pin on a puppet pin
Parameters:
| Name | Type | Description |
|---|---|---|
prop |
PropertyGroup
|
The puppet pin |
The new pin.
ShapeLayer
# static color(layeropt) → {DuColor}
Checks the color of the pin layer
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
layer |
Layer
|
<optional> |
DuAEComp.getActiveLayer | The layer. If omitted, will check the first selected pin of the current comp |
# static create(compopt, typeopt) → {ShapeLayer}
Creates a stand alone pin in the comp
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
comp |
CompItem
|
<optional> |
DuAEProject.getActiveComp() | The containing composition |
type |
Duik.Pin.Type
|
<optional> |
Duik.Pin.Type.PIN | The type |
The pin
ShapeLayer
# static get(selectedOnlyopt, compopt) → {Array.<ShapeLayer>}
Gets the pins 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 |
The bones
Array.<ShapeLayer>
# static getByName(comp, name, selectedOnlyopt) → {Layer|null}
Gets a Pin layer in the comp or the selection.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
comp |
CompItem
|
The composition where to get the bones | ||
name |
string
|
A name filter | ||
selectedOnly |
Boolean
|
<optional> |
false | Selected layers only |
The pin layer.
Layer
|
null
# static linkPathToLayers(pathProp, layers)
Links the path to the given layers.
Parameters:
| 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 |
# static linkPositionToPin(prop, boneLayer, keepOffsetopt) → {PropertyGroup}
Links a spatial property to a layer
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
prop |
Property
|
DuAEProperty
|
The property to link | ||
boneLayer |
Layer
|
The parent layer | ||
keepOffset |
bool
|
<optional> |
true | True to not move the parent layer to the position of the property |
The effect created to link the bone.
PropertyGroup
# static linkPuppetPinsToLayers(pins, layers)
Links the puppet pins to the given layers.
Parameters:
| 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 |
# static opacity(layeropt) → {float}
Checks the opacity of the pin 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 |
float
# static rigPath(prop, tangentsopt, createPinLayersopt) → {Array.<DuAEProperty>}
Links the path to pins
Works with After Effects CC2018 (15.0) and newer only
Works with After Effects CC2018 (15.0) and newer only
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
prop |
Property
|
DuAEProperty
|
The path property | ||
tangents |
bool
|
<optional> |
true | True to create bones for the tangents |
createPinLayers |
bool
|
<optional> |
true | True to create layers, false to only create a controller effect |
The pin effects created.
Array.<DuAEProperty>
# 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 |
# static setColor(color, layersopt) → {DuColor}
Sets the color of the pin layers
Parameters:
# 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 |
# static setLocation(side, layersopt)
Sets the location of the layer
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
side |
OCO.Side
|
The side | ||
layers |
Array.<Layer>
|
<optional> |
DuAEComp.getSelectedLayers() | The layers. If omitted, will use all selected layers in the comp |
# static setOpacity(opacity, layeropt) → {float}
Sets the opacity of the pin 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 |
float
# static setSide(side, layersopt)
Sets the side of the layer
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
side |
OCO.Side
|
The side | ||
layers |
Array.<Layer>
|
<optional> |
DuAEComp.getSelectedLayers() | The layer. If omitted, will use all selected layers in the comp |
# static setSize(size, layeropt)
Sets the size of the pin 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 |
# static size(layeropt) → {float}
Checks the size of the pin layer
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
layer |
Layer
|
<optional> |
DuAEComp.getActiveLayer | The layer. If omitted, will check the first selected pin of the current comp |
float