UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::MovieScene::TPreAnimatedCaptureSources< KeyType > Struct Template Reference

#include <MovieScenePreAnimatedCaptureSources.h>

+ Inheritance diagram for UE::MovieScene::TPreAnimatedCaptureSources< KeyType >:

Public Member Functions

 TPreAnimatedCaptureSources (FPreAnimatedStateExtension *InOwner)
 
MOVIESCENE_API EPreAnimatedCaptureSourceState BeginTrackingCaptureSource (const KeyType &InKey, const FPreAnimatedStateMetaData &MetaData)
 
MOVIESCENE_API void StopTrackingCaptureSource (const KeyType &InKey, FPreAnimatedStorageID InStorageID)
 
MOVIESCENE_API void StopTrackingCaptureSource (const KeyType &InKey)
 
MOVIESCENE_API void Reset () override
 
MOVIESCENE_API bool ContainsInstanceHandle (FRootInstanceHandle RootInstanceHandle) const override
 
MOVIESCENE_API void GatherAndRemoveExpiredMetaData (const FRestoreStateParams &Params, TArray< FPreAnimatedStateMetaData > &OutExpiredMetaData) override
 
MOVIESCENE_API void GatherAndRemoveMetaDataForGroup (FPreAnimatedStorageGroupHandle Group, TArray< FPreAnimatedStateMetaData > &OutExpiredMetaData) override
 
MOVIESCENE_API void GatherAndRemoveMetaDataForStorage (FPreAnimatedStorageID StorageID, FPreAnimatedStorageIndex StorageIndex, TArray< FPreAnimatedStateMetaData > &OutExpiredMetaData) override
 
MOVIESCENE_API void GatherAndRemoveMetaDataForRootInstance (FRootInstanceHandle InstanceHandle, TArray< FPreAnimatedStateMetaData > &OutExpiredMetaData) override
 
- Public Member Functions inherited from UE::MovieScene::IPreAnimatedCaptureSource
virtual ~IPreAnimatedCaptureSource ()
 

Detailed Description

template<typename KeyType>
struct UE::MovieScene::TPreAnimatedCaptureSources< KeyType >

Structure responsible for tracking contributions to pre-animated state entries that originate from track templates (ie, from an IMovieSceneExecutionToken::Execute)

Constructor & Destructor Documentation

◆ TPreAnimatedCaptureSources()

template<typename KeyType >
UE::MovieScene::TPreAnimatedCaptureSources< KeyType >::TPreAnimatedCaptureSources ( FPreAnimatedStateExtension InOwner)

Member Function Documentation

◆ BeginTrackingCaptureSource()

template<typename KeyType >
EPreAnimatedCaptureSourceState UE::MovieScene::TPreAnimatedCaptureSources< KeyType >::BeginTrackingCaptureSource ( const KeyType &  InKey,
const FPreAnimatedStateMetaData MetaData 
)

Make an association for the specified evaluation key to the value specified by Entry, along with an indication of whether it should be restored on completion

◆ ContainsInstanceHandle()

template<typename KeyType >
bool UE::MovieScene::TPreAnimatedCaptureSources< KeyType >::ContainsInstanceHandle ( FRootInstanceHandle  RootInstanceHandle) const
overridevirtual

◆ GatherAndRemoveExpiredMetaData()

template<typename KeyType >
void UE::MovieScene::TPreAnimatedCaptureSources< KeyType >::GatherAndRemoveExpiredMetaData ( const FRestoreStateParams Params,
TArray< FPreAnimatedStateMetaData > &  OutExpiredMetaData 
)
overridevirtual

◆ GatherAndRemoveMetaDataForGroup()

template<typename KeyType >
void UE::MovieScene::TPreAnimatedCaptureSources< KeyType >::GatherAndRemoveMetaDataForGroup ( FPreAnimatedStorageGroupHandle  Group,
TArray< FPreAnimatedStateMetaData > &  OutExpiredMetaData 
)
overridevirtual

◆ GatherAndRemoveMetaDataForRootInstance()

template<typename KeyType >
void UE::MovieScene::TPreAnimatedCaptureSources< KeyType >::GatherAndRemoveMetaDataForRootInstance ( FRootInstanceHandle  InstanceHandle,
TArray< FPreAnimatedStateMetaData > &  OutExpiredMetaData 
)
overridevirtual

◆ GatherAndRemoveMetaDataForStorage()

template<typename KeyType >
void UE::MovieScene::TPreAnimatedCaptureSources< KeyType >::GatherAndRemoveMetaDataForStorage ( FPreAnimatedStorageID  StorageID,
FPreAnimatedStorageIndex  StorageIndex,
TArray< FPreAnimatedStateMetaData > &  OutExpiredMetaData 
)
overridevirtual

◆ Reset()

template<typename KeyType >
void UE::MovieScene::TPreAnimatedCaptureSources< KeyType >::Reset ( )
overridevirtual

◆ StopTrackingCaptureSource() [1/2]

template<typename KeyType >
void UE::MovieScene::TPreAnimatedCaptureSources< KeyType >::StopTrackingCaptureSource ( const KeyType &  InKey)

Stop tracking the evaluation key in question, restoring the value if it was captured with bWantsRestoreState

◆ StopTrackingCaptureSource() [2/2]

template<typename KeyType >
void UE::MovieScene::TPreAnimatedCaptureSources< KeyType >::StopTrackingCaptureSource ( const KeyType &  InKey,
FPreAnimatedStorageID  InStorageID 
)

Stop tracking the evaluation key in question, where associated with the given storage value ID This restores the value if it was captured with bWantsRestoreState


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