C++ API Reference
MAnimCurveClipboardItemArray Class Reference

Array of MAnimCurveClipboardItem data type. More...

#include <MAnimCurveClipboardItemArray.h>

Public Member Functions

 MAnimCurveClipboardItemArray ()
 Default Constructor. More...
 
 MAnimCurveClipboardItemArray (const MAnimCurveClipboardItemArray &other)
 Copy Constructor. More...
 
 MAnimCurveClipboardItemArray (unsigned int initialSize, const MAnimCurveClipboardItem &initialValue)
 Create a new array of items of a specified size and initialize all the elements with the given initial value. More...
 
 ~MAnimCurveClipboardItemArray ()
 Class Destructor.
 
const MAnimCurveClipboardItemoperator[] (unsigned int index) const
 Index operator. More...
 
MStatus set (const MAnimCurveClipboardItem &element, unsigned int index)
 Sets the value of the indicated element to the indicated MAnimCurveClipboardItem 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 (const MAnimCurveClipboardItem &element, unsigned int index)
 Inserts a new value into the array at the given index. More...
 
MStatus append (const MAnimCurveClipboardItem &element)
 Adds a new element to the end of the 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...
 
bool isValid (unsigned int &failedIndex) const
 Ensures that the MAnimCurveClipboard items in the array make sense. More...
 
 MAnimCurveClipboardItemArray (const MAnimCurveClipboardItem src[], unsigned int count)
 NO SCRIPT SUPPORT. More...
 
MStatus get (MAnimCurveClipboardItem array[]) const
 NO SCRIPT SUPPORT. More...
 
MAnimCurveClipboardItemoperator[] (unsigned int index)
 NO SCRIPT SUPPORT. More...
 
MAnimCurveClipboardItemArrayoperator= (const MAnimCurveClipboardItemArray &other)
 Assignment operator copies all of the elements of the other array into this one. More...
 
MStatus copy (const MAnimCurveClipboardItemArray &source)
 Copy the contents of the source array to this array. More...
 

Static Public Member Functions

static const char * className ()
 Returns the name of this class. More...
 

Detailed Description

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.

Constructor & Destructor Documentation

OPENMAYA_MAJOR_NAMESPACE_OPEN MAnimCurveClipboardItemArray ( )

Default Constructor.

The instance is set to contain no elements.

Copy Constructor.

Parameters
[in]otherthe array with which to initialize this instance
MAnimCurveClipboardItemArray ( unsigned int  initialSize,
const MAnimCurveClipboardItem initialValue 
)

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

Parameters
[in]initialSizethe initial size of the array
[in]initialValuethe initial value of each element
MAnimCurveClipboardItemArray ( const MAnimCurveClipboardItem  src[],
unsigned int  count 
)

NO SCRIPT SUPPORT.

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

Parameters
[in]srcan array of MAnimCurveClipboardItems
[in]countthe number of elements in the src array

Member Function Documentation

const MAnimCurveClipboardItem & 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]indexthe index of the desired element
Returns
A reference to the indicated element
MStatus set ( const MAnimCurveClipboardItem element,
unsigned int  index 
)

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

Parameters
[in]elementthe new value for the indicated element
[in]indexthe 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]lengththe 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
Examples:
animImportExport/animFileUtils.cpp, and atomImportExport/atomFileUtils.cpp.
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]indexindex of the element to be removed
Returns
MS::kSuccess if the remove was successful and MS::kFailure otherwise
MStatus insert ( const MAnimCurveClipboardItem 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]elementthe new value to insert into the array
[in]indexthe index of the element to set to the the new value
Returns
MS::kSuccess if the insert was successful and MS::kFailure otherwise
MStatus append ( const MAnimCurveClipboardItem 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]elementthe 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.
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.

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]newIncrementthe 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]failedIndexThe failed index value
Returns
true if the clipboard item array is valid, and false otherwise
MStatus get ( MAnimCurveClipboardItem  array[]) const

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]arraythe array to populate
Returns
MS::kSuccess if the array argument is a non-zero pointer and MS::kFailure otherwise
MAnimCurveClipboardItem & 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]indexthe 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]otherthe array being copied
Returns
A reference to this array
MStatus copy ( const MAnimCurveClipboardItemArray source)

Copy the contents of the source array to this array.

Parameters
[in]sourcearray 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: