OpenMaya.MFnComponentListData Class Reference

OpenMaya.MFnComponentListData Class Reference

Class Description

MFnComponentListData allows the creation and manipulation of component list
(represented as MObjects) data objects for use in the dependency graph.

__init__()
Initializes a new, empty MFnComponentListData object.

__init__(MObject)
Initializes a new MFnComponentListData function set, attached
to the specified object.

Method resolution order:
-   MFnComponentListData
-   MFnData
-   MFnBase
-   __builtin__.object

Base Class

MFnData

Constructors

Signature Parameters Description
MFnComponentListData()  

Default constructor. Returns a new, empty MFnComponentListData object.

MFnComponentListData(object) object - MObject

Returns a new MFnComponentListData function set, with the specified Maya object attached.

 


+ Inheritance diagram for OpenMaya.MFnComponentListData:

Public Member Functions

__init__ ()
 
add ()
 
clear ()
 
create ()
 
get ()
 
has ()
 
length ()
 
remove ()
 
- Public Member Functions inherited from OpenMaya.MFnData
__init__ ()
 
- Public Member Functions inherited from OpenMaya.MFnBase
__init__ ()
 
hasObj ()
 
object ()
 
setObject ()
 
type ()
 

Additional Inherited Members

- Static Public Attributes inherited from OpenMaya.MFnData
int kAny = 24
 
int kFloatArray = 8
 
int kMatrixArray = 12
 
int kComponentList = 13
 
int kDoubleArray = 7
 
int kDynArrayAttrs = 19
 
int kDynSweptGeometry = 20
 
int kIntArray = 9
 
int kInvalid = 0
 
int kLast = 25
 
int kLattice = 15
 
int kMatrix = 5
 
int kMesh = 14
 
int kNId = 23
 
int kNObject = 22
 
int kNumeric = 1
 
int kNurbsCurve = 16
 
int kNurbsSurface = 17
 
int kPlugin = 2
 
int kPluginGeometry = 3
 
int kPointArray = 10
 
int kSphere = 18
 
int kString = 4
 
int kStringArray = 6
 
int kSubdSurface = 21
 
int kVectorArray = 11
 

Constructor & Destructor Documentation

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

Member Function Documentation

OpenMaya.MFnComponentListData.add ( )
add(MObject) -> self

Adds the specified component to the end of the list.
Signature: add(component)
Parameters: component - MObject
Returns: Reference to self.
Description: Adds the specified component to the end of the list.
OpenMaya.MFnComponentListData.clear ( )
clear() -> self

Removes all of the components from the list.
Signature: clear()
Parameters:
Returns: Reference to self.
Description: Removes all of the components from the list.
OpenMaya.MFnComponentListData.create ( )
create() -> MObject

Creates a new, empty component list, attaches it to the
function set and returns an MObject which references it.
Signature: create()
Parameters:
Returns: MObject
Description: Creates a new, empty component list, attaches it to the function set and returns an MObject which references it.
OpenMaya.MFnComponentListData.get ( )
get(index) -> MObject

Returns a copy of the component at the specified index.
Raises IndexError if the index is out of range.
Signature: get(index)
Parameters: index - int
Returns: MObject
Description: Returns a copy of the component at the specified index. Raises IndexError if the index is out of range.
OpenMaya.MFnComponentListData.has ( )
has(MObject) -> bool

Returns True if the list contains the specified
component, False otherwise.
Signature: has(component)
Parameters: component - MObject
Returns: bool
Description: Returns True if the list contains the specified component, False otherwise.
OpenMaya.MFnComponentListData.length ( )
length() -> int

Returns the number of components in the list.
Signature: length()
Parameters:
Returns: int
Description: Returns the number of components in the list.
OpenMaya.MFnComponentListData.remove ( )
remove(MObject) -> self
remove(index) -> self

Removes the specified component from the list.
No exception is raised if the component is not in the list,
raises IndexError if index is out of range
Signature: remove(component)
Parameters: component - MObject
Returns: Reference to self.
Description: Removes the specified component from the list. No exception is raised if the component is not in the list.
Signature: remove(index)
Parameters: index - int
Returns: Reference to self.
Description: Removes the component at the specified index from the list. Raises IndexError if the index is out of range.

The documentation for this class was generated from the following files:
  • D:/Maya-MD-Merge/input/python/2.0/OpenMaya.py
  • D:/Maya-MD-Merge/input/python/extras.dox