Module |
|
Header |
/Engine/Source/Runtime/MovieScene/Public/Evaluation/MovieSceneEvalTemplate.h |
Include |
#include "Evaluation/MovieSceneEvalTemplate.h" |
struct FMovieSceneEvalTemplate : public FMovieSceneEvalTemplateBase
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
Name | Description | ||
---|---|---|---|
|
CompletionMode |
Enumeration value signifying whether we should restore any animated state stored by this entity when this eval tempalte is no longer evaluated |
|
|
TWeakObjectPtr<... |
SourceSectionPtr |
The section from which this template originates |
Name | Description | |
---|---|---|
|
FMovieSceneEvalTemplate() |
Default Constructor |
Name | Description | ||
---|---|---|---|
|
Evaluate ( |
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. |
|
|
float |
EvaluateEasing ( |
Evaluate this template's easing functions based on the specified time |
|
EvaluateSwept ( |
Evaluate this template over the given swept range, adding any execution tokens to the specified list. |
|
|
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. |
|
const UMovie... |
GetSourceSection() |
Get the source section from which this template originated |
|
Initialize ( |
Initialize this template, copying any data required for evaluation into the specified state block. |
|
|
Interrogate ( |
Interrogate this template for its output. Should not have any side effects. |
|
|
Interrogate ( |
Interrogate this template for its output. Should not have any side effects. |
|
|
RequiresInitialization() |
Check whether this template mandates Initialize being called. |
|
|
SetCompletionMode ( |
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. |
|
|
SetSourceSection ( |
Set the source section from which this template originated |
Name |
Description |
|
---|---|---|
|
EOverrideMask |
Enum evaluation flag structure defining which functions are to be called in implementations of this struct |