FMovieSceneEvaluationTrack

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

Windows
MacOS
Linux

References

Module

MovieScene

Header

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

Include

#include "Evaluation/MovieSceneEvaluationTrack.h"

Syntax

struct FMovieSceneEvaluationTrack

Remarks

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

Constructors

Name Description

Public function

FMovieSceneEvaluationTrack()

Default construction (only for serialization)

Public function

FMovieSceneEvaluationTrack

(
    const FGuid& InObjectBindingID
)

User construction, for initialization during compilation

Public function

FMovieSceneEvaluationTrack

(
    const FMovieSceneEvaluationTrack&
)

Copy construction/assignment

Public function

FMovieSceneEvaluationTrack

Move construction/assignment

Functions

Name Description

Public function

int32

 

AddChildTemplate

(
    FMovieSceneEvalTemplatePtr&& InTem...
)

Add an evaluation template to this track with the given track index

Public function

void

 

AddTreeData

(
    TRange< FFrameNumber > Range,
    FSectionEvaluationData EvalData
)

Add section evaluation data to the evaluation tree for this track

Public function

void

 

AddUniqueTreeData

(
    TRange< FFrameNumber > Range,
    FSectionEvaluationData EvalData
)

Add section evaluation data to the evaluation tree for this track, ensuring no duplciates

Public function Const

void

 

DefaultEvaluate

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

Default implementation of evaluation of child templates for the specified segment

Public function Const

void

 

DefaultInitialize

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

Default implementation of initialization of child templates for the specified segment

Public function

void

 

DefineAsSingleTemplate

(
    FMovieSceneEvalTemplatePtr&& InTem...
)

Assign a single eval template to this track, spanning the entire sequence

Public function Const

void

 

Evaluate

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

Called to evaluate the specified segment index

Public function

FMovieSceneS...

 

FindFirstSegment

(
    TRange< FFrameNumber > InLocalRange
)

Find the first segment that overlaps the specified range

Public function Const

const FMovie...

 

GetChildTemplate

(
    int32 TemplateIndex
)

Get the template from the given template index

Public function

TArrayView< ...

 

GetChildTemplates()

Get this track's child templates NOTE that this is intended for use during the compilation phase in-editor.

Public function Const

TMovieSceneE...

 

GetData

Retrieve the section evaluation data for the specified node in this track's evaluation tree

Public function Const

FName

 

GetEvaluationGroup()

Get this track's evaluation group name. Only used during compilation.

Public function Const

EEvaluationM...

 

GetEvaluationMethod()

Get the method we should use to evaluate this track

Public function Const

uint16

 

GetEvaluationPriority()

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

Public function Const

const FGuid ...

 

GetObjectBindingID()

Get the object binding ID that this track belongs to

Public function Const

const FMovie...

 

GetSegment

Get the segment from the given segment index

Public function

FMovieSceneS...

 

GetSegmentFromIterator

Find or compile a segment for the specified iterator

Public function

FMovieSceneS...

 

GetSegmentFromTime

(
    FFrameNumber InTime
)

Find or compile a segment for the specified time

Public function

TArray< FMov...

 

GetSegmentsInRange

(
    TRange< FFrameNumber > InLocalRange
)

Find or compile all segments that overlap the specified range

Public function Const

TArrayView< ...

 

GetSortedSegments()

Get the segment from the given segment index

Public function Const

const UMovie...

 

GetSourceTrack()

Get the source track from which this track originates

Public function Const

bool

 

HasChildTemplate

(
    int32 TemplateIndex
)

Check whether we have a valid child template for the specified index

Public function Const

bool

 

HasTearDownPriority()

Check whether this track has tear down priority or not

Public function Const

void

 

Initialize

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

Called to initialize the specified segment index

Public function

void

 

Interrogate

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

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

Public function Const

FMovieSceneE...

 

Iterate()

Iterate all this track's unique time ranges

Public function Const

FMovieSceneE...

 

IterateFrom

(
    TRangeBound< FFrameNumber > LowerBo...
)

Iterate all this track's unique time ranges starting from the specified lower bound

Public function Const

void

 

OnBeginEvaluation

(
    FPersistentEvaluationData& Persist...,
    IMovieScenePlayer& Player
)

Called before this track is evaluated for the first time, or since OnEndEvaluation has been called

Public function Const

void

 

OnEndEvaluation

(
    FPersistentEvaluationData& Persist...,
    IMovieScenePlayer& Player
)

Called after this track is no longer being evaluated

Public function

void

 

PostSerialize

(
    const FArchive& Ar
)

Post serialize function

Public function

void

 

PrioritizeTearDown()

Tell this track to prioritize its tear down over other tracks, regardless of evaluation priority

Public function

void

 

SetEvaluationGroup

(
    FName InEvaluationGroup
)

Set this track's flush group name.

Public function

void

 

SetEvaluationMethod

(
    EEvaluationMethod InMethod
)

Set the method we should use to evaluate this track

Public function

void

 

SetEvaluationPriority

(
    uint16 InEvaluationPriority
)

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

Public function

void

 

SetPreAndPostrollConditions

(
    bool bInEvaluateInPreroll,
    bool bInEvaluateInPostroll
)

Define how this track evaluates in pre and postroll

Public function

void

 

SetSourceTrack

(
    const UMovieSceneTrack* InSour...
)

Set the source track from which this track originates

Public function

TEnableIf< T...

 

SetTrackImplementation

(
    T&& InImpl
)

Assign a track implementation template to this track

Public function

void

 

SetupOverrides()

Setup overrides for any contained templates

Public function Const

bool

 

ShouldEvaluateInPostroll()

Public function Const

bool

 

ShouldEvaluateInPreroll()

Operators

Name Description

Public function

FMovieSceneE...

 

operator=

(
    const FMovieSceneEvaluationTrack&
)

Public function

FMovieSceneE...

 

operator=

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