Python API 2.0 Reference
OpenMayaUI.MPxToolCommand Class Reference
+ Inheritance diagram for OpenMayaUI.MPxToolCommand:

Public Member Functions

def __init__ ()
 
def cancel ()
 
def doFinalize ()
 
def doIt ()
 
def finalize ()
 
- Public Member Functions inherited from OpenMaya.MPxCommand
def __init__ ()
 
def doIt ()
 
def hasSyntax ()
 
def isUndoable ()
 
def redoIt ()
 
def syntax ()
 
def undoIt ()
 

Static Public Member Functions

def __new__ ()
 
- Static Public Member Functions inherited from OpenMaya.MPxCommand
def __new__ ()
 
def appendToResult ()
 
def clearResult ()
 
def currentResult ()
 
def currentResultType ()
 
def displayError ()
 
def displayInfo ()
 
def displayWarning ()
 
def isCurrentResultArray ()
 
def setResult ()
 

Additional Inherited Members

- Static Public Attributes inherited from OpenMaya.MPxCommand
int kDouble = 1
 
int kLong = 0
 
int kNoArg = 3
 
int kString = 2
 
- Properties inherited from OpenMaya.MPxCommand
 commandString = property(...)
 
 historyOn = property(...)
 

Detailed Description

Base class for custom tool commands.

Method resolution order:
-   MPxToolCommand
-   OpenMaya.MPxCommand
-   builtins.object

Constructor & Destructor Documentation

def OpenMayaUI.MPxToolCommand.__init__ ( )
Initialize self.  See help(type(self)) for accurate signature.

Member Function Documentation

def OpenMayaUI.MPxToolCommand.__new__ ( )
static
Create and return a new object.  See help(type) for accurate signature.
def OpenMayaUI.MPxToolCommand.cancel ( )
cancel() -> None

This method cancels the command.
The user should override this method when the original program state
needs to be restored.
def OpenMayaUI.MPxToolCommand.doFinalize ( )
doFinalize() -> None

Call this method with an MArgList representing your command.
This method will register the command with the undo manager
for journalling.

* command (MArgList) Reference representing an equivalent
def OpenMayaUI.MPxToolCommand.doIt ( )
Called by Maya to execute the command.
def OpenMayaUI.MPxToolCommand.finalize ( )
finalize() -> None

This method is used to create a string representing the command
and its arguments.
Users should override this method and contruct an MArgList and
then pass it to <b>doFinalize</b> for journalling.