OverridableManager.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "UObject/Object.h"
#include "UObject/ObjectMacros.h"
#include "UObject/OverriddenPropertySet.h"
#include "UObject/ScriptMacros.h"
#include "UObject/UObjectAnnotation.h"
 
// TODO: Internal headers should not be included
#include "Runtime/CoreUObject/Internal/UObject/PropertyBagRepository.h"
 
 
#include "OverridableManager.generated.h"
 
/*
 *************************************************************************************
 * Overridable serialization is experimental, not supported and use at your own risk *
 *************************************************************************************
 */
 
#if WITH_EDITORONLY_DATA
 
struct FOverriddenPropertyAnnotation
{
    bool IsDefault() const
    {
        return !OverriddenProperties.IsValid();
    }
 
    TSharedPtr<FOverriddenPropertySet> OverriddenProperties;
};
 
#endif // WITH_EDITORONLY_DATA
 
UENUM()
enum class EOverriddenState : uint8
{
    NoOverrides, // no on this object and any of its instanced subobjects
    HasOverrides, // has overrides in the object properties
    AllOverridden, // all properties are overridden for this object and its subobjects
    SubObjectsHasOverrides, // at least one of its subobjects has overrides
    Added, // This object was added
};
 
struct FOverrideManagerCapabilityInterface;
 
/*
 *************************************************************************************
 * Overridable serialization is experimental, not supported and use at your own risk *
 *************************************************************************************
 */
class FOverridableManager 
#if WITH_EDITORONLY_DATA
    : protected FUObjectAnnotationSparse<FOverriddenPropertyAnnotation, true/*bAutoRemove*/>
