ObjectHandleTracking.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
 
#include "Delegates/Delegate.h"
#include "UObject/ObjectHandleDefines.h"
#include "Templates/Function.h"
#include <atomic>
 
struct FObjectRef;
 
namespace UE::CoreUObject
{
#if UE_WITH_OBJECT_HANDLE_TRACKING
 
    using FObjectHandleReadFunc = TFunction<void(const TArrayView<const UObject* const>& Objects)>;
 
    using FObjectHandleClassResolvedFunc = TFunction<void(const FObjectRef& SourceRef, UPackage* ClassPackage, UClass* Class)>;
    using FObjectHandleReferenceResolvedFunc = TFunction<void(const FObjectRef& SourceRef, UPackage* ObjectPackage, UObject* Object)>;
    using FObjectHandleReferenceLoadedFunc = TFunction<void(const FObjectRef& SourceRef, UPackage* ObjectPackage, UObject* Object)>;
 
    struct FObjectHandleTrackingCallbackId
    {
        int32 Id = -1;
        bool IsValid() { return Id != -1; }
    };
 
    COREUOBJECT_API FObjectHandleTrackingCallbackId AddObjectHandleReadCallback(FObjectHandleReadFunc Delegate);
    COREUOBJECT_API void RemoveObjectHandleReadCallback(FObjectHandleTrackingCallbackId DelegateHandle);
 
    COREUOBJECT_API FObjectHandleTrackingCallbackId AddObjectHandleClassResolvedCallback(FObjectHandleClassResolvedFunc Callback);
    COREUOBJECT_API void RemoveObjectHandleClassResolvedCallback(FObjectHandleTrackingCallbackId DelegateHandle);
 
    COREUOBJECT_API FObjectHandleTrackingCallbackId AddObjectHandleReferenceResolvedCallback(FObjectHandleReferenceResolvedFunc Callback);
    COREUOBJECT_API void RemoveObjectHandleReferenceResolvedCallback(FObjectHandleTrackingCallbackId DelegateHandle);
 
    COREUOBJECT_API FObjectHandleTrackingCallbackId AddObjectHandleReferenceLoadedCallback(FObjectHandleReferenceLoadedFunc Callback);
    COREUOBJECT_API void RemoveObjectHandleReferenceLoadedCallback(FObjectHandleTrackingCallbackId DelegateHandle);
 
#endif
}
 
#if UE_WITH_OBJECT_HANDLE_TRACKING
namespace UE::CoreUObject::Private
{
    extern COREUOBJECT_API std::atomic<int32> HandleReadCallbackQuantity;
    COREUOBJECT_API void OnHandleReadInternal(TArrayView<const UObject* const> Objects);
    COREUOBJECT_API void OnHandleReadInternal(const UObject* Object);
    inline void OnHandleRead(TArrayView<const UObject* const> Objects)
    {
        if (HandleReadCallbackQuantity.load(std::memory_order_relaxed) > 0)
        {
            OnHandleReadInternal(Objects);
        }
    }
    inline void OnHandleRead(const UObject* Object)
    {
        if (HandleReadCallbackQuantity.load(std::memory_order_relaxed) > 0)
        {
            OnHandleReadInternal(Object);
        }
    }
    COREUOBJECT_API void OnClassReferenceResolved(const FObjectRef& ObjectRef, UPackage* ClassPackage, UClass* Class);
    COREUOBJECT_API void OnReferenceResolved(const FObjectRef& ObjectRef, UPackage* ObjectPackage, UObject* Object);
    COREUOBJECT_API void OnReferenceLoaded(const FObjectRef& ObjectRef, UPackage* ObjectPackage, UObject* Object);
}
#else
 
namespace UE::CoreUObject::Private
{
    inline void OnHandleRead(const UObject* Object) { }
    inline void OnHandleRead(TArrayView<const UObject*> Objects) { }
    inline void OnClassReferenceResolved(const FObjectRef& ObjectRef, UPackage* Package, UClass* Class) { }
    inline void OnReferenceResolved(const FObjectRef& ObjectRef, UPackage* Package, UClass* Class) { }
    inline void OnReferenceLoaded(const FObjectRef& ObjectRef, UPackage* Package, UObject* Object) { }
}
 
 
#endif