C++ API Reference

Component list function set for dependency node data. More...

#include <MFnComponentListData.h>

+ Inheritance diagram for MFnComponentListData:

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...
 

Detailed Description

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.

Examples:
basicBlendShape/basicBlendShape.cpp, basicBlendShapeDeformer/basicBlendShapeDeformer.cpp, meshOpCmd/meshOpCmd.cpp, meshOpCmd/meshOpNode.cpp, splitUVCmd/splitUVCmd.cpp, and splitUVCmd/splitUVNode.cpp.

Constructor & Destructor Documentation

MFnComponentListData ( MObject object,
MStatus ReturnStatus = NULL 
)

Constructor.

Class constructor that initializes the function set to the given MObject.

Parameters
[in]objectThe MObject to attach the function set to
[out]ReturnStatusthe return status
Status Codes:
  • MS::kSuccess if the function set is successfully attached
  • MS::kInvalidParameter if the MObject does not represent a valid Maya object or if the function set is not allowed to attach to this MObject
MFnComponentListData ( const MObject object,
MStatus ReturnStatus = NULL 
)

NO SCRIPT SUPPORT.

Class constructor that initializes the function set to the given MObject.

Constructor

Parameters
[in]objectThe MObject to attach the function set to
[out]ReturnStatusthe return status
Status Codes:
  • MS::kSuccess if the function set is successfully attached
  • MS::kInvalidParameter if the MObject does not represent a valid Maya object or if the function set is not allowed to attach to this MObject

Member Function Documentation

MFn::Type type ( ) const
virtual

Function set type.

Return the class type : MFn::kComponentListData.

Returns
the class type.

Reimplemented from MFnData.

OPENMAYA_MAJOR_NAMESPACE_OPEN const char * className ( )
static

Returns the name of this class.

Return the class name : "MFnComponentListData".

Returns
Name of this class.
unsigned int length ( MStatus ReturnStatus = NULL) const

Return the number of components in the instance.

Parameters
[out]ReturnStatusStatus code.
Returns
The number of components in the instance
Status Codes:
  • MS::kSuccess Operation successful.
  • MS::kFailure The instance is not attached to a component list.
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.

Parameters
[in]objthe MObject containing the component to look for
[out]ReturnStatusStatus code.
Status Codes:
  • MS::kSuccess operation successful
  • MS::kFailure operation failed
Returns
true if the component list contains the component, false otherwise
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.

Parameters
[in]indexthe index of the component to extract
Returns
The indicated component
MStatus add ( MObject obj)

Add the given component to the component list.

Parameters
[in]objan MObject containing the component to add
Returns
kSuccess if successful, kFailure if either the instance is not attached to a component list, or the given MObject does not contain a component.
Examples:
meshOpCmd/meshOpCmd.cpp, and splitUVCmd/splitUVCmd.cpp.
MStatus remove ( const MObject obj)

Remove the given component from the component list.

Parameters
[in]objan MObject containing the component to remove
Returns
kSuccess if successful, kFailure if either the instance is not attached to a component list, or the given MObject does not contain a component.
MStatus remove ( unsigned int  index)

Remove the indicated component from the component list.

Parameters
[in]indexthe index of the component to remove
Returns
kSuccess if successful, kFailure if either the instance is not attached to a component list.
MStatus clear ( )

Remove all components from the component list.

Returns
kSuccess if successful, kFailure if the instance is not attached to a component list.
MObject create ( MStatus ReturnStatus = NULL)

Create a new MObject, attach it to this instance, and initialize it to contain an empty component list.

Parameters
[out]ReturnStatuskSuccess
Returns
The newly created MObject
Examples:
meshOpCmd/meshOpCmd.cpp, and splitUVCmd/splitUVCmd.cpp.

The documentation for this class was generated from the following files: