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

#include <MDagPathArray.h>

List of all members.

---

Detailed Description

Indexable Array of DAG Paths.

Provides methods for manipulating arrays of DAG Paths.

Arrays of DAG Paths are useful for storing and manipluating multiple Paths to a particular DAG Node. The DAG Path method MDagPath::getAllPathsTo() and DAG Node Function Set method MFnDagNode::getAllPaths() implicitly return an array of DAG Paths.

These arrays may also be used to manage Paths for a number of different Nodes.

DAG Path arrays are used in conjunction with DAG Paths (MDagPath) and individual elements of the arrays can be parameters to some methods of the DAG Node Function Set (MFnDagNode).

Use this DAG Path Array Class to create and manipulate arrays of DAG Paths, for either a particular DAG Node or a number of different DAG Nodes.

The length of the array adjusts automatically.

Examples:

exportSkinClusterDataCmd.cpp, instancerListCmd.cpp, listLightLinksCmd.cpp, maTranslator.cpp, meshMapUtils.cpp, meshMapUtils.h, meshRemapCmd.cpp, meshRemapTool.h, meshReorderCmd.cpp, meshReorderTool.h, narrowPolyViewer.cpp, narrowPolyViewer.h, and narrowPolyViewerCmd.h.

Public Member Functions
	MDagPathArray ()
	MDagPathArray (const MDagPathArray &other)
	~MDagPathArray ()
const MDagPath &	operator[] (unsigned int index) const
MDagPathArray &	operator= (const MDagPathArray &other)
MStatus	setLength (unsigned int length)
unsigned int	length () const
MStatus	remove (unsigned int index)
MStatus	insert (const MDagPath &element, unsigned int index)
MStatus	append (const MDagPath &element)
MStatus	clear ()
MDagPath &	operator[] (unsigned int index)
Friends
OPENMAYA_EXPORT std::ostream &	operator<< (std::ostream &os, const MDagPathArray &array)
	NO SCRIPT SUPPORT.

---

Constructor & Destructor Documentation

MDagPathArray::MDagPathArray

(

)

Class Constructor

Creates a DAG Path Array

MDagPathArray::MDagPathArray

(

const MDagPathArray &

other

)

Copy Constructor.

Parameters:

[in]

other

the array with which to initialize this instance

MDagPathArray::~MDagPathArray

(

)

Class Destructor

No additional action.

---

Member Function Documentation

const MDagPath & MDagPathArray::operator[]

(

unsigned int

index

)

const

Retrieves the read-only DAG Path which is at the specified index in the array.

Parameters:

[in]

index

Zero-based index to the array

Returns:

DAG Path at the specified index

MDagPathArray & MDagPathArray::operator=

(

const MDagPathArray &

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

Examples:

meshRemapCmd.cpp, and meshReorderCmd.cpp.

unsigned int MDagPathArray::length

(

)

const

Determines the number of elements in the array.

Returns:

Number of elements in the array

Examples:

listLightLinksCmd.cpp, meshMapUtils.cpp, and narrowPolyViewer.cpp.

MStatus MDagPathArray::remove

(

unsigned int

index

)

Removes the DAG Path which is at the specified index in the array.

Parameters:

[in]

index

Zero-based index to the array

Returns:

MS::kSuccess on success, otherwise MS::kFailure

MStatus MDagPathArray::insert	(	const MDagPath &	element,
		unsigned int	index
	)

Inserts the given DAG Path at the specified index in the array.

Parameters:

[in]	element	DAG Path to be inserted
[in]	index	Zero-based index to the array

Returns:

MS::kSuccess on success, otherwise MS::kFailure

MStatus MDagPathArray::append

(

const MDagPath &

element

)

Appends the given DAG Path to the end of the array.

Parameters:

[in]

element

DAG Path to be appended

Returns:

MS::kSuccess on success, otherwise MS::kFailure

Examples:

narrowPolyViewer.cpp.

MStatus MDagPathArray::clear

(

)

Clears this array. Length of the array becomes zero.

Returns:

MS::kSuccess on success, otherwise MS::kFailure

Examples:

listLightLinksCmd.cpp, and narrowPolyViewer.cpp.

MDagPath & MDagPathArray::operator[]

(

unsigned int

index

)

Retrieves the DAG Path which is at the specified index in the array.

Parameters:

[in]

index

Zero-based index to the array

Returns:

DAG Path at the specified index

---

Friends And Related Function Documentation

OPENMAYA_EXPORT std::ostream& operator<<	(	std::ostream &	os,
		const MDagPathArray &	array
	)			[friend]

NO SCRIPT SUPPORT.

Print the contents of the given MDagPathArray on the given ostream. The format used is [fullPathName, fullPathName, fullPathName, ... fullPathName].

Parameters:

[in]	os	the ostream to print to
[in]	array	the MDagPathArray whose value is to be printed

Returns:

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