Structure(file, matchNameopt, nameopt)

Describes a pseudo effect

new Structure(file, matchNameopt, nameopt)

Constructs a Pseudo Effect
Parameters:
Name Type Attributes Default Description
file File The ffx file
matchName string <optional>
"" The matchName
name string <optional>
"" The default name
Properties:
Name Type Description
file File The ffx file
matchName string The matchName
name string The default name

Methods

bakeAppearence()

"Bakes" the appearance of the Structure,
in order to improve performance and simplify the use of the rig when animating.

duplicate() → {Structure}

Duplicates a structure,
Returns:
Structure - The new Structure

getController(layers, preferFKopt, thresholdopt) → {Layer|null}

Search for a controller which can be used with this Structure.
Parameters:
Name Type Attributes Default Description
layers Array.<Layer> | LayerCollection The layers where to search for the controller
preferFK boolean <optional>
false Set to true to search for the controller at the root of the chain first instead of the end
threshold int <optional>
0 The minimum distance in pixels between the controller and the structure to consider it valid.
Returns:
Layer | null - The controller found or null if there's nothing to find
The Controller object has an attribute "structureIndex" corresponding to the index of the element of the structure where it was found.

getId() → {int}

Gets the unique identifier of the structure
Returns:
int - the id

select()

Selects all the elements of the structure

setColor(coloropt)

Sets a new display color for the structure
Parameters:
Name Type Attributes Default Description
color Array.<float> <optional>
DuAEF.Duik.Structure.color The color

setSize(sizeopt)

Sets a new display size for the structure
Parameters:
Name Type Attributes Description
size int <optional>
The element size, a percentage. By default, it will adjust automatically depending on comp size and DuAEF.Duik.Structure.sizeHint

showHide()

Toggles visibility of the structure

toggleEditMode()

Toggles the edit mode

toggleElementEditMode(elementIndex, setEditMode)

Toggles the edit mode of one element in the structure
Parameters:
Name Type Description
elementIndex int The index of the element to toggle in the Structure.elements Array
setEditMode boolean true to turn on edit mode, false to turn it off.

Structure()

A Structure.

new Structure()

Constructs a Structure
Properties:
Name Type Description
elements Array.<Layer> The elements of the structure
structureId int The unique Id set when this structure was created

Methods

bakeAppearence()

"Bakes" the appearance of the Structure,
in order to improve performance and simplify the use of the rig when animating.

duplicate() → {Structure}

Duplicates a structure,
Returns:
Structure - The new Structure

getController(layers, preferFKopt, thresholdopt) → {Layer|null}

Search for a controller which can be used with this Structure.
Parameters:
Name Type Attributes Default Description
layers Array.<Layer> | LayerCollection The layers where to search for the controller
preferFK boolean <optional>
false Set to true to search for the controller at the root of the chain first instead of the end
threshold int <optional>
0 The minimum distance in pixels between the controller and the structure to consider it valid.
Returns:
Layer | null - The controller found or null if there's nothing to find
The Controller object has an attribute "structureIndex" corresponding to the index of the element of the structure where it was found.

getId() → {int}

Gets the unique identifier of the structure
Returns:
int - the id

select()

Selects all the elements of the structure

setColor(coloropt)

Sets a new display color for the structure
Parameters:
Name Type Attributes Default Description
color Array.<float> <optional>
DuAEF.Duik.Structure.color The color

setSize(sizeopt)

Sets a new display size for the structure
Parameters:
Name Type Attributes Description
size int <optional>
The element size, a percentage. By default, it will adjust automatically depending on comp size and DuAEF.Duik.Structure.sizeHint

showHide()

Toggles visibility of the structure

toggleEditMode()

Toggles the edit mode

toggleElementEditMode(elementIndex, setEditMode)

Toggles the edit mode of one element in the structure
Parameters:
Name Type Description
elementIndex int The index of the element to toggle in the Structure.elements Array
setEditMode boolean true to turn on edit mode, false to turn it off.