1. Epic GamesDeveloper
  3. FMovieSceneEvaluationTrack

FMovieSceneEvaluationTrack

Evaluation track that is stored within an evaluation template for a sequence.

API > API/Runtime > API/Runtime/MovieScene

Evaluation track that is stored within an evaluation template for a sequence. Contains user-defined evaluation templates, and an optional track implementation

   
Name FMovieSceneEvaluationTrack
Type struct
Header File /Engine/Source/Runtime/MovieScene/Public/Evaluation/MovieSceneEvaluationTrack.h
Include Path #include "Evaluation/MovieSceneEvaluationTrack.h"

Syntax

USTRUCT ()  
struct FMovieSceneEvaluationTrack

Constructors

Name Remarks Include Path Unreal Specifiers
Copy construction/assignment Evaluation/MovieSceneEvaluationTrack.h  
Move construction/assignment Evaluation/MovieSceneEvaluationTrack.h  

FMovieSceneEvaluationTrack ( const FGuid& InObjectBindingID
)

 User construction, for initialization during compilation Evaluation/MovieSceneEvaluationTrack.h  
Default construction (only for serialization) Evaluation/MovieSceneEvaluationTrack.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bEvaluateInPostroll uint32 Whether this track is evaluated in postroll Evaluation/MovieSceneEvaluationTrack.h  
bEvaluateInPreroll uint32 Whether this track is evaluated in preroll Evaluation/MovieSceneEvaluationTrack.h  
bTearDownPriority uint32 Whether track should be given priority when being torn down Evaluation/MovieSceneEvaluationTrack.h  
ChildTemplates TArray< FMovieSceneEvalTemplatePtr > Domain-specific evaluation templates (normally 1 per section) Evaluation/MovieSceneEvaluationTrack.h  
EvaluationGroup FName Flush group that determines whether this track belongs to a group of tracks Evaluation/MovieSceneEvaluationTrack.h  
EvaluationMethod EEvaluationMethod Evaluation method - static or swept Evaluation/MovieSceneEvaluationTrack.h  
EvaluationPriority uint16 Evaluation priority. Highest is evaluated first Evaluation/MovieSceneEvaluationTrack.h  
ObjectBindingID FGuid ID of the possessable or spawnable within the UMovieScene this track belongs to, if any. Evaluation/MovieSceneEvaluationTrack.h  
SourceTrack TWeakObjectPtr< UMovieSceneTrack > The movie scene track that created this evaluation track. Evaluation/MovieSceneEvaluationTrack.h  
TrackTemplate FMovieSceneTrackImplementationPtr Domain-specific track implementation override. Evaluation/MovieSceneEvaluationTrack.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

int32 AddChildTemplate ( FMovieSceneEvalTemplatePtr&& InTemplate
)

 Add an evaluation template to this track with the given track index Evaluation/MovieSceneEvaluationTrack.h  

void DefaultEvaluate ( TArrayView< const FMovieSceneFieldEntry_ChildTemplate > Children,
const FMovieSceneEvaluationOperand& Operand,
const FMovieSceneContext& Context,
const FPersistentEvaluationData& PersistentData,
FMovieSceneExecutionTokens& ExecutionTokens
) const

 Default implementation of evaluation of child templates for the specified segment Evaluation/MovieSceneEvaluationTrack.h  

void DefaultInitialize ( TArrayView< const FMovieSceneFieldEntry_ChildTemplate > Children,
const FMovieSceneEvaluationOperand& Operand,
FMovieSceneContext Context,
FPersistentEvaluationData& PersistentData,
IMovieScenePlayer& Player
) const

 Default implementation of initialization of child templates for the specified segment Evaluation/MovieSceneEvaluationTrack.h  

void DefineAsSingleTemplate ( FMovieSceneEvalTemplatePtr&& InTemplate
)

 Assign a single eval template to this track, spanning the entire sequence Evaluation/MovieSceneEvaluationTrack.h  

void Evaluate ( TArrayView< const FMovieSceneFieldEntry_ChildTemplate > Children,
const FMovieSceneEvaluationOperand& Operand,
const FMovieSceneContext& Context,
const FPersistentEvaluationData& PersistentData,
FMovieSceneExecutionTokens& ExecutionTokens
) const

 Called to evaluate the specified segment index Evaluation/MovieSceneEvaluationTrack.h  

const FMovieSceneEvalTemplate & GetChildTemplate ( int32 TemplateIndex
) const

 Get the template from the given template index Evaluation/MovieSceneEvaluationTrack.h  
