#include <MFnArrayAttrsData.h>

Class Description

Function set for multiple arrays of attributes for dependency node data.

MFnArrayAttrsData allows the creation and manipulation of multiple arrays of attributes as a data object over a single connection for use as dependency graph data.

If a user written dependency node either accepts or produces MFnArrayAttrsData, then this class is used to extract or create the data that comes from or goes to other dependency graph nodes. The MDataHandle::type method will return kDynArrayAttrsData when data of this type is present. 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 MFnArrayAttrsData.

NOTE: these data attributes are not storable.

Examples:: dynExprField/dynExprField.cpp, ownerEmitter/ownerEmitter.cpp, simpleEmitter/simpleEmitter.cpp, and sweptEmitter/sweptEmitter.cpp.

Inheritance diagram for MFnArrayAttrsData:

Public Types
enum	Type { , kVectorArray, kDoubleArray, kIntArray, kStringArray }

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

Public Member Functions
virtual MFn::Type	type () const
	Function set type. More...

virtual	~MFnArrayAttrsData ()
	Destructor.

	MFnArrayAttrsData ()
	Default constructor.

	MFnArrayAttrsData (MObject &object, MStatus *ReturnStatus=NULL)
	Constructor. More...

MStatus	clear ()
	Clear the contents of all of the arrays. More...

unsigned int	count () const
	Returns the number of attribute arrays. More...

MStringArray	list (MStatus *ReturnStatus=NULL) const
	Returns a list of names for the attribute arrays. More...

bool	checkArrayExist (const MString attrName, MFnArrayAttrsData::Type &arrayType, MStatus *ReturnStatus=NULL)
	Check if the attribute array related to the given name has been created. More...

MVectorArray	vectorArray (const MString attrName, MStatus *ReturnStatus=NULL)
	Return an MVectorArray containing the vector array currently operated upon by the function set. More...

MDoubleArray	doubleArray (const MString attrName, MStatus *ReturnStatus=NULL)
	Return an MDoubleArray containing the double array currently operated upon by the function set. More...

MIntArray	intArray (const MString attrName, MStatus *ReturnStatus=NULL)
	Return an MIntArray containing the int array currently operated upon by the function set. More...

MStringArray	stringArray (const MString attrName, MStatus *ReturnStatus=NULL)
	Return an MStringArray containing the string array currently operated upon by the function set. More...

MObject	create (MStatus *ReturnStatus=NULL)
	Create a new MObject, attach it to this instance, and initialize it to be empty. More...

MVectorArray	getVectorData (const MString attrName, MStatus *ReturnStatus=NULL)
	Return an MVectorArray containing the vector array currently operated upon by the function set. More...

MDoubleArray	getDoubleData (const MString attrName, MStatus *ReturnStatus=NULL)
	Return an MDoubleArray containing the double array currently operated upon by the function set. More...

MIntArray	getIntData (const MString attrName, MStatus *ReturnStatus=NULL)
	Return an MIntArray containing the int array currently operated upon by the function set. More...

