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_TRAILstring STRUCTUREstring X_SHEETstring CELstring EFFECTORstring CONTROLLERstring TWOD_CAMERA_LAYERstring ZEROstring BONEstring NULLstring LOCATORstring CONNECTORstring -
static, readonly Presets :File
-
The presets used by Duik.
Properties:
Name Type Description FRAMEFile -
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 KLEANERPseudoEffect WALK_CYCLEPseudoEffect SIDEPseudoEffect FOOT_ROLLPseudoEffect DIGI_FOOT_ROLLPseudoEffect SHOULDERPseudoEffect TWOD_CAMERAPseudoEffect FRAMEPseudoEffect ONELAYER_IKPseudoEffect TWOLAYER_IKPseudoEffect THREELAYER_IKPseudoEffect BEZIER_IKPseudoEffect BEZIER_IK_CURVEPseudoEffect BEZIER_IK_LAYERPseudoEffect IKPseudoEffect FK_OVERLAPPseudoEffect ONED_CONNECTORPseudoEffect TWOD_CONNECTORPseudoEffect THREED_CONNECTORPseudoEffect COLOR_CONNECTORPseudoEffect QUICK_CONNECTORPseudoEffect EXPOSE_TRANSFORMPseudoEffect BONEPseudoEffect BONE_LINKERPseudoEffect SHAPE_LINKERPseudoEffect ATTACHMENT_OPTIONSPseudoEffect ATTACHMENTPseudoEffect PARENTPseudoEffect PATHPseudoEffect POSITIONPseudoEffect ORIENTATIONPseudoEffect CONTROLLERPseudoEffect CONTROLLER_SLIDERPseudoEffect CONTROLLER_DOUBLE_SLIDERPseudoEffect CONTROLLER_ANGLEPseudoEffect X_SHEETPseudoEffect MOTION_TRAILPseudoEffect PAINT_RIGPseudoEffect COLOR_BLINKPseudoEffect ONED_BLINKPseudoEffect TWOD_BLINKPseudoEffect THREED_BLINKPseudoEffect ONED_SPRINGPseudoEffect MULTID_SPRINGPseudoEffect SPATIAL_SPRINGPseudoEffect EFFECTORPseudoEffect MAP_EFFECTORPseudoEffect WHEELPseudoEffect ONED_SWINGPseudoEffect SPATIAL_SWINGPseudoEffect TWOD_SWINGPseudoEffect THREED_SWINGPseudoEffect ONED_WIGGLEPseudoEffect ONED_MULTIWIGGLEPseudoEffect TWOD_WIGGLEPseudoEffect THREED_WIGGLEPseudoEffect LOOPERPseudoEffect ONED_LISTPseudoEffect TWOD_LISTPseudoEffect THREED_LISTPseudoEffect STRUCTUREPseudoEffect BLENDERPseudoEffect TWO_DIMENSIONSPseudoEffect TWO_DIMENSIONS_SCALEPseudoEffect TWO_DIMENSIONS_ANGLEPseudoEffect THREE_DIMENSIONSPseudoEffect THREE_DIMENSIONS_SCALEPseudoEffect THREE_DIMENSIONS_ANGLEPseudoEffect COLORPseudoEffect EYESPseudoEffect FINGERSPseudoEffect HANDPseudoEffect HEADPseudoEffect 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_CYCLEstring SIDEstring DIGI_FOOT_ROLLstring SHOULDERstring BEZIER_IKstring BEZIER_IK_LAYERstring IKstring FK_OVERLAPstring BONEstring ATTACHMENT_OPTIONSstring ATTACHMENTstring X_SHEETstring PAINT_RIGstring COLOR_BLINKstring ONED_BLINKstring TWOD_BLINKstring THREED_BLINKstring ONED_SPRINGstring MULTID_SPRINGstring SPATIAL_SPRINGstring WHEELstring ONED_SWINGstring SPATIAL_SWINGstring TWOD_SWINGstring THREED_SWINGstring -
static, readonly Sizes :int
-
Predefined sizes
Properties:
Name Type Description SMALLint MEDIUMint LARGEint CUSTOMint
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 layerTypeDuAEF.Duik.LayerTypes The type of the layer. selectedOnlyboolean <optional>
false Wether to search only in the layer selection compCompItem <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 layerTypeDuAEF.Duik.LayerTypes <optional>
The type of the layer. selectedOnlyboolean <optional>
false Wether to search only in the layer selection compCompItem <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 layerLayer The layer to check layerTypeDuAEF.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 layerLayer The layer to set the marker on. displayNamestring The name to display on the marker (the comment of the marker) layerTypeDuAEF.Duik.LayerTypes The type