Navigation
API > API/Runtime > API/Runtime/MovieScene
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 | FMovieSceneEvalTemplate |
| Type | struct |
| Header File | /Engine/Source/Runtime/MovieScene/Public/Evaluation/MovieSceneEvalTemplate.h |
| Include Path | #include "Evaluation/MovieSceneEvalTemplate.h" |
Syntax
USTRUCT ()
struct FMovieSceneEvalTemplate : public FMovieSceneEvalTemplateBase
Inheritance Hierarchy
- FMovieSceneEvalTemplateBase → FMovieSceneEvalTemplate
Derived Classes
- FMovieSceneParameterSectionTemplate
- FMovieSceneDMXLibraryTemplate
- FMovieSceneGeometryCollectionSectionTemplate
- FMovieScenePropertySectionTemplate
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FMovieSceneEvalTemplate() |
Default Constructor | Evaluation/MovieSceneEvalTemplate.h |
Enums
Protected
| Name | Remarks |
|---|---|
| EOverrideMask | Enum evaluation flag structure defining which functions are to be called in implementations of this struct |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Evaluate
(
const FMovieSceneEvaluationOperand& Operand, |
Evaluate this template, adding any execution tokens to the specified list | Evaluation/MovieSceneEvalTemplate.h | |
virtual void EvaluateSwept
(
const FMovieSceneEvaluationOperand& Operand, |
Evaluate this template over the given swept range, adding any execution tokens to the specified list. | Evaluation/MovieSceneEvalTemplate.h | |
| Check whether we should restore any pre-animated state that was supplied by this template when it is no longer evaluated | Evaluation/MovieSceneEvalTemplate.h | ||
const UMovieSceneSection * GetSourceSection() |
Get the source section from which this template originated | Evaluation/MovieSceneEvalTemplate.h | |
virtual void Initialize
(
const FMovieSceneEvaluationOperand& Operand, |
Initialize this template, copying any data required for evaluation into the specified state block. | Evaluation/MovieSceneEvalTemplate.h | |
virtual void Interrogate
(
const FMovieSceneContext& Context, |
Interrogate this template for its output. Should not have any side effects. | Evaluation/MovieSceneEvalTemplate.h | |
virtual void Interrogate
(
const FMovieSceneContext& Context, |
Interrogate this template for its output. Should not have any side effects. | Evaluation/MovieSceneEvalTemplate.h | |
bool RequiresInitialization () |
Check whether this template mandates Initialize being called. | Evaluation/MovieSceneEvalTemplate.h | |
void SetCompletionMode
(
EMovieSceneCompletionMode InCompletionMode |
Set this template's completion mode | Evaluation/MovieSceneEvalTemplate.h | |
void SetSourceSection
(
const UMovieSceneSection* InSourceSection |
Set the source section from which this template originated | Evaluation/MovieSceneEvalTemplate.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
float EvaluateEasing
(
FFrameTime CurrentTime |
Evaluate this template's easing functions based on the specified time | Evaluation/MovieSceneEvalTemplate.h |