class MFloatArray

Jump to documentation

public members:

	MFloatArray ()
	MFloatArray ( const MFloatArray & other )
	MFloatArray ( const float src[], unsigned int count )
	MFloatArray ( const double src[], unsigned int count )
	MFloatArray ( unsigned int initialSize, float initialValue = 0 )
	~MFloatArray ()
float	operator[] ( unsigned int index ) const
float &	operator[] ( unsigned int index )
MFloatArray &	operator= ( const MFloatArray & other )
MStatus	set ( float element, unsigned int index )
MStatus	set ( double element, unsigned int index )
MStatus	setLength ( unsigned int length )
unsigned int	length () const
MStatus	remove ( unsigned int index )
MStatus	insert ( float element, unsigned int index )
MStatus	append ( float element )
MStatus	copy ( const MFloatArray & source )
MStatus	clear ()
MStatus	get ( float[] ) const
MStatus	get ( double[] ) const
void	setSizeIncrement ( unsigned int newIncrement )
unsigned int	sizeIncrement () const
friend ostream &	operator<< (ostream &os, const MFloatArray &array)

Documentation

Description

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

Functions

MFloatArray:: MFloatArray ()

Description

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

MFloatArray:: MFloatArray ( const MFloatArray & other )

Description

Copy Constructor.

Arguments

• other the array with which to initialize this instance

MFloatArray:: MFloatArray ( const float src[], unsigned int count )

Description

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

Arguments

• src a C++ array of floats
• count the number of elements in the src array

MFloatArray:: MFloatArray ( const double src[], unsigned int count )

Description

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

Arguments

• src a C++ array of floats
• count the number of elements in the src array

MFloatArray:: MFloatArray ( unsigned int initialSize, float initialValue )

Description

Create a new array of floats of a specified size and initialize all the elements with the given initial value.

Arguments

• initialSize the initial size of the array
• initialValue the initial value of each element

MFloatArray:: ~MFloatArray ()

Description

The class destructor.

float MFloatArray:: operator[] ( unsigned int index ) const

Description

Index operator. Returns the value of the element at the given index. No range checking is done - valid indices are 0 to length()-1.

Arguments

• index the index of the element whose value is to be returned

Return Value

• the value of the indicated element.

float& MFloatArray:: operator[] ( unsigned int index )

Description

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.

Arguments

• index the index of the desired element

Return Value

• a reference to the indicated element

MFloatArray & MFloatArray:: operator= ( const MFloatArray & other )

Description

Assignment operator copies all of the elements of the other array into this one.

Arguments

• other the array being copied

Return Value

• a reference to this array

MStatus MFloatArray:: setLength ( unsigned int length )

Description

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

Arguments

• size the new size of the array

unsigned int MFloatArray:: length () const

Description

Returns the number of elements in the instance.

Return Value

• the number of elements in the instance

MStatus MFloatArray:: remove ( unsigned int index )

Description

Remove the array element at the given index. All array elements following the removed element are shifted toward the first element.

Arguments

• index index of the element to be removed

Return Value

• MS::kSuccess if the remove was successful and MS::kFailure otherwise

MStatus MFloatArray:: insert ( float element, unsigned int index )

Description

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.

Arguments

• element the new value to insert into the array
• index the index of the element to set to the the new value

Return Value

• MS::kSuccess if the insert was successful and MS::kFailure otherwise

MStatus MFloatArray:: set ( float element, unsigned int index )

Description

Sets the value of the indicated element to the indicated float value.

NOTE: This method does not grow the array if the index is out of bounds. Only a valid index should be used.

Arguments

• element the new value for the indicated element
• index the index of the element that is to be set to the the new value

Return Value

• MS::kSuccess if the value was set successfully and MS::kFailure otherwise

MStatus MFloatArray:: set ( double element, unsigned int index )

Description

Sets the value of the indicated element to the indicated double value.

NOTE: This method does not grow the array if the index is out of bounds. Only a valid index should be used.

Arguments

• element the new value for the indicated element
• index the index of the element that is to be set to the the new value

Return Value

• MS::kSuccess if the value was set successfully and MS::kFailure otherwise

MStatus MFloatArray:: append ( float element )

Description

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.

Arguments

• element the value for the new last element

Return Value

• MS::kSuccess if the append was successful and MS::kFailure otherwise

MStatus MFloatArray:: copy ( const MFloatArray & source )

Description

Copy the contents of the source array to this array.

Arguments

• source array to copy from

Return Value

• MS::kSuccess if the copy was successful and MS::kFailure otherwise

MStatus MFloatArray:: clear ()

Description

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

MStatus MFloatArray:: get ( float array[] ) const

Description

Copy the elements of the array into the given C++ array of floats. No checking is done to ensure that the destination C++ array of floats is large enough to hold all the elements of the instance.

Arguments

• array the array to populate

Return Value

• MS::kSuccess if the array argument is a non-zero pointer and MS::kFailure otherwise

MStatus MFloatArray:: get ( double array[] ) const

Description

Copy the elements of the array into the given C++ array of doubles. No checking is done to ensure that the destination C++ array of doubles is large enough to hold all the elements of the instance.

Arguments

• array the array to populate

Return Value

• MS::kSuccess if the array argument is a non-zero pointer and MS::kFailure otherwise

void MFloatArray:: setSizeIncrement ( unsigned int newIncrement )

Description

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

Arguments

• newIncrement the new increment

unsigned int MFloatArray:: sizeIncrement () const

Description

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

Return Value

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

ostream& operator<< (ostream &os, const MFloatArray &array)

Description

Print the contents of the given MFloatArray on the given ostream. The format used is [1.1, 2.2, 3.3, ... 9.9].

Arguments

• os the ostream to print to
• array the MFloatArray whose value is to be printed

Return Value

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

This class has no child classes.