us.temerity.pipeline.plugin.MayaAnimExportAction.v2_0_12
Class MayaAnimExportAction
java.lang.Object
us.temerity.pipeline.Named
us.temerity.pipeline.PluginID
us.temerity.pipeline.BasePlugin
us.temerity.pipeline.BaseAction
us.temerity.pipeline.plugin.MayaAnimExportAction.v2_0_12.MayaAnimExportAction
- All Implemented Interfaces:
- Serializable, Cloneable, Comparable<PluginID>, Glueable
public class MayaAnimExportAction
- extends BaseAction
Exports animation channels from a Maya scene.
For each target file sequence which contains a single Maya animation (.anim) file, there
should exist a namespace in the animated Maya scene which matches the animation file
" prefix exactly.
Each of these namespaces should contain a Maya set used to select the DAG nodes owning the
animation channels to be baked and/or exported in that namespace. This selection set is
specified by the Export Set single parameter. The namespace should also contain a DAG
node under which all visible geometry is grouped (usually called ROOT). This root DAG
node should have its visibility channel set to keyable so that the MayaCollate action can
properly control when objects should be visible in multiple shot animation sequences.
If the primary file sequences is not an animation file, it will simply be touched by
this action. This can be useful when exporting several animation files at once so that
the name of the Pipeline node need not correspond to one of these sequences, but instead
can be given a more appropriate name.
This action defines the following single valued parameters:
Method
The animation export method:
- Export - Exports the animation channels of the members of the Export Set.
- Bake - First bakes per-frame animation (simulation OFF) for the channels of
the members of the Export Set and then exports these baked channels.
- Simulate - First bakes per-frame animation (simulation ON) for the channels of
the members of the Export Set and then exports these baked channels.
- Script - The Export MEL script is responsible for performing all animation
baking and/or export operations.
Export Set
The name of the Maya Set (under each namespace) used to identify the DAG nodes who's
animation channels should be baked and/or exported.
First Frame
The first exported frame of animation.
Last Frame
The last export frame of animation.
Note that a frame of animation is defined as continuing up to the start of the frame
after this frame. Exported animation curves should contain valid data over the entire
last frame to insure valid motion blur at shot transitions. If no key exists at the
time (Last Frame + 1.0), a key will be inserted at that time and included in the
exported animation.
Maya Scene
The source who's primay file sequence is the Maya scene which contains the animation
being exported.
Prep MEL
If set, this parameter specifies the node containing the MEL script to evalute after
loading the Maya Scene but before baking and/or exporting animation. This script can
be useful for performing any dynamic setup needed before animation export begins.
Export MEL
When the Method parameter is set to Script, this parameter specifies the node
containing the MEL script resposible for exporting all animation files. Any baking
of channels required before export is the responsibility of this script.
This action adds several environmental variables to the environment under which Maya is
run in order to communicate action parameters to the Prep and Export MEL scripts:
ANIM_EXPORT_ANIMS
A comma seperated list of the prefixes of the animation files being exported.
ANIM_EXPORT_SET
The value of the Export Set single parameter.
ANIM_EXPORT_FIRST_FRAME
The value of the First Frame single parameter.
ANIM_EXPORT_LAST_FRAME
The value of the Last Frame single parameter.
- See Also:
- Serialized Form
| Fields inherited from class us.temerity.pipeline.Named |
pName |
| Methods inherited from class us.temerity.pipeline.BaseAction |
addPreset, addPresetValues, addSingleParam, chmod, cleanupLater, clearAllLinkParams, clearLinkParams, clone, createTemp, createTemp, equals, equalSingleParams, equalSourceParams, fromGlue, getInitialSourceParams, getPluginType, getPresetChoices, getPresetValues, getSecondarySequences, getSecondarySourceNames, getSecondarySourceParam, getSecondarySourceParams, getSecondarySourceParamValue, getSingleLayout, getSingleParam, getSingleParams, getSingleParamValue, getSourceLayout, getSourceNames, getSourceParam, getSourceParams, getSourceParamValue, getTempDir, getTempPath, hasSecondarySourceParams, hasSingleParams, hasSourceParams, initSecondarySourceParams, initSourceParams, removeAllSourceParams, removeSecondarySourceParams, removeSecondarySourceParams, removeSourceParams, setSecondarySourceParamValue, setSingleLayout, setSingleParamValue, setSingleParamValues, setSourceLayout, setSourceParamValue, setSourceParamValues, supportsSourceParams, toGlue |
| Methods inherited from class us.temerity.pipeline.BasePlugin |
addSupport, compareTo, getDescription, getFullMessage, getPluginID, getResource, getResources, getResourceSize, getSupports, isUnderDevelopment, removeSupport, setSupports, supports, toString, underDevelopment |
| Methods inherited from class us.temerity.pipeline.Named |
getName |
MayaAnimExportAction
public MayaAnimExportAction()
prep
public SubProcessHeavy prep(ActionAgenda agenda,
File outFile,
File errFile)
throws PipelineException
- Construct a
SubProcessHeavy instance which when executed will
fulfill the given action agenda.
- Overrides:
prep in class BaseAction
- Parameters:
agenda - The agenda to be accomplished by the action.outFile - The file to which all STDOUT output is redirected.errFile - The file to which all STDERR output is redirected.
- Returns:
- The SubProcess which will fulfill the agenda.
- Throws:
PipelineException - If unable to prepare a SubProcess due to illegal, missing or imcompatable
information in the action agenda or a general failure of the prep method code.