MCallbackIdArray Class Reference
[OpenMaya - API module for common classes]

#include <MCallbackIdArray.h>

Detailed Description

Array of MCallbackId data type.

This class implements an array of MCallbackId. Common convenience functions are available, and the implementation is compatible with the internal Maya implementation so that it can be passed efficiently between plugins and internal maya data structures.

Examples:

: dagMessageCmd.cpp, deletedMsgCmd.cpp, fileIOMsgCmd.cpp, lockEvent.cpp, nodeMessageCmd.cpp, polyMessageCmd.cpp, and undoRedoMsgCmd.cpp.


Public Member Functions
	MCallbackIdArray ()
	MCallbackIdArray (const MCallbackIdArray &other)
	MCallbackIdArray (unsigned int initialSize, MCallbackId initialValue=0)
	~MCallbackIdArray ()
MCallbackId	operator[] (unsigned int index) const
MCallbackIdArray &	operator= (const MCallbackIdArray &other)
MStatus	set (MCallbackId element, unsigned int index)
MStatus	setLength (unsigned int length)
unsigned int	length () const
MStatus	remove (unsigned int index)
MStatus	insert (MCallbackId element, unsigned int index)
MStatus	append (MCallbackId element)
MStatus	copy (const MCallbackIdArray &source)
MStatus	clear ()
void	setSizeIncrement (unsigned int newIncrement)
unsigned int	sizeIncrement () const
	MCallbackIdArray (const MCallbackId src[], unsigned int count)
	NO SCRIPT SUPPORT.
MStatus	get (MCallbackId[]) const
	NO SCRIPT SUPPORT.
MCallbackId &	operator[] (unsigned int index)
	NO SCRIPT SUPPORT.
Friends
OPENMAYA_EXPORT std::ostream &	operator<< (std::ostream &os, const MCallbackIdArray &array)
	NO SCRIPT SUPPORT.

Constructor & Destructor Documentation

MCallbackIdArray::MCallbackIdArray ( )

Default constructor. The instance is set to contain no elements.

MCallbackIdArray::MCallbackIdArray ( const MCallbackIdArray & other )

Copy Constructor.

Parameters:

[in] other the array with which to initialize this instance

MCallbackIdArray::MCallbackIdArray	(	unsigned int	initialSize,
		MCallbackId	initialValue = `0`
	)

Create a new array of MCallbackIds of a specified size and initialize all the elements with the given initial value.

Parameters:

`[in]`	initialSize	the initial size of the array
`[in]`	initialValue	the initial value of each element

MCallbackIdArray::~MCallbackIdArray ( )

The class destructor.

MCallbackIdArray::MCallbackIdArray	(	const MCallbackId	src[],
		unsigned int	count
	)

NO SCRIPT SUPPORT.

Create a new array of MCallbackIds and initialize it with the given elements.

Parameters:

`[in]`	src	a C++ array of MCallbackIds
`[in]`	count	the number of elements in the src array

Member Function Documentation

MCallbackId MCallbackIdArray::operator[] ( unsigned int index ) const

Index operator. Returns the value of the element at the given index. No range checking is done - valid indices are 0 to length()-1.

Parameters:

[in] index the index of the element whose value is to be returned

Returns:: The value of the indicated element.

MCallbackIdArray & MCallbackIdArray::operator= ( const MCallbackIdArray & other )

Assignment operator copies all of the elements of the other array into this one.

Parameters:

[in] other the array being copied

Returns:: A reference to this array

MStatus MCallbackIdArray::set	(	MCallbackId	element,
		unsigned int	index
	)

Sets the value of the indicated element to the indicated value.

NOTE: This method does not grow the array if the index is out of bounds. Only a valid index should be used.

Parameters:

`[in]`	element	the new value for the indicated element
`[in]`	index	the index of the element that is to be set to the the new value

Returns:: MS::kSuccess if the value was set successfully and MS::kFailure otherwise

MStatus MCallbackIdArray::setLength ( unsigned int length )

Set the length of the array. This will grow and shrink the array as desired. Elements that are grown have uninitialized values, while those which are shrunk will lose the data contained in the deleted elements (ie. it will release the memory).

