1. Epic GamesDeveloper
  3. UMovieSceneSequence

UMovieSceneSequence

Abstract base class for movie scene animations (C++ version).

Unreal Engine C++ API Reference > Runtime > MovieScene

Inheritance Hierarchy

References

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

Syntax

UCLASS (Abstract, MinimalAPI, Config=Engine, BlueprintType)  
class UMovieSceneSequence : public UMovieSceneSignedObject

Remarks

Abstract base class for movie scene animations (C++ version).

Variables

  Type Name Description
Protected variable UProperty bool bParentContextsAreSignificant True if the result of GetParentObject is significant in object resolution for LocateBoundObjects.
Protected variable UProperty bool bPlayableDirectly When true, this sequence should be compiled as if it is playable directly (outside of a root sequence).
Public variable UProperty Config EMovieSceneCompletionMode DefaultCompletionMode The default completion mode for this movie scene when a section's completion mode is set to project default
Protected variable UProperty EMovieSceneSequenceFlags SequenceFlags Flags used to define this sequence's behavior and characteristics

Constructors

  Type Name Description
Public function  

UMovieSceneSequence ( const FObjectInitializer& Init
)

  

Functions

  Type Name Description
Public function Virtual Const bool Whether the sequence type supports custom bindings.
Public function Virtual Const bool Whether objects can be spawned at run-time.
Public function Const bool True if the result of GetParentObject is significant in object resolution for LocateBoundObjects.
Public function Virtual void  
Public function Virtual void

BindPossessableObject ( const FGuid& ObjectId,
UObject& PossessedObject,
UObject* Context
)

 Called when Sequencer has created an object binding for a possessable object
Public function Virtual Const bool

CanAnimateObject ( UObject& InObject
)

 Specifies whether this sequence can animate the object in question (either as a spawnable or possessable)
Public function Virtual Const bool

CanPossessObject ( UObject& Object,
UObject* InPlaybackContext
)

 Check whether the given object can be possessed by this animation.
Public function Virtual Const bool

CanRebindPossessable ( const FMovieScenePossessable& InPossessable
)

 Specifies whether this sequence allows rebinding of the specified possessable
Public function UObject *  
Public function Virtual UObject *

CreateDirectorInstance ( TSharedRef< const FSharedPlaybackState > SharedPlaybackState,
FMovieSceneSequenceID SequenceID
)

 Called to retrieve or construct a director instance to be used for the specified player
Public function Virtual FGuid

CreatePossessable ( UObject* ObjectToPossess
)

 Called to add a new possessable for the specified object
Public function Virtual FGuid

CreateSpawnable ( UObject* ObjectToSpawn
)

 Called to add a new spawnable for the specified object
Public function Const UFunction BlueprintCallable, Category FMovieSceneObjectBindingID

FindBindingByTag ( FName InBindingName
)

 Find the first object binding ID associated with the specified tag name (set up through RMB->Expose on Object bindings from within sequencer)
Public function Virtual Const FGuid

FindBindingFromObject ( UObject* InObject,
UObject* Context
)

  
Public function Virtual Const FGuid

FindBindingFromObject ( UObject* InObject,
TSharedRef< const FSharedPlaybackState > SharedPlaybackState
)

 Optional method for efficient lookup of an object binding from an actual object in the world
Public function Const UFunction BlueprintCallable, Category const TArray< FMovieSceneObjectBindingID > &

FindBindingsByTag ( FName InBindingName
)

 Find all object binding IDs associated with the specified tag name (set up through RMB->Expose on Object bindings from within sequencer)
Public function Const FGuid

FindPossessableObjectId ( UObject& Object,
UObject* Context
)

 Attempt to find the guid relating to the specified object
Public function Virtual Const void

GatherExpiredObjects ( const FMovieSceneObjectCache& InObjectCache,
TArray< FGuid >& OutInvalidIDs
)

 Called to validate the specified object cache by removing anything that should be deemed out of date
Public function FMovieSceneBindingReferences * Retrieve core UOL-based binding references for this sequence type.
Public function Virtual Const const FMovieSceneBindingReferences * (Optional) Retrieve core UOL-based binding references for this sequence type.
Public function Const UMovieSceneCompiledData *  
Public function Virtual Const const FSlateBrush *

