DX::IDXSkinEntry Struct Reference

#include <IDXSkinEntry.h>

Inherits DX::IDXModelOwned, DX::IDXSkinOwned, DX::IDXUserData, and DX::IDXHasFileBinding.

Collaboration diagram for DX::IDXSkinEntry:

Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual const DXMatrix DXMCALL GetOffsetMatrix () const =0
virtual const char *DXMCALL GetGroupID () const =0
virtual uint DXMCALL GetNumSkinVerts () const =0
virtual DXError DXMCALL GetSkinVert (uint index, IDXSkinVertPtr *out) const =0
virtual DXError DXMCALL GetSkinVerts (IDXSkinVertArray out) const =0
virtual DXError DXMCALL GetSkinVerts (uint start, uint count, IDXSkinVertArray out) const =0
virtual DXError DXMCALL GetSkinVertIndex (IDXSkinVertPtr vert, uint *out) const =0
virtual void DXMCALL SetOffsetMatrix (const DXMatrix &matrix)=0
virtual DXError DXMCALL SetGroupID (const char *id)=0
virtual void DXMCALL AddSkinVert (uint index, float weight)=0
virtual DXError DXMCALL RemoveSkinVert (uint index)=0
virtual DXError DXMCALL RemoveSkinVert (IDXSkinVertPtr vert)=0
virtual DXError DXMCALL RemoveSkinVert (uint start, uint count)=0
virtual void DXMCALL ClearSkinVerts ()=0


Detailed Description

Skin data for a specific group.

Member Function Documentation

virtual void DXMCALL DX::IDXSkinEntry::AddSkinVert ( uint  index,
float  weight 
) [pure virtual]

Add a skin vert to this SkinEntry.

Parameters:
vert A DXSkinVert to add.

virtual void DXMCALL DX::IDXSkinEntry::ClearSkinVerts (  )  [pure virtual]

Remove all skin verts from this skin entry.

virtual const char* DXMCALL DX::IDXSkinEntry::GetGroupID (  )  const [pure virtual]

Get the ID of the group that this skin entry is for.

Returns:
a const char* representing the group this skin entry skins.

virtual uint DXMCALL DX::IDXSkinEntry::GetNumSkinVerts (  )  const [pure virtual]

The number of verts that are attached to this skin entry.

Returns:
Number of attached verts.

virtual const DXMatrix DXMCALL DX::IDXSkinEntry::GetOffsetMatrix (  )  const [pure virtual]

Get the matrix that will be applied by this skin entry.

Returns:
A DXMatrix representing the skin transform

virtual DXError DXMCALL DX::IDXSkinEntry::GetSkinVert ( uint  index,
IDXSkinVertPtr *  out 
) const [pure virtual]

Get the skin vert at the specified index.

Parameters:
index The index of the skin vert to retrieve.
out A pointer to a DXSkinVert* where the result 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::IDXSkinEntry::GetSkinVertIndex ( IDXSkinVertPtr  vert,
uint *  out 
) const [pure virtual]

Get the index of the specified skin vert.

Parameters:
vert The IDXSkinVertPtr to look for.
out A pointer to a uint where the result will be stored.
Returns:
Error_NullParam if out was null.
Error_NullParam2 if vert was null.
Error_NotFound if the vert was not found.
Error_Success if the result was stored in out.

virtual DXError DXMCALL DX::IDXSkinEntry::GetSkinVerts ( uint  start,
uint  count,
IDXSkinVertArray  out 
) const [pure virtual]

Get a block of IDXSkinVertPtr from the entry.

Parameters:
start The index of the first element to retrieve.
count The number of elements to retrieve.
out A user allocated array of IDXSkinVertPtr where the result will be stored.
Returns:
Error_NullParam if out was null.
Error_OutOfRange if start was out of range.
Error_Success if the result was stored in out.

virtual DXError DXMCALL DX::IDXSkinEntry::GetSkinVerts ( IDXSkinVertArray  out  )  const [pure virtual]

Get all the skin verts on the skin entry.

Parameters:
out A user allocated array of IDXSkinVertPtr of length at least GetNumSkinVerts.
Returns:
Error_NullParam if out was null.
Error_Success if the result was stored in otu.

virtual DXError DXMCALL DX::IDXSkinEntry::RemoveSkinVert ( uint  start,
uint  count 
) [pure virtual]

Remove a range of skin verts from the skin entry.

Parameters:
start The index of the first element to remove.
end The number of elements to remove.
Returns:
Error_OutOfRange if start was out of range.
Error_Success if the range was removed.

virtual DXError DXMCALL DX::IDXSkinEntry::RemoveSkinVert ( IDXSkinVertPtr  vert  )  [pure virtual]

Remove the specified vert from the skin entry.

Parameters:
vert The IDXSkinVert to remove.
Returns:
Error_NullParam if vert was null.
Error_NotFound if the vert was not found.
Error_Success if the vert was removed.

virtual DXError DXMCALL DX::IDXSkinEntry::RemoveSkinVert ( uint  index  )  [pure virtual]

Remove the skin vert at the specified index.

Parameters:
index The index of the skin vert to remove.
Returns:
Error_OutOfRange if the index was out of range.
Error_Success if the SkinVert was removed.

virtual DXError DXMCALL DX::IDXSkinEntry::SetGroupID ( const char *  id  )  [pure virtual]

Set the group ID that this skin entry is for.

Parameters:
id The id of the group.
Returns:
Error_NullParam if id was null.
Error_Duplicate if there was already an entry for this id.
Error_NotFound if there was no group with this id.
Error_Success if the id was updated.

virtual void DXMCALL DX::IDXSkinEntry::SetOffsetMatrix ( const DXMatrix &  matrix  )  [pure virtual]

Set the matrix that will be applied with this skin entry.

Parameters:
matrix A DXMatrix.


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