Array of MAnimCurveClipboardItem data type.
More...
#include <MAnimCurveClipboardItemArray.h>
Array of MAnimCurveClipboardItem data type.
This class implements an array of MAnimCurveClipboardItems. 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:
- animImportExport/animFileUtils.cpp, atomImportExport/atomAnimLayers.cpp, atomImportExport/atomAnimLayers.h, and atomImportExport/atomFileUtils.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 items 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 MAnimCurveClipboardItems and initialize it with the given MAnimCurveClipboardItems elements.
- Parameters
-
[in] | src | an array of MAnimCurveClipboardItems |
[in] | count | the number of elements in the src array |
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 desired element |
- Returns
- A reference to the indicated element
Sets the value of the indicated element to the indicated MAnimCurveClipboardItem value.
- 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 |
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
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 the new value |
- Returns
- MS::kSuccess if the insert was successful and MS::kFailure otherwise
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:
- animImportExport/animFileUtils.cpp, and atomImportExport/atomFileUtils.cpp.
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.
- Returns
- MS::kSuccess 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.
bool isValid |
( |
unsigned int & |
failedIndex | ) |
const |
Ensures that the MAnimCurveClipboard items in the array make sense.
- Parameters
-
[in] | failedIndex | The failed index value |
- Returns
- true if the clipboard item array is valid, and false otherwise
NO SCRIPT SUPPORT.
Copy the elements of the array into the given array of MAnimCurveClipboardItems.
No checking is done to ensure that the destination array of MAnimCurveClipboardItems is large enough to hold all the elements of the instance.
- Parameters
-
[in] | array | the array to populate |
- Returns
- MS::kSuccess if the array argument is a non-zero pointer and MS::kFailure otherwise
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
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
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
const char * className |
( |
| ) |
|
|
static |
Returns the name of this class.
- Returns
- The name of this class.
The documentation for this class was generated from the following files:
- MAnimCurveClipboardItemArray.h
- MAnimCurveClipboardItemArray.cpp