IDelegateInstance.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "Templates/TypeHash.h" 
#include "UObject/NameTypes.h"
#include "Delegates/DelegateSettings.h"
 
class FDelegateHandle
{
public:
    enum EGenerateNewHandleType
    {
        GenerateNewHandle
    };
 
    FDelegateHandle()
        : ID(0)
    {
    }
 
    explicit FDelegateHandle(EGenerateNewHandleType)
        : ID(GenerateNewID())
    {
    }
 
    bool IsValid() const
    {
        return ID != 0;
    }
 
    void Reset()
    {
        ID = 0;
    }
 
    bool operator==(const FDelegateHandle& Rhs) const
    {
        return ID == Rhs.ID;
    }
 
    bool operator!=(const FDelegateHandle& Rhs) const
    {
        return ID != Rhs.ID;
    }
 
    friend UE_FORCEINLINE_HINT uint32 GetTypeHash(const FDelegateHandle& Key)
    {
        return GetTypeHash(Key.ID);
    }
 
private:
 
    static CORE_API uint64 GenerateNewID();
 
    uint64 ID;
};
 
#if UE_WITH_REMOTE_OBJECT_HANDLE
/*
 * Helper class that validates Delegate object type
 */
class FDelegateUserObject
{
    const void* UserObject;
    bool bIsUObject = false;
public:
    template<typename UserObjectType>
    FDelegateUserObject(const UserObjectType* InUserObject)
    {
        UE_STATIC_ASSERT_COMPLETE_TYPE(UserObjectType, "FDelegateUserObject(UserObject) UserObject must not be an incomplete type");
        UserObject = (const void*)InUserObject;
        bIsUObject = std::is_convertible_v<UserObjectType*, UObject*>;
    }
    UE_FORCEINLINE_HINT bool IsUObject() const
    {
        return bIsUObject;
    }
    UE_FORCEINLINE_HINT const void* GetRaw() const
    {
        return UserObject;
    }
    UE_FORCEINLINE_HINT const UObject* GetUObject() const
    {
        return (const UObject*)UserObject;
    }
    UE_FORCEINLINE_HINT operator const void* () const
    {
        return UserObject;
    }
};
using FDelegateUserObjectConst = const FDelegateUserObject;
#else
using FDelegateUserObject = void*;
using FDelegateUserObjectConst = const void*;
#endif
 
class IDelegateInstance
{
public:
    virtual ~IDelegateInstance() = default;
 
#if USE_DELEGATE_TRYGETBOUNDFUNCTIONNAME
 
    virtual FName TryGetBoundFunctionName() const = 0;
 
#endif
 
    virtual UObject* GetUObject( ) const = 0;
 
    virtual const void* GetObjectForTimerManager() const = 0;
 
    virtual uint64 GetBoundProgramCounterForTimerManager() const = 0;
 
    virtual bool HasSameObject(FDelegateUserObjectConst InUserObject) const = 0;
 
    virtual bool IsCompactable( ) const
    {
        return !IsSafeToExecute();
    }
 
    virtual bool IsSafeToExecute( ) const = 0;
 
    virtual FDelegateHandle GetHandle() const = 0;
};