1. Epic GamesDeveloper
  3. FMovieSceneEvalTemplate

FMovieSceneEvalTemplate

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

Unreal Engine C++ API Reference > Runtime > MovieScene > Evaluation

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

  Type Name Description
Protected variable EMovieSceneCompletionMode 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< const UMovieSceneSection > SourceSectionPtr The section from which this template originates

Constructors

  Type Name Description
Public function   Default Constructor

Functions

  Type Name Description
Public function Virtual Const void

Evaluate ( const FMovieSceneEvaluationOperand& Operand,
const FMovieSceneContext& Context,
const FPersistentEvaluationData& PersistentData,
FMovieSceneExecutionTokens& ExecutionTokens
)

 Evaluate this template, adding any execution tokens to the specified list
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& Operand,
const FMovieSceneContext& Context,
const TRange< FFrameNumber >& SweptRange,
const FPersistentEvaluationData& PersistentData,
FMovieSceneExecutionTokens& ExecutionTokens
)

 Evaluate this template over the given swept range, adding any execution tokens to the specified list.
Public function Const EMovieSceneCompletionMode Check whether we should restore any pre-animated state that was supplied by this template when it is no longer evaluated
Public function Const const UMovieSceneSection * Get the source section from which this template originated
Public function Virtual Const void

Initialize ( const FMovieSceneEvaluationOperand& Operand,
const FMovieSceneContext& Context,
FPersistentEvaluationData& PersistentData,
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& Container,
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& Container,
UObject* BindingOverride
)

 Interrogate this template for its output. Should not have any side effects.
Public function Const bool Check whether this template mandates Initialize being called.
Public function void

SetCompletionMode ( EMovieSceneCompletionMode InCompletionMode
)

 Set this template's completion mode
Public function void

SetSourceSection ( const UMovieSceneSection* InSourceSection
)

 Set the source section from which this template originated

Enums

  Type Name Description
Protected enum EOverrideMask Enum evaluation flag structure defining which functions are to be called in implementations of this struct  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page