DX::IDXAnimationKeyframe Struct Reference

#include <IDXAnimationKeyFrame.h>

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

Collaboration diagram for DX::IDXAnimationKeyframe:

Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual float DXMCALL GetTime () const =0
virtual DXError DXMCALL GetScript (const char **out) const =0
virtual void DXMCALL SetTime (float time)=0
virtual DXError DXMCALL SetScript (const char *script)=0
virtual DXError DXMCALL RemoveScript ()=0


Detailed Description

Used to store events and data that will happen at the specified time. Currently contains script.

Member Function Documentation

virtual DXError DXMCALL DX::IDXAnimationKeyframe::GetScript ( const char **  out  )  const [pure virtual]

Get the script at this keyframe.

Parameters:
out A const char** where the result will be stored.
Returns:
Error_NullParam if out was null.
Error_NotFound if there was no script.
Error_Success if the result was stored in out.

virtual float DXMCALL DX::IDXAnimationKeyframe::GetTime (  )  const [pure virtual]

Get the time that this keyframe is at.

Returns:
Time.

virtual DXError DXMCALL DX::IDXAnimationKeyframe::RemoveScript (  )  [pure virtual]

Remove the script on this keyframe.

Returns:
Error_NotFound if there was no script to remove.
Error_Success if the script was removed.

virtual DXError DXMCALL DX::IDXAnimationKeyframe::SetScript ( const char *  script  )  [pure virtual]

Set the script at this keyframe.

Parameters:
script A const char* which is the new script.
Returns:
Error_NullParam if script was null.
Error_Success if script was changed.

virtual void DXMCALL DX::IDXAnimationKeyframe::SetTime ( float  time  )  [pure virtual]

Set the time that this keyframe is at.


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