#include <MFnIntArrayData.h>

Class Description

int array function set for dependency node data.

MFnIntArrayData allows the creation and manipulation of MIntArray data objects for use in the dependency graph.

If a user written dependency node either accepts or produces MIntArrays, 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 kIntArray 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 MFnIntArrayData.

Examples:: AbcBullet/AttributesWriter.cpp, AbcExport/AttributesWriter.cpp, AbcImport/CreateSceneHelper.cpp, and AbcImport/NodeIteratorVisitorHelper.cpp.

Inheritance diagram for MFnIntArrayData:

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

virtual	~MFnIntArrayData ()
	Destructor.

	MFnIntArrayData ()
	Default constructor.

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

unsigned int	length (MStatus *ReturnStatus=NULL) const
	Return the number of integers in the instance. More...

int	operator[] (unsigned int index) const
	Extract the indicated integer from the const instance. More...

MStatus	set (int element, unsigned int index)
	Set the integer element at the specified index of this array. More...

MStatus	copyTo (MIntArray &) const
	Copy all the integers in the instance into the given MIntArray. More...

MStatus	set (const MIntArray &newArray)
	Set the instance to contain the integers defined in the given MIntArray. More...

MIntArray	array (MStatus *ReturnStatus=NULL)
	Return an MIntArray containing the integer 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 contain no ints. More...

MObject	create (const MIntArray &in, MStatus *ReturnStatus=NULL)
	Create a new MObject, attach it to this instance, and initialize it to contain the data from the given MIntArray. More...

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

int &	operator[] (unsigned int index)
	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

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

MFnIntArrayData	(	const 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

Member Function Documentation

MFn::Type type ( ) const

virtual

Function set type.

Return the class type : MFn::kIntArrayData.

Reimplemented from MFnData.

OPENMAYA_MAJOR_NAMESPACE_OPEN const char * className ( ) const

protectedvirtual

Class name.

Return the class name : "MFnIntArrayData".

Reimplemented from MFnData.

unsigned int length ( MStatus * ReturnStatus = NULL ) const

Return the number of integers in the instance.

Parameters

[out] ReturnStatus kFailure if the instance is not attached to an MObject, and kSuccess otherwise.

Returns: The number of integers in the instance

Examples:: AbcBullet/AttributesWriter.cpp, and AbcExport/AttributesWriter.cpp.

int operator[] ( unsigned int index ) const

Extract the indicated integer from the const instance.

No checking is done by this class to ensure that the index is valid - use the length method to determine the size of the array. If the instance is not attached to an MObject, this method will return an integer containing zero.

Parameters

[in] index the index of the integer to extract

Returns: The indicated integer

MStatus set	(	int	element,
		unsigned int	index
	)

Set the integer element at the specified index of this array.

No checking is done by this class to ensure that the index is valid - use the length method to determine the size of the array.

Parameters

[in]	element	the element
[in]	index	the index of the integer to extract

Returns

kSuccess operation successful
kFailure instance is not attached to an MObject

MStatus copyTo ( MIntArray & dest ) const

Copy all the integers in the instance into the given MIntArray.

Parameters

[out] dest the MIntArray to populate

Returns

kSuccess operation successful
kFailure instance is not attached to an MObject

MStatus set ( const MIntArray & array )

Set the instance to contain the integers defined in the given MIntArray.

Parameters

[in] array the MIntArray containing the data to set into this instance

Returns

kSuccess operation successful
kFailure instance is not attached to an MObject

MIntArray array ( MStatus * ReturnStatus = NULL )

Return an MIntArray containing the integer 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.

Parameters

[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

MObject create ( MStatus * ReturnStatus = NULL )

Create a new MObject, attach it to this instance, and initialize it to contain no ints.

Parameters

[out] ReturnStatus kSuccess

Returns: The newly created MObject

Examples:: AbcImport/NodeIteratorVisitorHelper.cpp.

MObject create	(	const MIntArray &	arr,
		MStatus *	ReturnStatus = `NULL`
	)

Create a new MObject, attach it to this instance, and initialize it to contain the data from the given MIntArray.

Parameters

[in]	arr	the data to use when initializing this instance
[out]	ReturnStatus	kSuccess

Returns: The newly created MObject

int & operator[] ( unsigned int index )

NO SCRIPT SUPPORT.

Extract the indicated integer from the instance.

by the function set. The integer returned by this method is editable, so any changes to the return instance also affects the MObject operated upon by this function set.

No checking is done by this class to ensure that the index is valid - use the length method to determine the size of the array. If the instance is not attached to an MObject, this method will return an integer containing zero.

Parameters

[in] index the index of the integer to extract

Returns: The indicated integer

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

MFnIntArrayData.h
MFnIntArrayData.cpp

MFnIntArrayData Class Reference

Class Description

Public Member Functions

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation