DX::IDXFace Struct Reference

#include <IDXFace.h>

Inherits DX::IDXModelOwned, DX::IDXMeshOwned, and DX::IDXUserData.

Collaboration diagram for DX::IDXFace:

Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual DXError DXMCALL GetVertexIndex (uint index, uint *out) const =0
virtual uint DXMCALL GetMaterialIndex () const =0
virtual DXError DXMCALL SetVertexIndex (uint index, uint value)=0
virtual DXError DXMCALL SetMaterialIndex (uint index)=0


Detailed Description

An IDXFace represents a face on a model. It has vertex indices and a material index.

Member Function Documentation

virtual uint DXMCALL DX::IDXFace::GetMaterialIndex (  )  const [pure virtual]

Get the index into the mesh's materialmaps array that this face is using.

virtual DXError DXMCALL DX::IDXFace::GetVertexIndex ( uint  index,
uint *  out 
) const [pure virtual]

Get the vertex index at the specified index in the face.

Parameters:
index The index in the face to retrieve.
out A pointer to a uint where the vertex index (index into IDXMesh vertex array) will be stored.
Returns:
Error_NullParam if out was null.
Error_OutOfRange if index was out of range.
Error_Success if the result was stored in out.

virtual DXError DXMCALL DX::IDXFace::SetMaterialIndex ( uint  index  )  [pure virtual]

Set the material index for this face. This is an index into the materialmaps array on the IDXMesh.

Parameters:
index The index into the materialmaps array to use.
Returns:
Error_OutOfRange if index was out of range.
Error_Success if the material index was updated.

virtual DXError DXMCALL DX::IDXFace::SetVertexIndex ( uint  index,
uint  value 
) [pure virtual]

Set the vertex at the specified index in the face to the specified mesh vertex index.

Parameters:
index The index of the vertex in the face (0, 1, 2)
value The index of the vertex in the mesh
Returns:
Error_OutOfRange if index was out of range.
Error_OutOfRange2 if value was out of range.
Error_Success if the vertex index was set.


Generated on Wed Jun 17 17:24:50 2009 for DXMesh API by  doxygen 1.5.7.1