FAnimAssetTickContext

This structure is used to either advance or synchronize animation players.

Windows
MacOS
Linux

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Animation/AnimationAsset.h

Include

#include "Animation/AnimationAsset.h"

Syntax

struct FAnimAssetTickContext

Remarks

This structure is used to either advance or synchronize animation players.

Variables

Name Description

Public variable

FMarkerTickCont...

 

MarkerTickContext

Public variable

ERootMotionMode...

 

RootMotionMode

The root motion mode of the owning AnimInstance.

Public variable

FRootMotionMove...

 

RootMotionMovementParams

Root Motion accumulated from this tick context.

Constructors

Name Description

Public function

FAnimAssetTickContext

(
    float InDeltaTime,
    ERootMotionMode::Type InRootMotionM...,
    bool bInOnlyOneAnimationInGroup
)

Public function

FAnimAssetTickContext

(
    float InDeltaTime,
    ERootMotionMode::Type InRootMotionM...,
    bool bInOnlyOneAnimationInGroup,
    const TArray< FName >& ValidMarker...
)

Functions

Name Description

Public function Const

bool

 

CanUseMarkerPosition()

Public function

void

 

ConvertToFollower()

Public function Const

float

 

GetAnimationPositionRatio()

Returns the synchronization point (normalized time; only legal to call if ticking a follower)

Public function Const

float

 

GetDeltaTime()

Return the delta time of the tick.

Public function Const

float

 

GetLeaderDelta()

Public function Const

float

 

GetPreviousAnimationPositionRatio()

Returns the previous synchronization point (normalized time; only legal to call if ticking a follower)

Public function

void

 

InvalidateMarkerSync()

Public function Const

bool

 

IsFollower()

Public function Const

bool

 

IsLeader()

Are we the leader of our sync group (or ungrouped)?

Public function Const

bool

 

IsSingleAnimationContext()

Public function

void

 

SetAnimationPositionRatio

(
    float NormalizedTime
)

Public function

void

 

SetLeaderDelta

(
    float InLeaderDelta
)

Public function

void

 

SetPreviousAnimationPositionRatio

(
    float NormalizedTime
)

Public function Const

bool

 

ShouldGenerateNotifies()

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback