TEMERITY

us.temerity.pipeline.plugin.MRayRenderGlobalsAction.v2_2_1
Class MRayRenderGlobalsAction

java.lang.Object
  extended by us.temerity.pipeline.Named
      extended by us.temerity.pipeline.PluginID
          extended by us.temerity.pipeline.BasePlugin
              extended by us.temerity.pipeline.BaseAction
                  extended by us.temerity.pipeline.plugin.CommonActionUtils
                      extended by us.temerity.pipeline.plugin.MRayRenderGlobalsAction.v2_2_1.MRayRenderGlobalsAction
All Implemented Interfaces:
Serializable, Cloneable, Comparable<PluginID>, Glueable

public class MRayRenderGlobalsAction
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 specific to the Mental Ray renderer.

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
Min Sample Level
The minimum sample rate, each pixel is sampled at least 2^(2*rate).

Max Sample Level
The maximim sample rate, each pixel is sampled at most 2^(2*rate).

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.

Sample Lock
???

Jitter
Whether to enable ray jittering.


Raytracing Quality Parameters
Use Raytracing
Whether to enable raytracing.

Reflections
The reflected ray depth.

Refractions
The refracted ray depth.

Max Trace Depth
The maximum ray depth.

Shadows
The shadow ray depth.

Scanline
Controls the use of scanline rendering.

Faces
Controls which side(s) of triangles are rendered.


Motion Blur Parameters
Motion Blur
Controls the motion blur technique.

Motion Blur By
???

Shutter
The time when the shutter closes.

Shutter Delay
The time when the shutter opens.

Time Contrast Red
The maximum temporal contrast in the red channel.

Time Contrast Green
The maximum temporal contrast in the green channel.

Time Contrast Blue
The maximum temporal contrast in the blue channel.

Time Contrast Alpha
The maximum temporal contrast in the alpha channel.

Motion Steps
Approximate instance motion transformations with steps segments.


Caustic Parameters
Use Caustics
Whether to enable caustics.

Caustics Accuracy
The number of photons used to estimate caustics during rendering.


The maximum radius to be used when picking up caustic photons.

Caustics Radius


Caustic Filter Type
The type of filter used by caustics.

Caustic Filter Kernel
The size of the caustics filter kernel.


Global Illumination Parameters
Use Global Illum
Whether to enable global illumination.

Global Illum Accuracy
The number of photons used to estimate global illumination during rendering.

Global Illum Radius
The maximum radius to be used when reading global illumination photons.

Photon Volume Accuracy
The maximum number of photons to examine in participating media.

Photon Volume Radius
The maximum radius to search for photons in participating media.

Max Reflection Photons
The reflected photon depth.

Max Refraction Photons
The refracted photon depth.

Max Photon Depth
The maximum photon depth.

Photon Map File
The name of the file to save/reuse photons.

Enable GI Map Visualizer
Produce a false-color rendering of photon density.

Photon Map Rebuild
Ignore and overwrite the photon map file if it exists.

Direct Illum Shadow Effects
???


Final Gathering Parameters
Use Final Gather
Whether to enable final gathering.

Precomp Photon Lookup
Whether to store final gather irradiance in photon map.

Final Gather Rays
The number of final gathering rays to cast.

Min Radius
The minimum distance within which final gather results must be reused.

Max Radius
The maximum distance within which a final gather result can be reused.

Filter
The number of neighboring samples to include in the speckle elimination filter.

Falloff Start
The distance at which final gather rays start blending with the env color.

Falloff Stop
The distance at which final gather rays completely blend with the env color.

Trace Depth
The maximum final gather ray depth.

Trace Reflection
The reflected final gather ray depth.

Trace Refraction
The refracted final gather ray depth.

Final Gather Map File
The name of the file to save/reuse final gather rays.

Preview Final Gather
Shows diagnostic final gathering points in output image


Framebuffer Attribute Parameters
Data Type
The output data format.

Gamma
The gamma correction factor.

Color Clip
Pre-quantization color clipping method.

Interp Samples
???

Desaturate
Bleach out clipped colors to maintain percieved brightness.

Premultiply
Whether to premultiply alpha into color channels.

Dither
Whether to enable dithering.


Translation Parameters
Export Verbosity
The verbosity of export messages.

Export Exact Hierarchy
???

Export Full Dagpath
???

Export Textures First
???

Export Particles
???

Export Particle Instances
???

Export Fluids


Export Post Effects

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

See Also:
Serialized Form

Field Summary
static String aAccelerationMethod
           
static String aBlueThreshold
           
