FPersistentEvaluationData | Unreal Engine 5.7 Documentation

API > API/Runtime > API/Runtime/MovieScene

Structure that stores persistent data that track templates may need during evaluation. Such data can be thought of as a cache which exists as long as the track is being evaluated. The cache can store any abstract data provided it implements IPersistentEvaluationData. Data is stored in buckets that is keyed on either the track (ie, accessible from all child templates/sections), or section (only accessible within the section) Type-safety (through the templated methods) is the responsibility of the user. There should only ever be 1 type of data for each section/track association.


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

Syntax

struct FPersistentEvaluationData

Constructors

Name	Remarks	Include Path	Unreal Specifiers
FPersistentEvaluationData ( const FPersistentEvaluationData& )		Evaluation/PersistentEvaluationData.h
FPersistentEvaluationData ( IMovieScenePlayer& InPlayer )	Proxy constructor from 2 externally owned maps for entity, and shared data	Evaluation/PersistentEvaluationData.h

Variables

Protected

Name	Type	Remarks	Include Path
EntityData	TMap< FMovieSceneEvaluationKey, TUniquePtr< IPersistentEvaluationData > > *	Persistent data that's associated with a template entity (such as a track or a section)	Evaluation/PersistentEvaluationData.h
Player	IMovieScenePlayer &	The movie scene player	Evaluation/PersistentEvaluationData.h
SectionKey	FMovieSceneEvaluationKey		Evaluation/PersistentEvaluationData.h
SharedData	TMap< FSharedPersistentDataKey, TUniquePtr< IPersistentEvaluationData > > *	Persistent data that's shared across multiple template entities	Evaluation/PersistentEvaluationData.h
TrackKey	FMovieSceneEvaluationKey	The keys themselves are mutable since this a proxy representation of the data above.	Evaluation/PersistentEvaluationData.h

Functions

Public

Name	Remarks	Include Path
T & Add ( const FSharedPersistentDataKey& InKey )		Evaluation/PersistentEvaluationData.h
T & AddSectionData()		Evaluation/PersistentEvaluationData.h
T & AddTrackData()		Evaluation/PersistentEvaluationData.h
const FMovieSceneEvaluationKey & DeriveSectionKey ( uint32 InSectionIdentifier ) const	Set the current section based off the current track with the specified section identifier	Evaluation/PersistentEvaluationData.h
const T * Find ( const FSharedPersistentDataKey& InKey ) const		Evaluation/PersistentEvaluationData.h
T * Find ( const FSharedPersistentDataKey& InKey )		Evaluation/PersistentEvaluationData.h
const T * FindInstanceData()	Find the current sequence's instance data as the templated type, provided its type matches	Evaluation/PersistentEvaluationData.h
T * FindSectionData()		Evaluation/PersistentEvaluationData.h
T * FindTrackData ()		Evaluation/PersistentEvaluationData.h
T * FindTrackData ()		Evaluation/PersistentEvaluationData.h
const T & Get ( const FSharedPersistentDataKey& InKey ) const		Evaluation/PersistentEvaluationData.h
T & Get ( const FSharedPersistentDataKey& InKey )		Evaluation/PersistentEvaluationData.h
const FMovieSceneSequenceInstanceData * GetInstanceData()	Get the raw instance data for the current sequence	Evaluation/PersistentEvaluationData.h
IMovieScenePlayer & GetMovieScenePlayer()	Get the player	Evaluation/PersistentEvaluationData.h
T & GetOrAdd ( const FSharedPersistentDataKey& InKey )	User accessor functions for shared data keys	Evaluation/PersistentEvaluationData.h
T & GetOrAddSectionData()	User accessor functions for persistent data relating to the current section	Evaluation/PersistentEvaluationData.h
T & GetOrAddTrackData()	User accessor functions for persistent data relating to the current track	Evaluation/PersistentEvaluationData.h
T & GetSectionData()	~ Section data access is considered const as it can only ever be accessed from a single template (it can do whatever it likes with its own data)	Evaluation/PersistentEvaluationData.h
const FMovieSceneEvaluationKey & GetSectionKey()	Get the currently set section key (ie the section we're currently evaluating)	Evaluation/PersistentEvaluationData.h
T & GetTrackData ()		Evaluation/PersistentEvaluationData.h
T & GetTrackData ()	~ Section data access is considered const as it can only ever be accessed from a single template (it can do whatever it likes with its own data)	Evaluation/PersistentEvaluationData.h
const FMovieSceneEvaluationKey & GetTrackKey()	Get the currently set track key (ie the track we're currently evaluating)	Evaluation/PersistentEvaluationData.h
void Reset ( const FSharedPersistentDataKey& InKey )		Evaluation/PersistentEvaluationData.h
void ResetSectionData()		Evaluation/PersistentEvaluationData.h
void ResetTrackData()		Evaluation/PersistentEvaluationData.h
void SetSectionKey ( const FMovieSceneEvaluationKey& Key ) const	Set the current section	Evaluation/PersistentEvaluationData.h
void SetTrackKey ( const FMovieSceneEvaluationKey& Key ) const	Set the current track	Evaluation/PersistentEvaluationData.h

Operators

Name	Remarks	Include Path	Unreal Specifiers
FPersistentEvaluationData & operator= ( const FPersistentEvaluationData& )		Evaluation/PersistentEvaluationData.h

Navigation