Package mrv :: Package maya :: Package nt :: Module apipatch :: Class MSelectionList

[frames] | no frames]

Class MSelectionList

OpenMaya.MSelectionList --+
                          |
           Abstract --+   |
                      |   |
              ArrayBase --+
                          |
                         MSelectionList

Instance Methods

mhasItem(self, rhs)
Returns: True if we contain rhs

source code

mtoList(self, *args, **kwargs)
Returns: list with the contents of this MSelectionList

source code

mtoIter(self, *args, **kwargs)
Returns: iterator yielding of Nodes and MPlugs stored in this given selection list

source code

miterComponents(self, **kwargs)
Returns: Iterator yielding node, component pairs, component is guaranteed to carry a component, implying that this iterator applies a filter

source code

miterPlugs(self, **kwargs)
Returns: Iterator yielding all plugs on this selection list.

source code

Inherited from ArrayBase: __len__, __setitem__

Static Methods

mfromStrings(iter_strings, **kwargs)
Returns: MSelectionList initialized from the given iterable of strings

source code

mfromList(iter_items, **kwargs)
Returns: MSelectionList as initialized from the given iterable of Nodes, MObjects, MDagPaths, MPlugs or strings

source code

mfromIter(iter_items, **kwargs)
Returns: MSelectionList as initialized from the given iterable of Nodes, MObjects, MDagPaths, MPlugs or strings

source code

mfromMultiple(*args, **kwargs)
Alternative form of mfromList as args can be passed in.

source code

mfromComponentList(iter_components, **kwargs)
Returns: MSelectionList as initialized from the given list of tuple( DagNode, Component ), Component can be a filled Component object or null MObject

source code

Class Variables

_apicls = api.MSelectionList

Method Details

mhasItem(self, rhs)

Returns:: True if we contain rhs

Note: As we check for Nodes as well as MayaAPI objects, we are possibly slow

mfromStrings(iter_strings, **kwargs)
Static Method

Parameters:

kwargs - passed to base.toSelectionListFromNames

Returns:

MSelectionList initialized from the given iterable of strings

mfromList(iter_items, **kwargs)
Static Method

Parameters:

kwargs - passed to base.toSelectionList

Returns:

MSelectionList as initialized from the given iterable of Nodes, MObjects, MDagPaths, MPlugs or strings

Overrides: ArrayBase.mfromList

mfromIter(iter_items, **kwargs)
Static Method

Parameters:

kwargs - passed to base.toSelectionList

Returns:

MSelectionList as initialized from the given iterable of Nodes, MObjects, MDagPaths, MPlugs or strings

Overrides: ArrayBase.mfromIter

mfromMultiple(*args, **kwargs)
Static Method

Alternative form of mfromList as args can be passed in.

Returns:: Array created from the given elements
Overrides: ArrayBase.mfromMultiple

mfromComponentList(iter_components, **kwargs)
Static Method

Parameters:

kwargs - passed to base.toComponentSelectionList

Returns:

MSelectionList as initialized from the given list of tuple( DagNode, Component ), Component can be a filled Component object or null MObject

mtoList(self, *args, **kwargs)

Returns:: list with the contents of this MSelectionList

Note: all args and kwargs passed to it.iterSelectionList

mtoIter(self, *args, **kwargs)

Returns:: iterator yielding of Nodes and MPlugs stored in this given selection list

Note: all args and kwargs are passed to it.iterSelectionList

miterComponents(self, **kwargs)

Parameters:

kwargs - passed on to it.iterSelectionList

Returns:

Iterator yielding node, component pairs, component is guaranteed to carry a component, implying that this iterator applies a filter

miterPlugs(self, **kwargs)

Parameters:

kwargs - passed on to it.iterSelectionList

Returns:

Iterator yielding all plugs on this selection list.