MStringArray	getStringData (const MString attrName, MStatus *ReturnStatus=NULL)
	Return an MStringArray containing the string array currently operated upon by the function set. More...

	MFnArrayAttrsData (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
Static Public Member Functions inherited from MFnBase
static const char *	className ()
	Returns the name of this class. More...

Member Enumeration Documentation

enum Type

Enumerator
kVectorArray	use vectorArray() method to extract the attribute array.
kDoubleArray	use doubleArray() method to extract the attribute array.
kIntArray	use intArray() method to extract the attribute array.
kStringArray	use stringArray() method to extract the attribute array.

Constructor & Destructor Documentation

MFnArrayAttrsData	(	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

MFnArrayAttrsData	(	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::kDynArrayAttrsData.

Reimplemented from MFnData.

OPENMAYA_MAJOR_NAMESPACE_OPEN const char * className ( ) const

protectedvirtual

Class name.

Return the class name : "MFnArrayAttrsData".

Reimplemented from MFnData.

MStatus clear ( )

Clear the contents of all of the arrays.

Returns

kSuccess operation successful
kFailure MS::kFailure if the instance is not attached to an MObject

unsigned int count ( ) const

Returns the number of attribute arrays.

Returns: The number or arrays

MStringArray list ( MStatus * ReturnStatus = NULL ) const

Returns a list of names for the attribute arrays.

Parameters

[out] ReturnStatus Status code.

Returns: A list of all the names of all the arrays stored in the data.

bool checkArrayExist	(	const MString	name,
		MFnArrayAttrsData::Type &	arrayType,
		MStatus *	ReturnStatus = `NULL`
	)

Check if the attribute array related to the given name has been created.

If the named array exists return true and the array data type.

Parameters

[in]	name	the name of the array to check
[out]	arrayType	the type of the array
[out]	ReturnStatus	kFailure if the instance is not attached to an MObject, and kSuccess otherwise.

Returns: True if the array exists and false otherwise.

MVectorArray vectorArray	(	const MString	name,
		MStatus *	ReturnStatus = `NULL`
	)

Return an MVectorArray containing the vector array currently operated upon by the function set.

The MVectorArray returned by this method is editable, so any changes to the return instance also affects the MObject operated upon by this function set. If the array did not exist it will be created.

Parameters

[in]	name	the name of the array to edit or create.
[out]	ReturnStatus	kFailure if the instance is not attached to an MObject, and kSuccess otherwise.

Returns: A copy of the MVectorArray held in this instance

Examples:: ownerEmitter/ownerEmitter.cpp, simpleEmitter/simpleEmitter.cpp, and sweptEmitter/sweptEmitter.cpp.

MDoubleArray doubleArray	(	const MString	name,
		MStatus *	ReturnStatus = `NULL`
	)

Return an MDoubleArray containing the double array currently operated upon by the function set.

The MDoubleArray returned by this method is editable, so any changes to the return instance also affects the MObject operated upon by this function set. If the array did not exist it will be created.

Parameters

[in]	name	the name of the array to edit or create.
[out]	ReturnStatus	kFailure if the instance is not attached to an MObject, and kSuccess otherwise.

Returns: A copy of the MDoubleArray held in this instance

Examples:: simpleEmitter/simpleEmitter.cpp.

MIntArray intArray	(	const MString	name,
		MStatus *	ReturnStatus = `NULL`
	)

Return an MIntArray containing the int array currently operated upon by the function set.

The MIntArray returned by this method is editable, so any changes to the return instance also affects the MObject operated upon by this function set. If the array did not exist it will be created.

Parameters

[in]	name	the name of the array to edit or create.
[out]	ReturnStatus	kFailure if the instance is not attached to an MObject, and kSuccess otherwise.

Returns: A copy of the MIntArray held in this instance

MStringArray stringArray	(	const MString	name,
		MStatus *	ReturnStatus = `NULL`
	)

Return an MStringArray containing the string array currently operated upon by the function set.

The MStringArray returned by this method is editable, so any changes to the return instance also affects the MObject operated upon by this function set. If the array did not exist it will be created.

Parameters

[in]	name	the name of the array to edit or create.
[out]	ReturnStatus	kFailure if the instance is not attached to an MObject, and kSuccess otherwise.

Returns: A copy of the MStringArray held in this instance

MObject create ( MStatus * ReturnStatus = NULL )

Create a new MObject, attach it to this instance, and initialize it to be empty.

Parameters

[out] ReturnStatus kSuccess

Returns: The newly created MObject

Examples:: ownerEmitter/ownerEmitter.cpp, simpleEmitter/simpleEmitter.cpp, and sweptEmitter/sweptEmitter.cpp.

MVectorArray getVectorData	(	const MString	attrName,
		MStatus *	ReturnStatus = `NULL`
	)

Return an MVectorArray containing the vector array currently operated upon by the function set.

The MVectorArray returned by this method is read only. If the array did not exist it will be created.

Parameters

[in]	attrName	the name of the array to read
[out]	ReturnStatus	kFailure if the instance is not attached to an MObject, and kSuccess otherwise.

Returns: A copy of the MVectorArray held in this instance

MDoubleArray getDoubleData	(	const MString	attrName,
		MStatus *	ReturnStatus = `NULL`
	)

Return an MDoubleArray containing the double array currently operated upon by the function set.

The MDoubleArray returned by this method is read only. If the array did not exist it will be created.

Parameters

[in]	attrName	the name of the array to edit or create.
[out]	ReturnStatus	kFailure if the instance is not attached to an MObject, and kSuccess otherwise.

Returns: A copy of the MDoubleArray held in this instance

MIntArray getIntData	(	const MString	attrName,
		MStatus *	ReturnStatus = `NULL`
	)

Return an MIntArray containing the int array currently operated upon by the function set.

The MIntArray returned by this method is read only. If the array did not exist it will be created.

Parameters

[in]	attrName	the name of the array to edit or create.
[out]	ReturnStatus	kFailure if the instance is not attached to an MObject, and kSuccess otherwise.

Returns: A copy of the MIntArray held in this instance

MStringArray getStringData	(	const MString	attrName,
		MStatus *	ReturnStatus = `NULL`
	)

Return an MStringArray containing the string array currently operated upon by the function set.

The MStringArray returned by this method is read only. If the array did not exist it will be created.

Parameters

[in]	attrName	the name of the array to edit or create.
[out]	ReturnStatus	kFailure if the instance is not attached to an MObject, and kSuccess otherwise.

Returns: A copy of the MStringArray held in this instance

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

MFnArrayAttrsData.h
MFnArrayAttrsData.cpp

MFnArrayAttrsData Class Reference

Class Description

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation