us.temerity.pipeline.plugin.MayaPygExportAction.v2_0_0
Class MayaPygExportAction

java.lang.Object
  us.temerity.pipeline.Named
      us.temerity.pipeline.PluginID
          us.temerity.pipeline.BasePlugin
              us.temerity.pipeline.BaseAction
                  us.temerity.pipeline.plugin.MayaPygExportAction.v2_0_0.MayaPygExportAction

All Implemented Interfaces:

Serializable, Cloneable, Comparable<PluginID>, Glueable

public class MayaPygExportAction
extends BaseAction

Exports Pyg input files for the Gelato renderer from a Maya scene.

Uses the mangoBatchExport MEL command to generate either a single or per-frame Pyg files. In addition, the exported files are renamed to comply with Pipeline file naming conventions. For each frame, there will be two Pyg files generated. The top level Pyg files which should be rendered with Gelato will be named to match the primary file sequence of this node. These top level Pyg files contain render settings, camera, outputs and include the main Pyg containing the geometry and lights which make up the scene. These main Pyg files will have "_main" appended to the prefix portion of the file sequence pattern. They should be added as a secondary sequence to this node.

Due to limitations in the mangoBatchExport MEL command, all frames must be exported by a single invocation of this action. Therefore only the Serial execution method should be used with this node. The mangoBatchExport MEL command is currently only capable of exporting the entire Maya scene.

Note the the Render Camera parameter is required by this action and is crucial to the proper renaming of the generated Pyg files.

See the Mango documentation for details about the mangoBatchExport(1) MEL command.

This action defines the following single valued parameters:

Maya Scene

The source node which contains the Maya scene file.

Render Camera

The name of the shape node in the Maya scene for the camera being rendered.

MEL Scripts

Pre Export MEL

The source node which contains the MEL script to evaluate before exporting begins.

Post Export MEL

The source node which contains the MEL script to evaluate after exporting ends.

See Also:

Serialized Form

Field Summary

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

MayaPygExportAction()

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

Constructor Detail

MayaPygExportAction

public MayaPygExportAction()

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.