UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::MovieScene::FPreAnimatedEvaluationHookCaptureSources Struct Reference

#include <MovieScenePreAnimatedCaptureSources.h>

+ Inheritance diagram for UE::MovieScene::FPreAnimatedEvaluationHookCaptureSources:

Public Member Functions

MOVIESCENE_API FPreAnimatedEvaluationHookCaptureSources (FPreAnimatedStateExtension *InOwner)
 
MOVIESCENE_API EPreAnimatedCaptureSourceState BeginTrackingCaptureSource (const UObject *Hook, FMovieSceneSequenceID SequenceID, const FPreAnimatedStateMetaData &MetaData)
 
MOVIESCENE_API void StopTrackingCaptureSource (const UObject *Hook, FRootInstanceHandle RootInstanceHandle, FMovieSceneSequenceID SequenceID)
 
- Public Member Functions inherited from UE::MovieScene::TPreAnimatedCaptureSources< FPreAnimatedEvalHookKeyType >
 TPreAnimatedCaptureSources (FPreAnimatedStateExtension *InOwner)
 
MOVIESCENE_API EPreAnimatedCaptureSourceState BeginTrackingCaptureSource (const FPreAnimatedEvalHookKeyType &InKey, const FPreAnimatedStateMetaData &MetaData)
 
MOVIESCENE_API void StopTrackingCaptureSource (const FPreAnimatedEvalHookKeyType &InKey, FPreAnimatedStorageID InStorageID)
 
MOVIESCENE_API void StopTrackingCaptureSource (const FPreAnimatedEvalHookKeyType &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

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

Constructor & Destructor Documentation

◆ FPreAnimatedEvaluationHookCaptureSources()

UE::MovieScene::FPreAnimatedEvaluationHookCaptureSources::FPreAnimatedEvaluationHookCaptureSources ( FPreAnimatedStateExtension InOwner)

Member Function Documentation

◆ BeginTrackingCaptureSource()

EPreAnimatedCaptureSourceState UE::MovieScene::FPreAnimatedEvaluationHookCaptureSources::BeginTrackingCaptureSource ( const UObject Hook,
FMovieSceneSequenceID  SequenceID,
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

◆ StopTrackingCaptureSource()

void UE::MovieScene::FPreAnimatedEvaluationHookCaptureSources::StopTrackingCaptureSource ( const UObject Hook,
FRootInstanceHandle  RootInstanceHandle,
FMovieSceneSequenceID  SequenceID 
)

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


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