1. Epic GamesDeveloper
  3. UMovieSceneSequence

UMovieSceneSequence

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

API > API/Runtime > API/Runtime/MovieScene

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

   
Name UMovieSceneSequence
Type class
Header File /Engine/Source/Runtime/MovieScene/Public/MovieSceneSequence.h
Include Path #include "MovieSceneSequence.h"

Syntax

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

Inheritance Hierarchy

Derived Classes

UMovieSceneSequence derived class hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UMovieSceneSequence ( const FObjectInitializer& Init
)

   MovieSceneSequence.h  

Typedefs

Name Type Remarks Include Path
FSharedPlaybackState UE::MovieScene::FSharedPlaybackState   MovieSceneSequence.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
DefaultCompletionMode EMovieSceneCompletionMode The default completion mode for this movie scene when a section's completion mode is set to project default MovieSceneSequence.h
  • Config

Protected

Name Type Remarks Include Path Unreal Specifiers
CompiledData TObjectPtr< UMovieSceneCompiledData > Serialized compiled data - should only be used through UMovieSceneCompiledDataManager MovieSceneSequence.h
  • Instanced

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual bool AllowsCustomBindings()

 Whether the sequence type supports custom bindings. MovieSceneSequence.h  

virtual bool AllowsSpawnableObjects()

 Whether objects can be spawned at run-time. MovieSceneSequence.h  

bool AreParentContextsSignificant()

 True if the result of GetParentObject is significant in object resolution for LocateBoundObjects. MovieSceneSequence.h  

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

 Called when Sequencer has created an object binding for a possessable object MovieSceneSequence.h  

virtual bool CanAnimateObject ( UObject& InObject
) const

 Specifies whether this sequence can animate the object in question (either as a spawnable or possessable) MovieSceneSequence.h  

virtual bool CanPossessObject ( UObject& Object,
UObject* InPlaybackContext
) const

 Check whether the given object can be possessed by this animation. MovieSceneSequence.h  

virtual bool CanRebindPossessable ( const FMovieScenePossessable& InPossessable
) const

 Specifies whether this sequence allows rebinding of the specified possessable MovieSceneSequence.h  
  MovieSceneSequence.h  

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

 Called to retrieve or construct a director instance to be used for the specified player MovieSceneSequence.h  

virtual FGuid CreatePossessable ( UObject* ObjectToPossess
)

 Called to add a new possessable for the specified object MovieSceneSequence.h  

virtual FGuid CreateSpawnable ( UObject* ObjectToSpawn
)

 Called to add a new spawnable for the specified object MovieSceneSequence.h  

FMovieSceneObjectBindingID FindBindingByTag ( FName InBindingName
) const

 Find the first object binding ID associated with the specified tag name (set up through RMB->Expose on Object bindings from within sequencer) MovieSceneSequence.h
  • BlueprintCallable
  • Category="Sequencer|Sequence"

virtual FGuid FindBindingFromObject ( UObject* InObject,
UObject* Context
) const

   MovieSceneSequence.h  

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

 Optional method for efficient lookup of an object binding from an actual object in the world MovieSceneSequence.h  

const TArray< FMovieSceneObjectBindingID > & FindBindingsByTag ( FName InBindingName
) const

 Find all object binding IDs associated with the specified tag name (set up through RMB->Expose on Object bindings from within sequencer) MovieSceneSequence.h
  • BlueprintCallable
  • Category="Sequencer|Sequence"

FGuid FindPossessableObjectId ( UObject& Object,
UObject* Context
) const

 Attempt to find the guid relating to the specified object MovieSceneSequence.h  

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

 Called to validate the specified object cache by removing anything that should be deemed out of date MovieSceneSequence.h  
Retrieve core UOL-based binding references for this sequence type. MovieSceneSequence.h  
(Optional) Retrieve core UOL-based binding references for this sequence type. MovieSceneSequence.h  

UMovieSceneCompiledData * GetCompiledData()

   MovieSceneSequence.h  

virtual const FSlateBrush * GetCustomBrushForBinding ( FGuid BindingID
) const

   MovieSceneSequence.h  

virtual FText GetDisplayName()

 Get the display name for this movie sequence MovieSceneSequence.h  

