Documentation Website Source code User guide Donate

Class

OCOLimb

OCOLimb(limbopt, sideopt, locationopt, typeopt)

A limb contained in an OCO Doc.
Constructor

# new OCOLimb(limbopt, sideopt, locationopt, typeopt)

Creates a new OCO Limb.
Parameters:
Name Type Attributes Default Description
limb OCO.Limb <optional>
 OCO.Limb.CUSTOM A Predefined limb
side OCO.Side <optional>
 OCO.Side.NONE The side of the limb
location OCO.Location <optional>
 OCO.Location.NONE The location of the limb
type OCO.LimbType <optional>
 OCO.LimbType.CUSTOM The type of the limb

View Source DuAEF.jsxinc, line 18401

Members

OCO.Limb

# static limb

The predefined limb

View Source DuAEF.jsxinc, line 18403

Array.<OCOLimb>

# static limbs

The limbs/ Armatures

View Source DuAEF.jsxinc, line 16827

OCO.Location

# static location

The location of the limb

View Source DuAEF.jsxinc, line 18424

Array.<OCOBone>

# static location

The bones of the limb

View Source DuAEF.jsxinc, line 18431

OCO.Side

# static side

The sided of the limb

View Source DuAEF.jsxinc, line 18417

OCO.LimbType

# static type

The type of the limb

View Source DuAEF.jsxinc, line 18410

Methods

# static fromObject(data) → {OCOLimb}

Creates a limb from a js object.
Parameters:
Name Type Description
data Object The js object representing the limb

View Source DuAEF.jsxinc, line 18617

The new limb
OCOLimb

# armatureFromLayers(doc, name, layers) → {OCOBone}

Creates a new chain of bones located on the layer anchor points.
Parameters:
Name Type Description
doc OCODoc The doc containing the limb.
name string The name of the bones (will increment if needed)
layers Array.<Layer> | LayerCollection The layers

View Source api3.jsxinc, line 2265

The root bone of the new chain
OCOBone

# armatureFromPath(doc, name, pathProp) → {OCOBone}

Creates a new chain of bones located on the vertices of the path.
Parameters:
Name Type Description
doc OCODoc The doc containing the limb.
name string The name of the bones (will increment if needed)
pathProp PropertyGroup | DuAEProperty The path property (either an "ADBE Vector Shape - Group" or an "ADBE Mask Atom")

View Source api3.jsxinc, line 2058

The root bone of the new chain
OCOBone

# armatureFromPuppetPins(doc, name, pins) → {OCOBone}

Creates a new chain of bones located on the puppet pins.
Parameters:
Name Type Description
doc OCODoc The doc containing the limb.
name string The name of the bones (will increment if needed)
pins Array.<Property> | Array.<DuAEProperty> The puppet pins

View Source api3.jsxinc, line 2170

The root bone of the new chain
OCOBone

# bounds() → {Array.<float>}

Gets the boundaries of the limb

View Source DuAEF.jsxinc, line 18486

[left, top, right, bottom]
Array.<float>

# getBones() → {Array.<OCOBone>}

Gets all the bones sorted by z index

View Source DuAEF.jsxinc, line 18582

The list of bones
Array.<OCOBone>

# getLayers() → {Array.<Layer>}

Gets the After Effects layers representing this limb

View Source api3.jsxinc, line 2339

May be an empty array if this limb has not been created in After Effects yet
Array.<Layer>

# getLimbs() → {Array.<OCOLimb>}

Recursively gets all the children limbs of this limb

View Source DuAEF.jsxinc, line 18472

The array of all limbs
Array.<OCOLimb>

# moveArmatureToLayers(doc, layers)

Moves the armature of the limb to the layers.
Parameters:
Name Type Description
doc OCODoc The doc containing the limb.
layers Array.<Layer> | LayerCollection The layers

View Source api3.jsxinc, line 2219

# moveArmatureToPath(doc, pathProp)

Moves the armature of the limb to the vertices of the path.
Parameters:
Name Type Description
doc OCODoc The doc containing the limb.
pathProp PropertyGroup | DuAEProperty The path property (either an "ADBE Vector Shape - Group" or an "ADBE Mask Atom")

View Source api3.jsxinc, line 2099

# moveArmatureToPuppetPins(doc, pins)

Moves the armature of the limb to the puppet pins.
Parameters:
Name Type Description
doc OCODoc The doc containing the limb.
pins Array.<Property> | Array.<DuAEProperty> The puppet pins

View Source api3.jsxinc, line 2131

# newArmature(name, numopt, lengthopt) → {OCOBone}

Creates a new chain of bones and adds it to the limb.
Parameters:
Name Type Attributes Default Description
name string The name of the bones (will increment if needed)
num int <optional>
 2 The number of bones in the chain
length float <optional>
 100.0 The length in centimeters

View Source DuAEF.jsxinc, line 18498

The root bone.
OCOBone

# normalizeZIndices(offsetopt) → {int}

Normalizes the Z indices of all bones so they're positive (including 0) and continuous integers
Parameters:
Name Type Attributes Default Description
offset int <optional>
 0 An offset/start number

View Source DuAEF.jsxinc, line 18565

The highest index
int

# numBones() → {int}

Counts the total number of bones in this limb

View Source DuAEF.jsxinc, line 18444

int

# numLimbs() → {int}

Counts the total number of limbs in this limb

View Source DuAEF.jsxinc, line 18458

int

# toComp(doc, compopt, parentLayeropt, limbIdopt) → {Array.<Layer>}

Creates the limb and armatures in the comp
Parameters:
Name Type Attributes Default Description
doc OCODoc The doc containing the limb.
comp CompItem <optional>
 DuAEProject.getActiveComp() The composition to use.
parentLayer Layer <optional>
 null The parent layer of the bone.
limbId int <optional>
 A Unique identifier for this armature. If omitted, a new one will be assigned.

View Source api3.jsxinc, line 2032

The new layers
Array.<Layer>

# toObject() → {Object}

Creates a js object containing this limb data.
This object could then be exported to JSON for example.

View Source DuAEF.jsxinc, line 18541

The JS Object
Object

# zBounds() → {Array.<int>}

Finds the maximum and minimum Z index from all bones

View Source DuAEF.jsxinc, line 18599

The [min, max] Z indices
Array.<int>