The IAnimation resource object interface. More...

#include "murl_resource_i_animation.h"

Inheritance diagram for Murl::Resource::IAnimation:

Classes

struct  Iff
 IFF file specific structs. More...
 
struct  Raw
 Raw data structs. More...
 

Public Member Functions

virtual IObjectGetObjectInterface ()=0
 Get the mutable Resource::IObject interface. More...
 
virtual const IObjectGetObjectInterface () const =0
 Get the constant Resource::IObject interface. More...
 
virtual Bool HasKeys (IEnums::AnimationKey keyType) const =0
 Check if this animation contains keys of a given type. More...
 
virtual UInt32 GetNumberOfClips () const =0
 Get the number of clips stored in the animation. More...
 
virtual SInt32 GetClipIndex (const Char *clipName) const =0
 Get the index of a clip with a given name. More...
 
virtual const CharGetClipName (UInt32 clipIndex) const =0
 Get the name of a clip at a given index. More...
 
virtual Float GetStartTime (UInt32 clipIndex) const =0
 Get a clip's start time. More...
 
virtual Float GetEndTime (UInt32 clipIndex) const =0
 Get a clip's end time. More...
 
virtual Float GetDuration (UInt32 clipIndex) const =0
 Get a clip's duration. More...
 
virtual UInt32 GetNumberOfVisibleKeys (UInt32 clipIndex) const =0
 Get the number of "visible" keys stored in a clip. More...
 
virtual UInt32 GetNumberOfActiveKeys (UInt32 clipIndex) const =0
 Get the number of "active" keys stored in a clip. More...
 
virtual const Raw::BoolKeyGetVisibleKeys (UInt32 clipIndex) const =0
 Get the "visible" keys stored in a clip. More...
 
virtual const Raw::BoolKeyGetActiveKeys (UInt32 clipIndex) const =0
 Get the "active" keys stored in a clip. More...
 
virtual UInt32 GetNumberOfIndexKeys (UInt32 clipIndex) const =0
 Get the number of index keys stored in a clip. More...
 
virtual UInt32 GetNumberOfDepthOrderKeys (UInt32 clipIndex) const =0
 Get the number of depth order keys stored in a clip. More...
 
virtual const Raw::IntegerKeyGetIndexKeys (UInt32 clipIndex) const =0
 Get the index keys stored in a clip. More...
 
virtual const Raw::IntegerKeyGetDepthOrderKeys (UInt32 clipIndex) const =0
 Get the depth order keys stored in a clip. More...
 
virtual UInt32 GetNumberOfAlphaKeys (UInt32 clipIndex) const =0
 Get the number of alpha keys stored in a clip. More...
 
virtual UInt32 GetNumberOfVolumeKeys (UInt32 clipIndex) const =0
 Get the number of audio volume keys stored in a clip. More...
 
virtual UInt32 GetNumberOfTimeKeys (UInt32 clipIndex) const =0
 Get the number of time keys stored in a clip. More...
 
virtual const Raw::FloatKeyGetAlphaKeys (UInt32 clipIndex) const =0
 Get the alpha keys stored in a clip. More...
 
virtual const Raw::FloatKeyGetVolumeKeys (UInt32 clipIndex) const =0
 Get the audio volume keys stored in a clip. More...
 
virtual const Raw::FloatKeyGetTimeKeys (UInt32 clipIndex) const =0
 Get the time keys stored in a clip. More...
 
virtual UInt32 GetNumberOfAmbientColorKeys (UInt32 clipIndex) const =0
 Get the number of ambient color keys stored in a clip. More...
 
virtual UInt32 GetNumberOfDiffuseColorKeys (UInt32 clipIndex) const =0
 Get the number of diffuse color keys stored in a clip. More...
 
virtual UInt32 GetNumberOfSpecularColorKeys (UInt32 clipIndex) const =0
 Get the number of specular color keys stored in a clip. More...
 
virtual UInt32 GetNumberOfEmissiveColorKeys (UInt32 clipIndex) const =0
 Get the number of emissive color keys stored in a clip. More...
 
virtual const Raw::ColorKeyGetAmbientColorKeys (UInt32 clipIndex) const =0
 Get the ambient color keys stored in a clip. More...
 
virtual const Raw::ColorKeyGetDiffuseColorKeys (UInt32 clipIndex) const =0
 Get the diffuse color keys stored in a clip. More...
 
virtual const Raw::ColorKeyGetSpecularColorKeys (UInt32 clipIndex) const =0
 Get the specular color keys stored in a clip. More...
 
virtual const Raw::ColorKeyGetEmissiveColorKeys (UInt32 clipIndex) const =0
 Get the emissive color keys stored in a clip. More...
 
virtual UInt32 GetNumberOfPositionKeys (UInt32 clipIndex) const =0
 Get the number of position keys stored in a clip. More...
 
virtual UInt32 GetNumberOfScalingKeys (UInt32 clipIndex) const =0
 Get the number of scaling keys stored in a clip. More...
 
virtual UInt32 GetNumberOfAxisAngleKeys (UInt32 clipIndex) const =0
 Get the number of axis/angle keys stored in a clip. More...
 
virtual UInt32 GetNumberOfQuaternionKeys (UInt32 clipIndex) const =0
 Get the number of quaternion keys stored in a clip. More...
 
virtual const Raw::PositionKeyGetPositionKeys (UInt32 clipIndex) const =0
 Get the position keys stored in a clip. More...
 
virtual const Raw::ScalingKeyGetScalingKeys (UInt32 clipIndex) const =0
 Get the scaling keys stored in a clip. More...
 
virtual const Raw::AxisAngleKeyGetAxisAngleKeys (UInt32 clipIndex) const =0
 Get the axis/angle keys stored in a clip. More...
 
virtual const Raw::QuaternionKeyGetQuaternionKeys (UInt32 clipIndex) const =0
 Get the quaternion keys stored in a clip. More...
 
virtual UInt32 GetNumberOfEulerAngleKeys (UInt32 clipIndex) const =0
 Get the number of euler X/Y/Z rotation angle keys stored in a clip. More...
 
virtual const Raw::EulerAngleKeyGetEulerAngleKeys (UInt32 clipIndex) const =0
 Get the euler X/Y/Z rotation angle keys stored in a clip. More...
 
virtual UInt32 GetNumberOfBlendFactorKeySets () const =0
 Get the number of blend factor key sets stored in the animation. More...
 
virtual UInt32 GetNumberOfBlendFactorKeys (UInt32 clipIndex, UInt32 keySet) const =0
 Get the number of blend factor keys for a given key set stored in a clip. More...
 
virtual const Raw::FloatKeyGetBlendFactorKeys (UInt32 clipIndex, UInt32 keySet) const =0
 Get the blend factor keys for a given key set stored in a clip. More...
 

Detailed Description

The IAnimation resource object interface.

Animation resources store a number of animation clips, which in turn can contain any number of key frames of different types, such as colors, positions, audio volumes etc, in an ascending order with respect to their time stamps.

Member Function Documentation

◆ GetObjectInterface() [1/2]

virtual IObject* Murl::Resource::IAnimation::GetObjectInterface ( )
pure virtual

Get the mutable Resource::IObject interface.

Returns
The IObject interface.

◆ GetObjectInterface() [2/2]

virtual const IObject* Murl::Resource::IAnimation::GetObjectInterface ( ) const
pure virtual

Get the constant Resource::IObject interface.

Returns
The IObject interface.

◆ HasKeys()

virtual Bool Murl::Resource::IAnimation::HasKeys ( IEnums::AnimationKey  keyType) const
pure virtual

Check if this animation contains keys of a given type.

Parameters
keyTypeThe animation key type to query.
Returns
true if keys of the requested type are present.

◆ GetNumberOfClips()

virtual UInt32 Murl::Resource::IAnimation::GetNumberOfClips ( ) const
pure virtual

Get the number of clips stored in the animation.

Returns
The total number of clips.

◆ GetClipIndex()

virtual SInt32 Murl::Resource::IAnimation::GetClipIndex ( const Char clipName) const
pure virtual

Get the index of a clip with a given name.

Parameters
clipNameThe name of the clip to query.
Returns
The zero-based index of the clip, or -1 if not found.

◆ GetClipName()

virtual const Char* Murl::Resource::IAnimation::GetClipName ( UInt32  clipIndex) const
pure virtual

