MPlugArray Class Reference
[OpenMaya - API module for common classes]

#include <MPlugArray.h>

List of all members.

---

Detailed Description

Array of MPlugs data type.

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.

Examples:

affectsNode.cpp, animExportUtil.cpp, animExportUtil.h, cgfxAttrDef.cpp, createClipCmd.cpp, cvColorShader.cpp, D3DViewportRenderer.cpp, dagPoseInfoCmd.cpp, exportJointClusterDataCmd.cpp, findFileTexturesCmd.cpp, findTexturesPerPolygonCmd.cpp, GLSLShaderNode.cpp, maTranslator.cpp, nodeInfoCmd.cpp, particleAttrNode.cpp, polyModifierCmd.cpp, polyWriter.cpp, ShadingConnection.cpp, and slopeShaderBehavior.cpp.

Public Member Functions
	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.
Friends
class	MPlug

---

Constructor & Destructor Documentation

MPlugArray::MPlugArray

(

)

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

MPlugArray::MPlugArray

(

const MPlugArray &

other

)

Copy Constructor.

Parameters:

[in]

other

the array with which to initialize this instance

MPlugArray::~MPlugArray

(

)

Class Destructor

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

NO SCRIPT SUPPORT.

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

Parameters:

[in]	src	an array of MPlugs
[in]	count	the number of elements in the src array

---

Member Function Documentation

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

Returns:

The value of the indicated element

MPlugArray & MPlugArray::operator=

(

const MPlugArray &

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

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

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 MPlugArray::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

unsigned int MPlugArray::length

(

)

const

Returns the number of elements in the instance.

Returns:

The number of elements in the instance

Examples:

animExportUtil.cpp, cgfxAttrDef.cpp, createClipCmd.cpp, D3DViewportRenderer.cpp, dagPoseInfoCmd.cpp, findFileTexturesCmd.cpp, findTexturesPerPolygonCmd.cpp, GLSLShaderNode.cpp, maTranslator.cpp, nodeInfoCmd.cpp, particleAttrNode.cpp, polyModifierCmd.cpp, polyWriter.cpp, ShadingConnection.cpp, and slopeShaderBehavior.cpp.

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

(

const MPlug &

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:

affectsNode.cpp, and polyModifierCmd.cpp.

MStatus MPlugArray::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.

Returns:

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

Examples:

polyModifierCmd.cpp.

void MPlugArray::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 MPlugArray::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

MStatus MPlugArray::get

(

MPlug

array[]

)

const

NO SCRIPT SUPPORT.

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.

Parameters:

[out]

array

the array to populate

Returns:

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

MPlug MPlugArray::operator[]

(

unsigned int

index

)

NO SCRIPT SUPPORT.

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

Returns:

The value of the indicated element