ArticyRef.h

//  
// Copyright (c) 2023 articy Software GmbH & Co. KG. All rights reserved.  
//
 
#pragma once
 
#include "ArticyBaseTypes.h"
#include "ArticyObject.h"
#include "ArticyRef.generated.h"
 
USTRUCT(BlueprintType)
struct ARTICYRUNTIME_API FArticyRef
{
    GENERATED_BODY()
 
public:
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Setup")
    bool bReferenceBaseObject = true;

    UPROPERTY(EditAnywhere, BlueprintReadWrite, meta = (EditCondition="!bReferenceBaseObject"), Category="Setup")
    mutable int32 CloneId = 0;
 
    void SetId(FArticyId NewId);
    void SetReference(UArticyObject* Object);
 
    const FArticyId& GetId() const;

    template<typename T = UArticyObject>
    T* GetObject(const UObject* WorldContext) const;
 
    uint32 GetEffectiveCloneId() const
    {
        return bReferenceBaseObject ? 0ul : *reinterpret_cast<uint32*>(&CloneId);
    }
    
    enum EStringInitResult
    {
        NoneSet,
        IdSet,
        RefSet,
        AllSet
    };
 
    // reference: color.h
    // used in details customization
    EStringInitResult InitFromString(const FString& SourceString)
    {
        Id.High = Id.Low = 0;
 
        const bool IdSet =
            FParse::Value(*SourceString, TEXT("Low="), Id.Low) &&
            FParse::Value(*SourceString, TEXT("High="), Id.High);
        const bool RefSet =
            FParse::Bool(*SourceString, TEXT("bReferenceBaseObject="), bReferenceBaseObject) &&
            FParse::Value(*SourceString, TEXT("CloneId="), CloneId);
 
        return IdSet && RefSet ? EStringInitResult::AllSet : IdSet ? EStringInitResult::IdSet : RefSet ? EStringInitResult::RefSet : EStringInitResult::NoneSet;
    }

    FString ToString() const
    {
        return FString::Printf(TEXT("(bReferenceBaseObject=%s, CloneId=%d, Id=(Low=%d, High=%d))"), bReferenceBaseObject ? TEXT("True") : TEXT("False"), CloneId, Id.Low, Id.High);
    }

    bool operator==(const FArticyRef& Other) const
    {
        return MatchesEffective(Other);
    }

    bool MatchesRaw(const FArticyRef& Other) const
    {
        return Other.Id.Low == Id.Low && Other.Id.High == Id.High && Other.bReferenceBaseObject == bReferenceBaseObject && Other.CloneId == CloneId;
    }

    bool MatchesEffective(const FArticyRef& Other) const
    {
        return Other.Id.Low == Id.Low && Other.Id.High == Id.High && Other.bReferenceBaseObject == bReferenceBaseObject && Other.GetEffectiveCloneId() == GetEffectiveCloneId();
    }
 
    bool operator!=(const FArticyRef& Other) const
    {
        return !this->operator==(Other);
    }
 
    friend uint32 GetTypeHash(const FArticyRef& Ref)
    {
        return HashCombine(GetTypeHash(Ref.GetId()), Ref.GetEffectiveCloneId());
    }
 
    
private:
    UPROPERTY(EditAnywhere, Category="Setup")
    mutable FArticyId Id = 0;

    mutable TWeakObjectPtr<UArticyObject> CachedObject = nullptr;
    mutable FArticyId CachedId = 0;
    mutable int32 CachedCloneId = 0;
 
    UArticyObject* GetObjectInternal(const UObject* WorldContext) const;
 
private:

    //template<class CPPSTRUCT>
    //friend typename TEnableIf<TStructOpsTypeTraits<CPPSTRUCT>::WithSerializer, bool>::Type SerializeOrNot(FArchive& Ar, CPPSTRUCT *Data);
 
    //bool Serialize(FArchive& Ar);

    //template<class CPPSTRUCT>
    //friend typename TEnableIf<TStructOpsTypeTraits<CPPSTRUCT>::WithPostSerialize>::Type PostSerializeOrNot(const FArchive& Ar, CPPSTRUCT *Data);
 
    //void PostSerialize(const FArchive& Ar);
};
 
template<typename T>
T* FArticyRef::GetObject(const UObject* WorldContext) const
{
    if (!CachedObject.IsValid() || CachedId != Id || CloneId != CachedCloneId)
    {
        CachedId = Id;
        CachedCloneId = CloneId;
        CachedObject = GetObjectInternal(WorldContext);
    }
 
    return Cast<T>(CachedObject.Get());
}
 
//template<>
//struct TStructOpsTypeTraits<FArticyRef> : public TStructOpsTypeTraitsBase2<FArticyRef>
//{
//  enum
//  {
//      WithSerializer = true,
//      WithPostSerialize = true
//  };
//};