MFloatVectorArray Class Reference
[OpenMaya - API module for common classes, FunctionSet classes]

#include <MFloatVectorArray.h>

List of all members.

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.


Public Member Functions
  MFloatVectorArray ()
  MFloatVectorArray (const MFloatVectorArray &other)
  MFloatVectorArray (const MFloatVector vectors[], unsigned int count)
  NO SCRIPT SUPPORT.
  MFloatVectorArray (const double vectors[][3], unsigned int count)
  MFloatVectorArray (const float vectors[][3], unsigned int count)
  MFloatVectorArray (unsigned int initialSize, const MFloatVector &initialValue=MFloatVector::zero)
  ~MFloatVectorArray ()
const MFloatVector &  operator[] (unsigned int index) const
MFloatVectorArray &  operator= (const MFloatVectorArray &other)
MStatus  set (const MFloatVector &element, unsigned int index)
MStatus  set (double element[3], unsigned int index)
MStatus  set (float element[3], unsigned int index)
MStatus  setLength (unsigned int length)
unsigned int  length () const
MStatus  remove (unsigned int index)
MStatus  insert (const MFloatVector &element, unsigned int index)
MStatus  append (const MFloatVector &element)
MStatus  copy (const MFloatVectorArray &source)
MStatus  clear ()
MStatus  get (double[][3]) const
MStatus  get (float[][3]) const
void  setSizeIncrement (unsigned int newIncrement)
unsigned int  sizeIncrement () const
MFloatVector &  operator[] (unsigned int index)
  NO SCRIPT SUPPORT.

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

Constructor & Destructor Documentation

MFloatVectorArray::MFloatVectorArray (  ) 

Default constructor. The instance is set to contain no elements.

MFloatVectorArray::MFloatVectorArray ( const MFloatVectorArray &  other  ) 

Copy Constructor.

Parameters:
[in]  other  the array with which to initialize this instance

MFloatVectorArray::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]  src  an array of MFloatVectors
[in]  count  the number of elements in the src array

MFloatVectorArray::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]  src  an array of double arrays of length 3
[in]  count  the number of elements in the src array

MFloatVectorArray::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]  src  an array of float arrays of length 3
[in]  count  the number of elements in the src array

MFloatVectorArray::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]  initialSize  the initial size of the array
[in]  initialValue  the initial value of each element

MFloatVectorArray::~MFloatVectorArray (  ) 

The class destructor.

Member Function Documentation

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

MFloatVectorArray & 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]  other  the array being copied
Returns:
A reference to this array

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

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

unsigned int MFloatVectorArray::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 MFloatVectorArray::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

MStatus MFloatVectorArray::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]  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

MStatus MFloatVectorArray::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]  element  the 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 MFloatVectorArray::copy ( const MFloatVectorArray &  source  ) 

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

MStatus MFloatVectorArray::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 MFloatVectorArray::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]  array  the array to populate
Returns:
MS::kSuccess if array argument is a non-zero pointer and MS::kFailure otherwise

MStatus MFloatVectorArray::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]  array  the array to populate
Returns:
MS::kSuccess if array argument is a non-zero pointer and MS::kFailure otherwise

void MFloatVectorArray::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 MFloatVectorArray::sizeIncrement (  )  const

Return the size by which the array will be expanded whenever expansion is necessary.

Returns:
true if the array argument is a non-zero pointer and false otherwise

MFloatVector & MFloatVectorArray::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]  index  the index of the desired element
Returns:
A reference to the indicated element

Friends And Related Function Documentation

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

NO SCRIPT SUPPORT.

Print the contents of the given MFloatVectorArray on the given ostream. The format used is [0: [x, y, z], 1: [x, y, z], 2: [x, y, z], ...].

Parameters:
[in]  os  the ostream to print to
[in]  array  the MFloatVectorArray whose value is to be printed
Returns:
The ostream reference, s, provided as the first parameter.
Autodesk® Maya® 2011 © 1997-2010 Autodesk, Inc. All rights reserved. Generated with doxygen 1.5.6