MovieSceneDecorationContainer.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "UObject/Interface.h"
#include "MovieSceneSignedObject.h"
#include "Templates/FunctionFwd.h"
#include "MovieSceneDecorationContainer.generated.h"
 
template <typename T> class TSubclassOf;
 
USTRUCT()
struct FMovieSceneDecorationContainer
{
public:
 
    GENERATED_BODY()
 
    
    MOVIESCENE_API UObject* FindDecoration(const TSubclassOf<UObject>& InClass) const;
 
    MOVIESCENE_API void AddDecoration(UObject* InDecoration, UObject* Outer, TFunctionRef<void(UObject*)> Event);
 
    MOVIESCENE_API UObject* GetOrCreateDecoration(const TSubclassOf<UObject>& InClass, UObject* Outer, TFunctionRef<void(UObject*)> Event);
 
    MOVIESCENE_API void RemoveDecoration(const TSubclassOf<UObject>& InClass, TFunctionRef<void(UObject*)> Event);
 
    MOVIESCENE_API TArrayView<const TObjectPtr<UObject>> GetDecorations() const;
 
    template<typename DecorationType>
    DecorationType* FindDecoration() const
    {
        UObject* Found = nullptr;
 
        if constexpr (TIsIInterface<DecorationType>::Value)
        {
            Found = FindDecoration(DecorationType::UClassType::StaticClass());
        }
        else
        {
            Found = FindDecoration(DecorationType::StaticClass());
        }
 
        return CastChecked<DecorationType>(Found, ECastCheckedType::NullAllowed);
    }
 
    template<typename DecorationType>
    DecorationType* GetOrCreateDecoration(UObject* Outer, TFunctionRef<void(UObject*)> Event)
    {
        UObject* Found = GetOrCreateDecoration(DecorationType::StaticClass(), Event);
        return CastChecked<DecorationType>(Found);
    }
 
    template<typename DecorationType>
    void RemoveDecoration()
    {
        RemoveDecoration(DecorationType::StaticClass());
    }
 
    void RemoveNulls()
    {
        Decorations.Remove(nullptr);
    }
 
protected:
 
    UPROPERTY()
    TArray<TObjectPtr<UObject>> Decorations;
};
 
 
UCLASS(DefaultToInstanced, MinimalAPI)
class UMovieSceneDecorationContainerObject
    : public UMovieSceneSignedObject
{
    GENERATED_BODY()
 
public:
 
    UObject* FindDecoration(const TSubclassOf<UObject>& InClass) const
    {
        return Decorations.FindDecoration(InClass);
    }
 
    MOVIESCENE_API void AddDecoration(UObject* InDecoration);
 
    MOVIESCENE_API UObject* GetOrCreateDecoration(const TSubclassOf<UObject>& InClass);
 
    MOVIESCENE_API void RemoveDecoration(const TSubclassOf<UObject>& InClass);
 
 
    TArrayView<const TObjectPtr<UObject>> GetDecorations() const
    {
        return Decorations.GetDecorations();
    }
 
    template<typename DecorationType>
    DecorationType* FindDecoration() const
    {
        return Decorations.FindDecoration<DecorationType>();
    }
 
    template<typename DecorationType>
    DecorationType* GetOrCreateDecoration()
    {
        return CastChecked<DecorationType>(GetOrCreateDecoration(DecorationType::StaticClass()));
    }
 
    template<typename DecorationType>
    void RemoveDecoration()
    {
        return RemoveDecoration(DecorationType::StaticClass());
    }
 
    void GetCompatibleUserDecorations(TSet<UClass*>& OutClasses) const
    {
        GetCompatibleUserDecorationsImpl(OutClasses);
    }
 
protected:
 
    virtual void OnDecorationAdded(UObject* Decoration)
    {}
 
    virtual void OnDecorationRemoved(UObject* Decoration)
    {}
 
    virtual void GetCompatibleUserDecorationsImpl(TSet<UClass*>& OutClasses) const
    {}
 
protected:
 
    MOVIESCENE_API virtual void Serialize(FArchive& Ar) override;
 
protected:
 
    UPROPERTY()
    FMovieSceneDecorationContainer Decorations;
};