us.temerity.pipeline.plugin.HfsGEOAction.v2_0_0
Class HfsGEOAction

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

All Implemented Interfaces:

Serializable, Cloneable, Comparable<PluginID>, Glueable

public class HfsGEOAction
extends BaseAction

Generates a sequence of cooked geometry files by evaluating a SOP.

This action provides a convienent method for evaluating a Geometry output operator contained in the source Houdini scene using hscript(1). The target primary file sequences should contain Houdini geometry files (.geo/.bgeo) which will be generated by this operator. The frame range (trange f1 f2 f3) and output filename (sopoutput) parameters of this operator will be overridden by the Action to correspond to the files to be regenerated by the job.

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

This action defines the following single valued parameters:

Houdini Scene

The source node which contains the Houdini scene file to load. This scene should contain the Geometry output operator which will be evaluated.

Output Operator

The name of the Geometry output operator to evaluate in order to generate the target geometry files. Only the last component of the operator name without a (/out) prefix is required.

Pre Render Script

The source node which contains the command script to evaluate before geometry output begins.

Post Render Script

The source node which contains the command script to evaluate after geometry output ends.

Pre Frame Script

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

Post Frame Script

The source node which contains the command script to evaluate after processing 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

HfsGEOAction()

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

HfsGEOAction

public HfsGEOAction()

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.