us.temerity.pipeline.plugin.MayaMelAction.v2_2_1
Class MayaMelAction

java.lang.Object
  us.temerity.pipeline.Named
      us.temerity.pipeline.PluginID
          us.temerity.pipeline.BasePlugin
              us.temerity.pipeline.BaseAction
                  us.temerity.pipeline.plugin.CommonActionUtils
                      us.temerity.pipeline.plugin.PythonActionUtils
                          us.temerity.pipeline.plugin.MayaActionUtils
                              us.temerity.pipeline.plugin.MayaMelAction.v2_2_1.MayaMelAction

All Implemented Interfaces:

Serializable, Cloneable, Comparable<PluginID>, Glueable

public class MayaMelAction
extends MayaActionUtils

Loads a Maya scene, evaluates a set of MEL scripts and optionally saves the modified scene as the primary target file sequence of the node.

This action defines the following single valued parameters:

Maya Scene

The source node which contains the Maya scene file to load. If this parameter is not set, then no scene will be loaded. This may be useful in the case where the MEL scripts create the scene from scratch.

Save Result

Whether to save the Maya scene as the node's primary target after all MEL scrips have been evaluated. It may be desirable to not save the Maya scene when the MEL scripts generate output during their evaluation.

Linear Unit

The linear unit that the generated scene will use.

Angular Unit

The angular unit that the generated scene will use.

Time Unit

The unit of time and frame rate that the generated scene will use.

This action defines the following per-source parameters:

Order

Each source node sequence which sets this parameter should contain a MEL script. This parameter determines the order in which the MEL scripts evaluated. If this parameter is not set for a source node file sequence, it will be ignored.

See Also:

Serialized Form

Field Summary

static String	aMayaScene
static String	aOrder
static String	aSaveResult

Fields inherited from class us.temerity.pipeline.plugin.MayaActionUtils

aAngularUnits, aAnimMEL, aFinalMEL, aInitialMEL, aLinearUnits, aModelMEL, aTimeUnits

Fields inherited from class us.temerity.pipeline.plugin.CommonActionUtils

aExtraOptions

Fields inherited from class us.temerity.pipeline.BasePlugin

pDescription

Fields inherited from class us.temerity.pipeline.PluginID

pVendor, pVersionID

Fields inherited from class us.temerity.pipeline.Named

pName

Constructor Summary

MayaMelAction()

Method Summary

TreeMap<String,ActionParam>	getInitialSourceParams() Get an initial set of action parameters associated with an upstream node.
SubProcessHeavy	prep(ActionAgenda agenda, File outFile, File errFile) Construct a SubProcessHeavy instance which when executed will fulfill the given action agenda.
boolean	supportsSourceParams() Does this action support per-source parameters?

Methods inherited from class us.temerity.pipeline.plugin.MayaActionUtils

addAnimMELParam, addFinalMELParam, addInitalMELParam, addMayaSceneParam, addModelMELParam, addUnitsParams, addUnitsParamsToLayout, createMayaCommand, createMayaPythonLauncher, createMayaPythonLauncher, createMayaSubProcess, genUnitsMEL, getMayaSceneSourcePath, getMayaSceneTargetPath, getMayaSceneType, getMelScriptSourcePath, getMelSnippet, getMiCustomShaderEnv, getMiCustomShaderEnv, writeAnimMEL, writeFinalMEL, writeInitialMEL, writeModelMEL

Methods inherited from class us.temerity.pipeline.plugin.PythonActionUtils

createPythonSubProcess, createPythonSubProcess, createPythonSubProcess, getPythonFileVerify, getPythonFileVerify, getPythonFileVerify, getPythonFileVerify, getPythonFileVerify, getPythonFileVerify, getPythonIndent, getPythonLaunchHeader, getPythonLaunchPipeHeader, getPythonProgram, getPythonProgram

Methods inherited from class us.temerity.pipeline.plugin.CommonActionUtils

addExtraOptionsParam, addExtraOptionsParamToLayout, createScriptSubProcess, createSubProcess, createSubProcess, createSubProcess, createSubProcess, createTempCopySubProcess, createTempScript, escPath, escPath, getExtraOptionsArgs, getPrimarySourcePath, getPrimarySourcePath, getPrimarySourcePath, getPrimarySourcePaths, getPrimarySourcePaths, getPrimarySourcePaths, getPrimaryTargetPath, getPrimaryTargetPath, getPrimaryTargetPath, getPrimaryTargetPaths, getPrimaryTargetPaths, getPrimaryTargetPaths, getSecondarySourceBooleanParamValue, getSecondarySourceDoubleParamValue, getSecondarySourceDoubleParamValue, getSecondarySourceEnumParamIndex, getSecondarySourceIntegerParamValue, getSecondarySourceIntegerParamValue, getSecondarySourceLongParamValue, getSecondarySourceLongParamValue, getSecondarySourceOptionalBooleanParamValue, getSecondarySourceStringParamValue, getSecondarySourceStringParamValue, getSingleBooleanParamValue, getSingleDoubleParamValue, getSingleDoubleParamValue, getSingleEnumParamIndex, getSingleIntegerParamValue, getSingleIntegerParamValue, getSingleLongParamValue, getSingleLongParamValue, getSingleOptionalBooleanParamValue, getSingleStringParamValue, getSingleStringParamValue, getSingleTuple2dParamValue, getSingleTuple2dParamValue, getSingleTuple2dParamValue, getSingleTuple2iParamValue, getSingleTuple2iParamValue, getSingleTuple2iParamValue, getSingleTuple3dParamValue, getSingleTuple3dParamValue, getSingleTuple3dParamValue, getSingleTuple3iParamValue, getSingleTuple3iParamValue, getSingleTuple3iParamValue, getSingleTuple4dParamValue, getSingleTuple4dParamValue, getSingleTuple4dParamValue, getSourceBooleanParamValue, getSourceDoubleParamValue, getSourceDoubleParamValue, getSourceEnumParamIndex, getSourceIntegerParamValue, getSourceIntegerParamValue, getSourceLongParamValue, getSourceLongParamValue, getSourceOptionalBooleanParamValue, getSourceStringParamValue, getSourceStringParamValue, getWorkingNodeFilePath, getWorkingNodeFilePath, getWorkingNodeFilePath, getWorkingNodeFilePath, getWorkingNodeFilePaths

Methods inherited from class us.temerity.pipeline.BaseAction

addPreset, addPresetValues, addSingleParam, chmod, cleanupLater, clearAllLinkParams, clearLinkParams, clone, createTemp, createTemp, equals, equalSingleParams, equalSourceParams, fromGlue, 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, 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.PluginID

getVendor, getVersionID

Methods inherited from class us.temerity.pipeline.Named

getName

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

aMayaScene

public static final String aMayaScene

See Also:

Constant Field Values

aSaveResult

public static final String aSaveResult

See Also:

Constant Field Values

aOrder

public static final String aOrder

See Also:

Constant Field Values

Constructor Detail

MayaMelAction

public MayaMelAction()

Method Detail

supportsSourceParams

public boolean supportsSourceParams()

Does this action support per-source parameters?

Overrides:

supportsSourceParams in class BaseAction

getInitialSourceParams

public TreeMap<String,ActionParam> getInitialSourceParams()

Get an initial set of action parameters associated with an upstream node.

Overrides:

getInitialSourceParams in class BaseAction

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.