Get the name of a clip at a given index.

Parameters
clipIndexThe zero-based index of the clip, in the range from 0 to GetNumberOfClips()-1.
Returns
The name of the clip, or null if the index was out of range.

◆ GetStartTime()

virtual Float Murl::Resource::IAnimation::GetStartTime ( UInt32  clipIndex) const
pure virtual

Get a clip's start time.

Parameters
clipIndexThe zero-based index of the clip, in the range from 0 to GetNumberOfClips()-1.
Returns
The start time in seconds, or 0.0 if the index was out of range.

◆ GetEndTime()

virtual Float Murl::Resource::IAnimation::GetEndTime ( UInt32  clipIndex) const
pure virtual

Get a clip's end time.

Parameters
clipIndexThe zero-based index of the clip, in the range from 0 to GetNumberOfClips()-1.
Returns
The end time in seconds, or 0.0 if the index was out of range.

◆ GetDuration()

virtual Float Murl::Resource::IAnimation::GetDuration ( UInt32  clipIndex) const
pure virtual

Get a clip's duration.

Parameters
clipIndexThe zero-based index of the clip, in the range from 0 to GetNumberOfClips()-1.
Returns
The duration in seconds, or 0.0 if the index was out of range.

◆ GetNumberOfVisibleKeys()

virtual UInt32 Murl::Resource::IAnimation::GetNumberOfVisibleKeys ( UInt32  clipIndex) const
pure virtual

Get the number of "visible" keys stored in a clip.

Parameters
clipIndexThe clip index.
Returns
The number of keys.

◆ GetNumberOfActiveKeys()

virtual UInt32 Murl::Resource::IAnimation::GetNumberOfActiveKeys ( UInt32  clipIndex) const
pure virtual

Get the number of "active" keys stored in a clip.

Parameters
clipIndexThe clip index.
Returns
The number of keys.

◆ GetVisibleKeys()

virtual const Raw::BoolKey* Murl::Resource::IAnimation::GetVisibleKeys ( UInt32  clipIndex) const
pure virtual

Get the "visible" keys stored in a clip.

Parameters
clipIndexThe clip index.
Returns
A pointer to the keys, or null if not present.

◆ GetActiveKeys()

virtual const Raw::BoolKey* Murl::Resource::IAnimation::GetActiveKeys ( UInt32  clipIndex) const
pure virtual

Get the "active" keys stored in a clip.

Parameters
clipIndexThe clip index.
Returns
A pointer to the keys, or null if not present.

◆ GetNumberOfIndexKeys()

virtual UInt32 Murl::Resource::IAnimation::GetNumberOfIndexKeys ( UInt32  clipIndex) const
pure virtual

Get the number of index keys stored in a clip.

Parameters
clipIndexThe clip index.
Returns
The number of keys.

◆ GetNumberOfDepthOrderKeys()

virtual UInt32 Murl::Resource::IAnimation::GetNumberOfDepthOrderKeys ( UInt32  clipIndex) const
pure virtual

Get the number of depth order keys stored in a clip.

Parameters
clipIndexThe clip index.
Returns
The number of keys.

◆ GetIndexKeys()

virtual const Raw::IntegerKey* Murl::Resource::IAnimation::GetIndexKeys ( UInt32  clipIndex) const
pure virtual

Get the index keys stored in a clip.

Parameters
clipIndexThe clip index.
Returns
A pointer to the keys, or null if not present.

◆ GetDepthOrderKeys()

virtual const Raw::IntegerKey* Murl::Resource::IAnimation::GetDepthOrderKeys ( UInt32  clipIndex) const
pure virtual

Get the depth order keys stored in a clip.

Parameters
clipIndexThe clip index.
Returns
A pointer to the keys, or null if not present.

◆ GetNumberOfAlphaKeys()

virtual UInt32 Murl::Resource::IAnimation::GetNumberOfAlphaKeys ( UInt32  clipIndex) const
pure virtual

Get the number of alpha keys stored in a clip.

Parameters
clipIndexThe clip index.
Returns
The number of keys.

◆ GetNumberOfVolumeKeys()

virtual UInt32 Murl::Resource::IAnimation::GetNumberOfVolumeKeys ( UInt32  clipIndex) const
pure virtual

