us.temerity.pipeline.plugin.NukeEditor.v2_2_1
Class NukeEditor

java.lang.Object
  us.temerity.pipeline.Named
      us.temerity.pipeline.PluginID
          us.temerity.pipeline.BasePlugin
              us.temerity.pipeline.BaseEditor
                  us.temerity.pipeline.SimpleEditor
                      us.temerity.pipeline.SimpleSingleEditor
                          us.temerity.pipeline.plugin.NukeEditor.v2_2_1.NukeEditor

All Implemented Interfaces:

Serializable, Cloneable, Comparable<PluginID>, Glueable

public class NukeEditor
extends SimpleSingleEditor

The Nuke compositing application from The Foundry.

All Read/Write nodes should have absolute file paths relative to the root working directory which start with the string "WORKING" in order to support portability of Nuke scripts between artists and operation sytems. To enable the "WORKING" prefix to be expanded to the value of the WORKING environmental variable in these file paths, a "init.tcl" script as been provided with Pipeline in the "app-extra/nuke" directory where Pipeline is installed at your site. You must either copy this script into the "plugin/user" directory of your Nuke installation or add Pipeline's "app-extra/nuke" directory to the NUKE_PATH defined in the Toolset using this plugin.

By default, this Editor launches 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 Editor plugin. On Windows, the Nuke binary name should include the ".exe" extension.

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

NukeEditor()

Method Summary

SubProcessLight

prep(String author, FileSeq fseq, Map<String,String> env, File dir) Construct a SubProcessLight instance which when executed will launch an editor program to view the given file sequence as arguments.

Methods inherited from class us.temerity.pipeline.SimpleEditor

launch

Methods inherited from class us.temerity.pipeline.BaseEditor

cleanupLater, clone, createTemp, equals, getPluginType, getProgram, hasPrepMethod, ignoreExitCode, makeWorkingDirs, setProgram

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

fromGlue, getVendor, getVersionID, toGlue

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

NukeEditor

public NukeEditor()

Method Detail

prep

public SubProcessLight prep(String author,
                            FileSeq fseq,
                            Map<String,String> env,
                            File dir)
                     throws PipelineException

Construct a SubProcessLight instance which when executed will launch an editor program to view the given file sequence as arguments.

Overrides:

prep in class SimpleSingleEditor

Parameters:

author - The name of the user owning the files.

fseq - The file sequence to edit.

env - The environment under which the editor is run.

dir - The working directory where the editor is run.

Returns:

The controlling SubProcessLight instance.

Throws:

PipelineException - If unable to launch the editor.

See Also:

SubProcessLight