us.temerity.pipeline.plugin.NukeFrameCyclerEditor.v2_4_1
Class NukeFrameCyclerEditor

java.lang.Object
  us.temerity.pipeline.Named
      us.temerity.pipeline.PluginID
          us.temerity.pipeline.BasePlugin
              us.temerity.pipeline.BaseEditor
                  us.temerity.pipeline.plugin.NukeFrameCyclerEditor.v2_4_1.NukeFrameCyclerEditor

All Implemented Interfaces:

Serializable, Cloneable, Comparable<PluginID>, Glueable

public class NukeFrameCyclerEditor
extends BaseEditor

Displays an image sequence using FrameCycler bundled with Nuke.

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.

By default, the "python" program is used by this Editor run feed the TCL required to launch FrameCycler into Nuke. An alternative program can be specified by setting PYTHON_BINARY in the Toolset environment to the name of the Python interpertor this Editor should use. When naming an alternative Python interpretor under Windows, make sure to include the ".exe" extension in the program name.

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

NukeFrameCyclerEditor()

Method Summary

SubProcessLight	launch(FileSeq fseq, Map<String,String> env, File dir) Deprecated.
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.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

NukeFrameCyclerEditor

public NukeFrameCyclerEditor()

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.

The default implementation executes the editor program obtained with getProgram method under the given environment. Subclasses should override this method if more specialized behavior or different command line arguments are needed in order to launch the editor for the given file sequence.

Overrides:

prep in class BaseEditor

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

launch

@Deprecated
public SubProcessLight launch(FileSeq fseq,
                                         Map<String,String> env,
                                         File dir)
                       throws PipelineException

Deprecated.

This implementation always throws a PipelineException, to insure that the prep method is used for this Editor instead of this deprecated method.

Overrides:

launch in class BaseEditor

Parameters:

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