MVertexBufferArray Class Reference

#include <MHWGeometry.h>

Class Description

Public Member Functions

 MVertexBufferArray ()
 Constructor.
 
 ~MVertexBufferArray ()
 Destructor.
 
unsigned int count () const
 Get num of vertex buffers in list. More...
 
MVertexBuffergetBuffer (const MString &name) const
 Get vertex buffer based on name. More...
 
MVertexBuffergetBuffer (unsigned int index) const
 Get vertex buffer based at desired index. More...
 
MString getName (unsigned int index) const
 Get the name of the buffer at desired index. More...
 
MStatus addBuffer (const MString &name, MVertexBuffer *buffer)
 Add a new vertex buffer to the list. More...
 
void clear ()
 Clear the array. More...
 

Static Public Member Functions

static const char * className ()
 Returns the name of this class. More...
 

Member Function Documentation

unsigned int count ( ) const
MVertexBuffer * getBuffer ( const MString name) const

Get vertex buffer based on name.

Parameters
[in]nameThe name of the vertex buffer to look for.
Returns
The vertex buffer pointer, NULL if no match found.
+ Examples:
MVertexBuffer * getBuffer ( unsigned int  index) const

Get vertex buffer based at desired index.

Parameters
[in]indexThe index of the vertex buffer to look for.
Returns
The vertex buffer pointer, NULL if out of bound
MString getName ( unsigned int  index) const

Get the name of the buffer at desired index.

Parameters
[in]indexThe 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 
)

Add a new vertex buffer to the list.

The list does not take ownership of the buffer.

Parameters
[in]nameThe name of the vertex buffer
[in]bufferThe vertex buffer to add
Returns
Status code
Status Codes:
+ Examples:
void clear ( )

Clear the array.

The buffers are not deleted by this method.

const char * className ( )
static

Returns the name of this class.

Returns
The name of this class.

The documentation for this class was generated from the following files:
  • MHWGeometry.h
  • MHWGeometry.cpp