us.temerity.pipeline.plugin.MayaAddRefTool.v2_2_1
Class MayaAddRefTool

java.lang.Object
  us.temerity.pipeline.Named
      us.temerity.pipeline.PluginID
          us.temerity.pipeline.BasePlugin
              us.temerity.pipeline.BaseTool
                  us.temerity.pipeline.plugin.MayaAddRefTool.v2_2_1.MayaAddRefTool

All Implemented Interfaces:

Serializable, Cloneable, Comparable<PluginID>, Glueable

public class MayaAddRefTool
extends BaseTool

Adds references to a Maya scene and makes the correct links in Pipeline.

If the target Maya scene uses a MayaBuild Action, this tool will also add set the appropriate action parameters to that the MayaBuild Action will correctly rebuild the target scene with the new references if it is enabled.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class us.temerity.pipeline.BaseTool

BaseTool.NextPhase, BaseTool.ToolPhase

Field Summary

Fields inherited from class us.temerity.pipeline.BaseTool

pPrefix, pPrimary, pRoots, pSelected

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

MayaAddRefTool()

Method Summary

String	collectPhaseInput() Create and show graphical user interface components to collect information from the user to use as input in the next phase of execution for the tool.
boolean	executePhase(MasterMgrClient mclient, QueueMgrClient qclient) Perform one phase in the execution of the tool.

Methods inherited from class us.temerity.pipeline.BaseTool

addPhase, authorOnExit, getAuthor, getPluginType, getView, initExecution, rootsOnExit, showLogHistory, updateOnExit, viewOnExit

Methods inherited from class us.temerity.pipeline.BasePlugin

addSupport, compareTo, equals, 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

clone, getName

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MayaAddRefTool

public MayaAddRefTool()

Method Detail

collectPhaseInput

public String collectPhaseInput()
                         throws PipelineException

Create and show graphical user interface components to collect information from the user to use as input in the next phase of execution for the tool.

Overrides:

collectPhaseInput in class BaseTool

Returns:

The phase progress message or null to abort early.

Throws:

PipelineException - If unable to validate the given user input.

executePhase

public boolean executePhase(MasterMgrClient mclient,
                            QueueMgrClient qclient)
                     throws PipelineException

Perform one phase in the execution of the tool.

Overrides:

executePhase in class BaseTool

Parameters:

mclient - The network connection to the plmaster(1) daemon.

qclient - The network connection to the plqueuemgr(1) daemon.

Returns:

Whether to continue and collect user input for the next phase of the tool.

Throws:

PipelineException - If unable to sucessfully execute this phase of the tool.