us.temerity.pipeline.plugin.NukeBuildAction.v2_3_4
Class NukeBuildAction

java.lang.Object
  us.temerity.pipeline.Named
      us.temerity.pipeline.PluginID
          us.temerity.pipeline.BasePlugin
              us.temerity.pipeline.BaseAction
                  us.temerity.pipeline.plugin.CommonActionUtils
                      us.temerity.pipeline.plugin.CompositeActionUtils
                          us.temerity.pipeline.plugin.NukeActionUtils
                              us.temerity.pipeline.plugin.NukeBuildAction.v2_3_4.NukeBuildAction

All Implemented Interfaces:

Serializable, Cloneable, Comparable<PluginID>, Glueable

public class NukeBuildAction
extends NukeActionUtils

Generates a new Nuke comp from component image sources. By default, this Action executes the "Nuke4.6" binary. This can be overridden by specifying an alternate binary with the NUKE_BINARY environmental variable in the Toolset used to run this Action plugin. On Windows, the Nuke binary name should include the ".exe" extension.

See Also:

Serialized Form

Field Summary

static String	aAtop
static String	aAverage
static String	aCompDoMerges
static String	aConjointOver
static String	aCopy
static String	aDisjointOver
static String	aDivide
static String	aFrom
static String	aIn
static String	aMask
static String	aMatte
static String	aMax
static String	aMin
static String	aMinus
static String	aOut
static String	aUnder
static String	aXor

Fields inherited from class us.temerity.pipeline.plugin.CompositeActionUtils

aAdd, aAlphaAdd, aAlphaMode, aBlack, aBlendMode, aClassicColorBurn, aClassicColorDodge, aClassicDifference, aColor, aColorBurn, aColorDodge, aCompFrameRate, aCompHeight, aCompPixelRatio, aCompWidth, aDancingDissolve, aDarken, aDifference, aDissolve, aExclusion, aFrameRate, aHardLight, aHue, aIgnore, aLayer, aLighten, aLinearBurn, aLinearDodge, aLinearLight, aLuminescentPremul, aLuminosity, aMultiply, aNormal, aOrder, aOverlay, aPass, aPinLight, aPixelRatio, aPreMultColor, aPreMultipled, aSaturation, aScreen, aSilhouetteAlpha, aSilhouetteLuma, aSoftLight, aStencilAlpha, aStencilLuma, aStraight, aVividLight, aWhite

Fields inherited from class us.temerity.pipeline.plugin.CommonActionUtils

aExtraOptions

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

NukeBuildAction()

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.plugin.NukeActionUtils

getNukeExtensions, getNukeProgram, getNukeProgram, getNukeProgramVersion, getNukeProgramVersion, toNukeFilePattern, toNukeFrameRange

Methods inherited from class us.temerity.pipeline.plugin.CompositeActionUtils

addCompFrameRateParam, addCompHeightParam, addCompPixelRatioParam, addCompWidthParam, addSourceAlphaModeParam, addSourceFrameRateParam, addSourceLayerParam, addSourceOrderParam, addSourcePassParam, addSourcePixelRatioParam, addSourcePreMultColorParam

Methods inherited from class us.temerity.pipeline.plugin.CommonActionUtils

addExtraOptionsParam, addExtraOptionsParamToLayout, createScriptSubProcess, createSubProcess, createSubProcess, createSubProcess, createSubProcess, createTempCopySubProcess, createTempScript, escPath, escPath, getExtraOptionsArgs, getPrimarySourcePath, getPrimarySourcePath, getPrimarySourcePath, getPrimarySourcePaths, getPrimarySourcePaths, getPrimarySourcePaths, getPrimaryTargetPath, getPrimaryTargetPath, getPrimaryTargetPath, getPrimaryTargetPaths, getPrimaryTargetPaths, getPrimaryTargetPaths, getSecondarySourceBooleanParamValue, getSecondarySourceDoubleParamValue, getSecondarySourceDoubleParamValue, getSecondarySourceEnumParamIndex, getSecondarySourceIntegerParamValue, getSecondarySourceIntegerParamValue, getSecondarySourceLongParamValue, getSecondarySourceLongParamValue, getSecondarySourceOptionalBooleanParamValue, getSecondarySourceStringParamValue, getSecondarySourceStringParamValue, getSingleBooleanParamValue, getSingleDoubleParamValue, getSingleDoubleParamValue, getSingleEnumParamIndex, getSingleIntegerParamValue, getSingleIntegerParamValue, getSingleLongParamValue, getSingleLongParamValue, getSingleOptionalBooleanParamValue, getSingleStringParamValue, getSingleStringParamValue, getSingleTuple2dParamValue, getSingleTuple2dParamValue, getSingleTuple2dParamValue, getSingleTuple2iParamValue, getSingleTuple2iParamValue, getSingleTuple2iParamValue, getSingleTuple3dParamValue, getSingleTuple3dParamValue, getSingleTuple3dParamValue, getSingleTuple3iParamValue, getSingleTuple3iParamValue, getSingleTuple3iParamValue, getSingleTuple4dParamValue, getSingleTuple4dParamValue, getSingleTuple4dParamValue, getSourceBooleanParamValue, getSourceDoubleParamValue, getSourceDoubleParamValue, getSourceEnumParamIndex, getSourceIntegerParamValue, getSourceIntegerParamValue, getSourceLongParamValue, getSourceLongParamValue, getSourceOptionalBooleanParamValue, getSourceStringParamValue, getSourceStringParamValue, getWorkingNodeFilePath, getWorkingNodeFilePath, getWorkingNodeFilePath, getWorkingNodeFilePath, getWorkingNodeFilePaths

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

Field Detail

aAtop

public static final String aAtop

See Also:

Constant Field Values

aAverage

public static final String aAverage

See Also:

Constant Field Values

aConjointOver

public static final String aConjointOver

See Also:

Constant Field Values

aCopy

public static final String aCopy

See Also:

Constant Field Values

aDisjointOver

public static final String aDisjointOver

See Also:

Constant Field Values

aDivide

public static final String aDivide

See Also:

Constant Field Values

aFrom

public static final String aFrom

See Also:

Constant Field Values

aIn

public static final String aIn

See Also:

Constant Field Values

aMask

public static final String aMask

See Also:

Constant Field Values

aMatte

public static final String aMatte

See Also:

Constant Field Values

aMax

public static final String aMax

See Also:

Constant Field Values

aMin

public static final String aMin

See Also:

Constant Field Values

aMinus

public static final String aMinus

See Also:

Constant Field Values

aOut

public static final String aOut

See Also:

Constant Field Values

aUnder

public static final String aUnder

See Also:

Constant Field Values

aXor

public static final String aXor

See Also:

Constant Field Values

aCompDoMerges

public static final String aCompDoMerges

See Also:

Constant Field Values

Constructor Detail

NukeBuildAction

public NukeBuildAction()

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.