static String aBspDepth
           
static String aBspSize
           
static String aCausticFilterKernel
           
static String aCausticFilterType
           
static String aCausticsAccuracy
           
static String aCausticsRadius
           
static String aColorClip
           
static String aCoverageThreshold
           
static String aDataType
           
static String aDesaturate
           
static String aDirectIllumShadowEffects
           
static String aDither
           
static String aEnableFGMapVisualizer
           
static String aEnableGIMapVisualizer
           
static String aExportExactHierarchy
           
static String aExportFluids
           
static String aExportFullDagpath
           
static String aExportParticleInstances
           
static String aExportParticles
           
static String aExportPostEffects
           
static String aExportTexturesFirst
           
static String aExportVerbosity
           
static String aFaces
           
static String aFalloffStart
           
static String aFalloffStop
           
static String aFilter
           
static String aFinalGatherMapFile
           
static String aFinalGatherMapRebuild
           
static String aFinalGatherRays
           
static String aGamma
           
static String aGlobalIllumAccuracy
           
static String aGlobalIllumRadius
           
static String aGreenThreshold
           
static String aGridDepth
           
static String aGridMaxSize
           
static String aGridResolution
           
static String aImageHeight
           
static String aImageResolution
           
static String aImageWidth
           
static String aInterpSamples
           
static String aJitter
           
static String aMaxPhotonDepth
           
static String aMaxRadius
           
static String aMaxReflectionPhotons
           
static String aMaxRefractionPhotons
           
static String aMaxSampleLevel
           
static String aMaxTraceDepth
           
static String aMinRadius
           
static String aMinSampleLevel
           
static String aMotionBlur
           
static String aMotionBlurBy
           
static String aMotionSteps
           
static String aPhotonMapFile
           
static String aPhotonMapRebuild
           
static String aPhotonVolumeAccuracy
           
static String aPhotonVolumeRadius
           
static String aPhysicalMemory
           
static String aPixelAspectRatio
           
static String aPixelFilterType
           
static String aPixelFilterWidthX
           
static String aPixelFilterWidthY
           
static String aPrecompPhotonLookup
           
static String aPremultiply
           
static String aPreviewFinalGather
           
static String aQuality
           
static String aRedThreshold
           
static String aReflections
           
static String aRefractions
           
static String aSampleLock
           
static String aScanline
           
static String aShadows
           
static String aShutter
           
static String aShutterDelay
           
static String aTaskSize
           
static String aTimeContrastAlpha
           
static String aTimeContrastBlue
           
static String aTimeContrastGreen
           
static String aTimeContrastRed
           
static String aTraceDepth
           
static String aTraceReflection
           
static String aTraceRefraction
           
static String aUseCaustics
           
static String aUseFinalGather
           
static String aUseGlobalIllum
           
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
MRayRenderGlobalsAction()
           
 
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

aMinSampleLevel

public static final String aMinSampleLevel
See Also:
Constant Field Values

aMaxSampleLevel

public static final String aMaxSampleLevel
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

aSampleLock

public static final String aSampleLock
See Also:
Constant Field Values

aJitter

public static final String aJitter
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

aMaxTraceDepth

public static final String aMaxTraceDepth
See Also:
Constant Field Values

aShadows

public static final String aShadows
See Also:
Constant Field Values

aScanline

public static final String aScanline
See Also:
Constant Field Values

aFaces

public static final String aFaces
See Also:
Constant Field Values

aMotionBlur

public static final String aMotionBlur
See Also:
Constant Field Values

aMotionBlurBy

public static final String aMotionBlurBy
See Also:
Constant Field Values

aShutter

public static final String aShutter
See Also:
Constant Field Values

aShutterDelay

public static final String aShutterDelay
See Also:
Constant Field Values

aTimeContrastRed

public static final String aTimeContrastRed
See Also:
Constant Field Values

aTimeContrastGreen

public static final String aTimeContrastGreen
See Also:
Constant Field Values

aTimeContrastBlue

public static final String aTimeContrastBlue
See Also:
Constant Field Values

aTimeContrastAlpha

public static final String aTimeContrastAlpha
See Also:
Constant Field Values

aMotionSteps

public static final String aMotionSteps
See Also:
Constant Field Values

aUseCaustics

public static final String aUseCaustics
See Also:
Constant Field Values

aCausticsAccuracy

public static final String aCausticsAccuracy
See Also:
Constant Field Values

aCausticsRadius

public static final String aCausticsRadius
See Also:
Constant Field Values

aCausticFilterType

