MVectorArray Class Reference

Search for all occurrences

---

Detailed Description

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.

Examples:

apiMeshCreator.cpp, apiMeshCreator.h, apiMeshGeom.h, apiMeshShape.cpp, apiMeshShape.h, apiSimpleShapeIterator.cpp, apiSimpleShapeIterator.h, apiSimpleShapeUI.cpp, dynExprField.cpp, dynExprField.h, geometryCacheBlockDVAData.cpp, geometryCacheBlockDVAData.h, geometryCacheBlockFVAData.cpp, geometryCacheBlockFVAData.h, hairCollisionSolver.cpp, ownerEmitter.cpp, ownerEmitter.h, particleAttrNode.cpp, particlePathsCmd.cpp, particleSystemInfoCmd.cpp, pfxInfoCmd.cpp, simpleEmitter.cpp, simpleEmitter.h, simpleFluidEmitter.cpp, simpleFluidEmitter.h, simpleSpring.h, sweptEmitter.cpp, sweptEmitter.h, torusField.cpp, torusField.h, and XmlGeometryCache.cpp.

#include <MVectorArray.h>

List of all members.

Public Member Functions
	MVectorArray ()
	Default constructor.
	MVectorArray (const MVectorArray &other)
	Copy Constructor.
	MVectorArray (const MVector vectors[], unsigned int count)
	NO SCRIPT SUPPORT.
	MVectorArray (const double vectors[][3], unsigned int count)
	Create a new array of MVectors and initialize it with the given double array elements.
	MVectorArray (const float vectors[][3], unsigned int count)
	Create a new array of MVectors and initialize it with the given float array elements.
	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.
	~MVectorArray ()
	The class destructor.
const MVector &	operator[] (unsigned int index) const
	Index operator.
MVectorArray &	operator= (const MVectorArray &other)
	Assignment operator copies all of the elements of the other array into this one.
MStatus	set (const MVector &element, unsigned int index)
	Sets the value of the indicated element to the indicated MVector 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 MVector &element, unsigned int index)
	Inserts a new value into the array at the given index.
MStatus	append (const MVector &element)
	Adds a new element to the end of the array.
MStatus	copy (const MVectorArray &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.
MVector &	operator[] (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 MVectorArray &array)
	NO SCRIPT SUPPORT.

---

Constructor & Destructor Documentation

MVectorArray

(

)

Default constructor.

The instance is set to contain no elements.

MVectorArray

(

const MVectorArray &

other

)

Copy Constructor.

Parameters:

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

Parameters:

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

Parameters:

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

Parameters:

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

Parameters:

[in]	initialSize	the initial size of the array
[in]	initialValue	the initial value of each element

---

Member Function Documentation

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.

Parameters:

[in]

index

the index of the element whose value is to be returned

Returns:

The value of the indicated element.

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.

Parameters:

[in]

other

the array being copied

Returns:

A reference to this array

MStatus set	(	const MVector &	element,
		unsigned int	index
	)

Search for all occurrences

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.

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 set	(	double	element[3],
		unsigned int	index
	)

Search for all occurrences

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 set	(	float	element[3],
		unsigned int	index
	)

Search for all occurrences

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 setLength

(

unsigned int

length

)

Search for all occurrences

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:

particleAttrNode.cpp, particleSystemInfoCmd.cpp, simpleFluidEmitter.cpp, and XmlGeometryCache.cpp.

unsigned int length

(

)

const

Search for all occurrences

Returns the number of elements in the instance.

Returns:

The number of elements in the instance

Examples:

apiSimpleShapeUI.cpp, dynExprField.cpp, hairCollisionSolver.cpp, ownerEmitter.cpp, particlePathsCmd.cpp, particleSystemInfoCmd.cpp, pfxInfoCmd.cpp, simpleEmitter.cpp, simpleFluidEmitter.cpp, sweptEmitter.cpp, torusField.cpp, and XmlGeometryCache.cpp.

MStatus remove

(

unsigned int

index

)

Search for all occurrences

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 insert	(	const MVector &	element,
		unsigned int	index
	)

Search for all occurrences

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:

true if the insert was successful and false otherwise

MStatus append

(

const MVector &

element

)

Search for all occurrences

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:

apiMeshCreator.cpp, apiMeshShape.cpp, dynExprField.cpp, ownerEmitter.cpp, particleSystemInfoCmd.cpp, simpleEmitter.cpp, simpleFluidEmitter.cpp, sweptEmitter.cpp, and torusField.cpp.

MStatus copy

(

const MVectorArray &

source

)

Search for all occurrences

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 clear

(

)

Search for all occurrences

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.

• MS::kSuccess if the operation is successful and MS::kFailure otherwise

Examples:

ownerEmitter.cpp, simpleEmitter.cpp, sweptEmitter.cpp, and torusField.cpp.

MStatus get

(

double

array[][3]

)

const

Search for all occurrences

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 the array argument is a non-zero pointer and MS::kFailure otherwise

MStatus get

(

float

array[][3]

)

const

Search for all occurrences

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 the array argument is a non-zero pointer and MS::kFailure otherwise

void setSizeIncrement

(

unsigned int

newIncrement

)

Search for all occurrences

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

Parameters:

[in]

newIncrement

the new increment

unsigned int sizeIncrement

(

)

const

Search for all occurrences

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

Returns:

The size increment.

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.

Parameters:

[in]

index

the index of the desired element

Returns:

A reference to the indicated element

const char * className

(

)

[static]

Search for all occurrences

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 MVectorArray &	array
	)		[friend]

NO SCRIPT SUPPORT.

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 MVectorArray whose value is to be printed

Returns:

The ostream reference, s, provided as the first parameter.