IAnimationSet

Hold description of a set of animation

C++

struct IAnimationSet {
};

File

ICryAnimation.h

Description

This interface hold a set of animation in which each animation is described as properties.

IAnimationSet::~IAnimationSet Destructor

C++

virtual ~IAnimationSet();

IAnimationSet::AddRef Method

C++

virtual void AddRef(const int32 nAnimationId) const = 0;

IAnimationSet::GetAnimationCount Method

Retrieves the amount of animation.

C++

virtual uint32 GetAnimationCount() const = 0;

Returns

An integer holding the amount of animation

IAnimationSet::GetAnimationDCCWorldSpaceLocation Method (CAnimation*, QuatT&, uint32)

C++

virtual bool GetAnimationDCCWorldSpaceLocation(const CAnimation* pAnim, QuatT& startLocation, uint32 nControllerID) const = 0;

Description

Retrieve the 'DCC world space' location of the current frame.

Returns true on success. Returns false and IDENTITY when animation is invalid.

IAnimationSet::GetAnimationDCCWorldSpaceLocation Method (char*, QuatT&)

C++

virtual bool GetAnimationDCCWorldSpaceLocation(const char* szAnimationName, QuatT& startLocation) const = 0;

Description

Retrieve the 'DCC world space' location of the first frame.

Returns true on success. Returns false and IDENTITY when animation is invalid.

IAnimationSet::GetAnimationDCCWorldSpaceLocation Method (int32, QuatT&)

C++

virtual bool GetAnimationDCCWorldSpaceLocation(int32 AnimID, QuatT& startLocation) const = 0;

Description

Retrieve the 'DCC world space' location of the first frame.

Returns true on success. Returns false and IDENTITY when animation is invalid.

IAnimationSet::GetAnimationFlags Method

C++

virtual uint32 GetAnimationFlags(int nAnimationId) const = 0;

IAnimationSet::GetAnimationSize Method

C++

virtual uint32 GetAnimationSize(const uint32 nAnimationId) const = 0;

IAnimationSet::GetAnimIDByCRC Method

C++

virtual int GetAnimIDByCRC(uint32 animationCRC) const = 0;

IAnimationSet::GetAnimIDByName Method

Searches for the index of an animation using its name.

C++

virtual int GetAnimIDByName(const char* szAnimationName) const = 0;

Parameters

Parameters	Description
const char* szAnimationName	Null terminated string holding the name of the animation.

Returns

An integer representing the index of the animation. In case the animation couldn't be found, -1 will be returned.

Description

! Returns the index of the animation in the set, -1 if there's no such animation

IAnimationSet::GetCRCByAnimID Method

C++

virtual uint32 GetCRCByAnimID(int nAnimationId) const = 0;

IAnimationSet::GetDuration_sec Method

C++

virtual f32 GetDuration_sec(int nAnimationId) const = 0;

IAnimationSet::GetFilePathByID Method

C++

virtual const char* GetFilePathByID(int nAnimationId) const = 0;

IAnimationSet::GetFilePathByName Method

C++

virtual const char* GetFilePathByName(const char* szAnimationName) const = 0;

IAnimationSet::GetFilePathCRCByAnimID Method

C++

virtual uint32 GetFilePathCRCByAnimID(int nAnimationId) const = 0;

IAnimationSet::GetNameByAnimID Method

Gets the name of the specified animation.

C++

virtual const char* GetNameByAnimID(int nAnimationId) const = 0;

Parameters

Parameters	Description
int nAnimationId	Id of an animation.

Returns

A null terminated string holding the name of the animation. In case the animation wasn't found, the string "!NEGATIVE ANIMATION ID!" will be returned.

Description

! Returns the given animation name

IAnimationSet::IsAimPose Method

C++

virtual bool IsAimPose(int nAnimationId, const IDefaultSkeleton& defaultSkeleton) const = 0;

IAnimationSet::IsAnimLoaded Method

C++

virtual bool IsAnimLoaded(int nAnimationId) const = 0;

IAnimationSet::IsLookPose Method

C++

virtual bool IsLookPose(int nAnimationId, const IDefaultSkeleton& defaultSkeleton) const = 0;

IAnimationSet::Release Method

C++

virtual void Release(const int32 nAnimationId) const = 0;

Documentation

IAnimationSet