GetCustomBrushForBinding ( FGuid BindingID
)

  
Public function Virtual Const FText Get the display name for this movie sequence
Public function Const UFunction BlueprintCallable, Category FMovieSceneTimecodeSource Get the earliest timecode source out of all of the movie scene sections contained within this sequence's movie scene.
Public function Const EMovieSceneSequenceFlags Access the flags that define this sequence's characteristics and behavior
Public function Virtual Const UMovieScene * Get the movie scene that controls this animation.
Public function UMovieSceneCompiledData *  
Public function Virtual Const UObject *

GetParentObject ( UObject* Object
)

 Get the logical parent object for the supplied object (not necessarily its outer).
Public function Const bool Check whether this sequence is playable directly outside of a root sub sequence or not
Public function Const ETrackSupport Sequences can determine whether they support a particular track type
Public function Virtual Const ETrackSupport Subclasses can implement this to determine whether they support a particular track type
Public function Virtual void

IterateDynamicBindings ( TFunction< void(const FGuid&, FMovieSceneDynamicBinding&)> InCallback
)

  
Public function Virtual Const void

LocateBoundObjects ( const FGuid& ObjectId,
const UE::UniversalObjectLocator::FResolveParams& ResolveParams,
TSharedPtr< const FSharedPlaybackState > SharedPlaybackState,
TArray< UObject*, TInlineAllocator< 1 > >& OutObjects
)

 Locate all the objects that correspond to the specified object ID, using the specified parameters.
Public function Virtual Const void

LocateBoundObjects ( const FGuid& ObjectId,
UObject* Context,
TArray< UObject*, TInlineAllocator< 1 > >& OutObjects
)

 Locate all the objects that correspond to the specified object ID, using the specified context.
Public function Const TArray< UObject *, TInlineAllocator< 1 > >

LocateBoundObjects ( const FGuid& ObjectId,
const UE::UniversalObjectLocator::FResolveParams& Context
)

 Locate all the objects that correspond to the specified object ID, using the specified context Calling this directly instead of IMovieScenePlayer::ResolveBoundObjects means that you won't be able to locate Spawnable objects or objects from Custom Bindings.
Public function Const void

LocateBoundObjects ( const FGuid& ObjectId,
const UE::UniversalObjectLocator::FResolveParams& ResolveParams,
TArray< UObject*, TInlineAllocator< 1 > >& OutObjects
)

 Locate all the objects that correspond to the specified object ID, using the specified parameters.
Public function Virtual Const bool

MakeLocatorForObject ( UObject* Object,
UObject* Context,
FUniversalObjectLocator& OutLocator
)

 Called when Sequencer has created an object binding for a possessable object
Public function Virtual UObject *

MakeSpawnableTemplateFromInstance ( UObject& InSourceObject,
FName ObjectName
)

 Create a spawnable object template from the specified source object
Public function Virtual Const EMovieSceneServerClientMask  
Public function Virtual void

PostDuplicate ( bool bDuplicateForPIE
)

  
Public function Virtual void

PreSave ( FObjectPreSaveContext ObjectSaveContext
)

  
Public function Virtual void

Serialize ( FArchive& Ar
)

  
Public function void

SetPlayableDirectly ( bool bInPlayableDirectly
)

 Assign whether this sequence is playable directly outside of a root sub sequence or not
Public function void  
Public function Virtual void

UnbindInvalidObjects ( const FGuid& ObjectId,
UObject* Context
)

 Unbinds specific objects from the provided GUID that do not resolve
Public function Virtual void

UnbindObjects ( const FGuid& ObjectId,
const TArray< UObject* >& InObjects,
UObject* Context
)

 Unbinds specific objects from the provided GUID
Public function Virtual void

UnbindPossessableObjects ( const FGuid& ObjectId
)

 Unbinds all possessable objects from the provided GUID.
Public function void

UnloadBoundObject ( const UE::UniversalObjectLocator::FResolveParams& ResolveParams,
const FGuid& ObjectId,
int32 BindingIndex
)

 Unloads an object that has been loaded via a locator.

Overridden from UMovieSceneSignedObject

  Type Name Description
Public function Virtual void  

Typedefs

Name Description
FSharedPlaybackState  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page