FMovieSceneTimecodeSource GetEarliestTimecodeSource()

 Get the earliest timecode source out of all of the movie scene sections contained within this sequence's movie scene. MovieSceneSequence.h
  • BlueprintCallable
  • Category="Sequencer|Sequence"
Access the flags that define this sequence's characteristics and behavior MovieSceneSequence.h  

virtual UMovieScene * GetMovieScene ()

 Get the movie scene that controls this animation. MovieSceneSequence.h  

UMovieSceneCompiledData * GetOrCreateCompiledData()

   MovieSceneSequence.h  

virtual UObject * GetParentObject ( UObject* Object
) const

 Get the logical parent object for the supplied object (not necessarily its outer). MovieSceneSequence.h  

virtual bool IsCompatibleAsSubSequence ( const UMovieSceneSequence& ParentSequence
) const

 Sequences can determine if they would be compatible as a subsequence to the given parent sequence. MovieSceneSequence.h  

virtual bool IsCompatibleSubSequence ( const UMovieSceneSequence& SubSequence
) const

 Sequences can determine if the given sequence would be compatible as a subsequence. MovieSceneSequence.h  

bool IsFilterSupported ( const FString& InFilterName
) const

 Sequences can determine whether they support a particular filter type MovieSceneSequence.h  

virtual bool IsFilterSupportedImpl ( const FString& InFilterName
) const

 Subclasses can implement this to determine whether they support a particular filter type MovieSceneSequence.h  

bool IsPlayableDirectly()

 Check whether this sequence is playable directly outside of a root sub sequence or not MovieSceneSequence.h  

bool IsSubSequenceCompatible ( const UMovieSceneSequence& SubSequence
) const

 Given a sequence, checks if it is compatible as a subsequence to this sequence. MovieSceneSequence.h  

ETrackSupport IsTrackSupported ( TSubclassOf< UMovieSceneTrack > InTrackClass
) const

 Sequences can determine whether they support a particular track type MovieSceneSequence.h  

virtual ETrackSupport IsTrackSupportedImpl ( TSubclassOf< UMovieSceneTrack > InTrackClass
) const

 Subclasses can implement this to determine whether they support a particular track type MovieSceneSequence.h  

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

   MovieSceneSequence.h  

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

 Locate all the objects that correspond to the specified object ID, using the specified parameters. MovieSceneSequence.h  

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

 Locate all the objects that correspond to the specified object ID, using the specified context. MovieSceneSequence.h  

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

 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. MovieSceneSequence.h  

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

 Locate all the objects that correspond to the specified object ID, using the specified parameters. MovieSceneSequence.h  

virtual bool MakeLocatorForObject ( UObject* Object,
UObject* Context,
FUniversalObjectLocator& OutLocator
) const

 Called when Sequencer has created an object binding for a possessable object MovieSceneSequence.h  

virtual UObject * MakeSpawnableTemplateFromInstance ( UObject& InSourceObject,
FName ObjectName
)

 Create a spawnable object template from the specified source object MovieSceneSequence.h  

virtual EMovieSceneServerClientMask OverrideNetworkMask ( EMovieSceneServerClientMask InDefaultMask
) const

   MovieSceneSequence.h  

void SetPlayableDirectly ( bool bInPlayableDirectly
)

 Assign whether this sequence is playable directly outside of a root sub sequence or not MovieSceneSequence.h  

void SetSequenceFlags ( EMovieSceneSequenceFlags InFlags
)

   MovieSceneSequence.h  

virtual void UnbindInvalidObjects ( const FGuid& ObjectId,
UObject* Context
)

 Unbinds specific objects from the provided GUID that do not resolve MovieSceneSequence.h  

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

 Unbinds specific objects from the provided GUID MovieSceneSequence.h  

virtual void UnbindPossessableObjects ( const FGuid& ObjectId
)

 Unbinds all possessable objects from the provided GUID. MovieSceneSequence.h  

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

 Unloads an object that has been loaded via a locator. MovieSceneSequence.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   MovieSceneSequence.h  

virtual void PostDuplicate ( bool bDuplicateForPIE
)

   MovieSceneSequence.h  

virtual void PostLoad()

   MovieSceneSequence.h  

virtual void PreSave ( FObjectPreSaveContext ObjectSaveContext
)

   MovieSceneSequence.h  

virtual void Serialize ( FArchive& Ar
)

   MovieSceneSequence.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page