us.temerity.pipeline.plugin.HfsMantraAction.v2_0_4
Class HfsMantraAction

java.lang.Object
  us.temerity.pipeline.Named
      us.temerity.pipeline.PluginID
          us.temerity.pipeline.BasePlugin
              us.temerity.pipeline.BaseAction
                  us.temerity.pipeline.plugin.HfsMantraAction.v2_0_4.HfsMantraAction

All Implemented Interfaces:

Serializable, Cloneable, Comparable<PluginID>, Glueable

public class HfsMantraAction
extends BaseAction

Renders a sequence of images using standalone Mantra from IFD files.

The most commonly used command line options of mantra(1) are supported through parameters of this action. See the Houdini documentation for details about mantra(1).

This action defines the following single valued parameters:

Input Files

The source node which contains the IFD files to be rendered.

Processors

The number of processors to use.

Image Width

The horizontal resolution of the output image in pixels.

Image Height

The vertical resolution of the output image in pixels.

Output Format

Specifies the type of files generated:

Color Image - Renders standard image formats.
Z-Depth - Renders z-depth maps.
Average Z-Depth - Integer 16-bits per channel.

Color Depth

Specifies the bit-depth of pixels in the output image (color only):

Natural - Use the natural bit depth of the target image format.
8-Bit (byte) - Integer 8-bits per channel.
16-Bit (short) - Integer 16-bits per channel.
16-Bit (half) - Half precision floating point.
16-Bit (half) Rounded - Rounded half precision floating point.
32-Bit (float) - Full precision floating point.
32-Bit (float) Rounded - Rounded full precision floating point.

Render Fields

Render field mode:

Full - Renders as full field.
Odd - Renders as odd field.
Even - Render as even field.

Extra Options

Additional command-line arguments.

Rendering Methods

Rendering Mode

The fundamental rendering technique:

MicroPolygon - Use micro-polygon rendering only.
RayTraced - Use pure ray-tracing only.
Mixed - Use mixed ray tracing and micro-polygon rendering.

AntiAliasing

Whether to turn on anti-aliasing.

Motion Blur

The technique used for motion blur:

None - No motion blur.
No RayTraced - Turn off ray-traced motion blur.
All - Use all motion blur techniques.

Depth Of Field

Whether to render depth-of-field.

Global Illumination

Whether to compute irradiance and occulsion.

Render Quality

Shading Quality

The shading quality multiplier.

AntiAliasing Threshold

The variance anti-aliasing threshold.

Jitter Scale

The jitter scale.

Coving Method

Methods for dealing with patch cracks:

None - No coving of patch cracks.
Default - Cove displaced and sub-division surfaces.
All - Forced coving of all primitives.

MicroPolygon Rendering

MicroPolygon Cache Size

The size of the micro-polygon cache.

MicroPolygon Max Splits

The maxmum number of micro-polygon splits.

Ray Tracing

Ray Mesh Cache Size

The size of the ray mesh cache.

Ray Shading Rate

Global ray-tracing level of detail factor.

Messages

Verbosity

The level of verbosity of rendering statistics.

Profiling

The fundamental rendering technique:

None - No profiling.
VEX - VEX profiling only.
VEX and NaN - VEX profiling and NaN detection.

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

HfsMantraAction()

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

HfsMantraAction

public HfsMantraAction()

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.