1. Epic GamesDeveloper
  3. UMovieScene

UMovieScene

Implements a movie scene asset.

API > API/Runtime > API/Runtime/MovieScene

Implements a movie scene asset.

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

Syntax

UCLASS (DefaultToInstanced, MinimalAPI)  
class UMovieScene : public UMovieSceneDecorationContainerObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UMovieScene ( const FObjectInitializer& ObjectInitializer
)

   MovieScene.h  

Typedefs

Name Type Remarks Include Path
FFixupDirectorBlueprintConditionPayloadParameterNameEvent TMulticastDelegate_FourParams< void, UMovieScene *, UK2Node *, FName, FName >   MovieScene.h
FFixupDynamicBindingPayloadParameterNameEvent TMulticastDelegate_FourParams< void, UMovieScene *, UK2Node *, FName, FName >   MovieScene.h
FIsConditionClassAllowedEvent TBaseDelegate_OneParam< bool, const UClass * >   MovieScene.h
FIsCustomBindingClassAllowedEvent TBaseDelegate_OneParam< bool, UClass * >   MovieScene.h
FIsTrackClassAllowedEvent TBaseDelegate_OneParam< bool, UClass * >   MovieScene.h

Constants

Name Type Remarks Include Path
FixupDirectorBlueprintConditionPayloadParameterNameEvent FFixupDirectorBlueprintConditionPayloadParameterNameEvent   MovieScene.h
FixupDynamicBindingPayloadParameterNameEvent FFixupDynamicBindingPayloadParameterNameEvent   MovieScene.h
IsConditionClassAllowedEvent FIsConditionClassAllowedEvent   MovieScene.h
IsCustomBindingClassAllowedEvent FIsCustomBindingClassAllowedEvent   MovieScene.h
IsTrackClassAllowedEvent FIsTrackClassAllowedEvent   MovieScene.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
EventHandlers UE::MovieScene::TDataEventContainer< UE::MovieScene::ISequenceDataEventHandler >   MovieScene.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
bGloballyShowMarkedFrames bool Whether this scene's marked frames should be shown globally MovieScene.h  
BindingGroups TMap< FName, FMovieSceneObjectBindingIDs > Map of persistent tagged bindings for this sequence MovieScene.h  
bMarkedFramesLocked bool User-defined marked frames are locked. MovieScene.h  
bPlaybackRangeLocked bool User-defined playback range is locked. MovieScene.h  
bReadOnly bool Indicates whether this movie scene is read only MovieScene.h  
CameraCutTrack TObjectPtr< UMovieSceneTrack > The camera cut track is a specialized track for switching between cameras on a cinematic MovieScene.h
  • Instanced
ClockSource EUpdateClockSource   MovieScene.h  
CustomClock TObjectPtr< UMovieSceneClock > A custom clock implementation MovieScene.h
  • Instanced
DisplayRate FFrameRate The rate at which we should interact with this moviescene data on UI, and to movie scene players. MovieScene.h  
EditorData FMovieSceneEditorData Editor only data that needs to be saved between sessions for editing but has no runtime purpose MovieScene.h  
EvaluationType EMovieSceneEvaluationType The type of evaluation to use when playing back this sequence MovieScene.h  
GeneratedConditions TArray< TObjectPtr< UMovieSceneGroupCondition > > List of compiler generated group conditions, stored here to prevent garbage collection. MovieScene.h  
MarkedFrames TArray< FMovieSceneMarkedFrame > The set of user-marked frames MovieScene.h  
NodeGroupCollection TObjectPtr< UMovieSceneNodeGroupCollection > Collection of user-defined groups MovieScene.h  
ObjectBindings TArray< FMovieSceneBinding > Tracks bound to possessed or spawned objects MovieScene.h  
ObjectsToDisplayNames TMap< FString, FText > Maps object GUIDs to user defined display names. MovieScene.h  
ObjectsToLabels TMap< FString, FMovieSceneTrackLabels > Maps object GUIDs to user defined labels. MovieScene.h  
OnChannelChangedDelegate FMovieSceneOnChannelChanged Delegates MovieScene.h  
PlaybackRange FMovieSceneFrameRange User-defined playback range for this movie scene. MovieScene.h  
Possessables TArray< FMovieScenePossessable > Typed slots for already-spawned objects that we are able to control with this MovieScene MovieScene.h  
RootFolders TArray< TObjectPtr< UMovieSceneFolder > > The root folders for this movie scene. MovieScene.h  
SectionGroups TArray< FMovieSceneSectionGroup > Groups of sections which should maintain the same relative offset MovieScene.h  
SelectionRange FMovieSceneFrameRange User-defined selection range. MovieScene.h  
Spawnables TArray< FMovieSceneSpawnable > Data-only blueprints for all of the objects that we we're able to spawn. MovieScene.h  
TickResolution FFrameRate The resolution at which all frame numbers within this movie-scene data are stored MovieScene.h  
Tracks TArray< TObjectPtr< UMovieSceneTrack > > Tracks which are not bound to spawned or possessed objects MovieScene.h
  • Instanced

