Public Member Functions | Static Public Member Functions | Friends

MFloatVectorArray Class Reference

Search for all occurrences

Detailed Description

Array of MFloatVectors data type.

This class implements an array of MFloatVectors. 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:

objExport.cpp, polyModifierCmd.h, polyWriter.h, sampleCmd.cpp, sampleParticles.cpp, and XmlGeometryCache.cpp.

#include <MFloatVectorArray.h>

List of all members.

Public Member Functions

 MFloatVectorArray ()
 Default constructor.
 MFloatVectorArray (const MFloatVectorArray &other)
 Copy Constructor.
 MFloatVectorArray (const MFloatVector vectors[], unsigned int count)
 NO SCRIPT SUPPORT.
 MFloatVectorArray (const double vectors[][3], unsigned int count)
 Create a new array of MFloatVectors and initialize it with the given double array elements.
 MFloatVectorArray (const float vectors[][3], unsigned int count)
 Create a new array of MFloatVectors and initialize it with the given float array elements.
 MFloatVectorArray (unsigned int initialSize, const MFloatVector &initialValue=MFloatVector::zero)
 Create a new array of MFloatVectors of a specified size and initialize all the elements with the given initial value.
 ~MFloatVectorArray ()
 The class destructor.
const MFloatVectoroperator[] (unsigned int index) const
 Index operator.
MFloatVectorArrayoperator= (const MFloatVectorArray &other)
 Assignment operator copies all of the elements of the other array into this one.
MStatus set (const MFloatVector &element, unsigned int index)
 Sets the value of the indicated element to the indicated MFloatVector value.
MStatus set (double element[3], unsigned int index)
 Sets the value of the indicated element to the indicated double array value.
MStatus set (float element[3], unsigned int index)
 Sets the value of the indicated element to the indicated float array value.
MStatus setLength (unsigned int length)
 Set the length 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.
MStatus insert (const MFloatVector &element, unsigned int index)
 Inserts a new value into the array at the given index.
MStatus append (const MFloatVector &element)
 Adds a new element to the end of the array.
MStatus copy (const MFloatVectorArray &source)
 Copy the contents of the source array to this array.
MStatus clear ()
 Clear the contents of the array.
MStatus get (double[][3]) const
 Copy the elements of the array into the given C++ array of double arrays.
MStatus get (float[][3]) const
 Copy the elements of the array into the given C++ array of float arrays.
void setSizeIncrement (unsigned int newIncrement)
 Set the size by which the array will be expanded whenever expansion is necessary.
unsigned int sizeIncrement () const
 Return the size by which the array will be expanded whenever expansion is necessary.
MFloatVectoroperator[] (unsigned int index)
 NO SCRIPT SUPPORT.

Static Public Member Functions

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

Friends

OPENMAYA_EXPORT std::ostream & operator<< (std::ostream &os, const MFloatVectorArray &array)
 NO SCRIPT SUPPORT.

Constructor & Destructor Documentation

Default constructor.

The instance is set to contain no elements.

Copy Constructor.

Parameters:
[in]otherthe array with which to initialize this instance
MFloatVectorArray ( const MFloatVector  src[],
unsigned int  count 
)

NO SCRIPT SUPPORT.

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

Parameters:
[in]srcan array of MFloatVectors
[in]countthe number of elements in the src array
MFloatVectorArray ( const double  src[][3],
unsigned int  count 
)

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

Parameters:
[in]srcan array of double arrays of length 3
[in]countthe number of elements in the src array
MFloatVectorArray ( const float  src[][3],
unsigned int  count 
)

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

Parameters:
[in]srcan array of float arrays of length 3
[in]countthe number of elements in the src array
MFloatVectorArray ( unsigned int  initialSize,
const MFloatVector initialValue = MFloatVector::zero 
)

Create a new array of MFloatVectors 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

Member Function Documentation

const MFloatVector & 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 element whose value is to be returned
Returns:
The value of the indicated element.
MFloatVectorArray & operator= ( const MFloatVectorArray 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.

Parameters:
[in]otherthe array being copied
Returns:
A reference to this array
MStatus set ( const MFloatVector element,
unsigned int  index 
)

Sets the value of the indicated element to the indicated MFloatVector 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]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
Examples:
XmlGeometryCache.cpp.
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.

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 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.

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
Examples:
XmlGeometryCache.cpp.
unsigned int length ( ) const

Returns the number of elements in the instance.

Returns:
The number of elements in the instance
Examples:
objExport.cpp, sampleCmd.cpp, and XmlGeometryCache.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 MFloatVector 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 MFloatVector 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:
sampleCmd.cpp, and sampleParticles.cpp.
MStatus copy ( const MFloatVectorArray 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
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.

Examples:
XmlGeometryCache.cpp.
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.

Parameters:
[out]arraythe array to populate
Returns:
MS::kSuccess if array argument is a non-zero pointer and MS::kFailure otherwise
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.

Parameters:
[out]arraythe array to populate
Returns:
MS::kSuccess if array argument is a non-zero pointer 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.
MFloatVector & 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
const char * className ( ) [static]

Returns the name of this class.

Returns:
The name of this class.

Friends And Related Function Documentation

OPENMAYA_EXPORT std::ostream& operator<< ( std::ostream &  os,
const MFloatVectorArray array 
) [friend]

NO SCRIPT SUPPORT.

The format used is [0: [x, y, z], 1: [x, y, z], 2: [x, y, z], ...].

Parameters:
[in]osthe ostream to print to
[in]arraythe MFloatVectorArray whose value is to be printed
Returns:
The ostream reference, s, provided as the first parameter.

MFloatVectorArray MFloatVectorArray MFloatVectorArray MFloatVectorArray MFloatVectorArray MFloatVectorArray MFloatVectorArray MFloatVectorArray MFloatVectorArray MFloatVectorArray
MFloatVectorArray MFloatVectorArray MFloatVectorArray MFloatVectorArray MFloatVectorArray MFloatVectorArray MFloatVectorArray MFloatVectorArray MFloatVectorArray MFloatVectorArray