C++ API Reference
|
Array of MCallbackId data type. More...
#include <MCallbackIdArray.h>
Public Member Functions | |
MCallbackIdArray () | |
Default constructor. More... | |
MCallbackIdArray (const MCallbackIdArray &other) | |
Copy Constructor. More... | |
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. More... | |
~MCallbackIdArray () | |
The class destructor. | |
MCallbackId | operator[] (unsigned int index) const |
Index operator. More... | |
MCallbackIdArray & | operator= (const MCallbackIdArray &other) |
Assignment operator copies all of the elements of the other array into this one. More... | |
MStatus | set (MCallbackId element, unsigned int index) |
Sets the value of the indicated element to the indicated value. More... | |
MStatus | setLength (unsigned int length) |
Set the length of the array. More... | |
unsigned int | length () const |
Returns the number of elements in the instance. More... | |
MStatus | remove (unsigned int index) |
Remove the array element at the given index. More... | |
MStatus | insert (MCallbackId element, unsigned int index) |
Inserts a new value into the array at the given index. More... | |
MStatus | append (MCallbackId element) |
Adds a new element to the end of the array. More... | |
MStatus | copy (const MCallbackIdArray &source) |
Copy the contents of the source array to this array. More... | |
MStatus | clear () |
Clear the contents of the array. More... | |
void | setSizeIncrement (unsigned int newIncrement) |
Set the size by which the array will be expanded whenever expansion is necessary. More... | |
unsigned int | sizeIncrement () const |
Return the size by which the array will be expanded whenever expansion is necessary. More... | |
MCallbackIdArray (const MCallbackId src[], unsigned int count) | |
NO SCRIPT SUPPORT. More... | |
MStatus | get (MCallbackId[]) const |
NO SCRIPT SUPPORT. More... | |
MCallbackId & | operator[] (unsigned int index) |
NO SCRIPT SUPPORT. More... | |
Iterator | begin () |
Returns an iterator object pointed to the beginning of the array. More... | |
Iterator | end () |
Returns an iterator object pointed to the end of the array. More... | |
ConstIterator | begin () const |
Returns a const iterator object pointed to the beginning of the array. More... | |
ConstIterator | end () const |
Returns a const iterator object pointed to the end of the array. More... | |
ConstIterator | cbegin () const |
Returns a const iterator object pointed to the beginning of the array. More... | |
ConstIterator | cend () const |
Returns a const iterator object pointed to the end of the array. More... | |
Static Public Member Functions | |
static const char * | className () |
Returns the name of this class. More... | |
Friends | |
OPENMAYA_EXPORT std::ostream & | operator<< (std::ostream &os, const MCallbackIdArray &array) |
NO SCRIPT SUPPORT. More... | |
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.
OPENMAYA_MAJOR_NAMESPACE_OPEN MCallbackIdArray | ( | ) |
Default constructor.
The instance is set to contain no elements.
MCallbackIdArray | ( | const MCallbackIdArray & | other | ) |
Copy Constructor.
[in] | other | the array with which to initialize this instance |
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.
[in] | initialSize | the initial size of the array |
[in] | initialValue | the initial value of each element |
MCallbackIdArray | ( | const MCallbackId | src[], |
unsigned int | count | ||
) |
NO SCRIPT SUPPORT.
Create a new array of MCallbackIds and initialize it with the given elements.
[in] | src | a C++ array of MCallbackIds |
[in] | count | the number of elements in the src array |
MCallbackId 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.
[in] | index | the index of the element whose value is to be returned |
MCallbackIdArray & operator= | ( | const MCallbackIdArray & | other | ) |
Assignment operator copies all of the elements of the other array into this one.
[in] | other | the array being copied |
MStatus 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.
[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 |
MStatus 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).
[in] | length | the new size of the array |
unsigned int length | ( | ) | const |
Returns the number of elements in the instance.
MStatus 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.
[in] | index | index of the element to be removed |
MStatus 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.
[in] | element | the new value to insert into the array |
[in] | index | the index of the element to set to the new value |
MStatus 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.
[in] | element | the value for the new last element |
MStatus copy | ( | const MCallbackIdArray & | source | ) |
Copy the contents of the source array to this array.
[in] | source | array to copy from |
MStatus 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.
void setSizeIncrement | ( | unsigned int | newIncrement | ) |
Set the size by which the array will be expanded whenever expansion is necessary.
[in] | newIncrement | the new increment |
unsigned int sizeIncrement | ( | ) | const |
Return the size by which the array will be expanded whenever expansion is necessary.
MStatus 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.
[out] | array | the array to populate |
MCallbackId & 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.
[in] | index | the index of the desired element |
MCallbackIdArray::Iterator begin | ( | ) |
Returns an iterator object pointed to the beginning of the array.
MCallbackIdArray::Iterator end | ( | ) |
Returns an iterator object pointed to the end of the array.
MCallbackIdArray::ConstIterator begin | ( | ) | const |
Returns a const iterator object pointed to the beginning of the array.
MCallbackIdArray::ConstIterator end | ( | ) | const |
Returns a const iterator object pointed to the end of the array.
MCallbackIdArray::ConstIterator cbegin | ( | ) | const |
Returns a const iterator object pointed to the beginning of the array.
MCallbackIdArray::ConstIterator cend | ( | ) | const |
Returns a const iterator object pointed to the end of the array.
|
static |
Returns the name of this class.
|
friend |
NO SCRIPT SUPPORT.
The format used is [1, 2, 3, ... 9].
[in] | os | the ostream to print to |
[in] | array | the MCallbackIdArray whose value is to be printed |