us.temerity.pipeline.plugin.MayaMRayRenderAction.v2_2_1
Class MayaMRayRenderAction

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

All Implemented Interfaces:

Serializable, Cloneable, Comparable<PluginID>, Glueable

public class MayaMRayRenderAction
extends MayaActionUtils

Takes a source Maya scene, exports a monolithic MI file for each frame that contains everything in the scene and then renders it with the Mental Ray standalone engine.

The Maya scene is opened and the export length is set correctly. The entire scene is then exported out to per-frame MI files. The Action then invokes the Mental Ray standalone renderer to generate the target images.

Both before and after the export, optional MEL scripts 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 PreExportMEL and PostExportMEL single valued parameters.

This action defines the following single valued parameters:

Maya Scene

The source Maya scene node.

Pre Export MEL

The MEL script to be sourced before MI file export.

Pre Export MEL

The MEL script to be sourced after MI file export.

Keep Temp Files

Should the Action preserve the temporary MI files it generates for rendering.

Render Verbosity

The verbosity of render progress, warning and error messages.

Include Path

A semicolon seperated list of directories which overrides the path used to resolve "$include" statements in the MI scene file. Toolset environmental variable substitutions are enabled (see evaluate).

Library Path

A semicolon seperated list of directories that Mental Ray searches for shader libraries containing shader code before the default library paths. Toolset environmental variable substitutions are enabled (see evaluate).

Texture Path

A semicolon seperated list of directories that Mental Ray searches for texture files. Toolset environmental variable substitutions are enabled (see evaluate).

Extra Opts

Additional command-line arguments for the Mental Ray renderer.

If the environmental variable MRAY_BINARY is defined, its value will be used as the name of the renderer executable instead of the "ray" (Unix/MacOS) or "ray345.exe" (Windows). On Windows, the renderer name should include the ".exe" extension.

By default, the "python" program is used by this action when running on Windows to run Maya and Mental Ray. An alternative program can be specified by setting PYTHON_BINARY in the Toolset environment to the name of the Python interpertor this Action should use. When naming an alternative Python interpretor under Windows, make sure to include the ".exe" extension in the program name.

See Also:

Serialized Form

Field Summary

static String	aBaseLibraries
static String	aIncludePath
static String	aKeepTempFiles
static String	aLibraryPath
static String	aMayaScene
static String	aPostExportMEL
static String	aPreExportMEL
static String	aRenderVerbosity
static String	aTexturePath

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

MayaMRayRenderAction()

Method Summary

SubProcessHeavy

prep(ActionAgenda agenda, File outFile, File errFile) Construct a SubProcessHeavy instance which when executed will fulfill the given action agenda.

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, 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.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

aPreExportMEL

public static final String aPreExportMEL

See Also:

Constant Field Values

aPostExportMEL

public static final String aPostExportMEL

See Also:

Constant Field Values

aKeepTempFiles

public static final String aKeepTempFiles

See Also:

Constant Field Values

aRenderVerbosity

public static final String aRenderVerbosity

See Also:

Constant Field Values

aBaseLibraries

public static final String aBaseLibraries

See Also:

Constant Field Values

aLibraryPath

public static final String aLibraryPath

See Also:

Constant Field Values

aIncludePath

public static final String aIncludePath

See Also:

Constant Field Values

aTexturePath

public static final String aTexturePath

See Also:

Constant Field Values

Constructor Detail

MayaMRayRenderAction

public MayaMRayRenderAction()

Method Detail

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.