Functions

Public

Name Remarks Include Path Unreal Specifiers

UMovieSceneTrack * AddCameraCutTrack ( TSubclassOf< UMovieSceneTrack > TrackClass
)

 Adds a new camera cut track if it doesn't exist A camera cut track allows for cutting between camera views There is only one per movie scene. MovieScene.h  

void AddGeneratedCondition ( UMovieSceneGroupCondition* InGeneratedCondition
)

 Called during compilation to add a new generated condition to store in the movie scene. MovieScene.h  

bool AddGivenTrack ( UMovieSceneTrack* InTrack,
const FGuid& ObjectGuid
)

 Adds a given track. MovieScene.h  

bool AddGivenTrack ( UMovieSceneTrack* InTrack
)

 Adds a given track as a track MovieScene.h  

int32 AddMarkedFrame ( const FMovieSceneMarkedFrame& InMarkedFrame
)

 Add a given user marked frame. MovieScene.h  

void AddNewBindingTag ( const FName& NewTag
)

 Add a new binding group for the specified name MovieScene.h  

void AddPossessable ( const FMovieScenePossessable& InNewPossessable,
const FMovieSceneBinding& InNewBinding
)

 Adds an existing possessable to this movie scene. MovieScene.h  

FGuid AddPossessable ( const FString& Name,
UClass* Class
)

 Adds a possessable to this movie scene. MovieScene.h  

void AddRootFolder ( UMovieSceneFolder* Folder
)

 Adds a root folder for this movie scene. MovieScene.h  

void AddSpawnable ( const FMovieSceneSpawnable& InNewSpawnable,
const FMovieSceneBinding& InNewBinding
)

 Adds an existing spawnable to this movie scene. MovieScene.h  

FGuid AddSpawnable ( const FString& Name,
UObject& ObjectTemplate
)

 Add a spawnable to this movie scene's list of owned blueprints. MovieScene.h  

UMovieSceneTrack * AddTrack ( TSubclassOf< UMovieSceneTrack > TrackClass,
const FGuid& ObjectGuid
)

 Adds a track.Note: The type should not already exist. MovieScene.h  
Adds a track.Note: The type should not already exist. MovieScene.h  

TrackClass * AddTrack ( const FGuid& ObjectGuid
)

 Adds a track.Note: The type should not already exist. MovieScene.h  

TrackClass * AddTrack ()

 Adds a track.Note: The type should not already exist. MovieScene.h  

const TMap< FName, FMovieSceneObjectBindingIDs > & AllTaggedBindings()

 Retrieve all the tagged binding groups for this movie scene MovieScene.h  

bool AreMarkedFramesLocked()

 Return whether marked frames are locked. MovieScene.h  

void CleanSectionGroups()

 Cleans stale UMovieSceneSection pointers, and removes any section groups which are no longer valid, e.g. contain less that two valid sections MovieScene.h  

bool ContainsTrack ( const UMovieSceneTrack& Track
) const

 Check whether the specified track is a track in this movie scene. MovieScene.h  

void DeleteMarkedFrame ( int32 DeleteIndex
)

 Delete the user marked frame by index.@DeleteIndex The index to the user marked frame to delete MovieScene.h  

void DeleteMarkedFrames()

 Delete all user marked frames MovieScene.h  

void EmptyRootFolders()

 Removes all root folders from this movie scene (does not delete tracks or objects contained within) MovieScene.h  

const FMovieSceneBinding * FindBinding ( const FGuid& ForGuid
) const

 Tries to find an FMovieSceneBinding for the specified Guid. MovieScene.h  

FMovieSceneBinding * FindBinding ( const FGuid& ForGuid
)

 Tries to find an FMovieSceneBinding for the specified Guid. MovieScene.h  

