class MMatrixArray

Jump to documentation

public members:

	MMatrixArray ()
	MMatrixArray ( const MMatrixArray & other )
	MMatrixArray ( unsigned initialSize )
	~MMatrixArray ()
const MMatrix &	operator[] ( unsigned index ) const
MMatrix &	operator[] ( unsigned index )
MMatrixArray &	operator= ( const MMatrixArray & other )
MStatus	set ( const MMatrix & element, unsigned index )
MStatus	setLength ( unsigned length )
unsigned	length () const
MStatus	remove ( unsigned index )
MStatus	insert ( const MMatrix & element, unsigned index )
MStatus	append ( const MMatrix & element )
MStatus	copy ( const MMatrixArray & source )
MStatus	clear ()
void	setSizeIncrement ( unsigned newIncrement )
unsigned	sizeIncrement () const
friend std::ostream &	operator<< (std::ostream &os, const MMatrixArray &array)

Documentation

Description

This class implements an array of MMatrix's. 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

MMatrixArray:: MMatrixArray ()

Description

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

MMatrixArray:: MMatrixArray ( const MMatrixArray & other )

Description

Copy Constructor.

Arguments

• other the array with which to initialize this instance

MMatrixArray:: MMatrixArray ( unsigned initialSize )

Description

Create a new array of MMatrix's of a specified size and initialize all the elements as the identity matrix

Arguments

• initialSize the initial size of the array

MMatrixArray:: ~MMatrixArray ()

Description

The class destructor.

const MMatrix & MMatrixArray:: operator[] ( unsigned 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.

MMatrix & MMatrixArray:: operator[] ( unsigned 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

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

Description

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 then this array will also become a reference rather than doing a full copy.

Arguments

• other the array being copied

Return Value

• a reference to this array

MStatus MMatrixArray:: setLength ( unsigned 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 MMatrixArray:: length () const

Description

Returns the number of elements in the instance.

Return Value

• the number of elements in the instance

MStatus MMatrixArray:: remove ( unsigned 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 MMatrixArray:: insert ( const MMatrix & element, unsigned 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

• true if the insert was successful and false otherwise

MStatus MMatrixArray:: set ( const MMatrix & element, unsigned index )

Description

Sets the value of the indicated element to the indicated MMatrix 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 MMatrixArray:: append ( const MMatrix & 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 MMatrixArray:: copy ( const MMatrixArray & 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 MMatrixArray:: 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

void MMatrixArray:: setSizeIncrement ( unsigned newIncrement )

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

Arguments

• newIncrement the new increment

unsigned MMatrixArray:: 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

std::ostream& operator<< (std::ostream &os, const MMatrixArray &array)

Description

Print the contents of the given MMatrixArray on the given ostream. The format used is:

element 0: [[r11, r12, r13, r14] [r21, r22, r23, r24] [r31, r32, r33, r34] [r41, r42, r43, r44]]

...

element n-1: [[r11, r12, r13, r14] [r21, r22, r23, r24] [r31, r32, r33, r34] [r41, r42, r43, r44]]

Where "n" is the length of the given MMatrixArray

Arguments

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

Return Value

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

This class has no child classes.