1. Epic GamesDeveloper
  3. UMovieScene

UMovieScene

Implements a movie scene asset.

API > API/Runtime > API/Runtime/MovieScene

Inheritance Hierarchy

References

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

Syntax

class UMovieScene : public UMovieSceneSignedObject

Remarks

Implements a movie scene asset.

Variables

  Type Name Description
Public variable UE::MovieScene::TDataEventContainer< UE::MovieScene::ISequenceDataEventHandler > EventHandlers  

Constructors

  Type Name Description
Public function  

UMovieScene ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function UMovieSceneTrack * 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.
Public function bool

AddGivenTrack ( UMovieSceneTrack* InTrack,
const FGuid& ObjectGuid
)

 Adds a given track.
Public function bool Adds a given track as a track
Public function int32

AddMarkedFrame ( const FMovieSceneMarkedFrame& InMarkedFrame
)

 Add a given user marked frame.
Public function void

AddNewBindingTag ( const FName& NewTag
)

 Add a new binding group for the specified name
Public function FGuid

AddPossessable ( const FString& Name,
UClass* Class
)

 Adds a possessable to this movie scene.
Public function void

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

 Adds an existing possessable to this movie scene.
Public function void Adds a root folder for this movie scene.
Public function void

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

 Adds an existing spawnable to this movie scene.
Public function FGuid

AddSpawnable ( const FString& Name,
UObject& ObjectTemplate
)

 Add a spawnable to this movie scene's list of owned blueprints.
Public function TrackClass *

AddTrack ( const FGuid& ObjectGuid
)

 Adds a track.Note: The type should not already exist.
Public function UMovieSceneTrack *

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

 Adds a track.Note: The type should not already exist.
Public function TrackClass * Adds a track.Note: The type should not already exist.
Public function UMovieSceneTrack * Adds a track.Note: The type should not already exist.
Public function Const const TMap< FName, FMovieSceneObjectBindingIDs > & Retrieve all the tagged binding groups for this movie scene
Public function Const bool Return whether marked frames are locked.
Public function void Cleans stale UMovieSceneSection pointers, and removes any section groups which are no longer valid, e.g. contain less that two valid sections
Public function Const bool

ContainsTrack ( const UMovieSceneTrack& Track
)

 Check whether the specified track is a track in this movie scene.
Public function Static void

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

  
Public function void

DeleteMarkedFrame ( int32 DeleteIndex
)

 Delete the user marked frame by index.The index to the user marked frame to delete
Public function void Delete all user marked frames
Public function void Removes all root folders from this movie scene (does not delete tracks or objects contained within)
Public function FMovieSceneBinding *

FindBinding ( const FGuid& ForGuid
)

 Tries to find an FMovieSceneBinding for the specified Guid.
Public function Const int32 Find the user marked frame by frame numberThe frame number of the user marked frame to find
Public function Const int32

FindMarkedFrameByLabel ( const FString& InLabel
)

 Find the user marked frame by labelThe label to the user marked frame to find
Public function int32

FindNextMarkedFrame ( FFrameNumber InFrameNumber,
bool bForward
)

 Find the next/previous user marked frame from the given frame number
Public function FMovieScenePossessable *

FindPossessable ( const FGuid& Guid
)

 Tries to locate a possessable in this MovieScene for the specified possessable GUID.
Public function FMovieScenePossessable *

FindPossessable ( const TFunctionRef< bool(FMovieScenePossessable&)>& InPredicate
)

 Attempt to find a possessable using some custom prdeicate
Public function FMovieSceneSpawnable *

FindSpawnable ( const FGuid& Guid
)

 Tries to locate a spawnable in this MovieScene for the specified spawnable GUID.
Public function FMovieSceneSpawnable *

FindSpawnable ( const TFunctionRef< bool(FMovieSceneSpawnable&)>& InPredicate
)

 Attempt to find a spawnable using some custom predicate
Public function Const UMovieSceneTrack *

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

 Finds a track.
Public function Const TrackClass *

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

 Finds a track.
Public function Const TrackClass * Finds a track (one not bound to a runtime objects).
Public function Const UMovieSceneTrack * Finds a track (one not bound to a runtime objects).
Public function Const bool