int32 FindMarkedFrameByFrameNumber ( FFrameNumber InFrameNumber
) const

 Find the user marked frame by frame number MovieScene.h  

int32 FindMarkedFrameByLabel ( const FString& InLabel
) const

 Find the user marked frame by label@InLabel The label to the user marked frame to find MovieScene.h  

int32 FindNextMarkedFrame ( FFrameNumber InFrameNumber,
bool bForward
)

 Find the next/previous user marked frame from the given frame number MovieScene.h  
Attempt to find a possessable using some custom prdeicate MovieScene.h  
Tries to locate a possessable in this MovieScene for the specified possessable GUID. MovieScene.h  
Tries to locate a spawnable in this MovieScene for the specified spawnable GUID. MovieScene.h  
Attempt to find a spawnable using some custom predicate MovieScene.h  

TrackClass * FindTrack ()

 Finds a track (one not bound to a runtime objects). MovieScene.h  
Finds a track (one not bound to a runtime objects). MovieScene.h  

UMovieSceneTrack * FindTrack ( TSubclassOf< UMovieSceneTrack > TrackClass,
const FGuid& ObjectGuid,
const FName& TrackName
) const

 Finds a track. MovieScene.h  

TrackClass * FindTrack ( const FGuid& ObjectGuid,
const FName& TrackName
) const

 Finds a track. MovieScene.h  

bool FindTrackBinding ( const UMovieSceneTrack& InTrack,
FGuid& OutGuid
) const

 Find a track binding Guid from a UMovieSceneTrack MovieScene.h  

TArray< UMovieSceneTrack * > FindTracks ( TSubclassOf< UMovieSceneTrack > TrackClass,
const FGuid& ObjectGuid,
const FName& TrackName
) const

 Find all tracks of a given class. MovieScene.h  

TArray< UMovieSceneSection * > GetAllSections()

 Returns all sections and their associated binding data. MovieScene.h  
  MovieScene.h  
  MovieScene.h  

UMovieSceneTrack * GetCameraCutTrack()

   MovieScene.h  

EUpdateClockSource GetClockSource()

 Retrieve the clock source to be used for this moviescene MovieScene.h  

UMovieSceneClock * GetCustomClock()

   MovieScene.h  

T * GetCustomClockAs()

   MovieScene.h  

FFrameRate GetDisplayRate()

 Retrieve the display frame rate for this data, in which frame numbers should be displayed on UI, and interacted with in movie scene players MovieScene.h  

FMovieSceneTimecodeSource GetEarliestTimecodeSource()

 Get the earliest timecode source out of all of the movie scene sections contained within this movie scene. MovieScene.h  
  MovieScene.h  
  MovieScene.h  

EMovieSceneEvaluationType GetEvaluationType()

 Retrieve a value signifying how to evaluate this movie scene data MovieScene.h  

bool GetGloballyShowMarkedFrames()

 Returns whether this scene's marked frames should be shown globally MovieScene.h  

const TArray< FMovieSceneMarkedFrame > & GetMarkedFrames()

   MovieScene.h  

TArray< FString > & GetMuteNodes()

 Gets the nodes marked as transient muted in the editor, as node tree paths MovieScene.h  

UMovieSceneNodeGroupCollection & GetNodeGroups()

   MovieScene.h  

int32 GetNumRootFolders()

 Gets the number of root folders in this movie scene. MovieScene.h  

FText GetObjectDisplayName ( const FGuid& ObjectId
) const

 Get the display name of the object with the specified identifier. MovieScene.h  

TMap< FString, FMovieSceneTrackLabels > & GetObjectsToLabels()

   MovieScene.h  

TRange< FFrameNumber > GetPlaybackRange()

 Get the playback time range of this movie scene, relative to its 0-time offset. MovieScene.h  

FMovieScenePossessable & GetPossessable ( const int32 Index
)

 Grabs a reference to a specific possessable by index. MovieScene.h  

int32 GetPossessableCount()

 Get the number of possessable objects in this scene. MovieScene.h  

UMovieSceneFolder * GetRootFolder ( int32 FolderIndex
) const

 Gets the i-th root folder for this movie scene. MovieScene.h  

void GetRootFolders ( TArray< UMovieSceneFolder* >& InRootFolders
)

 Gets a copy of the root folders for this movie scene. MovieScene.h  
Gets the root folders for this movie scene. MovieScene.h  

