us.temerity.pipeline.plugin.MaxwellGlobalsAction.v2_0_0
Class MaxwellGlobalsAction

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

All Implemented Interfaces:

Serializable, Cloneable, Comparable<PluginID>, Glueable

public class MaxwellGlobalsAction
extends BaseAction

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

This generated MEL script can then be used as the PreRenderMEL script of a MayaMxsExport action to allow control over Maxwell 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 Output Parameters

Output RGB

Whether to output a RGB color image.

Output Alpha

Whether to output an Alpha mask image.

Output Depth

Whether to output an Z Depth image.

Depth Min

The minimum depth value. ???

Depth Max

The maximum depth value. ???

Output Camera Cosine

Whether to output an image containing the cosine of the angle between surface normals and the view direction.

Output MXI

Whether to output an MXI file.

Render Quality Parameters

Render Time

The maximum number of minutes to render.

Sample Level

The maxmimum sampling level.

Motion Blur Subframes

The number of motion blur subframes.

Illumination Layers

Direct Lighting

Calculates light rays from emitters.

Indirect Lighting

Calculates bounced light rays from the surfaces.

Caustic Layers

Direct Reflection

Calculates direct reflected caustics.

Indirect Reflection

Calculates bounced reflected caustics.

Direct Refraction

Calculates direct refracted caustics.

Indirect Refraction

Calculates bounced refracted caustics.

Tone

Burn

Controls the white saturation of the burnt colors.

Monitor Gamma

The monitor gamma correction factor.

See the Maxwell documentation for more details about the meaning of these parameters.

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

MaxwellGlobalsAction()

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

MaxwellGlobalsAction

public MaxwellGlobalsAction()

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.