MVertexBufferArray Class Reference

This reference page is linked to from the following overview topics: Extension for Autodesk Maya 2013.

---

Search for all occurrences

---

Detailed Description

Array of Vertex buffers.

This class represents an array of vertex buffers.

#include <MHWGeometry.h>

List of all members.

Public Member Functions
	MVertexBufferArray ()
	Constructor.
	~MVertexBufferArray ()
	Destructor.
unsigned int	count () const
	Get num of vertex buffers in list.
MVertexBuffer *	getBuffer (const MString &name) const
	Get vertex buffer based on name.
MVertexBuffer *	getBuffer (unsigned int index) const
	Get vertex buffer based at desired index.
MString	getName (unsigned int index) const
	Get the name of the buffer at desired index.
MStatus	addBuffer (const MString &name, MVertexBuffer *buffer)
	Add a new vertex buffer to the list.
void	clear ()
	Clear the array.
Static Public Member Functions
static const char *	className ()
	Returns the name of this class.

---

Member Function Documentation

unsigned int count

(

)

const

Search for all occurrences

Get num of vertex buffers in list.

Returns:

The size of the array

MVertexBuffer * getBuffer

(

const MString &

name

)

const

Search for all occurrences

Get vertex buffer based on name.

Parameters:

[in]

name

The name of the vertex buffer to look for.

Returns:

The vertex buffer pointer, NULL if no match found.

MVertexBuffer * getBuffer

(

unsigned int

index

)

const

Search for all occurrences

Get vertex buffer based at desired index.

Parameters:

[in]

index

The index of the vertex buffer to look for.

Returns:

The vertex buffer pointer, NULL if out of bound

MString getName

(

unsigned int

index

)

const

Search for all occurrences

Get the name of the buffer at desired index.

Parameters:

[in]

index

The index of the vertex buffer to look for.

Returns:

The registered name, empty string if out of bound

MStatus addBuffer	(	const MString &	name,
		MVertexBuffer *	buffer
	)

Search for all occurrences

Add a new vertex buffer to the list.

The list does not take ownership of the buffer.

Parameters:

[in]	name	The name of the vertex buffer
[in]	buffer	The vertex buffer to add

Returns:

Status code

Status Codes:

• MStatus::kSuccess The method was successful
• MStatus::kFailure A buffer is already registered for this name

void clear

(

)

Search for all occurrences

Clear the array.

The buffers are not deleted by this method.

const char * className

(

)

[static]

Search for all occurrences

Returns the name of this class.

Returns:

The name of this class.