1. Epic GamesDeveloper
  3. UMovieSceneFolder

UMovieSceneFolder

Represents a folder used for organizing objects in tracks in a movie scene.

API > API/Runtime > API/Runtime/MovieScene

Represents a folder used for organizing objects in tracks in a movie scene.

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

Syntax

UCLASS (DefaultToInstanced, MinimalAPI, BlueprintType)  
class UMovieSceneFolder : public UMovieSceneDecorationContainerObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UMovieSceneFolder ( const FObjectInitializer& ObjectInitializer
)

   MovieSceneFolder.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
EventHandlers UE::MovieScene::TDataEventContainer< UE::MovieScene::IFolderEventHandler > Event handlers for handling changes to this object MovieSceneFolder.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
ChildFolders TArray< TObjectPtr< UMovieSceneFolder > > The folders contained by this folder. MovieSceneFolder.h  
ChildObjectBindings TArray< FGuid > The guids for the object bindings contained by this folder. MovieSceneFolder.h  
ChildObjectBindingStrings TArray< FString > The guid strings used to serialize the guids for the object bindings contained by this folder. MovieSceneFolder.h  
ChildTracks TArray< TObjectPtr< UMovieSceneTrack > > The tracks contained by this folder. MovieSceneFolder.h  
FolderColor FColor This folder's color MovieSceneFolder.h
  • EditAnywhere
  • Category=General
  • DisplayName=Color
FolderName FName The name of this folder. MovieSceneFolder.h  
SortingOrder int32 This folder's desired sorting order MovieSceneFolder.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddChildFolder ( UMovieSceneFolder* InChildFolder
)

 Adds a child folder to this folder. MovieSceneFolder.h  

void AddChildObjectBinding ( const FGuid& InObjectBinding
)

 Adds a guid for an object binding to this folder. MovieSceneFolder.h  

void AddChildTrack ( UMovieSceneTrack* InTrack
)

 Adds a track to this folder. Automatically calls Modify() on the folder object. MovieSceneFolder.h  

void ClearChildObjectBindings()

 Clear all child object bindings from this folder. MovieSceneFolder.h  

void ClearChildTracks()

 Clear all child tracks from this folder. MovieSceneFolder.h  
Searches for a track in this folder and its child folders, if found returns the folder containing the track. MovieSceneFolder.h  

UMovieSceneFolder * FindFolderContaining ( const FGuid& InObjectBinding
)

 Searches for a guid in this folder and its child folders, if found returns the folder containing the guid. MovieSceneFolder.h  

TArrayView< UMovieSceneFolder *const > GetChildFolders()

 Gets the folders contained by this folder. MovieSceneFolder.h  

const TArray< FGuid > & GetChildObjectBindings()

 Gets the guids for the object bindings contained by this folder. MovieSceneFolder.h  

const TArray< UMovieSceneTrack * > & GetChildTracks()

 Gets the tracks contained by this folder. MovieSceneFolder.h  

const FColor & GetFolderColor()

 Get this folder's color. MovieSceneFolder.h  

FName GetFolderName()

 Gets the name of this folder. MovieSceneFolder.h  

int32 GetSortingOrder()

 Get this folder's desired sorting order MovieSceneFolder.h  
  MovieSceneFolder.h  

void RemoveChildFolder ( UMovieSceneFolder* InChildFolder
)

 Removes a child folder from this folder. Automatically calls Modify() on the folder object. MovieSceneFolder.h  

void RemoveChildObjectBinding ( const FGuid& InObjectBinding
)

 Removes a guid for an object binding from this folder. MovieSceneFolder.h  

void RemoveChildTrack ( UMovieSceneTrack* InTrack
)

 Removes a track from this folder. Automatically calls Modify() on the folder object. MovieSceneFolder.h  

void SetFolderColor ( const FColor& InFolderColor
)

 Set this folder's color. Does not call Modify() on the folder object for legacy reasons. MovieSceneFolder.h  

void SetFolderName ( FName InFolderName
)

 Sets the name of this folder. Automatically calls Modify() on the folder object. MovieSceneFolder.h  

void SetSortingOrder ( const int32 InSortingOrder
)

 Set this folder's desired sorting order. Does not call Modify() internally for legacy reasons. MovieSceneFolder.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditUndo ( TSharedPtr< ITransactionObjectAnnotation > TransactionAnnotation
)

   MovieSceneFolder.h  

virtual void PostEditUndo ()

   MovieSceneFolder.h  

virtual void PostLoad()

 Called after this object has been deserialized MovieSceneFolder.h  

virtual void Serialize ( FArchive& Archive
)

   MovieSceneFolder.h  

Static

Name Remarks Include Path Unreal Specifiers

static void CalculateFolderPath ( UMovieSceneFolder* InFolder,
TArrayView< UMovieSceneFolder*const > RootFolders,
TArray< FName >& FolderPath
)

 Get the folder path for this folder, stopping at the given root folders MovieSceneFolder.h  

static UMovieSceneFolder * GetFolderWithPath ( const TArray< FName >& InFolderPath,
const TArray< UMovieSceneFolder* >& InFolders,
TArrayView< UMovieSceneFolder*const > RootFolders
)

 For the given set of folders, return the folder that has the matching folder path MovieSceneFolder.h  

static FName MakeUniqueChildFolderName ( FName InName,
TArrayView< UMovieSceneFolder*const > InFolders
)

   MovieSceneFolder.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page