FMovieSceneEvaluationTemplate

Template that is used for efficient runtime evaluation of a movie scene sequence.

Windows
MacOS
Linux

References

Module

MovieScene

Header

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

Include

#include "Evaluation/MovieSceneEvaluationTemplate.h"

Syntax

struct FMovieSceneEvaluationTemplate

Remarks

Template that is used for efficient runtime evaluation of a movie scene sequence. Potentially serialized into the asset.

Variables

Name Description

Public variable

FMovieSceneEval...

 

EvaluationField

Evaluation field for efficient runtime evaluation

Public variable

FMovieSceneSequ...

 

Hierarchy

Map of all sequences found in this template (recursively)

Public variable

FGuid

 

SequenceSignature

Public variable

FMovieSceneEval...

 

TemplateSerialNumber

Serial number that is incremented every time this template is re-generated through FMovieSceneEvaluationTemplateGenerator

Functions

Name Description

Public function

void

 

AddSubSectionRange

(
    UMovieSceneSubSection& InSubSectio...,
    const FGuid& InObjectBindingId,
    const TRange< FFrameNumber >& InRa...,
    ESectionEvaluationFlags InFlags
)

Add a new sub section

Public function

FMovieSceneT...

 

AddTrack

(
    const FGuid& InSignature,
    FMovieSceneEvaluationTrack&& InTra...
)

Add a new track for the specified identifier

Public function

void

 

DefineTrackStructure

(
    FMovieSceneTrackIdentifier TrackIde...,
    bool bInvalidateEvaluationField
)

Define the structural lookup for the specified track identifier, optionally invalidating any overlapping areas in the evaluation field

Public function Const

const FMovie...

 

FindTrack

(
    const FGuid& InSignature
)

Find a track within this template that relates to the specified signature

Public function

FMovieSceneE...

 

FindTrack

(
    const FGuid& InSignature
)

Find a track within this template that relates to the specified signature

Public function Const

const FMovie...

 

FindTrack

(
    FMovieSceneTrackIdentifier Identifi...
)

Attempt to locate a track with the specified identifier

Public function

FMovieSceneE...

 

FindTrack

(
    FMovieSceneTrackIdentifier Identifi...
)

Attempt to locate a track with the specified identifier

Public function Const

const FMovie...

 

GetLedger()

Get this template's generation ledger

Public function Const

const TMovie...

 

GetSubSectionField()

Access this template's sub section field

Public function Const

const TMovie...

 

GetTrackField()

Access this template's track field

Public function

TMap< FMovie...

 

GetTracks()

Iterate this template's tracks (non-const).

Public function Const

const TMap< ...

 

GetTracks()

Iterate this template's tracks.

Public function Const

bool

 

IsTrackStale

(
    FMovieSceneTrackIdentifier Identifi...
)

Test whether the specified track identifier relates to a stale track

Public function

void

 

PostSerialize

(
    const FArchive& Ar
)

Called after this template has been serialized in some way

Public function

void

 

PurgeStaleTracks()

Purge any stale tracks we may have

Public function

void

 

RemoveStaleData

(
    const TSet< FGuid >& ActiveSignatu...
)

Remove any data within this template that does not reside in the specified set of signatures

Public function

void

 

RemoveTrack

(
    const FGuid& InSignature
)

Remove any tracks that correspond to the specified signature

Public function

void

 

ResetFieldData()

Reset this template's field data and sub section cache (keeps tracks alive)

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