Get the number of audio volume keys stored in a clip.

Parameters
clipIndexThe clip index.
Returns
The number of keys.

◆ GetNumberOfTimeKeys()

virtual UInt32 Murl::Resource::IAnimation::GetNumberOfTimeKeys ( UInt32  clipIndex) const
pure virtual

Get the number of time keys stored in a clip.

Parameters
clipIndexThe clip index.
Returns
The number of keys.

◆ GetAlphaKeys()

virtual const Raw::FloatKey* Murl::Resource::IAnimation::GetAlphaKeys ( UInt32  clipIndex) const
pure virtual

Get the alpha keys stored in a clip.

Parameters
clipIndexThe clip index.
Returns
A pointer to the keys, or null if not present.

◆ GetVolumeKeys()

virtual const Raw::FloatKey* Murl::Resource::IAnimation::GetVolumeKeys ( UInt32  clipIndex) const
pure virtual

Get the audio volume keys stored in a clip.

Parameters
clipIndexThe clip index.
Returns
A pointer to the keys, or null if not present.

◆ GetTimeKeys()

virtual const Raw::FloatKey* Murl::Resource::IAnimation::GetTimeKeys ( UInt32  clipIndex) const
pure virtual

Get the time keys stored in a clip.

Parameters
clipIndexThe clip index.
Returns
A pointer to the keys, or null if not present.

◆ GetNumberOfAmbientColorKeys()

virtual UInt32 Murl::Resource::IAnimation::GetNumberOfAmbientColorKeys ( UInt32  clipIndex) const
pure virtual

Get the number of ambient color keys stored in a clip.

Parameters
clipIndexThe clip index.
Returns
The number of keys.

◆ GetNumberOfDiffuseColorKeys()

virtual UInt32 Murl::Resource::IAnimation::GetNumberOfDiffuseColorKeys ( UInt32  clipIndex) const
pure virtual

Get the number of diffuse color keys stored in a clip.

Parameters
clipIndexThe clip index.
Returns
The number of keys.

◆ GetNumberOfSpecularColorKeys()

virtual UInt32 Murl::Resource::IAnimation::GetNumberOfSpecularColorKeys ( UInt32  clipIndex) const
pure virtual

Get the number of specular color keys stored in a clip.

Parameters
clipIndexThe clip index.
Returns
The number of keys.

◆ GetNumberOfEmissiveColorKeys()

virtual UInt32 Murl::Resource::IAnimation::GetNumberOfEmissiveColorKeys ( UInt32  clipIndex) const
pure virtual

Get the number of emissive color keys stored in a clip.

Parameters
clipIndexThe clip index.
Returns
The number of keys.

◆ GetAmbientColorKeys()

virtual const Raw::ColorKey* Murl::Resource::IAnimation::GetAmbientColorKeys ( UInt32  clipIndex) const
pure virtual

Get the ambient color keys stored in a clip.

Parameters
clipIndexThe clip index.
Returns
A pointer to the keys, or null if not present.

◆ GetDiffuseColorKeys()

virtual const Raw::ColorKey* Murl::Resource::IAnimation::GetDiffuseColorKeys ( UInt32  clipIndex) const
pure virtual

Get the diffuse color keys stored in a clip.

Parameters
clipIndexThe clip index.
Returns
A pointer to the keys, or null if not present.

◆ GetSpecularColorKeys()

virtual const Raw::ColorKey* Murl::Resource::IAnimation::GetSpecularColorKeys ( UInt32  clipIndex) const
pure virtual

Get the specular color keys stored in a clip.

Parameters
clipIndexThe clip index.
Returns
A pointer to the keys, or null if not present.

◆ GetEmissiveColorKeys()

virtual const Raw::ColorKey* Murl::Resource::IAnimation::GetEmissiveColorKeys ( UInt32  clipIndex) const
pure virtual

Get the emissive color keys stored in a clip.

Parameters
clipIndexThe clip index.
Returns
A pointer to the keys, or null if not present.

◆ GetNumberOfPositionKeys()

virtual UInt32 Murl::Resource::IAnimation::GetNumberOfPositionKeys ( UInt32  clipIndex) const
pure virtual

Get the number of position keys stored in a clip.

Parameters
clipIndexThe clip index.
Returns
The number of keys.

◆ GetNumberOfScalingKeys()

virtual UInt32 Murl::Resource::IAnimation::GetNumberOfScalingKeys ( UInt32  clipIndex) const
pure virtual

Get the number of scaling keys stored in a clip.

Parameters
clipIndexThe clip index.
Returns
The number of keys.

◆ GetNumberOfAxisAngleKeys()

virtual UInt32 Murl::Resource::IAnimation::GetNumberOfAxisAngleKeys ( UInt32  clipIndex) const
pure virtual

Get the number of axis/angle keys stored in a clip.

Parameters
clipIndexThe clip index.
Returns
The number of keys.

◆ GetNumberOfQuaternionKeys()

virtual UInt32 Murl::Resource::IAnimation::GetNumberOfQuaternionKeys ( UInt32  clipIndex) const
pure virtual

Get the number of quaternion keys stored in a clip.

Parameters
clipIndexThe clip index.
Returns
The number of keys.

◆ GetPositionKeys()

virtual const Raw::PositionKey* Murl::Resource::IAnimation::GetPositionKeys ( UInt32  clipIndex) const
pure virtual

Get the position keys stored in a clip.

Parameters
clipIndexThe clip index.
Returns
A pointer to the keys, or null if not present.

◆ GetScalingKeys()

virtual const Raw::ScalingKey* Murl::Resource::IAnimation::GetScalingKeys ( UInt32  clipIndex) const
pure virtual

Get the scaling keys stored in a clip.

Parameters
clipIndexThe clip index.
Returns
A pointer to the keys, or null if not present.

◆ GetAxisAngleKeys()

virtual const Raw::AxisAngleKey* Murl::Resource::IAnimation::GetAxisAngleKeys ( UInt32  clipIndex) const
pure virtual

Get the axis/angle keys stored in a clip.

Parameters
clipIndexThe clip index.
Returns
A pointer to the keys, or null if not present.

◆ GetQuaternionKeys()

virtual const Raw::QuaternionKey* Murl::Resource::IAnimation::GetQuaternionKeys ( UInt32  clipIndex) const
pure virtual

Get the quaternion keys stored in a clip.

Parameters
clipIndexThe clip index.
Returns
A pointer to the keys, or null if not present.

◆ GetNumberOfEulerAngleKeys()

virtual UInt32 Murl::Resource::IAnimation::GetNumberOfEulerAngleKeys ( UInt32  clipIndex) const
pure virtual

Get the number of euler X/Y/Z rotation angle keys stored in a clip.

Parameters
clipIndexThe clip index.
Returns
The number of keys.

◆ GetEulerAngleKeys()

virtual const Raw::EulerAngleKey* Murl::Resource::IAnimation::GetEulerAngleKeys ( UInt32  clipIndex) const
pure virtual

Get the euler X/Y/Z rotation angle keys stored in a clip.

Parameters
clipIndexThe clip index.
Returns
A pointer to the keys, or null if not present.

◆ GetNumberOfBlendFactorKeySets()

virtual UInt32 Murl::Resource::IAnimation::GetNumberOfBlendFactorKeySets ( ) const
pure virtual

Get the number of blend factor key sets stored in the animation.

Returns
The number of key sets..

◆ GetNumberOfBlendFactorKeys()

virtual UInt32 Murl::Resource::IAnimation::GetNumberOfBlendFactorKeys ( UInt32  clipIndex,
UInt32  keySet 
) const
pure virtual

Get the number of blend factor keys for a given key set stored in a clip.

Parameters
clipIndexThe clip index.
keySetThe key set index.
Returns
The number of keys.

◆ GetBlendFactorKeys()

virtual const Raw::FloatKey* Murl::Resource::IAnimation::GetBlendFactorKeys ( UInt32  clipIndex,
UInt32  keySet 
) const
pure virtual

Get the blend factor keys for a given key set stored in a clip.

Parameters
clipIndexThe clip index.
keySetThe key set index.
Returns
A pointer to the keys, or null if not present.

The documentation for this interface was generated from the following file:
  • murl_resource_i_animation.h


Copyright © 2011-2018 Spraylight GmbH.