Duduf ik Tools
- Copyright:
- 2017,2018 Nicolas Dufresne, Rainbox Productions
https://rainboxprod.coop
- 2017,2018 Nicolas Dufresne, Rainbox Productions
- License:
- GPL-3.0
DuAEF is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
DuAEF is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with DuAEF. If not, see http://www.gnu.org/licenses/.
- GPL-3.0
Namespaces
Members
-
static, readonly LayerTypes :string
-
The different types of layers created by Duik
Properties:
Name Type Description MOTION_TRAIL
string STRUCTURE
string X_SHEET
string CEL
string EFFECTOR
string CONTROLLER
string TWOD_CAMERA_LAYER
string ZERO
string BONE
string NULL
string LOCATOR
string CONNECTOR
string -
static, readonly Presets :File
-
The presets used by Duik.
Properties:
Name Type Description FRAME
File -
static, readonly PseudoEffects :PseudoEffect
-
The pseudo effects contain all needed property indices from the corresponding effect in After Effects,
as attributes named after their display name in Ae.Properties:
Name Type Description KLEANER
PseudoEffect WALK_CYCLE
PseudoEffect SIDE
PseudoEffect FOOT_ROLL
PseudoEffect DIGI_FOOT_ROLL
PseudoEffect SHOULDER
PseudoEffect TWOD_CAMERA
PseudoEffect FRAME
PseudoEffect ONELAYER_IK
PseudoEffect TWOLAYER_IK
PseudoEffect THREELAYER_IK
PseudoEffect BEZIER_IK
PseudoEffect BEZIER_IK_CURVE
PseudoEffect BEZIER_IK_LAYER
PseudoEffect IK
PseudoEffect FK_OVERLAP
PseudoEffect ONED_CONNECTOR
PseudoEffect TWOD_CONNECTOR
PseudoEffect THREED_CONNECTOR
PseudoEffect COLOR_CONNECTOR
PseudoEffect QUICK_CONNECTOR
PseudoEffect EXPOSE_TRANSFORM
PseudoEffect BONE
PseudoEffect BONE_LINKER
PseudoEffect SHAPE_LINKER
PseudoEffect ATTACHMENT_OPTIONS
PseudoEffect ATTACHMENT
PseudoEffect PARENT
PseudoEffect PATH
PseudoEffect POSITION
PseudoEffect ORIENTATION
PseudoEffect CONTROLLER
PseudoEffect CONTROLLER_SLIDER
PseudoEffect CONTROLLER_DOUBLE_SLIDER
PseudoEffect CONTROLLER_ANGLE
PseudoEffect X_SHEET
PseudoEffect MOTION_TRAIL
PseudoEffect PAINT_RIG
PseudoEffect COLOR_BLINK
PseudoEffect ONED_BLINK
PseudoEffect TWOD_BLINK
PseudoEffect THREED_BLINK
PseudoEffect ONED_SPRING
PseudoEffect MULTID_SPRING
PseudoEffect SPATIAL_SPRING
PseudoEffect EFFECTOR
PseudoEffect MAP_EFFECTOR
PseudoEffect WHEEL
PseudoEffect ONED_SWING
PseudoEffect SPATIAL_SWING
PseudoEffect TWOD_SWING
PseudoEffect THREED_SWING
PseudoEffect ONED_WIGGLE
PseudoEffect ONED_MULTIWIGGLE
PseudoEffect TWOD_WIGGLE
PseudoEffect THREED_WIGGLE
PseudoEffect LOOPER
PseudoEffect ONED_LIST
PseudoEffect TWOD_LIST
PseudoEffect THREED_LIST
PseudoEffect STRUCTURE
PseudoEffect BLENDER
PseudoEffect TWO_DIMENSIONS
PseudoEffect TWO_DIMENSIONS_SCALE
PseudoEffect TWO_DIMENSIONS_ANGLE
PseudoEffect THREE_DIMENSIONS
PseudoEffect THREE_DIMENSIONS_SCALE
PseudoEffect THREE_DIMENSIONS_ANGLE
PseudoEffect COLOR
PseudoEffect EYES
PseudoEffect FINGERS
PseudoEffect HAND
PseudoEffect HEAD
PseudoEffect Example
alert(DuAEF.Duik.PseudoEffects.TWOLAYER_IK.reverseCheckBox); // 2 alert(DuAEF.Duik.PseudoEffects.TWOLAYER_IK.upperAngle); // 10
-
static, readonly PseudoEffectsMatchNames :string
-
The pseudo effects match names
Properties:
Name Type Description WALK_CYCLE
string SIDE
string DIGI_FOOT_ROLL
string SHOULDER
string BEZIER_IK
string BEZIER_IK_LAYER
string IK
string FK_OVERLAP
string BONE
string ATTACHMENT_OPTIONS
string ATTACHMENT
string X_SHEET
string PAINT_RIG
string COLOR_BLINK
string ONED_BLINK
string TWOD_BLINK
string THREED_BLINK
string ONED_SPRING
string MULTID_SPRING
string SPATIAL_SPRING
string WHEEL
string ONED_SWING
string SPATIAL_SWING
string TWOD_SWING
string THREED_SWING
string -
static, readonly Sizes :int
-
Predefined sizes
Properties:
Name Type Description SMALL
int MEDIUM
int LARGE
int CUSTOM
int
Methods
-
static getLayer(layerType, selectedOnlyopt, compopt) → {Layer|null}
-
Gets the first layer of a kind previously created by Duik
Parameters:
Name Type Attributes Default Description layerType
DuAEF.Duik.LayerTypes The type of the layer. selectedOnly
boolean <optional>
false Wether to search only in the layer selection comp
CompItem <optional>
The composition Returns:
Layer | null - The Structure or null if there is no active composition -
static getLayers(layerTypeopt, selectedOnlyopt, compopt) → {Array.<Layer>}
-
Gets layers previously created by Duik
Parameters:
Name Type Attributes Default Description layerType
DuAEF.Duik.LayerTypes <optional>
The type of the layer. selectedOnly
boolean <optional>
false Wether to search only in the layer selection comp
CompItem <optional>
The composition Returns:
Array.<Layer> - The Structure or null if there is no active composition -
static isLayerType(layer, layerType) → {boolean}
-
Checks if the layer is one of the types created by duik.
Parameters:
Name Type Description layer
Layer The layer to check layerType
DuAEF.Duik.LayerTypes The type of layer Returns:
boolean -
static setDuikMarker(layer, displayName, layerType)
-
Sets a new marker on the first frame of the layer, specifying the "Duik type" of the layer.
These markers are used by Duik and Dugr to recognise and manipulate the layers, or to store hidden data.Parameters:
Name Type Description layer
Layer The layer to set the marker on. displayName
string The name to display on the marker (the comment of the marker) layerType
DuAEF.Duik.LayerTypes The type