DuAEF.Duik.Controller

Controllers

Members

static color :Array.<float>

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

static defaultType :DuAEF.Duik.Controller.Types

The default type for new controllers
Default Value:
  • DuAEF.Duik.Controller.Types.TRANSFORM

static draft :boolean

The default quality for new controllers
Default Value:
  • false

static size :int

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

static sizeHint :int

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

static, readonly Strings :string

Translatable strings used to name layers and effects
These strings are translated at init time using the tr function from DuAEF.Dutranslator.
Properties:
Name Type Description
ROTATION string
X_POSITION string
Y_POSITION string
POSITION string
TRANSFORM string
EYE string
CAMERA string
HAND string
HEAD string
HIPS string
BODY string
SHOULDERS string
TAIL string
VULVA string
PENIS string
FOOT string
EAR string
HAIR string
MOUTH string
NOSE string
EYEBROW string
PONEYTAIL string
WALK_CYCLE string
BLENDER string
CONNECTOR string
CLAWS string
HOOF string
EXPOSE_TRANSFORM string
SLIDER string
DOUBLE_SLIDER string
ANGLE string

static, readonly Types :int

The shapes/type/icon of the controllers
Properties:
Name Type Description
ROTATION int
X_POSITION int
Y_POSITION int
POSITION int
TRANSFORM int
SLIDER int
DOUBLE_SLIDER int
ANGLE int
CAMERA int
HEAD int
HAND int
FOOT int
CLAWS int
HOOF int
EYE int
EYES int
FACE int
SQUARE int
HIPS int
BODY int
SHOULDERS int
TAIL int
PENIS int
VULVA int
WALK_CYCLE int
BLENDER int
NULL int
CONNECTOR int
EXPOSE_TRANSFORM int
EAR int
HAIR int
MOUTH int
NOSE int
EYEBROW int
PONEYTAIL int

Methods

static create(compopt, typeopt, layeropt, sizeopt, parentopt) → {Controller}

Creates a new controller
Parameters:
Name Type Attributes Default Description
comp CompItem <optional>
The composition
type DuAEF.Duik.Controller.Types <optional>
DuAEF.Duik.Controller.defaultType The type of Controller.
layer Layer | Array.<Layer> | LayerCollection <optional>
The layer(s) where to create the controller.
If several layers are provided, will create the controller at the average center of their world positions.
size float <optional>
The controller size, a percentage. By default, it will adjust automatically depending on comp size and DuAEF.Duik.Controller.sizeHint
parent boolean <optional>
false True to automatically parent the layer(s) to the controller
Returns:
Controller - The controller

static getControllers(compopt, selectedOnlyopt) → {Array.<Controller>}

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

static tag(layersopt)

Tags some layers to be recognized as controllers by DuAEF/Duik
Parameters:
Name Type Attributes Default Description
layers Layer | Array.<Layer> <optional>
DuAEF.DuAE.Comp.getSelectedLayers() The layers to tag.