C++ API Reference
|
Array of MVectors data type. More...
#include <MVectorArray.h>
Public Member Functions | |
MVectorArray () | |
Default constructor. More... | |
MVectorArray (const MVectorArray &other) | |
Copy Constructor. More... | |
MVectorArray (const MVector vectors[], unsigned int count) | |
NO SCRIPT SUPPORT. More... | |
MVectorArray (const double vectors[][3], unsigned int count) | |
Create a new array of MVectors and initialize it with the given double array elements. More... | |
MVectorArray (const float vectors[][3], unsigned int count) | |
Create a new array of MVectors and initialize it with the given float array elements. More... | |
MVectorArray (unsigned int initialSize, const MVector &initialValue=MVector::zero) | |
Create a new array of MVectors of a specified size and initialize all the elements with the given initial value. More... | |
~MVectorArray () | |
The class destructor. | |
const MVector & | operator[] (unsigned int index) const |
Index operator. More... | |
MVectorArray & | operator= (const MVectorArray &other) |
Assignment operator copies all of the elements of the other array into this one. More... | |
MStatus | set (const MVector &element, unsigned int index) |
Sets the value of the indicated element to the indicated MVector value. More... | |
MStatus | set (double element[3], unsigned int index) |
Sets the value of the indicated element to the indicated double array value. More... | |
MStatus | set (float element[3], unsigned int index) |
Sets the value of the indicated element to the indicated float array 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 MVector &element, unsigned int index) |
Inserts a new value into the array at the given index. More... | |
MStatus | append (const MVector &element) |
Adds a new element to the end of the array. More... | |
MStatus | copy (const MVectorArray &source) |
Copy the contents of the source array to this array. More... | |
MStatus | clear () |
Clear the contents of the array. More... | |
MStatus | get (double[][3]) const |
Copy the elements of the array into the given C++ array of double arrays. More... | |
MStatus | get (float[][3]) const |
Copy the elements of the array into the given C++ array of float arrays. 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... | |
MVector & | 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 MVectorArray &array) |
NO SCRIPT SUPPORT. More... | |
Array of MVectors data type.
This class implements an array of MVectors. 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 MVectorArray | ( | ) |
Default constructor.
The instance is set to contain no elements.
MVectorArray | ( | const MVectorArray & | other | ) |
Copy Constructor.
[in] | other | the array with which to initialize this instance |
MVectorArray | ( | const MVector | src[], |
unsigned int | count | ||
) |
NO SCRIPT SUPPORT.
Create a new array of MVectors and initialize it with the given MVector elements.
[in] | src | an array of MVectors |
[in] | count | the number of elements in the src array |
MVectorArray | ( | const double | src[][3], |
unsigned int | count | ||
) |
Create a new array of MVectors and initialize it with the given double array elements.
[in] | src | an array of double arrays of length 3 |
[in] | count | the number of elements in the src array |
MVectorArray | ( | const float | src[][3], |
unsigned int | count | ||
) |
Create a new array of MVectors and initialize it with the given float array elements.
[in] | src | an array of float arrays of length 3 |
[in] | count | the number of elements in the src array |
MVectorArray | ( | unsigned int | initialSize, |
const MVector & | initialValue = MVector::zero |
||
) |
Create a new array of MVectors 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 |
const MVector & 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 |
MVectorArray & operator= | ( | const MVectorArray & | 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 (eg MFnVectorArrayData::array), 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 MVector 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 set | ( | double | element[3], |
unsigned int | index | ||
) |
Sets the value of the indicated element to the indicated double array 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 set | ( | float | element[3], |
unsigned int | index | ||
) |
Sets the value of the indicated element to the indicated float array 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 |
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 copy | ( | const MVectorArray & | 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.
MStatus get | ( | double | array[][3] | ) | const |
Copy the elements of the array into the given C++ array of double arrays.
No checking is done to ensure that the destination C++ array of double arrays is large enough to hold all the elements of the instance.
[out] | array | the array to populate |
MStatus get | ( | float | array[][3] | ) | const |
Copy the elements of the array into the given C++ array of float arrays.
No checking is done to ensure that the destination C++ array of floats arrays is large enough to hold all the elements of the instance.
[out] | array | the array to populate |
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.
MVector & 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 |
MVectorArray::Iterator begin | ( | ) |
Returns an iterator object pointed to the beginning of the array.
MVectorArray::Iterator end | ( | ) |
Returns an iterator object pointed to the end of the array.
MVectorArray::ConstIterator begin | ( | ) | const |
Returns a const iterator object pointed to the beginning of the array.
MVectorArray::ConstIterator end | ( | ) | const |
Returns a const iterator object pointed to the end of the array.
MVectorArray::ConstIterator cbegin | ( | ) | const |
Returns a const iterator object pointed to the beginning of the array.
MVectorArray::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 [0: [x, y, z], 1: [x, y, z], 2: [x, y, z], ...].
[in] | os | the ostream to print to |
[in] | array | the MVectorArray whose value is to be printed |