FAnimationUpdateContext

Update context passed around during animation tree update

Windows
MacOS
Linux

Inheritance Hierarchy

FAnimationBaseContext

FAnimationUpdateContext

References

Module

Engine

Header

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

Include

#include "Animation/AnimNodeBase.h"

Syntax

struct FAnimationUpdateContext : public FAnimationBaseContext

Remarks

Update context passed around during animation tree update

Constructors

Name Description

Public function

FAnimationUpdateContext

(
    FAnimInstanceProxy * InAnimInst...
)

Public function

FAnimationUpdateContext

(
    const FAnimationUpdateContext & Cop...
)

Public function

FAnimationUpdateContext

(
    const FAnimationUpdateContext & Cop...,
    FAnimInstanceProxy * InAnimInst...
)

Public function

FAnimationUpdateContext

(
    FAnimInstanceProxy * InAnimInst...,
    float InDeltaTime,
    FAnimationUpdateSharedContext *...
)

Functions

Name Description

Public function Const

FAnimationUp ...

 

FractionalWeight

(
    float WeightMultiplier
)

Public function Const

FAnimationUp ...

 

FractionalWeightAndRootMotion

(
    float WeightMultiplier,
    float RootMotionMultiplier
)

Public function Const

FAnimationUp ...

 

FractionalWeightAndTime

(
    float WeightMultiplier,
    float TimeMultiplier
)

Public function Const

FAnimationUp ...

 

FractionalWeightTimeAndRootMotion

(
    float WeightMultiplier,
    float TimeMultiplier,
    float RootMotionMultiplier
)

Public function Const

NodeType ...

 

GetAncestor()

Returns the nearest ancestor node of a particular type.

Public function Const

float

 

GetDeltaTime()

Returns the delta time for this update, in seconds.

Public function Const

float

 

GetFinalBlendWeight()

Returns the final blend weight contribution for this stage.

Public function Const

float

 

GetRootMotionWeightModifier()

Returns the weight modifier for root motion (as root motion weight wont always match blend weight)

Public function Const

FAnimationUp ...

 

GetSharedContext()

Returns persistent state that is tracked through animation tree update.

Public function Const

void

 

LogMessage

(
    EMessageSeverity::Type InSeverity,
    FText InMessage
)

Log update message.

Public function Const

FScopedAnimN ...

 

TrackAncestor

(
    NodeType* Node
)

Add a node to the list of tracked ancestors.

Public function Const

FAnimationUp ...

 

WithNodeId

(
    int32 InNodeId
)

Public function Const

FAnimationUp ...

 

WithOtherProxy

(
    FAnimInstanceProxy * InAnimInst...
)

Public function Const

FAnimationUp ...

 

WithOtherSharedContext

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