us.temerity.pipeline.plugin.MayaRenderGlobalsAction.v2_2_1
Class MayaRenderGlobalsAction

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

All Implemented Interfaces:

Serializable, Cloneable, Comparable<PluginID>, Glueable

public class MayaRenderGlobalsAction
extends CommonActionUtils

Creates a MEL script which when executed by Maya will set many of the most useful global rendering parameters of the Maya scene.

This generated MEL script can then be used as the PreRenderMEL script of a MayaRender action to allow control over rendering parameters directly from Pipeline without the need to reopen the Maya scene.

This action defines the following single valued parameters:

Image Width

The horizontal resolution of the output image in pixels.

Image Height

The vertical resolution of the output image in pixels.

Pixel Aspect Ratio

Ratio of pixel height to pixel width.

Render Quality Parameters

Edge Anti Aliasing

The quality of edge anti-aliasing.

Shading Samples

The minimum number of shading samples.

Max Shading Samples

The maximum number of shading samples.

Particle Samples

The number of particle shading samples.

Use Multi Pixel Filtering

Whether to enable multi-pixel filtering.

Pixel Filter Type

The type of filter used to integrate pixels.

Pixel Filter Width X

The horizontal pixel filter width.

Pixel Filter Width Y

The vertical pixel filter width.

Red Threshold

The red contrast threshold.

Green Threshold

The green contrast threshold.

Blue Threshold

The blue contrast threshold.

Coverage Threshold

The alpha coverage threshold.

Raytracing Quality Parameters

Use Raytracing

Whether to enable raytracing.

Reflections

The reflection ray depth.

Refractions

The refraction ray depth.

Shadows

The shadow ray depth.

Bias

Distance a shadow ray travels before testing for intersections.

Motion Blur Parameters

Use Motion Blur

Whether to enable motion blur.

Motion Blur Type

The motion blur technique (2D or 3D).

Blur By Frame

The amount moving objects are blurred.

Blur Length

Scales the amount that moving objects are blurred.

Blur Sharpness

The sharpness of motion blurred objects.

Smooth

Anti-aliasing hack (Alpha or Color).

Smooth Value

The amount Maya blurs motion blur edges.

Keep Motion Vectors

Whehter to save the motion vectors for external 2D blur.

Use 2d Blur Memory Limit

Whether to limit 2D blur memory.

2d Blur Memory Limit

The maximum amount of memory used by the 2d blur operation.

See the Maya documentation for more details about the meaning of these Render Globals parameters.

See Also:

Serialized Form

Field Summary

static String	a2dBlurMemoryLimit
static String	aBias
static String	aBlueThreshold
static String	aBlurByFrame
static String	aBlurLength
static String	aBlurSharpness
static String	aCoverageThreshold
static String	aEdgeAntiAliasing
static String	aGreenThreshold
static String	aImageHeight
static String	aImageResolution
static String	aImageWidth
static String	aKeepMotionVectors
static String	aMaxShadingSamples
static String	aMotionBlurType
static String	aParticleSamples
static String	aPixelAspectRatio
static String	aPixelFilterType
static String	aPixelFilterWidthX
static String	aPixelFilterWidthY
static String	aQuality
static String	aRedThreshold
static String	aReflections
static String	aRefractions
static String	aShadingSamples
static String	aShadows
static String	aSmooth
static String	aSmoothValue
static String	aUse2dBlurMemoryLimit
static String	aUseMotionBlur
static String	aUseMultiPixelFiltering
static String	aUseRaytracing

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

MayaRenderGlobalsAction()

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

aImageWidth

public static final String aImageWidth

See Also:

Constant Field Values

aImageHeight

public static final String aImageHeight

See Also:

Constant Field Values

aPixelAspectRatio

public static final String aPixelAspectRatio

See Also:

Constant Field Values

aImageResolution

public static final String aImageResolution

See Also:

Constant Field Values

aEdgeAntiAliasing

public static final String aEdgeAntiAliasing

See Also:

Constant Field Values

aShadingSamples

public static final String aShadingSamples

See Also:

Constant Field Values

aMaxShadingSamples

public static final String aMaxShadingSamples

See Also:

Constant Field Values

aParticleSamples

public static final String aParticleSamples

See Also:

Constant Field Values

aUseMultiPixelFiltering

public static final String aUseMultiPixelFiltering

See Also:

Constant Field Values

aPixelFilterType

public static final String aPixelFilterType

See Also:

Constant Field Values

aPixelFilterWidthX

public static final String aPixelFilterWidthX

See Also:

Constant Field Values

aPixelFilterWidthY

public static final String aPixelFilterWidthY

See Also:

Constant Field Values

aRedThreshold

public static final String aRedThreshold

See Also:

Constant Field Values

aGreenThreshold

public static final String aGreenThreshold

See Also:

Constant Field Values

aBlueThreshold

public static final String aBlueThreshold

See Also:

Constant Field Values

aCoverageThreshold

public static final String aCoverageThreshold

See Also:

Constant Field Values

aQuality

public static final String aQuality

See Also:

Constant Field Values

aUseRaytracing

public static final String aUseRaytracing

See Also:

Constant Field Values

aReflections

public static final String aReflections

See Also:

Constant Field Values

aRefractions

public static final String aRefractions

See Also:

Constant Field Values

aShadows

public static final String aShadows

See Also:

Constant Field Values

aBias

public static final String aBias

See Also:

Constant Field Values

aUseMotionBlur

public static final String aUseMotionBlur

See Also:

Constant Field Values

aMotionBlurType

public static final String aMotionBlurType

See Also:

Constant Field Values

aBlurByFrame

public static final String aBlurByFrame

See Also:

Constant Field Values

aBlurLength

public static final String aBlurLength

See Also:

Constant Field Values

aBlurSharpness

public static final String aBlurSharpness

See Also:

Constant Field Values

aSmooth

public static final String aSmooth

See Also:

Constant Field Values

aSmoothValue

public static final String aSmoothValue

See Also:

Constant Field Values

aKeepMotionVectors

public static final String aKeepMotionVectors

See Also:

Constant Field Values

aUse2dBlurMemoryLimit

public static final String aUse2dBlurMemoryLimit

See Also:

Constant Field Values

a2dBlurMemoryLimit

public static final String a2dBlurMemoryLimit

See Also:

Constant Field Values

Constructor Detail

MayaRenderGlobalsAction

public MayaRenderGlobalsAction()

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.