FindTrackBinding ( const UMovieSceneTrack& InTrack,
FGuid& OutGuid
)

 Find a track binding Guid from a UMovieSceneTrack
Public function Const TArray< UMovieSceneTrack * >

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

 Find all tracks of a given class.
Public function Const TArray< UMovieSceneSection * > Returns all sections and their associated binding data.
Public function Const const TArray< FMovieSceneBinding > &  
Public function Const UMovieSceneTrack *  
Public function Const EUpdateClockSource Retrieve the clock source to be used for this moviescene
Public function Const FFrameRate Retrieve the display frame rate for this data, in which frame numbers should be displayed on UI, and interacted with in movie scene players
Public function Const FMovieSceneTimecodeSource Get the earliest timecode source out of all of the movie scene sections contained within this movie scene.
Public function FMovieSceneEditorData &  
Public function Const const FMovieSceneEditorData &  
Public function Const EMovieSceneEvaluationType Retrieve a value signifying how to evaluate this movie scene data
Public function Const bool Returns whether this scene's marked frames should be shown globally
Public function Const const TArray< FMovieSceneMarkedFrame > &  
Public function TArray< FString > & Gets the nodes marked as muted in the editor, as node tree paths
Public function UMovieSceneNodeGroupCollection &  
Public function Const int32 Gets the number of root folders in this movie scene.
Public function FText

GetObjectDisplayName ( const FGuid& ObjectId
)

 Get the display name of the object with the specified identifier.
Public function TMap< FString, FMovieSceneTrackLabels > &  
Public function Const TRange< FFrameNumber > Get the playback time range of this movie scene, relative to its 0-time offset.
Public function FMovieScenePossessable &

GetPossessable ( const int32 Index
)

 Grabs a reference to a specific possessable by index.
Public function Const int32 Get the number of possessable objects in this scene.
Public function Const UMovieSceneFolder *

GetRootFolder ( int32 FolderIndex
)

 Gets the i-th root folder for this movie scene.
Public function void

GetRootFolders ( TArray< UMovieSceneFolder* >& InRootFolders
)

 Gets a copy of the root folders for this movie scene.
Public function TArrayView< UMovieSceneFolder *const > Gets the root folders for this movie scene.
Public function Const const FMovieSceneSectionGroup *

GetSectionGroup ( const UMovieSceneSection& InSection
)

  
Public function Const TRange< FFrameNumber > Get the current selection range.
Public function TArray< FString > & Gets the nodes marked as solo in the editor, as node tree paths
Public function FMovieSceneSpawnable &

GetSpawnable ( int32 Index
)

 Grabs a reference to a specific spawnable by index.
Public function Const int32 Get the number of spawnable objects in this scene.
Public function Const FFrameRate Retrieve the tick resolution at which all frame numbers within this movie scene are defined
Public function Const const TArray< UMovieSceneTrack * > & Get all tracks.
Public function void

GroupSections ( const TArray< UMovieSceneSection* > InSections
)

 Create a group containing InSections, merging any existing groups the sections are in
Public function Const bool Return whether the playback range is locked.
Public function Const bool  
Public function Const bool

IsSectionInGroup ( const UMovieSceneSection& InSection
)

  
Public function Static bool  
Public function TSharedPtr< FMovieSceneTimeController >

MakeCustomTimeController ( UObject* PlaybackContext
)

 Retrieve a time controller from this sequence instance, if the clock source is set to custom
Public function void

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

 Move all the contents (tracks, child bindings) of the specified binding ID onto another
Public function FMovieSceneOnChannelChanged & WIP Set of Delegates.
Public function void

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

  
Protected function void

RemoveBinding ( const FGuid& Guid
)

 Removes animation data bound to a GUID.
Public function void Removes the camera cut track if it exists.
Public function bool

RemovePossessable ( const FGuid& PossessableGuid
)

 Removes a possessable from this movie scene.
Public function bool

RemoveRootFolder ( int32 FolderIndex
)

 Removes a root folder for this movie scene (does not delete tracks or objects contained within)
Public function int32 Removes a root folder for this movie scene (does not delete tracks or objects contained within)
Public function bool

