1.5.6
#include <MMatrixArray.h>
This class implements an array of MMatrix's. 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.
Public Member Functions | |
| MMatrixArray () | |
| MMatrixArray (const MMatrixArray &other) | |
| MMatrixArray (unsigned initialSize) | |
| ~MMatrixArray () | |
| const MMatrix & | operator[] (unsigned index) const |
| MMatrix & | operator[] (unsigned index) |
| MMatrixArray & | operator= (const MMatrixArray &other) |
| MStatus | set (const MMatrix &element, unsigned index) |
| MStatus | setLength (unsigned length) |
| unsigned | length () const |
| MStatus | remove (unsigned index) |
| MStatus | insert (const MMatrix &element, unsigned index) |
| MStatus | append (const MMatrix &element) |
| MStatus | copy (const MMatrixArray &source) |
| MStatus | clear () |
| void | setSizeIncrement (unsigned newIncrement) |
| unsigned | sizeIncrement () const |
Friends | |
| OPENMAYA_EXPORT std::ostream & | operator<< (std::ostream &os, const MMatrixArray &array) |
| MMatrixArray::MMatrixArray | ( | ) |
Default constructor. The instance is set to contain no elements.
| MMatrixArray::MMatrixArray | ( | const MMatrixArray & | other | ) |
Copy Constructor.
| [in] | other | the array with which to initialize this instance |
| MMatrixArray::MMatrixArray | ( | unsigned | initialSize | ) |
Create a new array of MMatrix's of a specified size and initialize all the elements as the identity matrix
| [in] | initialSize | the initial size of the array |
| MMatrixArray::~MMatrixArray | ( | ) |
The class destructor.
| const MMatrix & MMatrixArray::operator[] | ( | unsigned | 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 |
| MMatrix & MMatrixArray::operator[] | ( | unsigned | index | ) |
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 |
| MMatrixArray & MMatrixArray::operator= | ( | const MMatrixArray & | other | ) |
Assignment operator copies all of the elements of the other array into this one.
If the other array was returned as a reference to internal data then this array will also become a reference rather than doing a full copy.
| [in] | other | the array being copied |
Sets the value of the indicated element to the indicated MMatrix 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 MMatrixArray::setLength | ( | unsigned | 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 MMatrixArray::length | ( | ) | const |
Returns the number of elements in the instance.
| MStatus MMatrixArray::remove | ( | unsigned | 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 |
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 the new value |
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 MMatrixArray::copy | ( | const MMatrixArray & | source | ) |
Copy the contents of the source array to this array.
| [in] | source | array to copy from |
| MStatus MMatrixArray::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 MMatrixArray::setSizeIncrement | ( | unsigned | newIncrement | ) |
Set the size by which the array will be expanded whenever expansion is necessary.
| [in] | newIncrement | the new increment |
| unsigned MMatrixArray::sizeIncrement | ( | ) | const |
Return the size by which the array will be expanded whenever expansion is necessary.
| OPENMAYA_EXPORT std::ostream& operator<< | ( | std::ostream & | os, | |
| const MMatrixArray & | array | |||
| ) | [friend] |
Print the contents of the given MMatrixArray on the given ostream. The format used is:
element 0: [[r11, r12, r13, r14] [r21, r22, r23, r24] [r31, r32, r33, r34] [r41, r42, r43, r44]]
...
element n-1: [[r11, r12, r13, r14] [r21, r22, r23, r24] [r31, r32, r33, r34] [r41, r42, r43, r44]]
Where "n" is the length of the given MMatrixArray
| [in] | os | the ostream to print to |
| [in] | array | the MMatrixArray whose value is to be printed |
| Autodesk® Maya® 2009 © 1997-2008 Autodesk, Inc. All rights reserved. |
Generated with
1.5.6
|