MovieSceneFolder.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
 
#include "Containers/Array.h"
#include "Containers/ArrayView.h"
#include "Containers/UnrealString.h"
#include "CoreMinimal.h"
#include "CoreTypes.h"
#include "Decorations/MovieSceneDecorationContainer.h"
#include "EventHandlers/IFolderEventHandler.h"
#include "EventHandlers/MovieSceneDataEventContainer.h"
#include "Math/Color.h"
#include "Misc/Guid.h"
#include "Templates/SharedPointer.h"
#include "UObject/NameTypes.h"
#include "UObject/Object.h"
#include "UObject/ObjectMacros.h"
#include "UObject/ObjectPtr.h"
#include "UObject/UObjectGlobals.h"
 
#include "MovieSceneFolder.generated.h"
 
class FArchive;
class ITransactionObjectAnnotation;
class UMovieSceneTrack;
namespace UE { namespace MovieScene { class IFolderEventHandler; } }
 
UCLASS(DefaultToInstanced, MinimalAPI, BlueprintType)
class UMovieSceneFolder
    : public UMovieSceneDecorationContainerObject
{
    GENERATED_UCLASS_BODY()
 
    
    MOVIESCENE_API FName GetFolderName() const;
 
    MOVIESCENE_API void SetFolderName( FName InFolderName );
 
    MOVIESCENE_API TArrayView<UMovieSceneFolder* const> GetChildFolders() const;
 
    MOVIESCENE_API void AddChildFolder( UMovieSceneFolder* InChildFolder );
 
    MOVIESCENE_API void RemoveChildFolder( UMovieSceneFolder* InChildFolder );
 
    MOVIESCENE_API const TArray<UMovieSceneTrack*>& GetChildTracks() const;
 
    MOVIESCENE_API void AddChildTrack( UMovieSceneTrack* InTrack );
 
    MOVIESCENE_API void RemoveChildTrack( UMovieSceneTrack* InTrack );
 
    MOVIESCENE_API void ClearChildTracks();
 
    MOVIESCENE_API const TArray<FGuid>& GetChildObjectBindings() const;
 
    MOVIESCENE_API void AddChildObjectBinding(const FGuid& InObjectBinding );
 
    MOVIESCENE_API void RemoveChildObjectBinding( const FGuid& InObjectBinding );
 
    MOVIESCENE_API void ClearChildObjectBindings();
 
    MOVIESCENE_API virtual void PostLoad() override;
 
    MOVIESCENE_API UMovieSceneFolder* FindFolderContaining(const FGuid& InObjectBinding);
 
    MOVIESCENE_API UMovieSceneFolder* FindFolderContaining(const UMovieSceneTrack* InTrack);
 
    static MOVIESCENE_API void CalculateFolderPath(UMovieSceneFolder* InFolder, TArrayView<UMovieSceneFolder* const> RootFolders, TArray<FName>& FolderPath);
    
    static MOVIESCENE_API UMovieSceneFolder* GetFolderWithPath(const TArray<FName>& InFolderPath, const TArray<UMovieSceneFolder*>& InFolders, TArrayView<UMovieSceneFolder* const> RootFolders);
 
    MOVIESCENE_API virtual void Serialize( FArchive& Archive );
 
    MOVIESCENE_API FName MakeUniqueChildFolderName(FName InName) const;
 
    static MOVIESCENE_API FName MakeUniqueChildFolderName(FName InName, TArrayView<UMovieSceneFolder* const> InFolders);
 
#if WITH_EDITORONLY_DATA
    const FColor& GetFolderColor() const
    {
        return FolderColor;
    }
 
    void SetFolderColor(const FColor& InFolderColor)
    {
        FolderColor = InFolderColor;
    }
 
    int32 GetSortingOrder() const
    {
        return SortingOrder;
    }
 
    void SetSortingOrder(const int32 InSortingOrder)
    {
        SortingOrder = InSortingOrder;
    }
#endif
 
#if WITH_EDITOR
    MOVIESCENE_API virtual void PostEditUndo() override;
    MOVIESCENE_API virtual void PostEditUndo(TSharedPtr<ITransactionObjectAnnotation> TransactionAnnotation) override;
#endif
 
    UE::MovieScene::TDataEventContainer<UE::MovieScene::IFolderEventHandler> EventHandlers;
 
private:
    UPROPERTY()
    FName FolderName;
 
    UPROPERTY()
    TArray<TObjectPtr<UMovieSceneFolder>> ChildFolders;
 
    UPROPERTY()
    TArray<TObjectPtr<UMovieSceneTrack>> ChildTracks;
 
    UPROPERTY()
    TArray<FString> ChildObjectBindingStrings;
 
#if WITH_EDITORONLY_DATA
    UPROPERTY(EditAnywhere, Category=General, DisplayName=Color)
    FColor FolderColor;
 
    UPROPERTY()
    int32 SortingOrder;
#endif
 
    TArray<FGuid> ChildObjectBindings;
 
#if WITH_EDITORONLY_DATA
    UPROPERTY()
    TArray<TObjectPtr<UMovieSceneTrack>> ChildMasterTracks_DEPRECATED;
#endif
};
 
MOVIESCENE_API void GetMovieSceneFoldersRecursive(TArrayView<UMovieSceneFolder* const> InFoldersToRecurse, TArray<UMovieSceneFolder*>& OutFolders);