us.temerity.pipeline.plugin.MayaMiExportAction.v2_2_1
Class MayaMiExportAction

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

All Implemented Interfaces:

Serializable, Cloneable, Comparable<PluginID>, Glueable

public class MayaMiExportAction
extends MayaActionUtils

Exports MentalRay entities from a Maya scene.

See the Maya documentation for the MEL command (Mayatomr) for details. This action defines the following single valued parameters:

Maya Scene

The source node which contains the Maya scene file.

Output Format

The format of the output MI file.

Render Global Options

Export Exact Hierarchy

Tries to preserve the DAG hierarchy during processing. This produces additional Mental Ray instgroup entities. There are certain unresolved material inheritance issues in this mode, but it works well in the general case. Deeply nested DAG hierarchies may be translated much faster compared to the standard Maya iterator mode that always flattens the DAG.

Export Full DAG Path

Uses the full DAG path names instead of the shortest possible name for Mental Ray scene entities. This is not required to generate a valid scene, but ensures reproducible names even if DAG entity names are reused in Maya. On the other hand, with deeply nested DAG hierarchy names, you may exceed the maximum supported name length in Mental Ray.

Export Textures First

Collects all file texture references in the scene first. This ensures that missing texture files are reported early in the process, but may slow down scene processing depending on the number of file textures being used. It may also write out textures references that are never used in the shading graph, because it doesn't perform a complete scene graph traversal for performance reasons.

Export Post Effects

Lets you export post effects. This will create lots of maya garbage in your camera and shader scenes. Probably best to leave this off unless you specifically need this functionality.

Export Assigned Only

This option ignores objects without materials during translation so that they are not part of the final rendered scene.

Export Visible Only

This option ignores non-animated invisible scene entities during translation so that they are not part of the final rendered scene. This option is on by default.

Optimize Anim Detection

When this option is turned on, the processing of non-animated geometry is significantly optimized because Mental Ray for Maya detects animated nodes prior to processing the scene. This is especially useful for scenes that contain many static objects and only a few simply animated objects.

Use Default Light

Should the default light be turned on. By default this is off.

Fragment Export

Export Set

The name of the Maya Set used to select the DAG nodes to export from the Maya scene. If unset, then the entire scene will be exported.

Export Children

Whether to additionally export all child DAGs of the nodes selected for export.

Export Materials

Whether to additionally export all materials associated with the nodes selected for export.

Export Connections

Whether to additionally export shading nodes which are connected to (driving) the nodes selected for export.

Exported Entities

Links
Includes
Versions
Textures
Objects
Groups
Lights
Cameras
Materials
Options
Functions
Function Decls
Phenomena Decls
User Data

Object Instances
Light Instances
Group Instances
Camera Instances
Function Instances

Render

Custom Text
Custom Shaders
Custom Phenomena

MEL Scripts

Pre Export MEL

The MEL script to evaluate before exporting MI files.

Post Export MEL

The MEL script to evaluate after exporting MI files.

See Also:

Serialized Form

Field Summary

static String	aCameraInstances
static String	aCameras
static String	aCustomPhenomena
static String	aCustomShaders
static String	aCustomText
static String	aExportAssignedOnly
static String	aExportChildren
static String	aExportConnections
static String	aExportExactHierarchy
static String	aExportFullDagPath
static String	aExportMaterials
static String	aExportPostEffects
static String	aExportTexturesFirst
static String	aExportVisibleOnly
static String	aFunctionDecls
static String	aFunctionInstances
static String	aFunctions
static String	aGroupInstances
static String	aGroups
static String	aIncludes
static String	aLightInstances
static String	aLights
static String	aLinks
static String	aMaterials
static String	aMayaScene
static String	aObjectInstances
static String	aObjects
static String	aOptimizeAnimDetection
static String	aOptions
static String	aOutputFormat
static String	aPhenomenaDecls
static String	aPostExportMEL
static String	aPreExportMEL
static String	aRender
static String	aTextures
static String	aUseDefaultLight
static String	aUserData
static String	aVersions
static String	sExportSet

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

MayaMiExportAction()

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

aOutputFormat

public static final String aOutputFormat

See Also:

Constant Field Values

sExportSet

public static final String sExportSet

See Also:

Constant Field Values

aExportChildren

public static final String aExportChildren

See Also:

Constant Field Values

aExportMaterials

public static final String aExportMaterials

See Also:

Constant Field Values

aExportConnections

public static final String aExportConnections

See Also:

Constant Field Values

aLinks

public static final String aLinks

See Also:

Constant Field Values

aIncludes

public static final String aIncludes

See Also:

Constant Field Values

aVersions

public static final String aVersions

See Also:

Constant Field Values

aTextures

public static final String aTextures

See Also:

Constant Field Values

aObjects

public static final String aObjects

See Also:

Constant Field Values

aGroups

public static final String aGroups

See Also:

Constant Field Values

aLights

public static final String aLights

See Also:

Constant Field Values

aCameras

public static final String aCameras

See Also:

Constant Field Values

aMaterials

public static final String aMaterials

See Also:

Constant Field Values

aOptions

public static final String aOptions

See Also:

Constant Field Values

aFunctions

public static final String aFunctions

See Also:

Constant Field Values

aFunctionDecls

public static final String aFunctionDecls

See Also:

Constant Field Values

aPhenomenaDecls

public static final String aPhenomenaDecls

See Also:

Constant Field Values

aUserData

public static final String aUserData

See Also:

Constant Field Values

aObjectInstances

public static final String aObjectInstances

See Also:

Constant Field Values

aLightInstances

public static final String aLightInstances

See Also:

Constant Field Values

aGroupInstances

public static final String aGroupInstances

See Also:

Constant Field Values

aCameraInstances

public static final String aCameraInstances

See Also:

Constant Field Values

aFunctionInstances

public static final String aFunctionInstances

See Also:

Constant Field Values

aRender

public static final String aRender

See Also:

Constant Field Values

aCustomText

public static final String aCustomText

See Also:

Constant Field Values

aCustomShaders

public static final String aCustomShaders

See Also:

Constant Field Values

aCustomPhenomena

public static final String aCustomPhenomena

See Also:

Constant Field Values

aExportExactHierarchy

public static final String aExportExactHierarchy

See Also:

Constant Field Values

aExportFullDagPath

public static final String aExportFullDagPath

See Also:

Constant Field Values

aExportTexturesFirst

public static final String aExportTexturesFirst

See Also:

Constant Field Values

aExportPostEffects

public static final String aExportPostEffects

See Also:

Constant Field Values

aExportAssignedOnly

public static final String aExportAssignedOnly

See Also:

Constant Field Values

aExportVisibleOnly

public static final String aExportVisibleOnly

See Also:

Constant Field Values

aOptimizeAnimDetection

public static final String aOptimizeAnimDetection

See Also:

Constant Field Values

aUseDefaultLight

public static final String aUseDefaultLight

See Also:

Constant Field Values

aPostExportMEL

public static final String aPostExportMEL

See Also:

Constant Field Values

aPreExportMEL

public static final String aPreExportMEL

See Also:

Constant Field Values

Constructor Detail

MayaMiExportAction

public MayaMiExportAction()

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.