us.temerity.pipeline.plugin.HfsSdExportAction.v2_0_0
Class HfsSdExportAction

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

All Implemented Interfaces:

Serializable, Cloneable, Comparable<PluginID>, Glueable

public class HfsSdExportAction
extends BaseAction

Exports RealFlow geometry and other scene data from a Houdini scene.

This action provides a convienent method for evaluating the RealFlow SD File output operator contained in the source Houdini scene using hscript(1). The target primary file sequence should contain a single SD file to be generated.

See the RealFlow documentation for details on the usage and behavior of this output operator.

This action defines the following single valued parameters:

Output Operator

The name of the RealFlow SD File output operator.

Camera Override

Overrides the exported camera (if set).

Houdini Scene

The source node which contains the Houdini scene file to export.

Pre Render Script

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

Post Render Script

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

Pre Frame Script

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

Post Frame Script

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

HfsSdExportAction()

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

HfsSdExportAction

public HfsSdExportAction()

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.