public static final String aCausticFilterType
See Also:
Constant Field Values

aCausticFilterKernel

public static final String aCausticFilterKernel
See Also:
Constant Field Values

aUseGlobalIllum

public static final String aUseGlobalIllum
See Also:
Constant Field Values

aGlobalIllumAccuracy

public static final String aGlobalIllumAccuracy
See Also:
Constant Field Values

aGlobalIllumRadius

public static final String aGlobalIllumRadius
See Also:
Constant Field Values

aPhotonVolumeAccuracy

public static final String aPhotonVolumeAccuracy
See Also:
Constant Field Values

aPhotonVolumeRadius

public static final String aPhotonVolumeRadius
See Also:
Constant Field Values

aMaxReflectionPhotons

public static final String aMaxReflectionPhotons
See Also:
Constant Field Values

aMaxRefractionPhotons

public static final String aMaxRefractionPhotons
See Also:
Constant Field Values

aMaxPhotonDepth

public static final String aMaxPhotonDepth
See Also:
Constant Field Values

aPhotonMapFile

public static final String aPhotonMapFile
See Also:
Constant Field Values

aEnableGIMapVisualizer

public static final String aEnableGIMapVisualizer
See Also:
Constant Field Values

aPhotonMapRebuild

public static final String aPhotonMapRebuild
See Also:
Constant Field Values

aDirectIllumShadowEffects

public static final String aDirectIllumShadowEffects
See Also:
Constant Field Values

aUseFinalGather

public static final String aUseFinalGather
See Also:
Constant Field Values

aPrecompPhotonLookup

public static final String aPrecompPhotonLookup
See Also:
Constant Field Values

aFinalGatherRays

public static final String aFinalGatherRays
See Also:
Constant Field Values

aMinRadius

public static final String aMinRadius
See Also:
Constant Field Values

aMaxRadius

public static final String aMaxRadius
See Also:
Constant Field Values

aFilter

public static final String aFilter
See Also:
Constant Field Values

aFalloffStart

public static final String aFalloffStart
See Also:
Constant Field Values

aFalloffStop

public static final String aFalloffStop
See Also:
Constant Field Values

aTraceDepth

public static final String aTraceDepth
See Also:
Constant Field Values

aTraceReflection

public static final String aTraceReflection
See Also:
Constant Field Values

aTraceRefraction

public static final String aTraceRefraction
See Also:
Constant Field Values

aFinalGatherMapFile

public static final String aFinalGatherMapFile
See Also:
Constant Field Values

aEnableFGMapVisualizer

public static final String aEnableFGMapVisualizer
See Also:
Constant Field Values

aFinalGatherMapRebuild

public static final String aFinalGatherMapRebuild
See Also:
Constant Field Values

aPreviewFinalGather

public static final String aPreviewFinalGather
See Also:
Constant Field Values

aDataType

public static final String aDataType
See Also:
Constant Field Values

aGamma

public static final String aGamma
See Also:
Constant Field Values

aColorClip

public static final String aColorClip
See Also:
Constant Field Values

aInterpSamples

public static final String aInterpSamples
See Also:
Constant Field Values

aDesaturate

public static final String aDesaturate
See Also:
Constant Field Values

aPremultiply

public static final String aPremultiply
See Also:
Constant Field Values

aDither

public static final String aDither
See Also:
Constant Field Values

aAccelerationMethod

public static final String aAccelerationMethod
See Also:
Constant Field Values

aBspSize

public static final String aBspSize
See Also:
Constant Field Values

aBspDepth

public static final String aBspDepth
See Also:
Constant Field Values

aGridResolution

public static final String aGridResolution
See Also:
Constant Field Values

aGridMaxSize

public static final String aGridMaxSize
See Also:
Constant Field Values

aGridDepth

public static final String aGridDepth
See Also:
Constant Field Values

aTaskSize

public static final String aTaskSize
See Also:
Constant Field Values

aPhysicalMemory

public static final String aPhysicalMemory
See Also:
Constant Field Values

aExportVerbosity

public static final String aExportVerbosity
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

aExportParticles

public static final String aExportParticles
See Also:
Constant Field Values

aExportParticleInstances

public static final String aExportParticleInstances
See Also:
Constant Field Values

aExportFluids

public static final String aExportFluids
See Also:
Constant Field Values

aExportPostEffects

public static final String aExportPostEffects
See Also:
Constant Field Values

aQuality

public static final String aQuality
See Also:
Constant Field Values
Constructor Detail

MRayRenderGlobalsAction

public MRayRenderGlobalsAction()
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.

TEMERITY