ISMPartitionInstanceManager.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/Interface.h"
#include "Containers/ArrayView.h"
#include "ISMPartition/ISMPartitionClient.h"
#include "ISMPartitionInstanceManager.generated.h"
 
enum class ETypedElementWorldType : uint8;
 
UINTERFACE(MinimalAPI)
class UISMPartitionInstanceManager : public UInterface
{
    GENERATED_BODY()
};
class IISMPartitionInstanceManager
{
    GENERATED_BODY()
 
public:
    virtual FText GetISMPartitionInstanceDisplayName(const FISMClientInstanceId& InstanceId) const
    {
        return FText();
    }
 
    virtual FText GetISMPartitionInstanceTooltip(const FISMClientInstanceId& InstanceId) const
    {
        return FText();
    }
 
    virtual bool CanEditISMPartitionInstance(const FISMClientInstanceId& InstanceId) const = 0;
 
    virtual bool CanMoveISMPartitionInstance(const FISMClientInstanceId& InstanceId, const ETypedElementWorldType WorldType) const = 0;
 
    virtual bool GetISMPartitionInstanceTransform(const FISMClientInstanceId& InstanceId, FTransform& OutInstanceTransform, bool bWorldSpace = false) const = 0;
 
    virtual bool SetISMPartitionInstanceTransform(const FISMClientInstanceId& InstanceId, const FTransform& InstanceTransform, bool bWorldSpace = false, bool bTeleport = false) = 0;
 
    virtual void NotifyISMPartitionInstanceMovementStarted(const FISMClientInstanceId& InstanceId) = 0;
 
    virtual void NotifyISMPartitionInstanceMovementOngoing(const FISMClientInstanceId& InstanceId) = 0;
 
    virtual void NotifyISMPartitionInstanceMovementEnded(const FISMClientInstanceId& InstanceId) = 0;
 
    virtual void NotifyISMPartitionInstanceSelectionChanged(const FISMClientInstanceId& InstanceId, const bool bIsSelected) = 0;
 
    virtual bool CanDeleteISMPartitionInstance(const FISMClientInstanceId& InstanceId) const
    {
        return CanEditISMPartitionInstance(InstanceId);
    }
 
    virtual bool DeleteISMPartitionInstances(TArrayView<const FISMClientInstanceId> InstanceIds) = 0;
 
    virtual bool CanDuplicateISMPartitionInstance(const FISMClientInstanceId& InstanceId) const
    {
        return CanEditISMPartitionInstance(InstanceId);
    }
 
    virtual bool DuplicateISMPartitionInstances(TArrayView<const FISMClientInstanceId> InstanceIds, TArray<FISMClientInstanceId>& OutNewInstanceIds) = 0;
};
 
UINTERFACE(MinimalAPI)
class UISMPartitionInstanceManagerProvider : public UInterface
{
    GENERATED_BODY()
};
class IISMPartitionInstanceManagerProvider
{
    GENERATED_BODY()
 
public:
    virtual IISMPartitionInstanceManager* GetISMPartitionInstanceManager(const FISMClientHandle& ClientHandle) = 0;
};
 
struct FISMPartitionInstanceManager
{
public:
    FISMPartitionInstanceManager() = default;
 
    FISMPartitionInstanceManager(const FISMClientInstanceId& InInstanceId, IISMPartitionInstanceManager* InInstanceManager)
        : InstanceId(InInstanceId)
        , InstanceManager(InInstanceManager)
    {
    }
 
    explicit operator bool() const
    {
        return InstanceId
            && InstanceManager;
    }
 
    bool operator==(const FISMPartitionInstanceManager& InRHS) const
    {
        return InstanceId == InRHS.InstanceId
            && InstanceManager == InRHS.InstanceManager;
    }
 
    bool operator!=(const FISMPartitionInstanceManager& InRHS) const
    {
        return !(*this == InRHS);
    }
 
    friend inline uint32 GetTypeHash(const FISMPartitionInstanceManager& InId)
    {
        return GetTypeHash(InId.InstanceId);
    }
 
    const FISMClientInstanceId& GetInstanceId() const { return InstanceId; }
    IISMPartitionInstanceManager* GetInstanceManager() const { return InstanceManager; }
 
