Python API 2.0 Reference
OpenMaya.MArgDatabase Class Reference
+ Inheritance diagram for OpenMaya.MArgDatabase:

Public Member Functions

def __init__ ()
 
def commandArgumentMSelectionList ()
 
def flagArgumentMSelectionList ()
 
def getObjectList ()
 
- Public Member Functions inherited from OpenMaya.MArgParser
def __init__ ()
 
def commandArgumentBool ()
 
def commandArgumentDouble ()
 
def commandArgumentFloat ()
 
def commandArgumentInt ()
 
def commandArgumentMAngle ()
 
def commandArgumentMDistance ()
 
def commandArgumentMTime ()
 
def commandArgumentString ()
 
def flagArgumentBool ()
 
def flagArgumentDouble ()
 
def flagArgumentFloat ()
 
def flagArgumentInt ()
 
def flagArgumentMAngle ()
 
def flagArgumentMDistance ()
 
def flagArgumentMTime ()
 
def flagArgumentString ()
 
def getFlagArgumentList ()
 
def getFlagArgumentPosition ()
 
def getObjectStrings ()
 
def isFlagSet ()
 
def numberOfFlagUses ()
 

Static Public Member Functions

def __new__ ()
 
- Static Public Member Functions inherited from OpenMaya.MArgParser
def __new__ ()
 

Additional Inherited Members

- Properties inherited from OpenMaya.MArgParser
 isEdit = property(...)
 
 isQuery = property(...)
 
 numberOfFlagsUsed = property(...)
 

Detailed Description

Command argument list parser which extends MArgParser with the
ability to return arguments and objects as MSelectionLists

Method resolution order:
-   MArgDatabase
-   MArgParser
-   builtins.object

Base Class

MArgParser

Constructors

Signature Parameters

Description

MArgDatabase(syntax, args) syntax - MSyntax
args - MArgList

Creates a new MArgDatabase object which will parse args using the provided syntax.

str() Support

Default.

repr() Support

Default.

 


Constructor & Destructor Documentation

def OpenMaya.MArgDatabase.__init__ ( )
Initialize self.  See help(type(self)) for accurate signature.

Member Function Documentation

def OpenMaya.MArgDatabase.__new__ ( )
static
Create and return a new object.  See help(type) for accurate signature.
OpenMaya.MArgDatabase.commandArgumentMSelectionList ( )
commandArgumentMSelectionList(argIndex) -> MSelectionList

Returns the specified command argument as an MSelectionList.
Signature: commandArgumentMSelectionList(index)
Parameters: index - int
Returns: MSelectionList
Description: Returns the specified command argument in an MSelectionList. Raises TypeError if the argument cannot be placed in an MSelectionList. Raises IndexError if index is out of range.
OpenMaya.MArgDatabase.flagArgumentMSelectionList ( )
flagArgumentMSelectionList(flagName, argIndex) -> MSelectionList

Returns the specified argument of the specified single-use flag as
an MSelectionList.
Signature: flagArgumentMSelectionList(flag, index)
Parameters: flag - string
index - int
Returns: MSelectionList
Description: Returns the index'th argument of the specified flag in an MSelectionList. Raises TypeError if the argument cannot be placed in an MSelectionList. Raises IndexError if index is out of range.
OpenMaya.MArgDatabase.getObjectList ( )
getObjectList() -> MSelectionList

If the command's MSyntax has set the object format to kSelectionList
then this method will return the objects passed to the command as an
MSelectionList. If any other object format is set then an empty
selection list will be returned.
Signature: getObjectList()
Parameters:  
Returns: MSelectionList
Description: Returns the list of objects passed to the command as an MSelectionList.