us.temerity.pipeline.plugin.MayaBuildAction.v2_2_1
Class MayaBuildAction

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.MayaBuildAction.v2_2_1.MayaBuildAction

All Implemented Interfaces:

Serializable, Cloneable, Comparable<PluginID>, Glueable

public class MayaBuildAction
extends MayaActionUtils

Generates a new Maya scene from component scenes.

A new empty scene is first created. The component scenes are either referenced as Maya references or directly imported depending on a per-source parameter from each source node who's primary file sequence is a Maya scene file ("ma" or "mb"). At each stage in the process, an optional MEL script may be evaluated. The MEL scripts must be the primary file sequence of one of the source nodes and are assigned to the appropriate stage using the Intial MEL, Model MEL and Final MEL single valued parameters.

This action defines the following single valued parameters:

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.

Start Frame

The start frame of the generated Maya scene.

End Frame

The end frame of the generated Maya scene.

Initial MEL

The source node containing the MEL script to evaluate just after scene creation and before importing any models.

Model MEL

The source node containing the MEL script to evaluate after importing all models but before saving the generated Maya scene.

Final MEL

The source node containing the MEL script to evaluate after saving the generated Maya scene.

This action defines the following per-source parameters:

Build Type

The method Maya should use to merge the data from the source scene into the generated scene.

Name Space

Whether Maya should create a namespace for the imported/referenced scene. This option is highly recomended to avoid name clashes.

Prefix Name

The namespace prefix to use for the imported/referenced Maya scene inside the generated Maya scene. If unset, the namespace is based on the filename.

See Also:

Serialized Form

Field Summary

static String	aBuildType
static String	aEndFrame
static String	aFinalMEL
static String	aInitialMEL
static String	aModelMEL
static String	aNameSpace
static String	aPrefixName
static String	aStartFrame

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

aAngularUnits, aAnimMEL, aLinearUnits, aMayaScene, 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

MayaBuildAction()

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

aInitialMEL

public static final String aInitialMEL

See Also:

Constant Field Values

aModelMEL

public static final String aModelMEL

See Also:

Constant Field Values

aFinalMEL

public static final String aFinalMEL

See Also:

Constant Field Values

aBuildType

public static final String aBuildType

See Also:

Constant Field Values

aNameSpace

public static final String aNameSpace

See Also:

Constant Field Values

aPrefixName

public static final String aPrefixName

See Also:

Constant Field Values

aStartFrame

public static final String aStartFrame

See Also:

Constant Field Values

aEndFrame

public static final String aEndFrame

See Also:

Constant Field Values

Constructor Detail

MayaBuildAction

public MayaBuildAction()

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.