DX::IDXGroupAnim Struct Reference

#include <IDXGroupAnim.h>

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

Collaboration diagram for DX::IDXGroupAnim:

Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual const char *DXMCALL GetGroupID () const =0
virtual uint DXMCALL GetNumTranslationKeys () const =0
virtual uint DXMCALL GetNumRotationKeys () const =0
virtual uint DXMCALL GetNumScaleKeys () const =0
virtual DXError DXMCALL GetTranslationKey (uint index, IDXTranslationKeyPtr *out) const =0
virtual DXError DXMCALL GetTranslationKeys (uint start, uint count, IDXTranslationKeyArray out) const =0
virtual DXError DXMCALL GetTranslationKeys (IDXTranslationKeyArray out) const =0
virtual DXError DXMCALL GetRotationKey (uint index, IDXRotationKeyPtr *out) const =0
virtual DXError DXMCALL GetRotationKeys (uint start, uint count, IDXRotationKeyArray out) const =0
virtual DXError DXMCALL GetRotationKeys (IDXRotationKeyArray out) const =0
virtual DXError DXMCALL GetScaleKey (uint index, IDXScaleKeyPtr *out) const =0
virtual DXError DXMCALL GetScaleKeys (uint start, uint count, IDXScaleKeyArray out) const =0
virtual DXError DXMCALL GetScaleKeys (IDXScaleKeyArray out) const =0
virtual DXError DXMCALL GetTranslationKeyIndex (IDXTranslationKeyPtr key, uint *out) const =0
virtual DXError DXMCALL GetRotationKeyIndex (IDXRotationKeyPtr key, uint *out) const =0
virtual DXError DXMCALL GetScaleKeyIndex (IDXScaleKeyPtr key, uint *out) const =0
virtual DXError DXMCALL SetGroupID (const char *id)=0
virtual DXError DXMCALL AddTranslationKey (float time, const DXVector &translation)=0
virtual DXError DXMCALL AddRotationKey (float time, const DXRotation &rotation)=0
virtual DXError DXMCALL AddScaleKey (float time, const DXVector &scale)=0
virtual DXError DXMCALL RemoveTranslationKey (uint index)=0
virtual DXError DXMCALL RemoveTranslationKey (IDXTranslationKeyPtr key)=0
virtual DXError DXMCALL RemoveTranslationKey (uint start, uint count)=0
virtual DXError DXMCALL RemoveRotationKey (uint index)=0
virtual DXError DXMCALL RemoveRotationKey (IDXRotationKeyPtr key)=0
virtual DXError DXMCALL RemoveRotationKey (uint start, uint count)=0
virtual DXError DXMCALL RemoveScaleKey (uint index)=0
virtual DXError DXMCALL RemoveScaleKey (IDXScaleKeyPtr key)=0
virtual DXError DXMCALL RemoveScaleKey (uint start, uint count)=0
virtual void DXMCALL SortTranslationKeys ()=0
virtual void DXMCALL SortRotationKeys ()=0
virtual void DXMCALL SortScaleKeys ()=0


Detailed Description

A group anim controls animations (translation, rotation, scale) for a specific group in the model.

Member Function Documentation

virtual DXError DXMCALL DX::IDXGroupAnim::AddRotationKey ( float  time,
const DXRotation &  rotation 
) [pure virtual]

Add a rotation key to the group animation.

Parameters:
key The key to add. Can be created with CreateRotationKey.
Returns:
Error_Sucess if the key was added to the timeline.

virtual DXError DXMCALL DX::IDXGroupAnim::AddScaleKey ( float  time,
const DXVector &  scale 
) [pure virtual]

Add a scale key to the group animation.

Parameters:
key The key to add. Can be created with CreateScaleKey.
Returns:
Error_Sucess if the key was added to the timeline.

virtual DXError DXMCALL DX::IDXGroupAnim::AddTranslationKey ( float  time,
const DXVector &  translation 
) [pure virtual]

Add a translation key to the group animation.

Parameters:
key The key to add. Can be created with CreateTranslationKey.
Returns:
Error_Success if the key was added to the timeline.

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

Get the group that this is animation.

Returns:
The ID of the group that this is animating.

virtual uint DXMCALL DX::IDXGroupAnim::GetNumRotationKeys (  )  const [pure virtual]

