UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Public Attributes | List of all members
FMovieSceneEvaluationTemplate Struct Reference

#include <MovieSceneEvaluationTemplate.h>

Public Member Functions

FMovieSceneEvaluationTrack * FindTrack (FMovieSceneTrackIdentifier Identifier)
 
const FMovieSceneEvaluationTrack * FindTrack (FMovieSceneTrackIdentifier Identifier) const
 
FMovieSceneEvaluationTrack * FindTrack (const FGuid &InSignature)
 
const FMovieSceneEvaluationTrack * FindTrack (const FGuid &InSignature) const
 
bool IsTrackStale (FMovieSceneTrackIdentifier Identifier) const
 
MOVIESCENE_API FMovieSceneTrackIdentifier AddTrack (const FGuid &InSignature, FMovieSceneEvaluationTrack &&InTrack)
 
MOVIESCENE_API void RemoveTrack (const FGuid &InSignature)
 
MOVIESCENE_API const TMap< FMovieSceneTrackIdentifier, FMovieSceneEvaluationTrack > & GetTracks () const
 
MOVIESCENE_API TMap< FMovieSceneTrackIdentifier, FMovieSceneEvaluationTrack > & GetTracks ()
 
MOVIESCENE_API const TMap< FMovieSceneTrackIdentifier, FMovieSceneEvaluationTrack > & GetStaleTracks () const
 
void PurgeStaleTracks ()
 
const FMovieSceneTemplateGenerationLedger & GetLedger () const
 
void RemoveStaleData (const TSet< FGuid > &ActiveSignatures)
 

Public Attributes

FGuid SequenceSignature
 
FMovieSceneEvaluationTemplateSerialNumber TemplateSerialNumber
 

Detailed Description

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

Member Function Documentation

◆ AddTrack()

FMovieSceneTrackIdentifier FMovieSceneEvaluationTemplate::AddTrack ( const FGuid &  InSignature,
FMovieSceneEvaluationTrack &&  InTrack 
)

Add a new track for the specified identifier

◆ FindTrack() [1/4]

FMovieSceneEvaluationTrack * FMovieSceneEvaluationTemplate::FindTrack ( const FGuid &  InSignature)
inline

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

◆ FindTrack() [2/4]

const FMovieSceneEvaluationTrack * FMovieSceneEvaluationTemplate::FindTrack ( const FGuid &  InSignature) const
inline

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

◆ FindTrack() [3/4]

FMovieSceneEvaluationTrack * FMovieSceneEvaluationTemplate::FindTrack ( FMovieSceneTrackIdentifier  Identifier)
inline

Attempt to locate a track with the specified identifier

◆ FindTrack() [4/4]

const FMovieSceneEvaluationTrack * FMovieSceneEvaluationTemplate::FindTrack ( FMovieSceneTrackIdentifier  Identifier) const
inline

Attempt to locate a track with the specified identifier

◆ GetLedger()

const FMovieSceneTemplateGenerationLedger & FMovieSceneEvaluationTemplate::GetLedger ( ) const
inline

Get this template's generation ledger

◆ GetStaleTracks()

const TMap< FMovieSceneTrackIdentifier, FMovieSceneEvaluationTrack > & FMovieSceneEvaluationTemplate::GetStaleTracks ( ) const

Access this template's stale tracks.

◆ GetTracks() [1/2]

TMap< FMovieSceneTrackIdentifier, FMovieSceneEvaluationTrack > & FMovieSceneEvaluationTemplate::GetTracks ( )

Iterate this template's tracks (non-const). NOTE that this is intended for use during the compilation phase in-editor. Beware of using this to modify tracks afterwards as it will almost certainly break evaluation.

◆ GetTracks() [2/2]

const TMap< FMovieSceneTrackIdentifier, FMovieSceneEvaluationTrack > & FMovieSceneEvaluationTemplate::GetTracks ( ) const

Iterate this template's tracks.

◆ IsTrackStale()

bool FMovieSceneEvaluationTemplate::IsTrackStale ( FMovieSceneTrackIdentifier  Identifier) const
inline

Test whether the specified track identifier relates to a stale track

◆ PurgeStaleTracks()

void FMovieSceneEvaluationTemplate::PurgeStaleTracks ( )
inline

Called after this template has been serialized in some way Purge any stale tracks we may have

◆ RemoveStaleData()

void FMovieSceneEvaluationTemplate::RemoveStaleData ( const TSet< FGuid > &  ActiveSignatures)

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

◆ RemoveTrack()

void FMovieSceneEvaluationTemplate::RemoveTrack ( const FGuid &  InSignature)

Remove any tracks that correspond to the specified signature

Member Data Documentation

◆ SequenceSignature

FGuid FMovieSceneEvaluationTemplate::SequenceSignature

◆ TemplateSerialNumber

FMovieSceneEvaluationTemplateSerialNumber FMovieSceneEvaluationTemplate::TemplateSerialNumber

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

The documentation for this struct was generated from the following files: