1. Epic GamesDeveloper
  3. IMovieScenePlayer

IMovieScenePlayer

Interface for movie scene players Provides information for playback of a movie scene

API > API/Runtime > API/Runtime/MovieScene

Inheritance Hierarchy

References

   
Module MovieScene
Header /Engine/Source/Runtime/MovieScene/Public/IMovieScenePlayer.h
Include #include "IMovieScenePlayer.h"

Syntax

class IMovieScenePlayer :  
    public UE::MovieScene::IObjectBindingNotifyPlaybackCapability ,  
    public UE::MovieScene::IStaticBindingOverridesPlaybackCapability

Remarks

Interface for movie scene players Provides information for playback of a movie scene

Variables

  Type Name Description
Public variable TMap< FMovieSceneEvaluationOperand, FMovieSceneEvaluationOperand > BindingOverrides List of binding overrides to use for the sequence
Public variable FMovieScenePreAnimatedState PreAnimatedState Container that stores any per-animated state tokens
Public variable FMovieSceneEvaluationState State Evaluation state that stores global state to do with the playback operation

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Virtual UObject * Cast this player instance as a UObject if possible
Public function Virtual Const bool  
Public function Virtual UMovieSceneEntitySystemLinker * Called to retrieve or construct an entity linker for the specified playback context
Public function Virtual FGuid

CreateBinding ( UMovieSceneSequence* InSequence,
UObject* InObject
)

 Attempts to create a binding for the given object in the given sequence.
Public function void Discard all pre-animated state without restoring it
Public function TArrayView< TWeakObjectPtr<> >

FindBoundObjects ( const FGuid& ObjectBindingID,
FMovieSceneSequenceIDRef SequenceID
)

 Locate objects bound to the specified object guid, in the specified sequence
Public function TArrayView< TWeakObjectPtr<> > Locate objects bound to the specified sequence operand
Public function FGuid

FindCachedObjectId ( UObject& InObject,
FMovieSceneSequenceIDRef SequenceID
)

 Attempt to find the object binding ID for the specified object, in the specified sequence
Public function FGuid

FindObjectId ( UObject& InObject,
FMovieSceneSequenceIDRef SequenceID
)

 Attempt to find the object binding ID for the specified object, in the specified sequence
Public function Const TSharedPtr< const UE::MovieScene::FSharedPlaybackState >  
Public function TSharedPtr< UE::MovieScene::FSharedPlaybackState > Returns the evaluated sequence instance's shared playback state, if any.
Public function Static void

Get ( TArray< IMovieScenePlayer* >& OutPlayers,
bool bOnlyUnstoppedPlayers
)

  
Public function Static IMovieScenePlayer *

Get ( uint16 InUniqueIndex
)

  
Public function FMovieSceneRootEvaluationTemplateInstance & Access the evaluation template that we are playing back
Public function Virtual Const TArray< UObject * > Access the event contexts for this movie scene player
Public function Virtual TScriptInterface< IMovieSceneSequencePlayerObserver > Used to access the Observer in MovieSceneSequencePlayer
Public function UObject *

GetOrCreateDirectorInstance ( TSharedRef< const UE::MovieScene::FSharedPlaybackState > SharedPlaybackState,
FMovieSceneSequenceIDRef SequenceID
)

 Gets a new or existing director blueprint instance for the given root or sub sequence
Public function Virtual IMovieScenePlaybackClient * Access the client in charge of playback
Public function Const const IMovieScenePlaybackClient *  
Public function Virtual Const UObject * Access the playback context for this movie scene player
Public function Const EMovieScenePlayerStatus::Type  
Public function TSharedRef< UE::MovieScene::FSharedPlaybackState > Returns the evaluated sequence instance's shared playback state, asserts if there is none.
Public function Const TSharedRef< const UE::MovieScene::FSharedPlaybackState >  
Public function Virtual FMovieSceneSpawnRegister & Obtain an object responsible for managing movie scene spawnables
Public function Const uint16  
Public function Virtual Const void

