class MPlugArray

Jump to documentation

public members:

	MPlugArray ()
	MPlugArray ( const MPlugArray & other )
	~MPlugArray ()
MPlug	operator[] ( unsigned int index ) const
MPlugArray &	operator= ( const MPlugArray & other )
MStatus	set ( const MPlug & element, unsigned int index )
MStatus	setLength ( unsigned int length )
unsigned int	length () const
MStatus	remove ( unsigned int index )
MStatus	insert ( const MPlug & element, unsigned int index )
MStatus	append ( const MPlug & element )
MStatus	clear ()
void	setSizeIncrement ( unsigned int newIncrement )
unsigned int	sizeIncrement () const
	MPlugArray ( const MPlug src[], unsigned int count ) NO SCRIPT SUPPORT
MStatus	get ( MPlug dest[] ) const NO SCRIPT SUPPORT
MPlug	operator[] ( unsigned int index ) NO SCRIPT SUPPORT

Documentation

Description

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

MPlugArray:: MPlugArray ( )

Description

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

MPlugArray:: MPlugArray ( const MPlugArray & other )

Description

Copy Constructor.

Arguments

• other the array with which to initialize this instance

MPlugArray:: MPlugArray ( const MPlug src[], unsigned int count )

Description

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

Arguments

• src an array of MPlugs
• count the number of elements in the src array

MPlugArray:: ~MPlugArray ()

Description

Class Destructor

MPlug MPlugArray:: 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 desired element

Return Value

• the value of the indicated element

MPlug MPlugArray:: operator[] ( unsigned int index )

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 desired element

Return Value

• the value of the indicated element

MPlugArray & MPlugArray:: operator= ( const MPlugArray & 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 MPlugArray:: 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 MPlugArray:: length () const

Description

Returns the number of elements in the instance.

Return Value

• the number of elements in the instance

MStatus MPlugArray:: 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 MPlugArray:: insert ( const MPlug & 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 MPlugArray:: set ( const MPlug & element, unsigned int index )

Description

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

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 MPlugArray:: append ( const MPlug & 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 MPlugArray:: 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.

Return Value

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

MStatus MPlugArray:: get ( MPlug array[] ) const

Description

Copy the elements of the array into the given array of MPlugs. No checking is done to ensure that the destination array of MPlugs 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 MPlugArray:: 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 MPlugArray:: 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

This class has no child classes.