IMovieScenePlayer

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

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

MovieScene

Header

/Engine/Source/Runtime/MovieScene/Public/IMovieScenePlayer.h

Include

#include "IMovieScenePlayer.h"

Syntax

class IMovieScenePlayer

Remarks

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

Variables

Name Description

Public variable

TMap< FMovieSce...

 

BindingOverrides

List of binding overrides to use for the sequence

Public variable

FMovieScenePreA...

 

PreAnimatedState

Container that stores any per-animated state tokens

Public variable

FMovieSceneEval...

 

State

Evaluation state that stores global state to do with the playback operation

Constructors

Name Description

Public function

IMovieScenePlayer()

Destructors

Name Description

Public function Virtual

~IMovieScenePlayer()

Functions

Name Description

Public function Virtual

UObject *...

 

AsUObject()

Cast this player instance as a UObject if possible

Public function Virtual Const

bool

 

CanUpdateCameraCut()

Whether this player can update the camera cut

Public function Virtual

UMovieSceneE...

 

ConstructEntitySystemLinker()

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

Public function

TArrayView< ...

 

FindBoundObjects

(
    const FGuid& ObjectBindingID,
    FMovieSceneSequenceIDRef SequenceID
)

Locate objects bound to the specified object guid, in the specified sequence @note Objects lists are cached internally until they are invalidate.

Public function

TArrayView< ...

 

FindBoundObjects

(
    const FMovieSceneEvaluationOperand ...
)

Locate objects bound to the specified sequence operand @note Objects lists are cached internally until they are invalidate.

Public function

FGuid

 

FindCachedObjectId

(
    UObject& InObject,
    FMovieSceneSequenceIDRef SequenceID
)

Attempt to find the object binding ID for the specified object, in the specified sequence @note Does not clear the existing cache

Public function

FGuid

 

FindObjectId

(
    UObject& InObject,
    FMovieSceneSequenceIDRef SequenceID
)

Attempt to find the object binding ID for the specified object, in the specified sequence @note Will forcably resolve all out-of-date object mappings in the sequence

Public function Static

IMovieSceneP...

 

Get

(
    uint16 InUniqueIndex
)

Public function

FMovieSceneR...

 

GetEvaluationTemplate()

Access the evaluation template that we are playing back

Public function Virtual Const

TArray< UObj...

 

GetEventContexts()

Access the event contexts for this movie scene player

Public function Virtual

IMovieSceneP...

 

GetPlaybackClient()

Access the client in charge of playback

Public function Virtual Const

UObject *...

 

GetPlaybackContext()

Access the playback context for this movie scene player

Public function Const

EMovieSceneP...

 

GetPlaybackStatus()

Public function Virtual

FMovieSceneS...

 

GetSpawnRegister()

Obtain an object responsible for managing movie scene spawnables

Public function Const

uint16

 

GetUniqueIndex()

Public function Const

void

 

GetViewportSettings

(
    TMap< FViewportClient*, EMovie...
)

Get the current perspective viewport settings

Public function

void

 

InvalidateCachedData()

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 Virtual Const

bool

 

IsPreview()

Test whether this is a preview player or not.

Public function Virtual

void

 

NotifyBindingsChanged()

Called whenever any object bindings have changed

Public function Virtual

void

 

NotifyBindingUpdate

(
    const FGuid& InGuid,
    FMovieSceneSequenceIDRef InSequence...,
    TArrayView< TWeakObjectPtr<>> Objec...
)

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

Public function Virtual

void

 

OnObjectSpawned

(
    UObject* InObject,
    const FMovieSceneEvaluationOperand ...
)

Called wehn an object is spawned by sequencer

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 Virtual Const

void

 

ResolveBoundObjects

(
    const FGuid& InBindingId,
    FMovieSceneSequenceID SequenceID,
    UMovieSceneSequence& Sequence,
    UObject* ResolutionContext,
    TArray< UObject*, TInlineAlloc...
)

Resolve objects bound to the specified binding ID

Public function

void

 

RestorePreAnimatedState()

Restore all pre-animated state

Public function

void

 

SavePreAnimatedState

(
    FMovieSceneAnimTypeID InTokenType,
    const IMovieScenePreAnimatedGlobalT...
)

Attempt to save specific state for the specified token state before it mutates state.

Public function

void

 

SavePreAnimatedState

(
    UObject& InObject,
    FMovieSceneAnimTypeID InTokenType,
    const IMovieScenePreAnimatedTokenPr...
)

Attempt to save specific state for the specified token state before it animates an object.

Public function

void

 

SetPlaybackStatus

(
    EMovieScenePlayerStatus::Type InPla...
)

Public function

void

 

SetViewportSettings

(
    const TMap< FViewportClient*, ...
)

Set the perspective viewport settings

Public function

void

 

UpdateCameraCut

(
    UObject* CameraObject,
    const EMovieSceneCameraCutParams& ...
)

Updates the perspective viewports with the actor to view through

Public function

void

 

UpdateCameraCut

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

Updates the perspective viewports with the actor to view through