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

Inheritance Hierarchy

References

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

Syntax

class UMovieSceneFolder : public UObject

Remarks

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

Variables

  Type Name Description
Public variable UE::MovieScene::TDataEventContainer< UE::MovieScene::IFolderEventHandler > EventHandlers Event handlers for handling changes to this object

Constructors

  Type Name Description
Public function  

UMovieSceneFolder ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function void

AddChildFolder ( UMovieSceneFolder* InChildFolder
)

 Adds a child folder to this folder.
Public function void

AddChildObjectBinding ( const FGuid& InObjectBinding
)

 Adds a guid for an object binding to this folder.
Public function void Adds a track to this folder.
Public function 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
Public function void Clear all child object bindings from this folder.
Public function void Clear all child tracks from this folder.
Public function UMovieSceneFolder *

FindFolderContaining ( const FGuid& InObjectBinding
)

 Searches for a guid in this folder and its child folders, if found returns the folder containing the guid.
Public function UMovieSceneFolder * Searches for a track in this folder and its child folders, if found returns the folder containing the track.
Public function Const TArrayView< UMovieSceneFolder *const > Gets the folders contained by this folder.
Public function Const const TArray< FGuid > & Gets the guids for the object bindings contained by this folder.
Public function Const const TArray< UMovieSceneTrack * > & Gets the tracks contained by this folder.
Public function Const const FColor & Get this folder's color.
Public function Const FName Gets the name of this folder.
Public function 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
Public function Const int32 Get this folder's desired sorting order
Public function Const FName  
Public function Static FName  
Public function void Removes a child folder from this folder.
Public function void

RemoveChildObjectBinding ( const FGuid& InObjectBinding
)

 Removes a guid for an object binding from this folder.
Public function void Removes a track from this folder.
Public function void

SetFolderColor ( const FColor& InFolderColor
)

 Set this folder's color.
Public function void

SetFolderName ( FName InFolderName
)

 Sets the name of this folder.
Public function void

SetSortingOrder ( const int32 InSortingOrder
)

 Set this folder's desired sorting order.

Overridden from UObject

  Type Name Description
Public function Virtual void Called after applying a transaction to the object.
Public function Virtual void Called after applying a transaction to the object in cases where transaction annotation was provided.
Public function Virtual void Called after this object has been deserialized
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Deprecated Functions

  Type Name Description
Public function void AddChildMasterTrack is deprecated. Please use AddChildTrack instead
Public function void ClearChildMasterTracks is deprecated. Please use ClearChildTracks instead
Public function Const const TArray< UMovieSceneTrack * > & GetChildMasterTracks is deprecated. Please use GetChildTracks instead
Public function void RemoveChildMasterTrack is deprecated. Please use RemoveChildTrack instead

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page