The number of rotation keys there are in the IDXGroupAnim. If any of the remove or add methods are called, this number is changed.

Returns:
The number of rotation keys.

virtual uint DXMCALL DX::IDXGroupAnim::GetNumScaleKeys (  )  const [pure virtual]

The number of scale keys there are in the IDXGroupAnim. If any of the remove or add methods are called, this number is changed.

Returns:
The number of scale keys.

virtual uint DXMCALL DX::IDXGroupAnim::GetNumTranslationKeys (  )  const [pure virtual]

The number of translation keys there are in the IDXGroupAnim. If any of the remove or add methods are called, this number is changed.

Returns:
The number of translation keys.

virtual DXError DXMCALL DX::IDXGroupAnim::GetRotationKey ( uint  index,
IDXRotationKeyPtr *  out 
) const [pure virtual]

Get the rotation key at the specified index.

Parameters:
index The index of the key to retrieve.
out A pointer to an IDXRotationKeyPtr which will receive the result.
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::IDXGroupAnim::GetRotationKeyIndex ( IDXRotationKeyPtr  key,
uint *  out 
) const [pure virtual]

Get the index of the specified IDXRotationKey.

Parameters:
key An IDXRotationKeyPtr to search for.
out A pointer to a uint where the result will be stored.
Returns:
Error_NullParam if out was null.
Error_NullParam2 if key was null.
Error_NotFound if key was not found.
Error_Success if the result was stored in out.

virtual DXError DXMCALL DX::IDXGroupAnim::GetRotationKeys ( IDXRotationKeyArray  out  )  const [pure virtual]

Fill a user allocated array of IDXRotationKeyPtr with data. Array must be of length equal to GetNumRotationKeys.

Parameters:
out A pointer to an array of IDXRotationKeyPtr.
Returns:
Error_NullParam if out was null.
Error_Success if the result was stored in out.

virtual DXError DXMCALL DX::IDXGroupAnim::GetRotationKeys ( uint  start,
uint  count,
IDXRotationKeyArray  out 
) const [pure virtual]

Get a block of IDXRotationKeyPtr.

Parameters:
start The index of the first element to retrieve.
count The number of elemnents to retreive.
out A user allocated array of IDXRotationKeyPtr of length at least count.
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::IDXGroupAnim::GetScaleKey ( uint  index,
IDXScaleKeyPtr *  out 
) const [pure virtual]

Get the scale key at the specified index.

Parameters:
index The index of the key to retrieve.
out A pointer to an IDXScaleKeyPtr which will receive the result.
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::IDXGroupAnim::GetScaleKeyIndex ( IDXScaleKeyPtr  key,
uint *  out 
) const [pure virtual]

Get the index of the specified IDXScaleKey.

Parameters:
key An IDXScaleKeyPtr to search for.
out A pointer to a uint where the result will be stored.
Returns:
Error_NullParam if out was null.
Error_NullParam2 if key was null.
Error_NotFound if key was not found.
Error_Success if the result was stored in out.

virtual DXError DXMCALL DX::IDXGroupAnim::GetScaleKeys ( IDXScaleKeyArray  out  )  const [pure virtual]

Fill a user allocated array of IDXScaleKeyPtr with data. Array must be of length equal to GetNumScaleKeys.

Parameters:
out A pointer to an array of IDXScaleKeyPtr.
Returns:
Error_NullParam if out was null.
Error_Success if the result was stored in out.

virtual DXError DXMCALL DX::IDXGroupAnim::GetScaleKeys ( uint  start,
uint  count,
IDXScaleKeyArray  out 
) const [pure virtual]

Get a block of IDXScaleKeyPtr.

Parameters:
start The index of the first element to retrieve.
count The number of elemnents to retreive.
out A user allocated array of IDXScaleKeyPtr of length at least count.
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::IDXGroupAnim::GetTranslationKey ( uint  index,
IDXTranslationKeyPtr *  out 
) const [pure virtual]

Get the translation key at the specified index.

Parameters:
index The index of the key to retrieve.
out A pointer to an IDXTranslationKeyPtr which will receive the result.
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::IDXGroupAnim::GetTranslationKeyIndex ( IDXTranslationKeyPtr  key,
uint *  out 
) const [pure virtual]

Get the index of the specified IDXTranslationKey.