Parameters:

[in] length the new size of the array

unsigned int MCallbackIdArray::length ( ) const

Returns the number of elements in the instance.

Returns:: The number of elements in the instance

Examples:

: dagMessageCmd.cpp, lockEvent.cpp, nodeMessageCmd.cpp, and polyMessageCmd.cpp.

MStatus MCallbackIdArray::remove ( unsigned int index )

Remove the array element at the given index. All array elements following the removed element are shifted toward the first element.

Parameters:

[in] index index of the element to be removed

Returns:: MS::kSuccess if the remove was successful and MS::kFailure otherwise

MStatus MCallbackIdArray::insert	(	MCallbackId	element,
		unsigned int	index
	)

Inserts a new value into the array at the given index. The initial element at that index, and all following elements, are shifted towards the last. If the array cannot be expanded in size by 1 element, then the insert will fail and the existing array will remain unchanged.

Parameters:

`[in]`	element	the new value to insert into the array
`[in]`	index	the index of the element to set to the new value

Returns:: MS::kSuccess if the insert was successful and MS::kFailure otherwise

MStatus MCallbackIdArray::append ( MCallbackId element )

Adds a new element to the end of the array. If the array cannot be expanded in size by 1 element, then the append will fail and the existing array will remain unchanged.

Parameters:

[in] element the value for the new last element

Returns:: MS::kSuccess if the append was successful and MS::kFailure otherwise

Examples:

: dagMessageCmd.cpp, lockEvent.cpp, nodeMessageCmd.cpp, polyMessageCmd.cpp, and undoRedoMsgCmd.cpp.

MStatus MCallbackIdArray::copy ( const MCallbackIdArray & source )

Copy the contents of the source array to this array.

Parameters:

[in] source array to copy from

Returns:: MS::kSuccess if the copy was successful and MS::kFailure otherwise

MStatus MCallbackIdArray::clear ( )

Clear the contents of the array. After this operation the length method will return 0. This does not change the amount of memory allocated to the array, only the number of valid elements in it.

MS::kSuccess if the operation is successful and MS::kFailure otherwise

Examples:

: lockEvent.cpp.

void MCallbackIdArray::setSizeIncrement ( unsigned int newIncrement )

Set the size by which the array will be expanded whenever expansion is necessary.

Parameters:

[in] newIncrement the new increment

unsigned int MCallbackIdArray::sizeIncrement ( ) const

Return the size by which the array will be expanded whenever expansion is necessary.

Returns:: true if the array argument is a non-zero pointer and false otherwise

MStatus MCallbackIdArray::get ( MCallbackId array[] ) const

NO SCRIPT SUPPORT.

Copy the elements of the array into the given array of MCallbackIds. No checking is done to ensure that the destination C++ array of MCallbackIds is large enough to hold all the elements of the instance.

Parameters:

[out] array the array to populate

Returns:: MS::kSuccess if the array argument is a non-zero pointer and MS::kFailure otherwise

MCallbackId & MCallbackIdArray::operator[] ( unsigned int index )

NO SCRIPT SUPPORT.

Index operator allowing assignment to an element of the array. Returns a reference to the element at the given index. No range checking is done - valid indices are 0 to length()-1.

Parameters:

[in] index the index of the desired element

Returns:: A reference to the indicated element

Friends And Related Function Documentation

OPENMAYA_EXPORT std::ostream& operator<<	(	std::ostream &	os,
		const MCallbackIdArray &	array
	)			`[friend]`

NO SCRIPT SUPPORT.

Print the contents of the given MCallbackIdArray on the given ostream. The format used is [1, 2, 3, ... 9].

Parameters:

`[in]`	os	the ostream to print to
`[in]`	array	the MCallbackIdArray whose value is to be printed

Returns:: The ostream reference, s, provided as the first parameter.

MCallbackIdArray Class Reference [OpenMaya - API module for common classes]

Detailed Description

Public Member Functions

Friends

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

MCallbackIdArray Class Reference
[OpenMaya - API module for common classes]