OpenMaya.MItSelectionList Class Reference

Class Description

Class for iterating over the items in an MSelection list.
+ Inheritance diagram for OpenMaya.MItSelectionList:

Public Member Functions

__init__ ()
 
getComponent ()
 
getDagPath ()
 
getDependNode ()
 
getPlug ()
 
getStrings ()
 
hasComponents ()
 
isDone ()
 
itemType ()
 
next ()
 
reset ()
 
setFilter ()
 

Static Public Attributes

int kAnimSelectionItem = 1
 
int kDNselectionItem = 2
 
int kDagSelectionItem = 0
 
int kPlugSelectionItem = 3
 
int kUnknownItem = -1
 

Constructor & Destructor Documentation

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

Member Function Documentation

OpenMaya.MItSelectionList.getComponent ( )
getComponent() -> (MDagPath, MObject)

This method retrieves the dag path and the component of the current selection item.
OpenMaya.MItSelectionList.getDagPath ( )
getDagPath() -> MDagPath

This method retrieves the dag path of the current selection item.
OpenMaya.MItSelectionList.getDependNode ( )
getDependNode() -> MObject

This method retrieves the dependency node of the current selection itemRaises kFailure if there is no dependency node associated with the current item
OpenMaya.MItSelectionList.getPlug ( )
getPlug() -> MPlug

This method retrieves the plug of the current selection item.
OpenMaya.MItSelectionList.getStrings ( )
getStrings() -> list of strings

Get the string representation of the current item in the selection list.
It is possible that it will require more than one string to represent the item (the item may contain groups of CVs for example)
OpenMaya.MItSelectionList.hasComponents ( )
hasComponents() -> bool

Returns whether or not the current selection item has components.
OpenMaya.MItSelectionList.isDone ( )
isDone() -> bool

Specifies whether or not there is anything more to iterator over.
OpenMaya.MItSelectionList.itemType ( )
itemType() -> int

Returns the current selection item type.

  kDagSelectionItem    selection item is in the DAG
  kAnimSelectionItem   selection item is a keyset
  kDNselectionItem     selection item is a dependency node
OpenMaya.MItSelectionList.next ( )
next() -> self

Advance to the next item. If components are selected then advance to next component.

If a filter is specified then the next item will be one that matches the filter.
OpenMaya.MItSelectionList.reset ( )
reset() -> self

Reset the iterator.
If a filter has been specified then the current item will be the first selected item that matches the filter.
OpenMaya.MItSelectionList.setFilter ( )
setFilter(filter) -> self

Apply a filter to the iteration.
Selection items not matching the filter type will be excluded from the iteration.