us.temerity.pipeline.plugin.MayaMiShaderAction.v2_2_1
Class MayaMiShaderAction

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

All Implemented Interfaces:

Serializable, Cloneable, Comparable<PluginID>, Glueable

public class MayaMiShaderAction
extends MayaActionUtils

Exports shaders for the correct pass based on the name of the source.

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.

Material Namespace

The prefix used to identify the shading groups which will be used by this action to export shaders.

Shader Namespace

The prefix that will be used to identify the shaders that should be connected to the shading groups selected with the Material Namespace.

Render Pass Suffix

The name of the render pass used as the suffix of shader to connect to the shading groups selected with the Material Namespace.

Final Namespace

The prefix that will be included in all the exported shaders.

Fix Texture Paths

Whether to fix the texture paths written by Maya so that they will be compatible with the MRayRender Action.

Shader Export

Materal Shader

Whether the materal shader should be exported.

Displacement Shader

Whether the displacement shader should be exported.

Shadow Shader

Whether the shadow shader should be exported.

Volume Shader

Whether the volume shader should be exported.

Photon Shader

Whether the photon shader should be exported.

Photon Vol Shader

Whether the photon volume shader should be exported.

Env Shader

Whether the environment shader should be exported.

Light Map Shader

Whether the light map shader should be exported.

Contour Shader

Whether the contour shader should be exported.

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

static String	aContourShader
static String	aDisplacementShader
static String	aEnvShader
static String	aFinalNamespace
static String	aFixTexturePaths
static String	aLightMapShader
static String	aMaterialNamespace
static String	aMaterialShader
static String	aMayaScene
static String	aOutputFormat
static String	aPhotonShader
static String	aPhotonVolShader
static String	aPostExportMEL
static String	aPreExportMEL
static String	aRenderPassSuffix
static String	aShaderNamespace
static String	aShadowShader
static String	aVolumeShader

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

MayaMiShaderAction()

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

aMaterialNamespace

public static final String aMaterialNamespace

See Also:

Constant Field Values

aShaderNamespace

public static final String aShaderNamespace

See Also:

Constant Field Values

aRenderPassSuffix

public static final String aRenderPassSuffix

See Also:

Constant Field Values

aFinalNamespace

public static final String aFinalNamespace

See Also:

Constant Field Values

aFixTexturePaths

public static final String aFixTexturePaths

See Also:

Constant Field Values

aMaterialShader

public static final String aMaterialShader

See Also:

Constant Field Values

aDisplacementShader

public static final String aDisplacementShader

See Also:

Constant Field Values

aShadowShader

public static final String aShadowShader

See Also:

Constant Field Values

aVolumeShader

public static final String aVolumeShader

See Also:

Constant Field Values

aPhotonShader

public static final String aPhotonShader

See Also:

Constant Field Values

aPhotonVolShader

public static final String aPhotonVolShader

See Also:

Constant Field Values

aEnvShader

public static final String aEnvShader

See Also:

Constant Field Values

aLightMapShader

public static final String aLightMapShader

See Also:

Constant Field Values

aContourShader

public static final String aContourShader

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

MayaMiShaderAction

public MayaMiShaderAction()

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.