Parameters:
key An IDXTranslationKeyPtr to search for.
out A pointer to a uint where the result will be stored.
Returns:
Error_NullParam if out was null.
Error_NullParam2 if key was null.
Error_NotFound if key was not found.
Error_Success if the result was stored in out.

virtual DXError DXMCALL DX::IDXGroupAnim::GetTranslationKeys ( IDXTranslationKeyArray  out  )  const [pure virtual]

Fill a user allocated array of IDXTranslationKeyPtr with data. Array must be of length equal to GetNumTranslationKeys.

Parameters:
out A pointer to an array of IDXTranslationKeyPtr.
Returns:
Error_NullParam if out was null.
Error_Success if the result was stored in out.

virtual DXError DXMCALL DX::IDXGroupAnim::GetTranslationKeys ( uint  start,
uint  count,
IDXTranslationKeyArray  out 
) const [pure virtual]

Get a block of IDXTranslationKeyPtr.

Parameters:
start The index of the first element to retrieve.
count The number of elemnents to retreive.
out A user allocated array of IDXTranslationKeyPtr of length at least count.
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::IDXGroupAnim::RemoveRotationKey ( uint  start,
uint  count 
) [pure virtual]

Remove a range of rotation keys from rotation keys

Parameters:
start The start index of the range to remove.
count 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::IDXGroupAnim::RemoveRotationKey ( IDXRotationKeyPtr  key  )  [pure virtual]

Remove the specified IDXRotationKey from the IDXGroupAnim.

Parameters:
key The IDXRotationKeyPtr to remove.
Returns:
Error_NullParam if key was null.
Error_NotFound if key was not found on the IDXGroupAnim.
Error_Success if the key was removed.

virtual DXError DXMCALL DX::IDXGroupAnim::RemoveRotationKey ( uint  index  )  [pure virtual]

Remove a rotation key from the rotation keys.

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

virtual DXError DXMCALL DX::IDXGroupAnim::RemoveScaleKey ( uint  start,
uint  count 
) [pure virtual]

Remove a range of scale keys from scale keys

Parameters:
start The start index of the range to remove.
count 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::IDXGroupAnim::RemoveScaleKey ( IDXScaleKeyPtr  key  )  [pure virtual]

Remove the specified IDXScaleKey from the IDXGroupAnim.

Parameters:
key The IDXScaleKeyPtr to remove.
Returns:
Error_NullParam if key was null.
Error_NotFound if key was not found on the IDXGroupAnim.
Error_Success if the key was removed.

virtual DXError DXMCALL DX::IDXGroupAnim::RemoveScaleKey ( uint  index  )  [pure virtual]

Remove a scale key from the scale keys.

Parameters:
index The location in the scale keys array to remove.
Returns:
Error_OutOfRange if index was not less the number of scale keys.
Error_Success if the scale key was removed successfully.

virtual DXError DXMCALL DX::IDXGroupAnim::RemoveTranslationKey ( uint  start,
uint  count 
) [pure virtual]

Remove a range of translation keys from translation keys

Parameters:
start The start index of the range to remove.
count 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::IDXGroupAnim::RemoveTranslationKey ( IDXTranslationKeyPtr  key  )  [pure virtual]

Remove the specified IDXTranslationKey from the IDXGroupAnim.

Parameters:
key The IDXTranslationKeyPtr to remove.
Returns:
Error_NullParam if key was null.
Error_NotFound if key was not found on the IDXGroupAnim.
Error_Success if the key was removed.

virtual DXError DXMCALL DX::IDXGroupAnim::RemoveTranslationKey ( uint  index  )  [pure virtual]

Remove a translation key from the translation keys.

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

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

Set the group that this groupanim is animating.

Parameters:
id The id of the group to use.
Returns:
Error_NullParam if id was null.
Error_Duplicate if there was already a groupanim for the specified group id.
Error_NotFound if there was no group found with the specified id.
Error_Success if the group id was changed.

virtual void DXMCALL DX::IDXGroupAnim::SortRotationKeys (  )  [pure virtual]

Force a sort of the rotation keys.

virtual void DXMCALL DX::IDXGroupAnim::SortScaleKeys (  )  [pure virtual]

Force a sort of the scale keys.

virtual void DXMCALL DX::IDXGroupAnim::SortTranslationKeys (  )  [pure virtual]

Force a sort of the translation keys.


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