GetViewportSettings ( TMap< FViewportClient*, EMovieSceneViewportParams >& ViewportParamsMap
)

 Get the current perspective viewport settings
Public function Virtual Const bool Whether this player utilizes dynamic weighting
Public function Virtual void

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

 Initializes a new root sequence instance and its shared playback state.
Public function void Invalidate any cached state contained within this player causing all entities to be forcibly re-linked and evaluated
Public function Virtual Const bool

IsDisablingEventTriggers ( FFrameTime& DisabledUntilTime
)

 Returns whether event triggers are disabled and if so, until what time.
Public function Const bool  
Public function Virtual Const bool Test whether this is a preview player or not.
Public function Virtual void

OnObjectSpawned ( UObject* InObject,
const FMovieSceneEvaluationOperand& Operand
)

 Called when an object is spawned by sequencer
Public function Virtual void Called to initialize the flag structure that denotes what functions need to be called on this updater
Public function Virtual void

PostEvaluation ( const FMovieSceneContext& Context
)

 Called by the evaluation system after evaluation has occured
Public function Virtual void

PreEvaluation ( const FMovieSceneContext& Context
)

 Called by the evaluation system when evaluation has just started.
Public function void Remove all director blueprint instances
Public function Virtual Const void

ResolveBoundObjects ( const FGuid& InBindingId,
FMovieSceneSequenceID SequenceID,
UMovieSceneSequence& Sequence,
UObject* ResolutionContext,
TArray< UObject*, TInlineAllocator< 1 > >& OutObjects
)

 Resolve objects bound to the specified binding ID
Protected function Virtual Const void

ResolveBoundObjects ( UE::UniversalObjectLocator::FResolveParams& ResolveParams,
const FGuid& InBindingId,
FMovieSceneSequenceID SequenceID,
UMovieSceneSequence& Sequence,
TArray< UObject*, TInlineAllocator< 1 > >& OutObjects
)

 Resolve objects bound to the specified binding ID
Public function void Restore all pre-animated state
Public function void

SavePreAnimatedState ( UObject& InObject,
FMovieSceneAnimTypeID InTokenType,
const IMovieScenePreAnimatedTokenProducer& InProducer
)

 Attempt to save specific state for the specified token state before it animates an object.
Public function void Attempt to save specific state for the specified token state before it mutates state.
Public function Static void

SetIsEvaluatingFlag ( uint16 InUniqueIndex,
bool bIsUpdating
)

  
Public function void  
Public function Virtual void

SetViewportSettings ( const TMap< FViewportClient*, EMovieSceneViewportParams >& ViewportParamsMap
)

 Set the perspective viewport settings
Public function Virtual void

UpdateCameraCut ( UObject* CameraObject,
const EMovieSceneCameraCutParams& CameraCutParams
)

  
Public function Virtual void

UpdateCameraCut ( UObject* CameraObject,
UObject* UnlockIfCameraObject,
bool bJumpCut
)

  

Overridden from IObjectBindingNotifyPlaybackCapability

  Type Name Description
Public function Virtual void Called whenever any object bindings have changed
Public function Virtual void

NotifyBindingUpdate ( const FGuid& InGuid,
FMovieSceneSequenceIDRef InSequenceID,
TArrayView< TWeakObjectPtr<> > Objects
)

 Called whenever an object binding has been resolved to give the player a chance to interact with the objects before they are animated

Overridden from IStaticBindingOverridesPlaybackCapability

  Type Name Description
Public function Virtual void

AddBindingOverride ( const FMovieSceneEvaluationOperand& InOperand,
const FMovieSceneEvaluationOperand& InOverrideOperand
)

 Adds an override for the given operand
Public function Virtual FMovieSceneEvaluationOperand * Retrieves any override for the given operand
Public function Virtual void Removes any override set for the given operand

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page