RemoveSpawnable ( const FGuid& Guid
)

 Removes a spawnable from this movie scene.
Public function void

RemoveTag ( const FName& TagToRemove
)

 Remove the specified tag from any binding and forget about it completely
Public function bool Removes a track.
Public function void

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

 Replace an existing binding with another
Public function void

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

 Replace an existing binding with another.
Public function bool

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

 Replace an existing possessable with another
Public function void  
Public function void

SetClockSource ( EUpdateClockSource InNewClockSource
)

 Assign the clock source to be used for this moviescene
Public function void

SetClockSource ( UObject* InNewClockSource
)

 Assign the clock source to be used for this moviescene
Public function void

SetDisplayRate ( FFrameRate InDisplayRate
)

 Set the play rate for this movie scene
Public function void  
Public function void

SetEvaluationType ( EMovieSceneEvaluationType InNewEvaluationType
)

 Assign a value signifying how to evaluate this movie scene data
Public function void

SetGloballyShowMarkedFrames ( bool bShowMarkedFrames
)

 Set whether this scene's marked frames should be shown globally
Public function void

SetMarkedFrame ( int32 InMarkIndex,
FFrameNumber InFrameNumber
)

 Sets the frame number for the given marked frame index.
Public function void

SetMarkedFramesLocked ( bool bLocked
)

 Set whether marked frames are locked.
Public function void

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

 Get the display name of the object with the specified identifier.
Public function void

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

 Set the playback range for this movie scene
Public function void

SetPlaybackRange ( FFrameNumber Start,
int32 Duration,
bool bAlwaysMarkDirty
)

 Set the start and end playback positions (playback range) for this movie scene
Public function void

SetPlaybackRangeLocked ( bool bLocked
)

 Set whether the playback range is locked.
Public function void

SetReadOnly ( bool bInReadOnly
)

 Set whether this movie scene is read only.
Public function void Set the selection range.
Public function void

SetTickResolutionDirectly ( FFrameRate InTickResolution
)

 Directly set the tick resolution for this movie scene without applying any conversion whatsoever, or modifying the data
Public function void

SetViewRange ( float Start,
float End
)

 Set the start and end view range (inner) for this movie scene
Public function void

SetWorkingRange ( float Start,
float End
)

 Set the start and end working range (outer) for this movie scene
Public function void Sort the marked frames in chronological order
Public function void

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

 Tag the specified binding ID with the specified name
Public function void Toggle whether this scene's marked frames should be shown globally
Public function void

UngroupSection ( const UMovieSceneSection& InSection
)

 Remove InSection from any group it currently is in
Public function void Remove a tag from the specified object binding
Protected function void Perform legacy upgrade of time ranges

Overridden from UObject

  Type Name Description
Public function Virtual Const bool Called during async load to determine if PostLoad can be called on the loading thread.
Public function Virtual void Called after applying a transaction to the object.
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Protected function Virtual void

PreSave ( FObjectPreSaveContext ObjectSaveContext
)

 Called before this object is being deserialized.
Public function Virtual void ~ UObject implementation

Typedefs

Name Description
FFixupDynamicBindingPayloadParameterNameEvent  
FIsTrackClassAllowedEvent  

Constants

Name Description
FixupDynamicBindingPayloadParameterNameEvent  
IsTrackClassAllowedEvent  

Deprecated Functions

  Type Name Description
Public function bool AddGivenMasterTrack is deprecated. Please use AddGivenTrack instead
Public function UMovieSceneTrack * AddMasterTrack is deprecated. Please use AddTrack instead
Public function TrackClass * AddMasterTrack is deprecated. Please use AddTrack instead
Public function Const UMovieSceneTrack * FindMasterTrack is deprecated. Please use FindTrack instead
Public function Const TrackClass * FindMasterTrack is deprecated. Please use FindTrack instead
Public function Const const TArray< UMovieSceneTrack * > & GetMasterTracks is deprecated. Please use GetTracks instead
Public function Const bool

IsAMasterTrack ( const UMovieSceneTrack& Track
)

 IsAMasterTrack is deprecated. Please use ContainsTrack instead
Public function bool RemoveMasterTrack is deprecated. Please use RemoveTrack instead

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page