Main Page | Class Hierarchy | Class List | File List | Class Members | File Members

RmVertexArray Class Reference

Vertex Array class. More...

#include <RmMesh.h>

List of all members.

Public Member Functions

 RmVertexArray ()
 Constructor.

virtual ~RmVertexArray ()
 Destructor.

bool CreateVertexElementArray (RmStreamChannelUsageType usage, int nUsageIndex, RmStreamChannelDataType dataType)
 Create vertex element array.

void DestroyVertexElementArray (RmStreamChannelUsageType usage, int nUsageIndex, RmStreamChannelDataType dataType)
 Destroy one vertex element array.

void DestroyAllVertexElementArrays ()
 Destroy all vertex elements.

RmVertexElementArrayGetVertexElementArray (RmStreamChannelUsageType usage, int nUsageIndex, RmStreamChannelDataType dataType)
 Get element array.

const RmVertexElementArrayGetVertexElementArray (RmStreamChannelUsageType usage, int nUsageIndex, RmStreamChannelDataType dataType) const
 Get element array.

void SetNumVertices (int nNumVertices, bool bPreserve)
 Set number of vertices.

int GetNumVertices () const
 Number of vertices.

RmVertexElementArrayListIterator BeginElementArray ()
 Begin iterator.

RmVertexElementArrayListConstIterator BeginElementArray () const
 Begin iterator.

RmVertexElementArrayListIterator EndElementArray ()
 End iterator.

RmVertexElementArrayListConstIterator EndElementArray () const
 End iterator.

void Copy (RmVertexArray *pDestArray)
 Copy.


Detailed Description

Vertex Array class.

VertexArray ( collection of element array )


Constructor & Destructor Documentation

RmVertexArray::RmVertexArray  ) 
 

Constructor.

Constructor

virtual RmVertexArray::~RmVertexArray  )  [virtual]
 

Destructor.

Destructor


Member Function Documentation

RmVertexElementArrayListConstIterator RmVertexArray::BeginElementArray  )  const [inline]
 

Begin iterator.

Begin iterator for element array

Returns:
Begin iterator

RmVertexElementArrayListIterator RmVertexArray::BeginElementArray  )  [inline]
 

Begin iterator.

Begin iterator for element array

Returns:
Begin iterator

void RmVertexArray::Copy RmVertexArray pDestArray  ) 
 

Copy.

Copy ( copies data to destination )

Parameters:
pDestArray Array

bool RmVertexArray::CreateVertexElementArray RmStreamChannelUsageType  usage,
int  nUsageIndex,
RmStreamChannelDataType  dataType
 

Create vertex element array.

Creates a vertex element array of a specific usage, index, and data type

Parameters:
usage Usage of vertex
See also:
RmStreamChannelUsageType
Parameters:
nUsageIndex Usage index
dataType Data yype
See also:
RmStreamChannelDataType
Returns:
True on success

void RmVertexArray::DestroyAllVertexElementArrays  ) 
 

Destroy all vertex elements.

Destroys all vertex element arrays

Returns:
None

void RmVertexArray::DestroyVertexElementArray RmStreamChannelUsageType  usage,
int  nUsageIndex,
RmStreamChannelDataType  dataType
 

Destroy one vertex element array.

Destroys a vertex element array of a specific usage, index, and data type

Parameters:
usage Usage of vertex
See also:
RmStreamChannelUsageType
Parameters:
nUsageIndex Usage index
dataType Data yype
See also:
RmStreamChannelDataType
Returns:
None

RmVertexElementArrayListConstIterator RmVertexArray::EndElementArray  )  const [inline]
 

End iterator.

End iterator for element array

Returns:
End iterator

RmVertexElementArrayListIterator RmVertexArray::EndElementArray  )  [inline]
 

End iterator.

End iterator for element array

Returns:
End iterator

int RmVertexArray::GetNumVertices  )  const [inline]
 

Number of vertices.

Gets the number of vertices in the vertex array

Returns:
Number of vertices

const RmVertexElementArray* RmVertexArray::GetVertexElementArray RmStreamChannelUsageType  usage,
int  nUsageIndex,
RmStreamChannelDataType  dataType
const
 

Get element array.

Gets a vertex element array of a specific usage, index, and data type

Parameters:
usage Usage of vertex
See also:
RmStreamChannelUsageType
Parameters:
nUsageIndex Usage index
dataType Data type
See also:
RmStreamChannelDataType
Returns:
Element array
See also:
RmVertexElementArray

RmVertexElementArray* RmVertexArray::GetVertexElementArray RmStreamChannelUsageType  usage,
int  nUsageIndex,
RmStreamChannelDataType  dataType
 

Get element array.

Gets a vertex element array of a specific usage, index, and data type

Parameters:
usage Usage of vertex
See also:
RmStreamChannelUsageType
Parameters:
nUsageIndex Usage index
dataType Data type
See also:
RmStreamChannelDataType
Returns:
Element array
See also:
RmVertexElementArray

void RmVertexArray::SetNumVertices int  nNumVertices,
bool  bPreserve
 

Set number of vertices.

Resizes the number of vertices in the vertex array

Parameters:
nNumVertices Number of vertices to set to
bPreserve Flag to preserve already allocated data.


The documentation for this class was generated from the following file:
Generated on Fri Feb 25 16:09:34 2005 for RenderMonkey SDK by doxygen 1.3.6