DX::IDXSkin Struct Reference
#include <IDXSkin.h>
Inherits DX::IDXUserData, DX::IDXModelOwned, and DX::IDXMeshOwned.
List of all members.
|
Public Member Functions |
virtual DXError DXMCALL | AddSkinEntry (const char *groupid, const DXMatrix &offsetMatrix, IDXSkinEntryPtr *out)=0 |
virtual uint DXMCALL | GetNumSkinEntries () const =0 |
virtual DXError DXMCALL | GetSkinEntry (const char *groupID, IDXSkinEntryPtr *out) const =0 |
virtual DXError DXMCALL | GetSkinEntry (uint index, IDXSkinEntryPtr *out) const =0 |
virtual DXError DXMCALL | GetSkinEntries (IDXSkinEntryArray out) const =0 |
virtual DXError DXMCALL | GetSkinEntries (uint start, uint count, IDXSkinEntryArray out) const =0 |
virtual DXError DXMCALL | RemoveSkinEntry (const char *groupID)=0 |
virtual DXError DXMCALL | RemoveSkinEntry (IDXSkinEntryPtr skinEntry)=0 |
virtual DXError DXMCALL | RemoveSkinEntry (uint index)=0 |
virtual DXError DXMCALL | RemoveSkinEntry (uint start, uint count)=0 |
virtual void DXMCALL | ClearSkinEntries ()=0 |
Detailed Description
Controls assignment of vertices for skinning.
Member Function Documentation
virtual DXError DXMCALL DX::IDXSkin::AddSkinEntry |
( |
const char * |
groupid, |
|
|
const DXMatrix & |
offsetMatrix, |
|
|
IDXSkinEntryPtr * |
out | |
|
) |
| | [pure virtual] |
Create a new IDXSkinEntry. This will skin the specified groupID.
- Parameters:
-
| groupID | The ID of the group in the model to skin |
| out | A pointer to an IDXSkinEntryPtr where a copy will be saved. This may be null. |
- Returns:
- Error_NullParam if groupID was null.
Error_NotFound if the groupID specified could not be found in the model.
Error_Duplicate if an IDXSkinEntry already exists in the animation for the specified groupID.
Error_Success if the IDXSkinEntry was created and a copy saved in out.
virtual void DXMCALL DX::IDXSkin::ClearSkinEntries |
( |
|
) |
[pure virtual] |
Remove all IDXSkinEntryPtr from this IDXSkin.
virtual uint DXMCALL DX::IDXSkin::GetNumSkinEntries |
( |
|
) |
const [pure virtual] |
virtual DXError DXMCALL DX::IDXSkin::GetSkinEntries |
( |
uint |
start, |
|
|
uint |
count, |
|
|
IDXSkinEntryArray |
out | |
|
) |
| | const [pure virtual] |
Get a block of skin entries for this skin.
- Parameters:
-
| start | The index of the first element to retrieve. |
| count | The number of elements to retrieve. |
| out | A user allocated array of IDXSkinEntryPtr of length at least count 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::IDXSkin::GetSkinEntries |
( |
IDXSkinEntryArray |
out |
) |
const [pure virtual] |
Get all the skin entries on this skin.
- Parameters:
-
| out | A user allocated array of IDXSkinEntryPtr of length at least GetNumSkinEntries where the result will be stored. |
- Returns:
- Error_NullParam if out was null.
Error_Success if the result was stored in out.
virtual DXError DXMCALL DX::IDXSkin::GetSkinEntry |
( |
uint |
index, |
|
|
IDXSkinEntryPtr * |
out | |
|
) |
| | const [pure virtual] |
Get the IDXSkinEntryPtr at the speicified index.
- Parameters:
-
| index | The index of the IDXSkinEntryPtr to retrieve. |
| out | A pointer to an IDXSkinEntryPtr to output the result. |
- Returns:
- Error_NullParam if out was null.
Error_OutOfRange if index was not less than the number of IDXSkinEntryPtr in the IDXSkin.
Error_Success if an IDXSkinEntryPtr was saved in out.
virtual DXError DXMCALL DX::IDXSkin::GetSkinEntry |
( |
const char * |
groupID, |
|
|
IDXSkinEntryPtr * |
out | |
|
) |
| | const [pure virtual] |
Get the IDXSkinEntryPtr with the specified groupID.
- Parameters:
-
| groupID | The ID to search for. |
| out | A pointer to an IDXSkinEntryPtr to output the results. |
- Returns:
- Error_NullParam if out was null.
Error_NullParam if groupID was null.
Error_NotFound if there is no IDXSkinEntryPtr in the IDXSkinPtr with that group ID.
Error_Success if an IDXSkinEntryPtr was saved in out.
virtual DXError DXMCALL DX::IDXSkin::RemoveSkinEntry |
( |
uint |
start, |
|
|
uint |
count | |
|
) |
| | [pure virtual] |
Remove a range of IDXSkinEntry from this IDXSkin.
- Parameters:
-
| start | The index of the first element to remove. |
| count | The number of elements to remove. |
- Returns:
- Error_OutOfRange if start was out of range.
Error_Success if the IDXSkinEntryPtr was removed.
virtual DXError DXMCALL DX::IDXSkin::RemoveSkinEntry |
( |
uint |
index |
) |
[pure virtual] |
Remove the IDXSkinEntryPtr from the skin at the specified index.
- Parameters:
-
| index | The index of the IDXSkinEntryPtr to remove from the Skin. |
- Returns:
- Error_OutOfRange if index was not less than the number of skin entries.
Error_Success if the IDXSkinEntryPtr was removed.
virtual DXError DXMCALL DX::IDXSkin::RemoveSkinEntry |
( |
IDXSkinEntryPtr |
skinEntry |
) |
[pure virtual] |
Remove the IDXSkinEntryPtr from the Skin with the specified groupID.
- Parameters:
-
| skinEntry | The IDXSkinEntryPtr to remove. |
- Returns:
- Error_NullParam if IDXSkinEntryPtr was null.
Error_NotFound if the IDXSkinEntryPtr is not owned by this Skin.
Error_Success if the IDXSkinEntryPtr was removed
virtual DXError DXMCALL DX::IDXSkin::RemoveSkinEntry |
( |
const char * |
groupID |
) |
[pure virtual] |
Remove the IDXSkinEntry from the Skin with the specified groupID.
- Parameters:
-
| groupID | The groupID to search for. |
- Returns:
- Error_NullParam if the groupID was null.
Error_NotFound if there was no Skin Entry for the specified groupID.
Error_Success if the Skin Entry was removed