MFnComponentListData Class Reference

#include <MFnComponentListData.h>

Class 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:

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=NULL) 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...

Protected Member Functions
virtual const char *	className () const
	Class name. 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, kLast }
	Types of dependency graph data. More...
Static Public Member Functions inherited from MFnBase
static const char *	className ()
	Returns the name of this class. More...

Constructor & Destructor Documentation

MFnComponentListData	(	MObject &	object,
		MStatus *	ReturnStatus = NULL
	)

Constructor.

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

Parameters

[in]	object	The MObject to attach the function set to
[out]	ReturnStatus	the 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]	object	The MObject to attach the function set to
[out]	ReturnStatus	the 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.

Reimplemented from MFnData.

OPENMAYA_MAJOR_NAMESPACE_OPEN const char * className ( ) const

protectedvirtual

Class name.

Return the class name : "MFnComponentListData".

Reimplemented from MFnData.

unsigned int length

(

MStatus *

ReturnStatus = NULL

)

const

Return the number of components in the instance.

Parameters

[out]

ReturnStatus

Status 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]	obj	the MObject containing the component to look for
[out]	ReturnStatus	Status 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]

index

the index of the component to extract

Returns

The indicated component

MStatus add

(

MObject &

obj

)

Add the given component to the component list.

Parameters

[in]

obj

an 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:

MStatus remove

(

const MObject &

obj

)

Remove the given component from the component list.

Parameters

[in]

obj

an 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]

index

the 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]

ReturnStatus

kSuccess

Returns

The newly created MObject

Examples:

---

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

• MFnComponentListData.h
• MFnComponentListData.cpp