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

#include <MObjectArray.h>

List of all members.

---

Detailed Description

Array of MObjects data type.

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

animExportUtil.cpp, apiMeshData.cpp, apiMeshData.h, apiMeshIterator.cpp, apiMeshIterator.h, apiMeshShape.cpp, apiMeshShape.h, apiMeshShapeUI.cpp, apiSimpleShape.cpp, apiSimpleShape.h, apiSimpleShapeIterator.cpp, apiSimpleShapeIterator.h, apiSimpleShapeUI.cpp, cgfxShaderCmd.cpp, cgfxShaderNode.cpp, cgfxShaderNode.h, cleanPerFaceAssignmentCmd.cpp, clusterWeightFunction.cpp, createClipCmd.cpp, D3DGeometryItem.cpp, D3DViewportRenderer.cpp, findFileTexturesCmd.cpp, findTexturesPerPolygonCmd.cpp, geometrySurfaceConstraint.cpp, geometrySurfaceConstraint.h, getAttrAffectsCmd.cpp, hairCollisionSolver.cpp, hwManagedTextureShader.cpp, maTranslator.cpp, meshMapUtils.cpp, meshMapUtils.h, meshRemapCmd.cpp, meshRemapTool.h, meshReorderCmd.cpp, meshReorderTool.h, motionTraceCmd.cpp, narrowPolyViewer.h, objExport.cpp, OpenGLViewportRenderer.cpp, polyModifierCmd.cpp, polyWriter.h, and slopeShaderBehavior.cpp.

Public Member Functions
	MObjectArray ()
	MObjectArray (const MObjectArray &other)
	MObjectArray (unsigned int initialSize, const MObject &initialValue=MObject::kNullObj)
	~MObjectArray ()
const MObject &	operator[] (unsigned int index) const
MStatus	set (const MObject &element, unsigned int index)
MStatus	setLength (unsigned int length)
unsigned int	length () const
MStatus	remove (unsigned int index)
MStatus	insert (const MObject &element, unsigned int index)
MStatus	append (const MObject &element)
MStatus	clear ()
void	setSizeIncrement (unsigned int newIncrement)
unsigned int	sizeIncrement () const
	MObjectArray (const MObject src[], unsigned int count)
	NO SCRIPT SUPPORT.
MStatus	get (MObject array[]) const
	NO SCRIPT SUPPORT.
MObject &	operator[] (unsigned int index)
	NO SCRIPT SUPPORT.

---

Constructor & Destructor Documentation

MObjectArray::MObjectArray

(

)

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

MObjectArray::MObjectArray

(

const MObjectArray &

other

)

Copy Constructor.

Parameters:

[in]

other

the array with which to initialize this instance

MObjectArray::MObjectArray	(	unsigned int	initialSize,
		const MObject &	initialValue = MObject::kNullObj
	)

Create a new array of MObjects 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

MObjectArray::~MObjectArray

(

)

Class Destructor

MObjectArray::MObjectArray	(	const MObject	src[],
		unsigned int	count
	)

NO SCRIPT SUPPORT.

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

Parameters:

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

---

Member Function Documentation

const MObject & MObjectArray::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:

A reference to the indicated element

MStatus MObjectArray::set	(	const MObject &	element,
		unsigned int	index
	)

Sets the value of the indicated element to the indicated MObject 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 MObjectArray::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 MObjectArray::length

(

)

const

Returns the number of elements in the instance.

Returns:

The number of elements in the instance

Examples:

animExportUtil.cpp, apiMeshShape.cpp, cgfxShaderCmd.cpp, cleanPerFaceAssignmentCmd.cpp, clusterWeightFunction.cpp, D3DViewportRenderer.cpp, findFileTexturesCmd.cpp, findTexturesPerPolygonCmd.cpp, getAttrAffectsCmd.cpp, hwManagedTextureShader.cpp, meshMapUtils.cpp, motionTraceCmd.cpp, OpenGLViewportRenderer.cpp, and slopeShaderBehavior.cpp.

MStatus MObjectArray::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 MObjectArray::insert	(	const MObject &	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

Examples:

animExportUtil.cpp.

MStatus MObjectArray::append

(

const MObject &

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:

animExportUtil.cpp, clusterWeightFunction.cpp, createClipCmd.cpp, findFileTexturesCmd.cpp, geometrySurfaceConstraint.cpp, motionTraceCmd.cpp, polyModifierCmd.cpp, and slopeShaderBehavior.cpp.

MStatus MObjectArray::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:

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

Examples:

geometrySurfaceConstraint.cpp, and slopeShaderBehavior.cpp.

void MObjectArray::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 MObjectArray::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 MObjectArray::get

(

MObject

array[]

)

const

NO SCRIPT SUPPORT.

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

MObject & MObjectArray::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