FPersistentEvaluationData

Structure that stores persistent data that track templates may need during evaluation.

Windows
MacOS
Linux

References

Module

MovieScene

Header

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

Include

#include "Evaluation/PersistentEvaluationData.h"

Syntax

struct FPersistentEvaluationData

Remarks

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.

Constructors

Name Description

Public function

FPersistentEvaluationData

(
    IMovieScenePlayer& InPlayer
)

Proxy constructor from 2 externally owned maps for entity, and shared data

Public function

FPersistentEvaluationData

(
    const FPersistentEvaluationData&
)

Functions

Name Description

Public function

T &

 

Add

(
    const FSharedPersistentDataKey& In...
)

Public function

T &

 

AddSectionData()

Public function

T &

 

AddTrackData()

Public function Const

const FMovie...

 

DeriveSectionKey

(
    uint32 InSectionIdentifier
)

Set the current section based off the current track with the specified section identifier

Public function Const

const T *...

 

Find

(
    const FSharedPersistentDataKey& In...
)

Public function

T *

 

Find

(
    const FSharedPersistentDataKey& In...
)

Public function Const

const T *...

 

FindInstanceData()

Find the current sequence's instance data as the templated type, provided its type matches

Public function Const

T *

 

FindSectionData()

Public function Const

T *

 

FindTrackData()

Public function

T *

 

FindTrackData()

Public function Const

const T &

 

Get

(
    const FSharedPersistentDataKey& In...
)

Public function

T &

 

Get

(
    const FSharedPersistentDataKey& In...
)

Public function Const

const FMovie...

 

GetInstanceData()

Get the raw instance data for the current sequence

Public function

T &

 

GetOrAdd

(
    const FSharedPersistentDataKey& In...
)

User accessor functions for shared data keys

Public function

T &

 

GetOrAddSectionData()

User accessor functions for persistent data relating to the current section

Public function

T &

 

GetOrAddTrackData()

User accessor functions for persistent data relating to the current track

Public function Const

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)

Public function Const

const FMovie...

 

GetSectionKey()

Get the currently set section key (ie the section we're currently evaluating)

Public function Const

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)

Public function

T &

 

GetTrackData()

Public function Const

const FMovie...

 

GetTrackKey()

Get the currently set track key (ie the track we're currently evaluating)

Public function

void

 

Reset

(
    const FSharedPersistentDataKey& In...
)

Public function

void

 

ResetSectionData()

Public function

void

 

ResetTrackData()

Public function Const

void

 

SetSectionKey

(
    const FMovieSceneEvaluationKey& Ke...
)

Set the current section

Public function Const

void

 

SetTrackKey

(
    const FMovieSceneEvaluationKey& Ke...
)

Set the current track

Operators

Name Description

Public function

FPersistentE...

 

operator=

(
    const FPersistentEvaluationData&
)

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