C++ API Reference
|
Component list function set for dependency node data. More...
#include <MFnComponentListData.h>
Public Member Functions | |
virtual MFn::Type | type () const |
Function set type. More... | |
virtual | ~MFnComponentListData () |
Destructor. | |
MFnComponentListData () | |
Default constructor. | |
MFnComponentListData (MObject &object, MStatus *ReturnStatus=NULL) | |
Constructor. More... | |
unsigned int | length (MStatus *ReturnStatus=NULL) const |
Return the number of components in the instance. More... | |
bool | has (const MObject &obj, MStatus *ReturnStatus=NULL) const |
Determine if the instance of the component list contains the component represented by the given MObject. More... | |
MObject | operator[] (unsigned int index) const |
Extract the indicated component from the const instance. More... | |
MStatus | add (MObject &) |
Add the given component to the component list. More... | |
MStatus | remove (const MObject &) |
Remove the given component from the component list. More... | |
MStatus | remove (unsigned int index) |
Remove the indicated component from the component list. More... | |
MStatus | clear () |
Remove all components from the component list. More... | |
MObject | create (MStatus *ReturnStatus=NULL) |
Create a new MObject, attach it to this instance, and initialize it to contain an empty component list. More... | |
MFnComponentListData (const MObject &object, MStatus *ReturnStatus=NULL) | |
NO SCRIPT SUPPORT. More... | |
Public Member Functions inherited from MFnData | |
virtual | ~MFnData () |
Destructor. | |
MFnData (MObject &object, MStatus *ReturnStatus=NULL) | |
Constructor. More... | |
MFnData () | |
Default class constructor. | |
MFnData (const MObject &object, MStatus *ReturnStatus=NULL) | |
Constructor. More... | |
Public Member Functions inherited from MFnBase | |
virtual | ~MFnBase () |
Class Destructor. More... | |
bool | hasObj (MFn::Type) const |
Determines whether or not the Function Set is compatible with the specified Maya Object within the API RTTI system. More... | |
bool | hasObj (const MObject &) const |
Determines whether or not the Function Set is compatible with the specified Maya Object within the API RTTI system. More... | |
MObject | object (MStatus *ReturnStatus=nullptr) const |
Returns the MObject that is attached to the Function Set. More... | |
virtual MStatus | setObject (MObject &object) |
Attaches the Function Set to the specified Maya Object. More... | |
virtual MStatus | setObject (const MObject &object) |
NO SCRIPT SUPPORT. More... | |
Static Public Member Functions | |
static const char * | className () |
Returns the name of this class. More... | |
Static Public Member Functions inherited from MFnData | |
static const char * | className () |
Returns the name of this class. More... | |
Static Public Member Functions inherited from MFnBase | |
static const char * | className () |
Returns the name of this class. More... | |
static const char * | typeString (MFn::Type) |
Returns the type string for a given type. More... | |
static bool | isValid (MFn::Type) |
Returns true if type is in the range of valid types. More... | |
Additional Inherited Members | |
Public Types inherited from MFnData | |
enum | Type { kInvalid, kNumeric, kPlugin, kPluginGeometry, kString, kMatrix, kStringArray, kDoubleArray, kFloatArray, kIntArray, kPointArray, kVectorArray, kMatrixArray, kComponentList, kMesh, kLattice, kNurbsCurve, kNurbsSurface, kSphere, kDynArrayAttrs, kDynSweptGeometry, kSubdSurface, kNObject, kNId, kAny, kFalloffFunction } |
Types of dependency graph data. More... | |
Component list function set for dependency node data.
MFnComponentListData allows the creation and manipulation of component list (represented as MObjects) data objects for use in the dependency graph.
If a user written dependency node either accepts or produces MObjects containing component lists, then this class is used to extract or create the data that comes from or goes to other dependency graph nodes. To access it, the MDataHandle::data method is used to get an MObject for the data and this should then be used to initialize an instance of MFnComponentListData.
MFnComponentListData | ( | MObject & | object, |
MStatus * | ReturnStatus = NULL |
||
) |
MFnComponentListData | ( | const MObject & | object, |
MStatus * | ReturnStatus = NULL |
||
) |
|
virtual |
Function set type.
Return the class type : MFn::kComponentListData.
Reimplemented from MFnData.
|
static |
Returns the name of this class.
Return the class name : "MFnComponentListData".
unsigned int length | ( | MStatus * | ReturnStatus = NULL | ) | const |
Return the number of components in the instance.
[out] | ReturnStatus | Status code. |
Determine if the instance of the component list contains the component represented by the given MObject.
[in] | obj | the MObject containing the component to look for |
[out] | ReturnStatus | Status code. |
MObject operator[] | ( | unsigned int | index | ) | const |
Extract the indicated component from the const instance.
If the index is out of range or the functionset is not attached to a valid object, MObject::kNullObj will be returned.
[in] | index | the index of the component to extract |
Add the given component to the component list.
[in] | obj | an MObject containing the component to add |
MStatus remove | ( | unsigned int | index | ) |
Remove the indicated component from the component list.
[in] | index | the index of the component to remove |
MStatus clear | ( | ) |
Remove all components from the component list.
Create a new MObject, attach it to this instance, and initialize it to contain an empty component list.
[out] | ReturnStatus | kSuccess |