FMovieSceneLegacyPlayer Class Reference

#include <MovieSceneLegacyPlayer.h>

Inheritance diagram for FMovieSceneLegacyPlayer:

Public Member Functions
	FMovieSceneLegacyPlayer ()
	FMovieSceneLegacyPlayer (TSharedRef< UE::MovieScene::FSharedPlaybackState > InSharedPlaybackState)
virtual FMovieSceneRootEvaluationTemplateInstance &	GetEvaluationTemplate () override
virtual UMovieSceneEntitySystemLinker *	ConstructEntitySystemLinker () override
virtual UObject *	AsUObject () override
virtual EMovieScenePlayerStatus::Type	GetPlaybackStatus () const override
virtual void	SetPlaybackStatus (EMovieScenePlayerStatus::Type InPlaybackStatus) override
virtual IMovieScenePlaybackClient *	GetPlaybackClient () override
virtual FMovieSceneSpawnRegister &	GetSpawnRegister () override
virtual UObject *	GetPlaybackContext () const override
virtual void	InitializeRootInstance (TSharedRef< UE::MovieScene::FSharedPlaybackState > NewSharedPlaybackState) override
Public Member Functions inherited from IMovieScenePlayer
MOVIESCENE_API	IMovieScenePlayer ()
virtual MOVIESCENE_API	~IMovieScenePlayer ()
virtual void	SetViewportSettings (const TMap< FViewportClient *, EMovieSceneViewportParams > &ViewportParamsMap)
virtual void	GetViewportSettings (TMap< FViewportClient *, EMovieSceneViewportParams > &ViewportParamsMap) const
virtual MOVIESCENE_API void	ResolveBoundObjects (const FGuid &InBindingId, FMovieSceneSequenceID SequenceID, UMovieSceneSequence &Sequence, UObject *ResolutionContext, TArray< UObject *, TInlineAllocator< 1 > > &OutObjects) const
const IMovieScenePlaybackClient *	GetPlaybackClient () const
virtual void	OnObjectSpawned (UObject *InObject, const FMovieSceneEvaluationOperand &Operand)
virtual void	NotifyBindingUpdate (const FGuid &InGuid, FMovieSceneSequenceIDRef InSequenceID, TArrayView< TWeakObjectPtr<> > Objects) override
virtual void	NotifyBindingsChanged () override
FMovieSceneEvaluationOperand *	GetBindingOverride (const FMovieSceneEvaluationOperand &InOperand)
void	AddBindingOverride (const FMovieSceneEvaluationOperand &InOperand, const FMovieSceneEvaluationOperand &InOverrideOperand)
void	RemoveBindingOverride (const FMovieSceneEvaluationOperand &InOperand)
void	ResetDirectorInstances ()
UObject *	GetOrCreateDirectorInstance (TSharedRef< const UE::MovieScene::FSharedPlaybackState > SharedPlaybackState, FMovieSceneSequenceIDRef SequenceID)
virtual MOVIESCENE_API void	PopulateUpdateFlags (UE::MovieScene::ESequenceInstanceUpdateFlags &OutFlags)
virtual MOVIESCENE_API TArray< UObject * >	GetEventContexts () const
virtual MOVIESCENE_API bool	IsDisablingEventTriggers (FFrameTime &DisabledUntilTime) const
virtual bool	IsPreview () const
virtual bool	HasDynamicWeighting () const
virtual void	PreEvaluation (const FMovieSceneContext &Context)
virtual void	PostEvaluation (const FMovieSceneContext &Context)
virtual TScriptInterface< IMovieSceneSequencePlayerObserver >	GetObserver ()
virtual MOVIESCENE_API FGuid	CreateBinding (UMovieSceneSequence *InSequence, UObject *InObject)
MOVIESCENE_API TArrayView< TWeakObjectPtr<> >	FindBoundObjects (const FGuid &ObjectBindingID, FMovieSceneSequenceIDRef SequenceID)
TArrayView< TWeakObjectPtr<> >	FindBoundObjects (const FMovieSceneEvaluationOperand &Operand)
FGuid	FindObjectId (UObject &InObject, FMovieSceneSequenceIDRef SequenceID)
FGuid	FindCachedObjectId (UObject &InObject, FMovieSceneSequenceIDRef SequenceID)
void	SavePreAnimatedState (UObject &InObject, FMovieSceneAnimTypeID InTokenType, const IMovieScenePreAnimatedTokenProducer &InProducer)
void	SavePreAnimatedState (FMovieSceneAnimTypeID InTokenType, const IMovieScenePreAnimatedGlobalTokenProducer &InProducer)
void	RestorePreAnimatedState ()
void	DiscardPreAnimatedState ()
MOVIESCENE_API void	InvalidateCachedData ()
MOVIESCENE_API bool	IsEvaluating () const
MOVIESCENE_API TSharedPtr< UE::MovieScene::FSharedPlaybackState >	FindSharedPlaybackState ()
MOVIESCENE_API TSharedPtr< const UE::MovieScene::FSharedPlaybackState >	FindSharedPlaybackState () const
MOVIESCENE_API TSharedRef< UE::MovieScene::FSharedPlaybackState >	GetSharedPlaybackState ()
MOVIESCENE_API TSharedRef< const UE::MovieScene::FSharedPlaybackState >	GetSharedPlaybackState () const
uint16	GetUniqueIndex () const
virtual bool	CanUpdateCameraCut () const
virtual void	UpdateCameraCut (UObject *CameraObject, UObject *UnlockIfCameraObject=nullptr, bool bJumpCut=false)
virtual void	UpdateCameraCut (UObject *CameraObject, const EMovieSceneCameraCutParams &CameraCutParams)
MOVIESCENE_API FMovieSceneEvaluationState *	GetEvaluationState ()
MOVIESCENE_API UE::MovieScene::IStaticBindingOverridesPlaybackCapability *	GetStaticBindingOverrides ()

