ISkeletonAnim

C++
struct ISkeletonAnim {
  enum {
    LayerCount = 16
  };
};
File

ICryAnimation.h

Description

<> required for Interfuscator

ISkeletonAnim::~ISkeletonAnim Destructor
C++
virtual ~ISkeletonAnim();
ISkeletonAnim::CalculateCompleteBlendSpaceDuration Method
C++
virtual f32 CalculateCompleteBlendSpaceDuration(const CAnimation& rAnimation) const = 0;
Description

Calculates duration of blend space up to the point where it starts to repeat, that is a Least Common Multiple of a number of segments of different examples. For instance, if segments of caf1: A B C, caf2: 1 2. The whole duration will be calculated for sequence A1 B2 C1 A2 B1 C2.

ISkeletonAnim::CalculateRelativeMovement Method
C++
virtual QuatT CalculateRelativeMovement(const float deltaTime, const bool CurrNext = 0) const = 0;
Description

This function will move outside of this interface. Use at your own risk.

ISkeletonAnim::ClearFIFOLayer Method
C++
virtual void ClearFIFOLayer(uint32 nLayer) = 0;
ISkeletonAnim::FindAnimInFIFO Method
C++
virtual CAnimation* FindAnimInFIFO(uint32 nUserToken, int nLayer = 1) = 0;
Parameters
Parameters
Description
uint32 nUserToken
User token that identify an animation to search for.
int nLayer = 1
Layer of FIFO where to search for animation, if -1 all layers are searched.
Description

Find an animation with a given user token.

ISkeletonAnim::GetAnimationDrivenMotion Method
C++
virtual uint32 GetAnimationDrivenMotion() = 0;
ISkeletonAnim::GetAnimationNormalizedTime Method
C++
virtual f32 GetAnimationNormalizedTime(const CAnimation* pAnimation) const = 0;
Description

! Get the time for the animation in position index for the given layer. The return value is in the range [0..1

ISkeletonAnim::GetAnimFromFIFO Method (uint32, uint32)
C++
virtual CAnimation& GetAnimFromFIFO(uint32 nLayer, uint32 num) = 0;
ISkeletonAnim::GetAnimFromFIFO Method (uint32, uint32)
C++
virtual const CAnimation& GetAnimFromFIFO(uint32 nLayer, uint32 num) const = 0;
ISkeletonAnim::GetCurrentVelocity Method
C++
virtual Vec3 GetCurrentVelocity() = 0;
Description

return values

ISkeletonAnim::GetDesiredMotionParam Method
C++
virtual bool GetDesiredMotionParam(EMotionParamID id, float& value) const = 0;
ISkeletonAnim::GetLastAnimEvent Method
C++
virtual AnimEventInstance GetLastAnimEvent() = 0;
ISkeletonAnim::GetLayerNormalizedTime Method
C++
virtual f32 GetLayerNormalizedTime(uint32 layer) const = 0;
ISkeletonAnim::GetLayerPlaybackScale Method
C++
virtual f32 GetLayerPlaybackScale(uint32 nLayer) = 0;
Description

! NOTE: It does NOT override the overall animation speed, but it's multiplies it

ISkeletonAnim::GetNumAnimsInFIFO Method
C++
virtual int GetNumAnimsInFIFO(uint32 nLayer) const = 0;
ISkeletonAnim::GetRelMovement Method
C++
virtual const QuatT& GetRelMovement() const = 0;
ISkeletonAnim::GetTrackViewStatus Method
C++
virtual uint32 GetTrackViewStatus() = 0;
ISkeletonAnim::GetUserData Method
C++
virtual f32 GetUserData(int i) = 0;
ISkeletonAnim::ManualSeekAnimationInFIFO Method
C++
virtual void ManualSeekAnimationInFIFO(uint32 nLayer, uint32 num, float time, bool triggerAnimEvents) = 0;
Description

If manual update is set for anim, then set anim time and handle anim events.

ISkeletonAnim::PushPoseModifier Method
C++
virtual bool PushPoseModifier(uint32 layer, IAnimationPoseModifierPtr poseModifier, const char* name = NULL) = 0;
ISkeletonAnim::RemoveAnimFromFIFO Method
C++
virtual bool RemoveAnimFromFIFO(uint32 nLayer, uint32 num, bool forceRemove = false) = 0;
Parameters
Parameters
Description
uint32 nLayer
Animation layer to remove from.
uint32 num
Transition queue index to remove at.
bool forceRemove = false
Ignore special conditions and force a removal from the layer.
Description

Remove an animation with a given index and given layer.

ISkeletonAnim::RemoveTransitionDelayConditions Method
C++
virtual void RemoveTransitionDelayConditions(uint32 nLayer) = 0;
Description

makes sure there's no anim in this layer's queue that could cause a delay (useful when you want to play an animation that you want to be 100% sure is going to be transitioned to immediately)

ISkeletonAnim::SetAnimationDrivenMotion Method
C++
virtual void SetAnimationDrivenMotion(uint32 ts) = 0;
ISkeletonAnim::SetAnimationNormalizedTime Method
C++
virtual void SetAnimationNormalizedTime(CAnimation* pAnimation, f32 normalizedTime, bool entireClip = true) = 0;
Description

! Set the time for the animation in position index for the given layer to a value in the range [0..1

ISkeletonAnim::SetDebugging Method
C++
virtual void SetDebugging(uint32 flags) = 0;
Description

Enable special debug text for this skeleton

ISkeletonAnim::SetDesiredMotionParam Method
C++
virtual void SetDesiredMotionParam(EMotionParamID id, f32 value, f32 frametime) = 0;
Description

Updates the given parameter (will perform clamping and clearing as needed)

ISkeletonAnim::SetEventCallback Method
C++
virtual void SetEventCallback(CallBackFuncType func, void * pdata) = 0;
ISkeletonAnim::SetLayerBlendWeight Method
C++
virtual void SetLayerBlendWeight(int32 nLayer, f32 fMult) = 0;
ISkeletonAnim::SetLayerNormalizedTime Method
C++
virtual void SetLayerNormalizedTime(uint32 layer, f32 normalizedTime) = 0;
ISkeletonAnim::SetLayerPlaybackScale Method
C++
virtual void SetLayerPlaybackScale(int32 nLayer, f32 fSpeed) = 0;
ISkeletonAnim::SetMirrorAnimation Method
C++
virtual void SetMirrorAnimation(uint32 ts) = 0;
Description

motion initialization

ISkeletonAnim::SetTrackViewExclusive Method
C++
virtual void SetTrackViewExclusive(uint32 i) = 0;
ISkeletonAnim::SetTrackViewMixingWeight Method
C++
virtual void SetTrackViewMixingWeight(uint32 layer, f32 weight) = 0;
ISkeletonAnim::StartAnimation Method
C++
virtual bool StartAnimation(const char* szAnimName0, const CryCharAnimationParams& Params) = 0;
Description

motion playback and blending

ISkeletonAnim::StartAnimationById Method
C++
virtual bool StartAnimationById(int32 id, const CryCharAnimationParams& Params) = 0;
ISkeletonAnim::StopAnimationInLayer Method
C++
virtual bool StopAnimationInLayer(int32 nLayer, f32 BlendOutTime) = 0;
ISkeletonAnim::StopAnimationsAllLayers Method
C++
virtual bool StopAnimationsAllLayers() = 0;