us.temerity.pipeline.plugin.MaxwellRenderAction.v2_0_0
Class MaxwellRenderAction

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

All Implemented Interfaces:

Serializable, Cloneable, Comparable<PluginID>, Glueable

public class MaxwellRenderAction
extends BaseAction

Renders a series of images from a source Maxwell input file.

Normally the behavior of Maxwell is specified during generation of the input MXS file. However, this action provides the ability to override a subset of those parameters controllable from the mxcl(1) command line. When these parameters are not overridden, the MXS file will determine the behavior of Maxwell for those parameters.

This action defines the following single valued parameters:

Maxwell Scene

The source node which contains the Maxwell scene file to render.

Override Threads

Whether to override the number of render threads.

Threads

The number of render threads to use (0 = autodetect).

Override Resolution

Whether to override the image resolution.

Image Width

The horizontal resolution of the output image in pixels.

Image Height

The vertical resolution of the output image in pixels.

Render Output Parameters

Override Output

Whether to override the image output settings.

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

Override Quality

Whether to override the render quality settings.

Render Time

The maximum number of minutes to render.

Sample Level

The maxmimum sampling level.

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

MaxwellRenderAction()

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

MaxwellRenderAction

public MaxwellRenderAction()

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.