const FMovieSceneSectionGroup * GetSectionGroup ( const UMovieSceneSection& InSection
) const

   MovieScene.h  

TRange< FFrameNumber > GetSelectionRange()

 Get the current selection range. MovieScene.h  

TArray< FString > & GetSoloNodes()

 Gets the nodes marked as transient solo in the editor, as node tree paths MovieScene.h  

FMovieSceneSpawnable & GetSpawnable ( int32 Index
)

 Grabs a reference to a specific spawnable by index. MovieScene.h  

int32 GetSpawnableCount()

 Get the number of spawnable objects in this scene. MovieScene.h  

FFrameRate GetTickResolution()

 Retrieve the tick resolution at which all frame numbers within this movie scene are defined MovieScene.h  
Get all tracks. MovieScene.h  

void GroupSections ( const TArray< UMovieSceneSection* > InSections
)

 Create a group containing InSections, merging any existing groups the sections are in MovieScene.h  

bool IsPlaybackRangeLocked()

 Return whether the playback range is locked. MovieScene.h  

bool IsReadOnly()

   MovieScene.h  

bool IsSectionInGroup ( const UMovieSceneSection& InSection
) const

   MovieScene.h  

TSharedPtr< FMovieSceneTimeController > MakeCustomTimeController ( UObject* PlaybackContext
)

 Retrieve a time controller from this sequence instance, if the clock source is set to custom MovieScene.h  

void MoveBindingContents ( const FGuid& SourceBindingId,
const FGuid& DestinationBindingId
)

 Move all the contents (tracks, child bindings) of the specified binding ID onto another MovieScene.h  

FMovieSceneOnChannelChanged & OnChannelChanged ()

 WIP Set of Delegates. MovieScene.h  

void OnDirectorBlueprintConditionUserDefinedPinRenamed ( UK2Node* InNode,
FName OldPinName,
FName NewPinName
)

   MovieScene.h  

void OnDynamicBindingUserDefinedPinRenamed ( UK2Node* InNode,
FName OldPinName,
FName NewPinName
)

   MovieScene.h  

void RemoveCameraCutTrack()

 Removes the camera cut track if it exists. MovieScene.h  

bool RemovePossessable ( const FGuid& PossessableGuid
)

 Removes a possessable from this movie scene. MovieScene.h  
Removes a root folder for this movie scene (does not delete tracks or objects contained within) MovieScene.h  

bool RemoveRootFolder ( int32 FolderIndex
)

 Removes a root folder for this movie scene (does not delete tracks or objects contained within) MovieScene.h  

bool RemoveSpawnable ( const FGuid& Guid
)

 Removes a spawnable from this movie scene. MovieScene.h  

void RemoveTag ( const FName& TagToRemove
)

 Remove the specified tag from any binding and forget about it completely MovieScene.h  

bool RemoveTrack ( UMovieSceneTrack& Track
)

 Removes a track. MovieScene.h  

void ReplaceBinding ( const FGuid& OldGuid,
const FGuid& NewGuid,
const FString& Name
)

 Replace an existing binding with another MovieScene.h  

void ReplaceBinding ( const FGuid& BindingToReplaceGuid,
const FMovieSceneBinding& NewBinding
)

 Replace an existing binding with another. MovieScene.h  

bool ReplacePossessable ( const FGuid& OldGuid,
const FMovieScenePossessable& InNewPosessable
)

 Replace an existing possessable with another MovieScene.h  

void ResetGeneratedConditions()

 Called by the compiler to empty the list of generated conditions MovieScene.h  

void SetCameraCutTrack ( UMovieSceneTrack* Track
)

   MovieScene.h  

void SetClockSource ( EUpdateClockSource InNewClockSource
)

 Assign the clock source to be used for this moviescene MovieScene.h  

void SetClockSource ( UObject* InNewClockSource
)

 Assign the clock source to be used for this moviescene MovieScene.h  

void SetCustomClock ( UMovieSceneClock* InNewClockSource
)

   MovieScene.h  

void SetDisplayRate ( FFrameRate InDisplayRate
)

 Set the play rate for this movie scene MovieScene.h  

void SetEditorData ( FMovieSceneEditorData& InEditorData
)

   MovieScene.h  

void SetEvaluationType ( EMovieSceneEvaluationType InNewEvaluationType
)

 Assign a value signifying how to evaluate this movie scene data MovieScene.h  