Get this track's child templates Evaluation/MovieSceneEvaluationTrack.h  
Get this track's child templates NOTE that this is intended for use during the compilation phase in-editor. Evaluation/MovieSceneEvaluationTrack.h  

FName GetEvaluationGroup()

 Get this track's evaluation group name. Only used during compilation. Evaluation/MovieSceneEvaluationTrack.h  

EEvaluationMethod GetEvaluationMethod()

 Get the method we should use to evaluate this track Evaluation/MovieSceneEvaluationTrack.h  

uint16 GetEvaluationPriority()

 Get the evaluation bias to apply to this track. Higher priority tracks will be evaluated first. Evaluation/MovieSceneEvaluationTrack.h  

const FGuid & GetObjectBindingID()

 Get the object binding ID that this track belongs to Evaluation/MovieSceneEvaluationTrack.h  

UMovieSceneTrack * GetSourceTrack()

 Get the source track from which this track originates Evaluation/MovieSceneEvaluationTrack.h  

bool HasChildTemplate ( int32 TemplateIndex
) const

 Check whether we have a valid child template for the specified index Evaluation/MovieSceneEvaluationTrack.h  

bool HasCustomInitialize()

   Evaluation/MovieSceneEvaluationTrack.h  

bool HasTearDownPriority()

 Check whether this track has tear down priority or not Evaluation/MovieSceneEvaluationTrack.h  

void Initialize ( TArrayView< const FMovieSceneFieldEntry_ChildTemplate > Children,
const FMovieSceneEvaluationOperand& Operand,
const FMovieSceneContext& Context,
FPersistentEvaluationData& PersistentData,
IMovieScenePlayer& Player
) const

 Called to initialize the specified segment index Evaluation/MovieSceneEvaluationTrack.h  

void Interrogate ( const FMovieSceneContext& Context,
FMovieSceneInterrogationData& Container,
UObject* BindingOverride
) const

 Interrogate this template for its output. Should not have any side effects. Evaluation/MovieSceneEvaluationTrack.h  

void OnBeginEvaluation ( FPersistentEvaluationData& PersistentData,
IMovieScenePlayer& Player
) const

 Called before this track is evaluated for the first time, or since OnEndEvaluation has been called Evaluation/MovieSceneEvaluationTrack.h  

void OnEndEvaluation ( FPersistentEvaluationData& PersistentData,
IMovieScenePlayer& Player
) const

 Called after this track is no longer being evaluated Evaluation/MovieSceneEvaluationTrack.h  

void PostSerialize ( const FArchive& Ar
)

 Post serialize function Evaluation/MovieSceneEvaluationTrack.h  

void PrioritizeTearDown()

 Tell this track to prioritize its tear down over other tracks, regardless of evaluation priority Evaluation/MovieSceneEvaluationTrack.h  

void SetEvaluationGroup ( FName InEvaluationGroup
)

 Set this track's flush group name. Evaluation/MovieSceneEvaluationTrack.h  

void SetEvaluationMethod ( EEvaluationMethod InMethod
)

 Set the method we should use to evaluate this track Evaluation/MovieSceneEvaluationTrack.h  

void SetEvaluationPriority ( uint16 InEvaluationPriority
)

 Get the evaluation bias to apply to this track. Higher priority tracks will be evaluated first. Evaluation/MovieSceneEvaluationTrack.h  

void SetPreAndPostrollConditions ( bool bInEvaluateInPreroll,
bool bInEvaluateInPostroll
)

 Define how this track evaluates in pre and postroll Evaluation/MovieSceneEvaluationTrack.h  

void SetSourceTrack ( UMovieSceneTrack* InSourceTrack
)

 Set the source track from which this track originates Evaluation/MovieSceneEvaluationTrack.h  
Assign a track implementation template to this track Evaluation/MovieSceneEvaluationTrack.h  

void SetupOverrides()

 Setup overrides for any contained templates Evaluation/MovieSceneEvaluationTrack.h  

bool ShouldEvaluateInPostroll()

   Evaluation/MovieSceneEvaluationTrack.h  

bool ShouldEvaluateInPreroll()

   Evaluation/MovieSceneEvaluationTrack.h  

Operators

Name Remarks Include Path Unreal Specifiers
  Evaluation/MovieSceneEvaluationTrack.h  
  Evaluation/MovieSceneEvaluationTrack.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page