Additional Inherited Members
Static Public Member Functions inherited from IMovieScenePlayer
static MOVIESCENE_API IMovieScenePlayer *	Get (uint16 InUniqueIndex)
static MOVIESCENE_API void	Get (TArray< IMovieScenePlayer * > &OutPlayers, bool bOnlyUnstoppedPlayers)
static MOVIESCENE_API void	SetIsEvaluatingFlag (uint16 InUniqueIndex, bool bIsUpdating)
Public Attributes inherited from IMovieScenePlayer
FMovieSceneEvaluationState	State
FMovieScenePreAnimatedState	PreAnimatedState
TMap< FMovieSceneEvaluationOperand, FMovieSceneEvaluationOperand > &	BindingOverrides
Protected Member Functions inherited from IMovieScenePlayer
virtual MOVIESCENE_API void	ResolveBoundObjects (UE::UniversalObjectLocator::FResolveParams &ResolveParams, const FGuid &InBindingId, FMovieSceneSequenceID SequenceID, UMovieSceneSequence &Sequence, TArray< UObject *, TInlineAllocator< 1 > > &OutObjects) const

Detailed Description

A legacy player implementation only meant for running legacy tracks using the older evaluation template system.

Constructor & Destructor Documentation

FMovieSceneLegacyPlayer() [1/2]

FMovieSceneLegacyPlayer::FMovieSceneLegacyPlayer

(

)

FMovieSceneLegacyPlayer() [2/2]

FMovieSceneLegacyPlayer::FMovieSceneLegacyPlayer

(

TSharedRef< UE::MovieScene::FSharedPlaybackState >

InSharedPlaybackState

)

Member Function Documentation

AsUObject()

UObject * FMovieSceneLegacyPlayer::AsUObject ( )

overridevirtual

Cast this player instance as a UObject if possible

Reimplemented from IMovieScenePlayer.

ConstructEntitySystemLinker()

UMovieSceneEntitySystemLinker * FMovieSceneLegacyPlayer::ConstructEntitySystemLinker ( )

overridevirtual

Called to retrieve or construct an entity linker for the specified playback context

Reimplemented from IMovieScenePlayer.

GetEvaluationTemplate()

FMovieSceneRootEvaluationTemplateInstance & FMovieSceneLegacyPlayer::GetEvaluationTemplate ( )

overridevirtual

Access the evaluation template that we are playing back

Implements IMovieScenePlayer.

GetPlaybackClient()

IMovieScenePlaybackClient * FMovieSceneLegacyPlayer::GetPlaybackClient ( )

overridevirtual

Access the client in charge of playback

Returns

A pointer to the playback client, or nullptr if one is not available

Reimplemented from IMovieScenePlayer.

GetPlaybackContext()

UObject * FMovieSceneLegacyPlayer::GetPlaybackContext ( ) const

overridevirtual

Access the playback context for this movie scene player

Reimplemented from IMovieScenePlayer.

GetPlaybackStatus()

EMovieScenePlayerStatus::Type FMovieSceneLegacyPlayer::GetPlaybackStatus ( ) const

overridevirtual

Returns

whether the player is currently playing, scrubbing, etc.

Implements IMovieScenePlayer.

GetSpawnRegister()

FMovieSceneSpawnRegister & FMovieSceneLegacyPlayer::GetSpawnRegister ( )

overridevirtual

Obtain an object responsible for managing movie scene spawnables

Reimplemented from IMovieScenePlayer.

InitializeRootInstance()

void FMovieSceneLegacyPlayer::InitializeRootInstance ( TSharedRef< UE::MovieScene::FSharedPlaybackState >  NewSharedPlaybackState )

overridevirtual

Initializes a new root sequence instance and its shared playback state. This adds all the player's playback capabilities to the given state.

Reimplemented from IMovieScenePlayer.

SetPlaybackStatus()

void FMovieSceneLegacyPlayer::SetPlaybackStatus ( EMovieScenePlayerStatus::Type  InPlaybackStatus )

overridevirtual

Parameters

PlaybackStatus

The playback status to set

Implements IMovieScenePlayer.

---

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

• Engine/Source/Runtime/MovieScene/Public/MovieSceneLegacyPlayer.h
• Engine/Source/Runtime/MovieScene/Private/MovieSceneLegacyPlayer.cpp