    //~ IISMPartitionInstanceManager interface
    FText GetISMPartitionInstanceDisplayName() const { return InstanceManager->GetISMPartitionInstanceDisplayName(InstanceId); }
    FText GetISMPartitionInstanceTooltip() const { return InstanceManager->GetISMPartitionInstanceTooltip(InstanceId); }
    bool CanEditISMPartitionInstance() const { return InstanceManager->CanEditISMPartitionInstance(InstanceId); }
    bool CanMoveISMPartitionInstance(const ETypedElementWorldType WorldType) const { return InstanceManager->CanMoveISMPartitionInstance(InstanceId, WorldType); }
    bool GetISMPartitionInstanceTransform(FTransform& OutInstanceTransform, bool bWorldSpace = false) const { return InstanceManager->GetISMPartitionInstanceTransform(InstanceId, OutInstanceTransform, bWorldSpace); }
    bool SetISMPartitionInstanceTransform(const FTransform& InstanceTransform, bool bWorldSpace = false, bool bTeleport = false) const { return InstanceManager->SetISMPartitionInstanceTransform(InstanceId, InstanceTransform, bWorldSpace, bTeleport); }
    void NotifyISMPartitionInstanceMovementStarted() const { return InstanceManager->NotifyISMPartitionInstanceMovementStarted(InstanceId); }
    void NotifyISMPartitionInstanceMovementOngoing() const { return InstanceManager->NotifyISMPartitionInstanceMovementOngoing(InstanceId); }
    void NotifyISMPartitionInstanceMovementEnded() const { return InstanceManager->NotifyISMPartitionInstanceMovementEnded(InstanceId); }
    void NotifyISMPartitionInstanceSelectionChanged(const bool bIsSelected) const { return InstanceManager->NotifyISMPartitionInstanceSelectionChanged(InstanceId, bIsSelected); }
    bool CanDeleteISMPartitionInstance() const { return InstanceManager->CanDeleteISMPartitionInstance(InstanceId); }
    bool DeleteISMPartitionInstance() const { return InstanceManager->DeleteISMPartitionInstances(MakeArrayView(&InstanceId, 1)); }
    bool CanDuplicateISMPartitionInstance() const { return InstanceManager->CanDuplicateISMPartitionInstance(InstanceId); }
    bool DuplicateISMPartitionInstance(FISMClientInstanceId& OutNewInstanceId) const
    {
        TArray<FISMClientInstanceId> NewInstanceIds;
        if (InstanceManager->DuplicateISMPartitionInstances(MakeArrayView(&InstanceId, 1), NewInstanceIds))
        {
            OutNewInstanceId = NewInstanceIds[0];
            return true;
        }
        return false;
    }
 
private:
    FISMClientInstanceId InstanceId;
    IISMPartitionInstanceManager* InstanceManager = nullptr;
};
 
USTRUCT()
struct FISMClientInstanceManagerData
{
    GENERATED_BODY()
    
public:
    bool Serialize(FArchive& Ar)
    {
        SerializePtr(Ar, Manager);
        SerializePtr(Ar, ManagerProvider);
        return true;
    }
 
    void SetInstanceManager(IISMPartitionInstanceManager* InManager)
    {
        Manager = InManager;
        ManagerProvider = nullptr;
    }
 
    void SetInstanceManagerProvider(IISMPartitionInstanceManagerProvider* InManagerProvider)
    {
        Manager = nullptr;
        ManagerProvider = InManagerProvider;
    }
    
    IISMPartitionInstanceManager* ResolveInstanceManager(const FISMClientHandle& ClientHandle) const
    {
        return ManagerProvider
            ? ManagerProvider->GetISMPartitionInstanceManager(ClientHandle)
            : Manager;
    }
    
private:
    template <typename T>
    static void SerializePtr(FArchive& Ar, T*& Ptr)
    {
        enum class ERefType : uint8
        {
            Null,
            Object,
            Raw,
        };
 
        if (Ar.IsSaving())
        {
            if (UObject* Obj = Cast<UObject>(Ptr))
            {
                ERefType RefType = ERefType::Object;
                Ar << RefType;
 
                Ar << Obj;
            }
            else if (Ptr && !Ar.IsPersistent())
            {
                ERefType RefType = ERefType::Raw;
                Ar << RefType;
 
                uint64 PtrInt = (uint64)Ptr;
                Ar << PtrInt;
            }
            else
            {
                ERefType RefType = ERefType::Null;
                Ar << RefType;
            }
        }
        else if (Ar.IsLoading())
        {
            ERefType RefType;
            Ar << RefType;
 
            switch (RefType)
            {
            case ERefType::Object:
                {
                    UObject* Obj = nullptr;
                    Ar << Obj;
                    Ptr = Cast<T>(Obj);
                }
                break;
            case ERefType::Raw:
                {
                    uint64 PtrInt = 0;
                    Ar << PtrInt;
                    Ptr = (T*)PtrInt;
                }
                break;
            default:
                Ptr = nullptr;
                break;
            }
        }
    };
 
    IISMPartitionInstanceManager* Manager = nullptr;
    IISMPartitionInstanceManagerProvider* ManagerProvider = nullptr;
};
 
template<>
struct TStructOpsTypeTraits<FISMClientInstanceManagerData> : public TStructOpsTypeTraitsBase2<FISMClientInstanceManagerData>
{
    enum
    {
        WithSerializer = true,
    };
};