MCallbackIdArray Class Reference
#include <MCallbackIdArray.h>
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.
- cgFx/cgfxShaderNode.h, dagMessageCmd/dagMessageCmd.cpp, deletedMsgCmd/deletedMsgCmd.cpp, fileIOMsgCmd/fileIOMsgCmd.cpp, gpuCache/gpuCacheSubSceneOverride.h, lockEvent/lockEvent.cpp, nodeMessageCmd/nodeMessageCmd.cpp, polyMessageCmd/polyMessageCmd.cpp, testCameraSetCmd/testCameraSetCmd.cpp, transformDrawNode/transformDrawNode.cpp, and undoRedoMsgCmd/undoRedoMsgCmd.cpp.
Default constructor.
The instance is set to contain no elements.
Copy Constructor.
- Parameters
-
[in] | other | the array with which to initialize this instance |
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 |
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 |
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.
- Parameters
-
[in] | index | the index of the element whose value is to be returned |
- Returns
- The value of the indicated element.
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 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 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 length |
( |
| ) |
const |
Returns the number of elements in the instance.
- 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.
- Parameters
-
[in] | index | index of the element to be removed |
- Returns
- MS::kSuccess if the remove was successful and MS::kFailure otherwise
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.
- 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 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
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
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
void 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 sizeIncrement |
( |
| ) |
const |
Return the size by which the array will be expanded whenever expansion is necessary.
- Returns
- The size increment.
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.
- Parameters
-
[out] | array | the array to populate |
- Returns
- MS::kSuccess if the array argument is a non-zero pointer and MS::kFailure otherwise
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.
- Parameters
-
[in] | index | the index of the desired element |
- Returns
- A reference to the indicated element
const char * className |
( |
| ) |
|
|
static |
Returns the name of this class.
- Returns
- The name of this class.
OPENMAYA_EXPORT std::ostream& operator<< |
( |
std::ostream & |
os, |
|
|
const MCallbackIdArray & |
array |
|
) |
| |
|
friend |
NO SCRIPT SUPPORT.
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.
The documentation for this class was generated from the following files:
- MCallbackIdArray.h
- MCallbackIdArray.cpp