us.temerity.pipeline.plugin.NukeQtAction.v2_4_3
Class NukeQtAction

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.NukeQtAction.v2_4_3.NukeQtAction

All Implemented Interfaces:

Serializable, Cloneable, Comparable<PluginID>, Glueable

public class NukeQtAction
extends NukeActionUtils

Creates a QuickTime movie using Nuke from either a sequence of images or by evaluating a given Nuke script which generates the source images.

An optional audio soundtrack can also be specified for the generated movie. When reading from a Nuke script, this action can be used in conjunction with the NukeSubstComp action or other dynamic Nuke script generating actions to avoid the need of pre-rendering source images.

This action defines the following single valued parameters:

Image Source

The source node which contains the images used to create the movie.

Generate Script

The source node which contains the Nuke script responsible for generating the source images for the QuickTime movie.

Reformat Script

The source node which contains the optional Nuke script fragment to be appended to the Nuke Read node created to load the source images before generating the QuickTime movie.

Codec

The name of the QuickTime codec to use to encode the images.

Fast Start

Whether to flatten the QuickTime movie so it can be played while still downloading.

Quality

The QuickTime video compression quality.

Keyframe Rate

The minimum frequency of keyframes by the encoding codec. Set to (0) to allow codec to choose rate automatically.

FPS

The number of image frames per second.

Audio Source

The optional source node which contains the audio soundtrack for the movie.

Audio Offset

The offset of the source audio soundtrack to the source images.

Audio Units

The time units to use when interpreting the AudioOffset parameter.

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	aAudioOffset
static String	aAudioSource
static String	aAudioUnits
static String	aCodec
static String	aFastStart
static String	aFPS
static String	aFrames
static String	aGenerateScript
static String	aHigh
static String	aImageSource
static String	aKeyframeRate
static String	aLossless
static String	aLow
static String	aMax
static String	aMin
static String	aNormal
static String	aPresets
static String	aQuality
static String	aReformatScript
static String	aSeconds

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, 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

NukeQtAction()

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.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, 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

Field Detail

aImageSource

public static final String aImageSource

See Also:

Constant Field Values

aGenerateScript

public static final String aGenerateScript

See Also:

Constant Field Values

aReformatScript

public static final String aReformatScript

See Also:

Constant Field Values

aPresets

public static final String aPresets

See Also:

Constant Field Values

aCodec

public static final String aCodec

See Also:

Constant Field Values

aFastStart

public static final String aFastStart

See Also:

Constant Field Values

aQuality

public static final String aQuality

See Also:

Constant Field Values

aMin

public static final String aMin

See Also:

Constant Field Values

aLow

public static final String aLow

See Also:

Constant Field Values

aNormal

public static final String aNormal

See Also:

Constant Field Values

aHigh

public static final String aHigh

See Also:

Constant Field Values

aMax

public static final String aMax

See Also:

Constant Field Values

aLossless

public static final String aLossless

See Also:

Constant Field Values

aKeyframeRate

public static final String aKeyframeRate

See Also:

Constant Field Values

aFPS

public static final String aFPS

See Also:

Constant Field Values

aAudioSource

public static final String aAudioSource

See Also:

Constant Field Values

aAudioOffset

public static final String aAudioOffset

See Also:

Constant Field Values

aAudioUnits

public static final String aAudioUnits

See Also:

Constant Field Values

aSeconds

public static final String aSeconds

See Also:

Constant Field Values

aFrames

public static final String aFrames

See Also:

Constant Field Values

Constructor Detail

NukeQtAction

public NukeQtAction()

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.