void SetGloballyShowMarkedFrames ( bool bShowMarkedFrames
)

 Set whether this scene's marked frames should be shown globally MovieScene.h  

void SetMarkedFrame ( int32 InMarkIndex,
FFrameNumber InFrameNumber
)

 Sets the frame number for the given marked frame index. MovieScene.h  

void SetMarkedFramesLocked ( bool bLocked
)

 Set whether marked frames are locked. MovieScene.h  

void SetObjectDisplayName ( const FGuid& ObjectId,
const FText& DisplayName
)

 Get the display name of the object with the specified identifier. MovieScene.h  

void SetPlaybackRange ( const TRange< FFrameNumber >& NewRange,
bool bAlwaysMarkDirty
)

 Set the playback range for this movie scene MovieScene.h  

void SetPlaybackRange ( FFrameNumber Start,
int32 Duration,
bool bAlwaysMarkDirty
)

 Set the start and end playback positions (playback range) for this movie scene MovieScene.h  

void SetPlaybackRangeLocked ( bool bLocked
)

 Set whether the playback range is locked. MovieScene.h  

void SetReadOnly ( bool bInReadOnly
)

 Set whether this movie scene is read only. MovieScene.h  

void SetSelectionRange ( TRange< FFrameNumber > Range
)

 Set the selection range. MovieScene.h  

void SetTickResolutionDirectly ( FFrameRate InTickResolution
)

 Directly set the tick resolution for this movie scene without applying any conversion whatsoever, or modifying the data MovieScene.h  

void SetViewRange ( double Start,
double End
)

 Set the start and end view range (inner) for this movie scene MovieScene.h  

void SetWorkingRange ( double Start,
double End
)

 Set the start and end working range (outer) for this movie scene MovieScene.h  

void SortMarkedFrames()

 Sort the marked frames in chronological order MovieScene.h  

void TagBinding ( const FName& NewTag,
const UE::MovieScene::FFixedObjectBindingID& BindingToTag
)

 Tag the specified binding ID with the specified name MovieScene.h  

void ToggleGloballyShowMarkedFrames()

 Toggle whether this scene's marked frames should be shown globally MovieScene.h  

void UngroupSection ( const UMovieSceneSection& InSection
)

 Remove InSection from any group it currently is in MovieScene.h  

void UntagBinding ( const FName& Tag,
const UE::MovieScene::FFixedObjectBindingID& Binding
)

 Remove a tag from the specified object binding MovieScene.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual bool IsPostLoadThreadSafe()

   MovieScene.h  

virtual void PostEditUndo()

   MovieScene.h  

virtual void PostInitProperties()

   MovieScene.h  

virtual void PostLoad()

   MovieScene.h  

virtual void Serialize ( FArchive& Ar
)

 ~ UObject implementation MovieScene.h  

Protected

Name Remarks Include Path Unreal Specifiers

int32 IndexOfBinding ( const FGuid& ForGuid
) const

 Tries to find an FMovieSceneBinding for the specified Guid. MovieScene.h  

int32 IndexOfPossessable ( const FGuid& ForGuid
) const

 Tries to find an FMovieScenePossessable for the specified Guid. MovieScene.h  

int32 IndexOfSpawnable ( const FGuid& ForGuid
) const

 Tries to find an FMovieSceneSpawnable for the specified Guid. MovieScene.h  

void RemoveBinding ( const FGuid& Guid
)

 Removes animation data bound to a GUID. MovieScene.h  

void UpgradeTimeRanges()

 Perform legacy upgrade of time ranges MovieScene.h  

Overridden from UMovieSceneDecorationContainerObject

Name Remarks Include Path Unreal Specifiers

virtual void OnDecorationAdded ( UObject* NewDecoration
)

   MovieScene.h  

virtual void OnDecorationRemoved ( UObject* NewDecoration
)

   MovieScene.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PreSave ( FObjectPreSaveContext ObjectSaveContext
)

 Called before this object is being deserialized. MovieScene.h  

Static

Name Remarks Include Path Unreal Specifiers

static void DeclareConstructClasses ( TArray< FTopLevelAssetPath >& OutConstructClasses,
const UClass* SpecificSubclass
)

   MovieScene.h  

static bool IsConditionClassAllowed ( const UClass* InClass
)

   MovieScene.h  

static bool IsCustomBindingClassAllowed ( UClass* InClass
)

   MovieScene.h  

static bool IsTrackClassAllowed ( UClass* InClass
)

   MovieScene.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page