#endif // WITH_EDITORONLY_DATA
{
public:
    static FOverridableManager& Get()
    {
        checkf(OverridableManager, TEXT("Expected the overridable manager to be created."))
        return *OverridableManager;
    }
 
    static FOverridableManager* TryGet()
    {
        return OverridableManager;
    }
 
    COREUOBJECT_API static void Create();
 
     COREUOBJECT_API bool IsEnabled(TNotNull<const UObject*> Object);
 
    COREUOBJECT_API void Enable(TNotNull<UObject*> Object);
 
    COREUOBJECT_API void Disable(TNotNull<UObject*> Object, bool bPropagateToSubObjects = false);
 
    COREUOBJECT_API void DisableInstancedSubObject(TNotNull<const UObject*> Object, TNotNull<UObject*> InstancedSubObject);
 
    COREUOBJECT_API void InheritEnabledFrom(TNotNull<UObject*> Object, const UObject* DefaultData);
 
    COREUOBJECT_API bool NeedSubObjectTemplateInstantiation(TNotNull<const UObject*> Object);
 
    template<
        typename InputType
        UE_REQUIRES(std::is_convertible_v<InputType, TNotNull<const UObject*>> || std::is_convertible_v<InputType, TNotNull<UObject*>>)
    >
    auto GetOverriddenProperties(InputType&& Object)
    {
        // Use a template because the compiler cannot discern which method to use if UObject* is passed (both TNotNulls accept UObject*).
        if constexpr (std::is_convertible_v<InputType, TNotNull<UObject*>>)
        {
            return GetOverriddenPropertiesInternal(TNotNull<UObject*>(Object));
        }
        else
        {
            return GetOverriddenPropertiesInternal(TNotNull<const UObject*>(Object));
        }
    }
 
    COREUOBJECT_API FOverriddenPropertySet* RestoreOverrideOperation(TNotNull<UObject*> Object, EOverriddenPropertyOperation Operation, const bool bNeedsSubobjectTemplateInstantiation, const bool bDontClearOverrides = false);
 
    COREUOBJECT_API void RestoreOverrideState(TNotNull<const UObject*> OldObject, TNotNull<UObject*> NewObject);
 
    COREUOBJECT_API EOverriddenState GetOverriddenState(TNotNull<UObject*> Object, 
        TFunction<bool(TNotNull<const FProperty*>)> ConsiderPropertyForOverriddenState = TFunction<bool(TNotNull<const FProperty*>)>(),
        const FPropertyVisitorPath& Path = FPropertyVisitorPath(), bool* bOutInheritedState = nullptr);
 
    COREUOBJECT_API void OverrideAllObjectProperties(TNotNull<UObject*> Object);
 
    COREUOBJECT_API void ClearOverrides(TNotNull<UObject*> Object);
 
    COREUOBJECT_API void ClearInstancedSubObjectOverrides(TNotNull<const UObject*> Object, TNotNull<UObject*> InstancedSubObject);
 
    COREUOBJECT_API void PropagateClearOverridesToInstancedSubObjects(TNotNull<UObject*> Object);
 
    COREUOBJECT_API void OverrideProperty(TNotNull<UObject*> Object, const FPropertyVisitorPath& PropertyPath);
 
    bool ClearOverriddenProperty(TNotNull<UObject*> Object, const FPropertyVisitorPath& PropertyPath)
    {
        return ClearOverriddenProperty(Object, PropertyPath.GetRootIterator());
    }
 
    COREUOBJECT_API void PreOverrideProperty(TNotNull<UObject*> Object, const FPropertyVisitorPath& PropertyPath, const EPropertyChangeType::Type ChangeType = EPropertyChangeType::Unspecified);
 
    COREUOBJECT_API void PostOverrideProperty(TNotNull<UObject*> Object, const FPropertyVisitorPath& PropertyPath, const EPropertyChangeType::Type ChangeType);
 
    EOverriddenPropertyOperation GetOverriddenPropertyOperation(TNotNull<UObject*> Object, const FPropertyVisitorPath& PropertyPath, bool* bOutInheritedOperation = nullptr)
    {
        return GetOverriddenPropertyOperation(Object, PropertyPath.GetRootIterator(), bOutInheritedOperation);
    }
 
    COREUOBJECT_API void SerializeOverriddenProperties(TNotNull<UObject*> Object, FStructuredArchive::FRecord ObjectRecord);
 
    void OverrideProperty(TNotNull<UObject*> Object, const FPropertyChangedChainEvent& PropertyEvent)
    {
        OverrideProperty(Object, FPropertyVisitorPath(PropertyEvent, PropertyEvent.PropertyChain));
    }
 
    bool ClearOverriddenProperty(TNotNull<UObject*> Object, const FPropertyChangedEvent& PropertyEvent, const FEditPropertyChain& PropertyChain)
    {
        return ClearOverriddenProperty(Object, FPropertyVisitorPath(PropertyEvent, PropertyChain));
    }
 
    void PreOverridePropertyChain(UObject* Object, const FEditPropertyChain& PropertyChain)
    {
        PreOverrideProperty(Object, FPropertyVisitorPath(FPropertyChangedEvent(nullptr), PropertyChain));
    }
 
    void PreOverrideProperty(UObject* Object, const FPropertyChangedChainEvent& PropertyChainEvent)
    {
        PreOverrideProperty(Object, FPropertyVisitorPath(PropertyChainEvent, PropertyChainEvent.PropertyChain), PropertyChainEvent.ChangeType);
    }
 
    void PostOverrideProperty(UObject* Object, const FPropertyChangedChainEvent& PropertyChainEvent)
    {
        PostOverrideProperty(Object, FPropertyVisitorPath(PropertyChainEvent, PropertyChainEvent.PropertyChain), PropertyChainEvent.ChangeType);
    }
 
    UE_FORCEINLINE_HINT EOverriddenPropertyOperation GetOverriddenPropertyOperation(TNotNull<UObject*> Object, const FPropertyChangedEvent& PropertyEvent, const FEditPropertyChain& PropertyChain, bool* bOutInheritedOperation = nullptr)
    {
        return GetOverriddenPropertyOperation(Object, FPropertyVisitorPath(PropertyEvent, PropertyChain), bOutInheritedOperation);
    }
 
 
    void HandleObjectsReInstantiated(const TMap<UObject*, UObject*>& OldToNewInstanceMap);
    void HandleDeadObjectReferences(const TSet<UClass*>& DeadClasses, const TSet<UObject*>& ActiveInstances, const TSet<UObject*>& TemplateInstances);
 
protected:
    FOverridableManager();
 
    COREUOBJECT_API static FOverridableManager* OverridableManager;
 
#if WITH_EDITORONLY_DATA
    FOverriddenPropertySet* Find(TNotNull<const UObject*> Object);
    FOverriddenPropertySet& FindChecked(TNotNull<const UObject*> Object);
    FOverriddenPropertySet& FindOrAdd(TNotNull<UObject*> Object);
#else
    FUObjectAnnotationSparseBool NeedsSubobjectTemplateInstantiation;
#endif // WITH_EDITORONLY_DATA
 
    friend FOverriddenPropertySet;
    COREUOBJECT_API void NotifyPropertyChange(const EPropertyNotificationType Notification, TNotNull<UObject*> Object, FPropertyVisitorPath::Iterator PropertyIterator, const EPropertyChangeType::Type ChangeType);
    COREUOBJECT_API EOverriddenPropertyOperation GetOverriddenPropertyOperation(TNotNull<UObject*> Object, FPropertyVisitorPath::Iterator PropertyIterator, bool* bOutInheritedOperation = nullptr);
    COREUOBJECT_API bool ClearOverriddenProperty(TNotNull<UObject*> Object, FPropertyVisitorPath::Iterator PropertyIterator);
    COREUOBJECT_API FOverriddenPropertySet* GetOverriddenPropertiesInternal(TNotNull<UObject*> Object);
    COREUOBJECT_API const FOverriddenPropertySet* GetOverriddenPropertiesInternal(TNotNull<const UObject*> Object);
};