FMovieSceneEvalTemplate

Structure used for movie scene evaluation templates contained within a track.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

MovieScene

Header

/Engine/Source/Runtime/MovieScene/Public/Evaluation/MovieSceneEvalTemplate.h

Include

#include "Evaluation/MovieSceneEvalTemplate.h"

Syntax

struct FMovieSceneEvalTemplate : public FMovieSceneEvalTemplateBase

Remarks

Structure used for movie scene evaluation templates contained within a track. Typically these are defined as one per-section. Serialized into a FMovieSceneEvaluationTemplate contained within the sequence itself (for fast initialization at runtime). Templates are executed in a 3-phase algorithm: 1) Initialize: (opt-in) Called at the start of the frame. Able to access mutable state from the playback context. Used to initialize any persistent state required for the evaluation pass. 2) Evaluate: Potentially called on a thread. Should (where possible) perform all costly evaluation logic, accumulating into execution tokens which will be executed at a later time on the game thread. 3) Execute: Called on all previously submitted execution tokens to apply the evaluated state to the movie scene player

Variables

Name Description

Protected variable

EMovieSceneComp...

 

CompletionMode

Enumeration value signifying whether we should restore any animated state stored by this entity when this eval tempalte is no longer evaluated

Protected variable

TWeakObjectPtr<...

 

SourceSectionPtr

The section from which this template originates

Constructors

Name Description

Public function

FMovieSceneEvalTemplate()

Default Constructor

Functions

Name Description

Public function Virtual Const

void

 

Evaluate

(
    const FMovieSceneEvaluationOperand ...,
    const FMovieSceneContext& Context,
    const FPersistentEvaluationData& P...,
    FMovieSceneExecutionTokens& Execut...
)

Evaluate this template, adding any execution tokens to the specified list @note Only called when the containing template has an evaluation method of EEvaluationMethod::Static This function should perform any expensive or costly evaluation logic required to calculate the final animated state.

Protected function Const

float

 

EvaluateEasing

(
    FFrameTime CurrentTime
)

Evaluate this template's easing functions based on the specified time

Public function Virtual Const

void

 

EvaluateSwept

(
    const FMovieSceneEvaluationOperand ...,
    const FMovieSceneContext& Context,
    const TRange< FFrameNumber >& Swep...,
    const FPersistentEvaluationData& P...,
    FMovieSceneExecutionTokens& Execut...
)

Evaluate this template over the given swept range, adding any execution tokens to the specified list.

Public function Const

EMovieSceneC...

 

GetCompletionMode()

Check whether we should restore any pre-animated state that was supplied by this template when it is no longer evaluated @note Pre-animated state bound to evaluation templates is reference counted across all similar animation types for a given object.

Public function Const

const UMovie...

 

GetSourceSection()

Get the source section from which this template originated

Public function Virtual Const

void

 

Initialize

(
    const FMovieSceneEvaluationOperand ...,
    const FMovieSceneContext& Context,
    FPersistentEvaluationData& Persist...,
    IMovieScenePlayer& Player
)

Initialize this template, copying any data required for evaluation into the specified state block.

Public function Virtual Const

void

 

Interrogate

(
    const FMovieSceneContext& Context,
    FMovieSceneInterrogationData& Cont...,
    UObject* BindingOverride
)

Interrogate this template for its output. Should not have any side effects.

Public function Virtual Const

void

 

Interrogate

(
    const FMovieSceneContext& Context,
    TRange< FFrameNumber > SweptRange,
    FMovieSceneInterrogationData& Cont...,
    UObject* BindingOverride
)

Interrogate this template for its output. Should not have any side effects.

Public function Const

bool

 

RequiresInitialization()

Check whether this template mandates Initialize being called.

Public function

void

 

SetCompletionMode

(
    EMovieSceneCompletionMode InComplet...
)

Set this template's completion mode @note Pre-animated state bound to evaluation templates is reference counted across all similar animation types for a given object.

Public function

void

 

SetSourceSection

(
    const UMovieSceneSection* InSo...
)

Set the source section from which this template originated

Enums

Name

Description

Protected enum

EOverrideMask

Enum evaluation flag structure defining which functions are to be called in implementations of this struct

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss