TypedElementId.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
//#include "CoreMinimal.h"
#include "Elements/Framework/TypedElementLimits.h"
#include "Misc/AssertionMacros.h"
#include "Templates/TypeHash.h"
 
struct FTypedElementId
{
public:
    FTypedElementId()
        : CombinedId(0)
    {
    }
 
    FTypedElementId(const FTypedElementId&) = delete;
    FTypedElementId& operator=(const FTypedElementId&) = delete;
    
    FTypedElementId(FTypedElementId&& InOther)
        : CombinedId(InOther.CombinedId)
    {
        InOther.Private_DestroyNoRef();
    }
 
    FTypedElementId& operator=(FTypedElementId&& InOther)
    {
        if (this != &InOther)
        {
            CombinedId = InOther.CombinedId;
 
            InOther.Private_DestroyNoRef();
        }
        return *this;
    }
 
    ~FTypedElementId()
    {
        checkf(!IsSet(), TEXT("Element ID was still set during destruction! This will leak an element reference, and you should release this ID prior to destruction!"));
    }
 
    inline explicit operator bool() const
    {
        return IsSet();
    }
 
    inline bool IsSet() const
    {
        return TypeId != 0;
    }
 
    inline FTypedHandleTypeId GetTypeId() const
    {
        return TypeId;
    }
 
    inline FTypedHandleElementId GetElementId() const
    {
        return ElementId;
    }
 
    inline FTypedHandleCombinedId GetCombinedId() const
    {
        return CombinedId;
    }
 
    inline friend bool operator==(const FTypedElementId& InLHS, const FTypedElementId& InRHS)
    {
        return InLHS.CombinedId == InRHS.CombinedId;
    }
 
    inline friend bool operator!=(const FTypedElementId& InLHS, const FTypedElementId& InRHS)
    {
        return !(InLHS == InRHS);
    }
 
    friend inline uint32 GetTypeHash(const FTypedElementId& InElementId)
    {
        return GetTypeHash(InElementId.CombinedId);
        
    }
 
    inline void Private_InitializeNoRef(const FTypedHandleTypeId InTypeId, const FTypedHandleElementId InElementId)
    {
        TypeId = InTypeId;
        ElementId = InElementId;
    }
 
    inline void Private_DestroyNoRef()
    {
        CombinedId = 0;
    }
 
    static TYPEDELEMENTFRAMEWORK_API const FTypedElementId Unset;
 
private:
    union
    {
        struct
        {
            // Note: These are arranged in this order to give CombinedId better hash distribution for GetTypeHash!
            FTypedHandleCombinedId ElementId : TypedHandleElementIdBits;
            FTypedHandleCombinedId TypeId : TypedHandleTypeIdBits;
        };
        FTypedHandleCombinedId CombinedId;
    };
};