OpenMaya.MArgDatabase Class Reference

Class Description

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

Method resolution order:
-   MArgDatabase
-   MArgParser
-   __builtin__.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.

 

---

Inheritance diagram for OpenMaya.MArgDatabase:

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

Additional Inherited Members
Properties inherited from OpenMaya.MArgParser
	isEdit
	isQuery
	numberOfFlagsUsed

Constructor & Destructor Documentation

OpenMaya.MArgDatabase.__init__

(

)

x.__init__(...) initializes x; see help(type(x)) for signature

Member Function Documentation

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.