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

#include <MovieScenePreAnimatedCaptureSource.h>

Public Types

using FRootInstanceHandle = UE::MovieScene::FRootInstanceHandle
 
using FSharedPlaybackState = UE::MovieScene::FSharedPlaybackState
 

Public Member Functions

MOVIESCENE_API FScopedPreAnimatedCaptureSource (TSharedRef< const FSharedPlaybackState > SharedPlaybackState, const FMovieSceneEvaluationKey &InEvalKey, bool bInWantsRestoreState)
 
MOVIESCENE_API FScopedPreAnimatedCaptureSource (FMovieScenePreAnimatedState *InPreAnimatedState, const FMovieSceneEvaluationKey &InEvalKey, bool bInWantsRestoreState)
 
MOVIESCENE_API FScopedPreAnimatedCaptureSource (TSharedRef< const FSharedPlaybackState > SharedPlaybackState, const UObject *InEvalHook, FMovieSceneSequenceID InSequenceID, bool bInWantsRestoreState)
 
MOVIESCENE_API FScopedPreAnimatedCaptureSource (FMovieScenePreAnimatedState *InPreAnimatedState, const UObject *InEvalHook, FMovieSceneSequenceID InSequenceID, bool bInWantsRestoreState)
 
MOVIESCENE_API FScopedPreAnimatedCaptureSource (UMovieSceneEntitySystemLinker *InLinker, UMovieSceneTrackInstance *InTrackInstance, bool bInWantsRestoreState)
 
MOVIESCENE_API FScopedPreAnimatedCaptureSource (UMovieSceneEntitySystemLinker *InLinker, const FMovieSceneTrackInstanceInput &TrackInstanceInput)
 
 FScopedPreAnimatedCaptureSource (const FScopedPreAnimatedCaptureSource &)=delete
 
void operator= (const FScopedPreAnimatedCaptureSource &)=delete
 
 FScopedPreAnimatedCaptureSource (FScopedPreAnimatedCaptureSource &&)=delete
 
void operator= (FScopedPreAnimatedCaptureSource &&)=delete
 
MOVIESCENE_API ~FScopedPreAnimatedCaptureSource ()
 
bool WantsRestoreState () const
 

Friends

class FMovieSceneEntitySystemRunner
 
struct UE::MovieScene::FPreAnimatedStateExtension
 

Detailed Description

Scoped structure that can be used to wrap a call to SavePreAnimatedState to associate the capture with a specific capture source.

Member Typedef Documentation

◆ FRootInstanceHandle

using FScopedPreAnimatedCaptureSource::FRootInstanceHandle = UE::MovieScene::FRootInstanceHandle

◆ FSharedPlaybackState

using FScopedPreAnimatedCaptureSource::FSharedPlaybackState = UE::MovieScene::FSharedPlaybackState

Constructor & Destructor Documentation

◆ FScopedPreAnimatedCaptureSource() [1/8]

FScopedPreAnimatedCaptureSource::FScopedPreAnimatedCaptureSource ( TSharedRef< const FSharedPlaybackState >  SharedPlaybackState,
const FMovieSceneEvaluationKey &  InEvalKey,
bool  bInWantsRestoreState 
)
explicit

Construct this capture source from a template (FMovieSceneEvalTemplate) evaluation key, and whether this should restore state when the template is finished

◆ FScopedPreAnimatedCaptureSource() [2/8]

FScopedPreAnimatedCaptureSource::FScopedPreAnimatedCaptureSource ( FMovieScenePreAnimatedState *  InPreAnimatedState,
const FMovieSceneEvaluationKey &  InEvalKey,
bool  bInWantsRestoreState 
)
explicit

Construct this capture source from a template (FMovieSceneEvalTemplate) evaluation key, and whether this should restore state when the template is finished

◆ FScopedPreAnimatedCaptureSource() [3/8]

FScopedPreAnimatedCaptureSource::FScopedPreAnimatedCaptureSource ( TSharedRef< const FSharedPlaybackState >  SharedPlaybackState,
const UObject *  InEvalHook,
FMovieSceneSequenceID  InSequenceID,
bool  bInWantsRestoreState 
)
explicit

Construct this capture source from an evaluation hook (UMovieSceneEvaluationHookSection), its instance handle, and whether this should restore state when the template is finished

◆ FScopedPreAnimatedCaptureSource() [4/8]

FScopedPreAnimatedCaptureSource::FScopedPreAnimatedCaptureSource ( FMovieScenePreAnimatedState *  InPreAnimatedState,
const UObject *  InEvalHook,
FMovieSceneSequenceID  InSequenceID,
bool  bInWantsRestoreState 
)
explicit

Construct this capture source from an evaluation hook (UMovieSceneEvaluationHookSection), its instance handle, and whether this should restore state when the template is finished

◆ FScopedPreAnimatedCaptureSource() [5/8]

FScopedPreAnimatedCaptureSource::FScopedPreAnimatedCaptureSource ( UMovieSceneEntitySystemLinker *  InLinker,
UMovieSceneTrackInstance *  InTrackInstance,
bool  bInWantsRestoreState 
)
explicit

Construct this capture source from a track instance (UMovieSceneTrackInstance) and whether this should restore state when the template is finished

◆ FScopedPreAnimatedCaptureSource() [6/8]

FScopedPreAnimatedCaptureSource::FScopedPreAnimatedCaptureSource ( UMovieSceneEntitySystemLinker *  InLinker,
const FMovieSceneTrackInstanceInput &  TrackInstanceInput 
)
explicit

Construct this capture source from a track instance input (UMovieSceneTrackInstance + FMovieSceneTrackInstanceInput) and whether this should restore state when the template is finished

◆ FScopedPreAnimatedCaptureSource() [7/8]

FScopedPreAnimatedCaptureSource::FScopedPreAnimatedCaptureSource ( const FScopedPreAnimatedCaptureSource &  )
delete

◆ FScopedPreAnimatedCaptureSource() [8/8]

FScopedPreAnimatedCaptureSource::FScopedPreAnimatedCaptureSource ( FScopedPreAnimatedCaptureSource &&  )
delete

◆ ~FScopedPreAnimatedCaptureSource()

FScopedPreAnimatedCaptureSource::~FScopedPreAnimatedCaptureSource ( )

Member Function Documentation

◆ operator=() [1/2]

void FScopedPreAnimatedCaptureSource::operator= ( const FScopedPreAnimatedCaptureSource &  )
delete

◆ operator=() [2/2]

void FScopedPreAnimatedCaptureSource::operator= ( FScopedPreAnimatedCaptureSource &&  )
delete

◆ WantsRestoreState()

bool FScopedPreAnimatedCaptureSource::WantsRestoreState ( ) const
inline

Friends And Related Symbol Documentation

◆ FMovieSceneEntitySystemRunner

friend class FMovieSceneEntitySystemRunner
friend

◆ UE::MovieScene::FPreAnimatedStateExtension

friend struct UE::MovieScene::FPreAnimatedStateExtension
friend
The documentation for this struct was generated from the following files: