UMovieScene

Implements a movie scene asset.

Choose your operating system:

Windows

macOS

Linux

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

Name Description

Public variable

FMovieSceneTime...

 

TimecodeSource

The timecode at which this movie scene section is based (ie. when it was recorded)

Constructors

Name Description

Public function

UMovieScene

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function

UMovieSceneT...

 

AddCameraCutTrack

(
    TSubclassOf< UMovieSceneTrack > Tra...
)

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

 

AddGivenMasterTrack

(
    UMovieSceneTrack* InTrack
)

Adds a given track as a master track

Public function

bool

 

AddGivenTrack

(
    UMovieSceneTrack* InTrack,
    const FGuid& ObjectGuid
)

Adds a given track.

Public function

int32

 

AddMarkedFrame

(
    const FMovieSceneMarkedFrame& InMa...
)

Add a given user marked frame.

Public function

UMovieSceneT...

 

AddMasterTrack

(
    TSubclassOf< UMovieSceneTrack > Tra...
)

Adds a master track.

The type should not already exist.

Public function

TrackClass &...

 

AddMasterTrack()

Adds a master track.

The type should not already exist.

Public function

void

 

AddNewBindingTag

(
    const FName& NewTag
)

Add a new binding group for the specified name

Public function

void

 

AddPossessable

(
    const FMovieScenePossessable& InNe...,
    const FMovieSceneBinding& InNewBin...
)

Adds an existing possessable to this movie scene.

Public function

FGuid

 

AddPossessable

(
    const FString& Name,
    UClass* Class
)

Adds a possessable 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

void

 

AddSpawnable

(
    const FMovieSceneSpawnable& InNewS...,
    const FMovieSceneBinding& InNewBin...
)

Adds an existing spawnable to this movie scene.

Public function

TrackClass &...

 

AddTrack

(
    const FGuid& ObjectGuid
)

Adds a track.

The type should not already exist.

Public function

UMovieSceneT...

 

AddTrack

(
    TSubclassOf< UMovieSceneTrack > Tra...,
    const FGuid& ObjectGuid
)

Adds a track.

The type should not already exist.

Public function Const

const TMap< ...

 

AllTaggedBindings()

Retrieve all the tagged binding groups for this movie scene

Public function

void

 

CleanSectionGroups()

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

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

 

DeleteMarkedFrames()

Delete all user marked frames

Public function

FMovieSceneB...

 

FindBinding

(
    const FGuid& ForGuid
)

Tries to find an FMovieSceneBinding for the specified Guid.

Public function Const

int32

 

FindMarkedFrameByFrameNumber

(
    FFrameNumber InFrameNumber
)

Find the user marked frame by frame number

The frame number of the user marked frame to find

Public function Const

int32

 

FindMarkedFrameByLabel

(
    const FString& InLabel
)

Find the user marked frame by label

The label to the user marked frame to find

Public function Const

UMovieSceneT...

 

FindMasterTrack

(
    TSubclassOf< UMovieSceneTrack > Tra...
)

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

Public function Const

TrackClass &...

 

FindMasterTrack()

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

Public function

int32

 

FindNextMarkedFrame

(
    FFrameNumber InFrameNumber,
    bool bForward
)

Find the next/previous user marked frame from the given frame number

Public function

FMovieSceneP...

 

FindPossessable

(
    const TFunctionRef< bool...
)

Attempt to find a possessable using some custom prdeicate

Public function

FMovieSceneP...

 

FindPossessable

(
    const FGuid& Guid
)

Tries to locate a possessable in this MovieScene for the specified possessable GUID.

Public function

FMovieSceneS...

 

FindSpawnable

(
    const FGuid& Guid
)

Tries to locate a spawnable in this MovieScene for the specified spawnable GUID.

Public function

FMovieSceneS...

 

FindSpawnable

(
    const TFunctionRef< bool...
)

Attempt to find a spawnable using some custom predicate

Public function Const

UMovieSceneT...

 

FindTrack

