TEMERITY

us.temerity.pipeline.plugin.ImfDispEditor.v2_2_1
Class ImfDispEditor

java.lang.Object
  extended by us.temerity.pipeline.Named
      extended by us.temerity.pipeline.PluginID
          extended by us.temerity.pipeline.BasePlugin
              extended by us.temerity.pipeline.BaseEditor
                  extended by us.temerity.pipeline.plugin.ImfDispEditor.v2_2_1.ImfDispEditor
All Implemented Interfaces:
Serializable, Cloneable, Comparable<PluginID>, Glueable

public class ImfDispEditor
extends BaseEditor

The Mental Ray image viewer.

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
ImfDispEditor()
           
 
Method Summary
 boolean ignoreExitCode()
          Whether Pipeline programs which launch Editor plugins should ignore the exit code returned by the Subprocess created in the prep method.
 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, 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

ImfDispEditor

public ImfDispEditor()
Method Detail

ignoreExitCode

public boolean ignoreExitCode()
Whether Pipeline programs which launch Editor plugins should ignore the exit code returned by the Subprocess created in the prep method.

Overrides:
ignoreExitCode in class BaseEditor

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

Launch imfdisp under the given environmant to view the images in the given file sequence.

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

TEMERITY