SMInstanceManager.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 "Elements/SMInstance/SMInstanceElementId.h"
#include "Templates/SubclassOf.h"
#include "SMInstanceManager.generated.h"
 
enum class ETypedElementWorldType : uint8;
class USMInstanceProxyEditingObject;
 
UINTERFACE(MinimalAPI)
class USMInstanceManager : public UInterface
{
    GENERATED_BODY()
};
class ISMInstanceManager
{
    GENERATED_BODY()
 
public:
    virtual FText GetSMInstanceDisplayName(const FSMInstanceId& InstanceId) const
    {
        return FText();
    }
 
    virtual FText GetSMInstanceTooltip(const FSMInstanceId& InstanceId) const
    {
        return FText();
    }
 
    virtual bool CanEditSMInstance(const FSMInstanceId& InstanceId) const = 0;
 
    virtual bool CanMoveSMInstance(const FSMInstanceId& InstanceId, const ETypedElementWorldType WorldType) const = 0;
 
    virtual bool GetSMInstanceTransform(const FSMInstanceId& InstanceId, FTransform& OutInstanceTransform, bool bWorldSpace = false) const = 0;
 
    virtual bool SetSMInstanceTransform(const FSMInstanceId& InstanceId, const FTransform& InstanceTransform, bool bWorldSpace = false, bool bMarkRenderStateDirty = false, bool bTeleport = false) = 0;
 
    virtual void NotifySMInstanceMovementStarted(const FSMInstanceId& InstanceId) = 0;
 
    virtual void NotifySMInstanceMovementOngoing(const FSMInstanceId& InstanceId) = 0;
 
    virtual void NotifySMInstanceMovementEnded(const FSMInstanceId& InstanceId) = 0;
 
    virtual void NotifySMInstanceSelectionChanged(const FSMInstanceId& InstanceId, const bool bIsSelected) = 0;
 
    virtual void ForEachSMInstanceInSelectionGroup(const FSMInstanceId& InstanceId, TFunctionRef<bool(FSMInstanceId)> Callback)
    {
        Callback(InstanceId);
    }
 
    virtual bool CanDeleteSMInstance(const FSMInstanceId& InstanceId) const
    {
        return CanEditSMInstance(InstanceId);
    }
 
    virtual bool DeleteSMInstances(TArrayView<const FSMInstanceId> InstanceIds) = 0;
 
    virtual bool CanDuplicateSMInstance(const FSMInstanceId& InstanceId) const
    {
        return CanEditSMInstance(InstanceId);
    }
 
    virtual bool DuplicateSMInstances(TArrayView<const FSMInstanceId> InstanceIds, TArray<FSMInstanceId>& OutNewInstanceIds) = 0;
 
    virtual TSubclassOf<USMInstanceProxyEditingObject> GetSMInstanceEditingProxyClass() const
    {
        return nullptr;
    }
};
 
UCLASS(MinimalAPI, Abstract)
class USMInstanceProxyEditingObject : public UObject
{
    GENERATED_BODY()
 
public:
    virtual void Initialize(const FSMInstanceElementId& InSMInstanceElementId) {}
    virtual void Shutdown() {}
private:
    virtual bool SyncProxyStateFromInstance() { return false; }
};
 
UINTERFACE(MinimalAPI)
class USMInstanceManagerProvider : public UInterface
{
    GENERATED_BODY()
};
class ISMInstanceManagerProvider
{
    GENERATED_BODY()
 
public:
    virtual ISMInstanceManager* GetSMInstanceManager(const FSMInstanceId& InstanceId) = 0;
};
 
struct FSMInstanceManager
{
public:
    FSMInstanceManager() = default;
 
    FSMInstanceManager(const FSMInstanceId& InInstanceId, ISMInstanceManager* InInstanceManager)
        : InstanceId(InInstanceId)
        , InstanceManager(InInstanceManager)
    {
    }
 
    explicit operator bool() const
    {
        return InstanceId
            && InstanceManager;
    }
 
    bool operator==(const FSMInstanceManager& InRHS) const
    {
        return InstanceId == InRHS.InstanceId
            && InstanceManager == InRHS.InstanceManager;
    }
 
    bool operator!=(const FSMInstanceManager& InRHS) const
    {
        return !(*this == InRHS);
    }
 
    friend inline uint32 GetTypeHash(const FSMInstanceManager& InId)
    {
        return GetTypeHash(InId.InstanceId);
    }
 
    const FSMInstanceId& GetInstanceId() const { return InstanceId; }
    ISMInstanceManager* GetInstanceManager() const { return InstanceManager; }
 
    UInstancedStaticMeshComponent* GetISMComponent() const { return InstanceId.ISMComponent; }
    int32 GetISMInstanceIndex() const { return InstanceId.InstanceIndex; }
 
    //~ ISMInstanceManager interface
    FText GetSMInstanceDisplayName() const { return InstanceManager->GetSMInstanceDisplayName(InstanceId); }
    FText GetSMInstanceTooltip() const { return InstanceManager->GetSMInstanceTooltip(InstanceId); }
    bool CanEditSMInstance() const { return InstanceManager->CanEditSMInstance(InstanceId); }
    bool CanMoveSMInstance(const ETypedElementWorldType WorldType) const { return InstanceManager->CanMoveSMInstance(InstanceId, WorldType); }
    bool GetSMInstanceTransform(FTransform& OutInstanceTransform, bool bWorldSpace = false) const { return InstanceManager->GetSMInstanceTransform(InstanceId, OutInstanceTransform, bWorldSpace); }
    bool SetSMInstanceTransform(const FTransform& InstanceTransform, bool bWorldSpace = false, bool bMarkRenderStateDirty = false, bool bTeleport = false) const { return InstanceManager->SetSMInstanceTransform(InstanceId, InstanceTransform, bWorldSpace, bMarkRenderStateDirty, bTeleport); }
    void NotifySMInstanceMovementStarted() const { return InstanceManager->NotifySMInstanceMovementStarted(InstanceId); }
    void NotifySMInstanceMovementOngoing() const { return InstanceManager->NotifySMInstanceMovementOngoing(InstanceId); }
    void NotifySMInstanceMovementEnded() const { return InstanceManager->NotifySMInstanceMovementEnded(InstanceId); }
    void NotifySMInstanceSelectionChanged(const bool bIsSelected) const { return InstanceManager->NotifySMInstanceSelectionChanged(InstanceId, bIsSelected); }
    void ForEachSMInstanceInSelectionGroup(TFunctionRef<bool(FSMInstanceId)> Callback) const { return InstanceManager->ForEachSMInstanceInSelectionGroup(InstanceId, Callback); }
    bool CanDeleteSMInstance() const { return InstanceManager->CanDeleteSMInstance(InstanceId); }
    bool DeleteSMInstance() const { return InstanceManager->DeleteSMInstances(MakeArrayView(&InstanceId, 1)); }
    bool CanDuplicateSMInstance() const { return InstanceManager->CanDuplicateSMInstance(InstanceId); }
    bool DuplicateSMInstance(FSMInstanceId& OutNewInstanceId) const
    {
        TArray<FSMInstanceId> NewInstanceIds;
        if (InstanceManager->DuplicateSMInstances(MakeArrayView(&InstanceId, 1), NewInstanceIds))
        {
            OutNewInstanceId = NewInstanceIds[0];
            return true;
        }
        return false;
    }
 
private:
    FSMInstanceId InstanceId;
    ISMInstanceManager* InstanceManager = nullptr;
};