us.temerity.pipeline.plugin.HfsGenerateAction.v2_0_0
Class HfsGenerateAction

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

All Implemented Interfaces:

Serializable, Cloneable, Comparable<PluginID>, Glueable

public class HfsGenerateAction
extends BaseAction

Generates a sequences of renderer input files from a Houdini scene.

This action provides a convienent method for evaluating a renderer output operator contained in the source Houdini scene using hscript(1). The target primary file sequence should contain the input files to be generated. The frame range (trange f1 f2 f3), script file (script) and generate script (tscript) parameters of this operator will be overridden by the Action to correspond to the input files regenerated by the job.

The output picture (picture) parameter of this operator should be set to generate the image files associated with the rendering node downstream of the node using this action. The output picture path should begin with $WORKING or be relative to the current working directory to insure proper behavior when used by different artists or in different working area views of the same artist. It is recommended that the filename prefix used for the output picture match that of this node. For example:

Generated File Sequence - myrender.#.ifd, 1-100x1
Output Picture Parameter - "$WORKING/shot123/images/myrender.$F4.pic"

The following Houdini output operators are supported by this action:

Mantra - The Houdini renderer.
Wren - The Houdini line renderer.
RenderMan - RenderMan compliant renderers.
MentalRay - The MentalRay raytracer.

See the Houdini documentation for details on the usage and behavior of renderer output operators and hscript(1).

This action defines the following single valued parameters:

Output Operator

The name of the render output operator.

Camera Override

Overrides the render camera (if set).

Houdini Scene

The source node which contains the Houdini scene file used to generate the input files.

Pre Generate Script

The source node which contains the command script to evaluate before file generation begins.

Post Generate Script

The source node which contains the command script to evaluate after file generation ends.

Pre Frame Script

The source node which contains the command script to evaluate before generating each frame.

Post Frame Script

The source node which contains the command script to evaluate after generating each frame.

Use Graphical License

Whether to use an interactive graphical Houdini license when running hscript(1). Normally, hscript(1) is run using a non-graphical license (-R option). A graphical license may be required if the site has not obtained any non-graphical licenses.

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

HfsGenerateAction()

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

HfsGenerateAction

public HfsGenerateAction()

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.