(
    TSubclassOf< UMovieSceneTrack > Tra...,
    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

bool

 

FindTrackBinding

(
    const UMovieSceneTrack& InTrack,
    FGuid& OutGuid
)

Find a track binding Guid from a UMovieSceneTrack

Public function Const

TArray< UMov...

 

FindTracks

(
    TSubclassOf< UMovieSceneTrack > Tra...,
    const FGuid& ObjectGuid,
    const FName& TrackName
)

Find all tracks of a given class.

Public function Const

TArray< UMov...

 

GetAllSections()

Returns all sections and their associated binding data.

Public function Const

const TArray...

 

GetBindings()

Public function Const

UMovieSceneT...

 

GetCameraCutTrack()

Public function Const

EUpdateClock...

 

GetClockSource()

Retrieve the clock source to be used for this moviescene

Public function Const

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

Public function Const

FMovieSceneT...

 

GetEarliestTimecodeSource()

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

Public function

FMovieSceneE...

 

GetEditorData()

Public function Const

EMovieSceneE...

 

GetEvaluationType()

Retrieve a value signifying how to evaluate this movie scene data

Public function Const

bool

 

GetGloballyShowMarkedFrames()

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

Public function Const

const TArray...

 

GetMarkedFrames()

Public function Const

const TArray...

 

GetMasterTracks()

Get all master tracks.

Public function

TArray< FStr...

 

GetMuteNodes()

Gets the nodes marked as muted in the editor, as node tree paths

Public function

UMovieSceneN...

 

GetNodeGroups()

Public function

FText

 

GetObjectDisplayName

(
    const FGuid& ObjectId
)

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

Public function

TMap< FStrin...

 

GetObjectsToLabels()

Public function Const

TRange< FFra...

 

GetPlaybackRange()

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

Public function

FMovieSceneP...

 

GetPossessable

(
    const int32 Index
)

Grabs a reference to a specific possessable by index.

Public function Const

int32

 

GetPossessableCount()

Get the number of possessable objects in this scene.

Public function

TArray< UMov...

 

GetRootFolders()

Gets the root folders for this movie scene.

Public function Const

const FMovie...

 

GetSectionGroup

(
    const UMovieSceneSection& InSectio...
)

Public function Const

TRange< FFra...

 

GetSelectionRange()

Get the current selection range.

Public function

TArray< FStr...

 

GetSoloNodes()

Gets the nodes marked as solo in the editor, as node tree paths

Public function

FMovieSceneS...

 

GetSpawnable

(
    int32 Index
)

Grabs a reference to a specific spawnable by index.

Public function Const

int32

 

GetSpawnableCount()

Get the number of spawnable objects in this scene.

Public function Const

FFrameRate

 

GetTickResolution()

Retrieve the tick resolution at which all frame numbers within this movie scene are defined

Public function

void

 

GroupSections

(
    const TArray< UMovieSceneSection&#...
)

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

Public function Const

bool

 

IsAMasterTrack

(
    const UMovieSceneTrack& Track
)

Check whether the specified track is a master track in this scene.

Public function Const

bool

 

IsPlaybackRangeLocked()

Return whether the playback range is locked.

Public function Const

bool

 

IsReadOnly()

Public function Const

bool

 

IsSectionInGroup

(
    const UMovieSceneSection& InSectio...
)

Public function

TSharedPtr< ...

 

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

FMovieSceneO...

 

OnChannelChanged()

WIP Set of Delegates.

Protected function

void

 

RemoveBinding

(
    const FGuid& Guid
)

Removes animation data bound to a GUID.

Public function

void

 

RemoveCameraCutTrack()

Removes the camera cut track if it exists.

Public function

bool

 

RemoveMasterTrack

(
    UMovieSceneTrack& Track
)

Removes a master track.

Public function

bool

 

RemovePossessable

(
    const FGuid& PossessableGuid
)

Removes a possessable from this movie scene.

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

 

RemoveTrack

(
    UMovieSceneTrack& Track
)

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& NewBindi...
)

Replace an existing binding with another.

Public function

bool

 

ReplacePossessable

(
    const FGuid& OldGuid,
    const FMovieScenePossessable& InNe...
)

Replace an existing possessable with another

Public function

void

 

SetCameraCutTrack

(
    UMovieSceneTrack* Track
)

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

 

SetEditorData

(
    FMovieSceneEditorData& InEditorDat...
)

Public function

void

 

SetEvaluationType

(
    EMovieSceneEvaluationType InNewEval...
)

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

 

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 >& NewR...,
    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

 

SetSelectionRange

(
    TRange< FFrameNumber > Range
)

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

 

SortMarkedFrames()

Sort the marked frames in chronological order

Public function

void

 

TagBinding

(
    const FName& NewTag,
    const UE::MovieScene::FFixedObjectB...
)

Tag the specified binding ID with the specified name

Public function

void

 

ToggleGloballyShowMarkedFrames()

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

Public function

void

 

UngroupSection

(
    const UMovieSceneSection& InSectio...
)

Remove InSection from any group it currently is in

Public function

void

 

UntagBinding

(
    const FName& Tag,
    const UE::MovieScene::FFixedObjectB...
)

Remove a tag from the specified object binding

Protected function

void

 

UpgradeTimeRanges()

Perform legacy upgrade of time ranges

Overridden from UObject

Name Description

Public function Virtual Const

bool

 

IsPostLoadThreadSafe()

Called during async load to determine if PostLoad can be called on the loading thread.

Public function Virtual

void

 

PostEditUndo()

Called after applying a transaction to the object.

Public function Virtual

void

 

PostInitProperties()

Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

Public function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object.

Protected function Virtual

void

 

PreSave

(
    FObjectPreSaveContext ObjectSaveCon...
)

Called before this object is being deserialized.

Public function Virtual

void

 

Serialize

(
    FArchive& Ar
)

~ UObject implementation

Deprecated Functions

Name Description

Protected function Virtual

void

 

PreSave

(
    const ITargetPlatform* TargetP...
)

Use version that takes FObjectPreSaveContext instead.