DuAEF.Duik.Bone

Bones

Members

static, readonly BoneTypes :int

The shapes/type/icon of the bones
Properties:
Name Type Description
PIN int
VERTEX int
TANGENT int

static color :Array.<float>

The default color for new bones
Default Value:
  • DuAEF.DuJS.Color.Colors.RAINBOX_RED

static size :int

The default size for new bones if boneSizeHint is DuAEF.Duik.Sizes.CUSTOM
Default Value:
  • 100

static sizeHint :int

Size hint of bones
Default Value:
  • DuAEF.Duik.Sizes.SMALL

Methods

static addBone(prop, sizeopt, tangentsopt) → {Array.<Bone>}

Links the property to a bone
Parameters:
Name Type Attributes Default Description
prop Property | PropertyInfo The property
size float <optional>
The bone size, a percentage. By default, it will adjust automatically depending on comp size and DuAEF.Duik.Bone.sizeHint
tangents bool <optional>
true True to create bones for the tangents if prop is a Shape
Returns:
Array.<Bone> - The bones created.

static addBones(prop, sizeopt, tangentsopt) → {Array.<Bone>}

Links the spatial child properties to bones
Parameters:
Name Type Attributes Default Description
prop PropertyGroup | PropertyInfo The property
size float <optional>
The bone size, a percentage. By default, it will adjust automatically depending on comp size and DuAEF.Duik.Bone.sizeHint
tangents bool <optional>
true True to create bones for the tangents if prop is a Shape
Returns:
Array.<Bone> - The bones created.

static createBone(comp, sizeopt, typeopt) → {Bone}

Creates a stand alone bone in the comp
Parameters:
Name Type Attributes Default Description
comp CompItem The containing composition
size float <optional>
The bone size, a percentage. By default, it will adjust automatically depending on comp size and DuAEF.Duik.Bone.sizeHint
type DuAEF.Duik.Bone.BoneTypes <optional>
DuAEF.Duik.Bone.BoneTypes.PIN The type
Returns:
Bone - The bone

static getBoneByName(comp, name, selectedOnlyopt) → {Bone|null}

Gets Bones 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
Returns:
Bone | null - The bones.

static getBones(comp, selectedOnlyopt) → {Array.<Bone>}

Gets Bones in the comp or the selection.
Parameters:
Name Type Attributes Default Description
comp CompItem The composition where to get the bones
selectedOnly boolean <optional>
false Selected layers only
Returns:
Array.<Bone> - The bones.

static rigShape(prop, sizeopt, tangentsopt, createBonesopt) → {Array.<Bone>}

Links the shape to bones
Works with After Effects CC2018 (15.0) and newer only
Parameters:
Name Type Attributes Default Description
prop Property | PropertyInfo The property
size float <optional>
The bone size, a percentage. By default, it will adjust automatically depending on comp size and DuAEF.Duik.Bone.sizeHint
tangents bool <optional>
true True to create bones for the tangents if prop is a Shape
createBones bool <optional>
true True to create bones, false to only create a controller effect
Returns:
Array.<Bone> - The bones created.