us.temerity.pipeline.plugin.HfsBuildAction.v2_0_0
Class HfsBuildAction

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

All Implemented Interfaces:

Serializable, Cloneable, Comparable<PluginID>, Glueable

public class HfsBuildAction
extends BaseAction

Builds a new Houdini scene from a set of component Houdini Scenes.

This action provides a convienent way of building a Houdini scene from components parts procedurally using hscript(1). The per-source parameters control the order these scenes are loaded and how common sections are merged. Houdini command scripts may also be executed at various stages in the process.

See the Houdini documentation for details about hscript(1) and the "mread" and "mwrite" commands used by this action.

This action defines the following single valued parameters:

Pre Build Script

The source node which contains the command script to evaluate before loading any source scenes.

Post Build Script

The source node which contains the command script to evaluate after loading all source scenes.

Pre Scene Script

The source node which contains the command script to evaluate before loading each source scene.

Post Scene Script

The source node which contains the command script to evaluate after loading each source scene.

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.

This action defines the following per-source parameters:

Order

Each source node which sets this parameter should have a Houdini scene file as the sole member of the selected file sequence. This parameter specifies the order in which will this scene will be loaded. If this parameter is not set for a source node, it will be ignored.

Merge Pattern

This parameter species which portions of the Houdini scene should be merged into the newly generated scene. The first scene loaded, as determined by Order, will always replace the entire contents of the current scene ignoring this parameter. A pattern of "*" indicates that the entire contents should be loaded. Existing components in the generated scene will be overridden by components matching this pattern in the loaded scene.

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

HfsBuildAction()

Method Summary

TreeMap<String,ActionParam>	getInitialSourceParams() Get an initial set of action parameters associated with an upstream node.
SubProcessHeavy	prep(ActionAgenda agenda, File outFile, File errFile) Construct a SubProcessHeavy instance which when executed will fulfill the given action agenda.
boolean	supportsSourceParams() Does this action support per-source parameters?

Methods inherited from class us.temerity.pipeline.BaseAction

addPreset, addPresetValues, addSingleParam, chmod, cleanupLater, clearAllLinkParams, clearLinkParams, clone, createTemp, createTemp, equals, equalSingleParams, equalSourceParams, fromGlue, 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, 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

HfsBuildAction

public HfsBuildAction()

Method Detail

supportsSourceParams

public boolean supportsSourceParams()

Does this action support per-source parameters?

Overrides:

supportsSourceParams in class BaseAction

getInitialSourceParams

public TreeMap<String,ActionParam> getInitialSourceParams()

Get an initial set of action parameters associated with an upstream node.

Overrides:

getInitialSourceParams in class BaseAction

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.