SMInstanceElementId.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/GCObject.h"
#include "InstancedStaticMeshDelegates.h"
#include "SMInstanceElementId.generated.h"
 
class FSMInstanceElementIdMap;
class UInstancedStaticMeshComponent;
class USMInstanceElementIdMapTransactor;
 
ENGINE_API extern const FName NAME_SMInstance;
 
struct FSMInstanceId
{
    explicit operator bool() const
    {
        return ISMComponent != nullptr
            && InstanceIndex != INDEX_NONE;
    }
 
    bool operator==(const FSMInstanceId& InRHS) const
    {
        return ISMComponent == InRHS.ISMComponent
            && InstanceIndex == InRHS.InstanceIndex;
    }
 
    bool operator!=(const FSMInstanceId& InRHS) const
    {
        return !(*this == InRHS);
    }
 
    friend inline uint32 GetTypeHash(const FSMInstanceId& InId)
    {
        return HashCombine(GetTypeHash(InId.InstanceIndex), GetTypeHash(InId.ISMComponent));
    }
 
    UInstancedStaticMeshComponent* ISMComponent = nullptr;
    int32 InstanceIndex = INDEX_NONE;
};
 
struct FSMInstanceElementId
{
    explicit operator bool() const
    {
        return ISMComponent != nullptr
            && InstanceId != 0;
    }
 
    bool operator==(const FSMInstanceElementId& InRHS) const
    {
        return ISMComponent == InRHS.ISMComponent
            && InstanceId == InRHS.InstanceId;
    }
 
    bool operator!=(const FSMInstanceElementId& InRHS) const
    {
        return !(*this == InRHS);
    }
 
    friend inline uint32 GetTypeHash(const FSMInstanceElementId& InId)
    {
        return HashCombine(GetTypeHash(InId.InstanceId), GetTypeHash(InId.ISMComponent));
    }
 
    UInstancedStaticMeshComponent* ISMComponent = nullptr;
    uint64 InstanceId = 0;
};
 
struct FSMInstanceElementIdMapEntry
{
    FSMInstanceElementIdMapEntry(FSMInstanceElementIdMap* InOwner, UInstancedStaticMeshComponent* InComponent);
    ~FSMInstanceElementIdMapEntry();
 
    FSMInstanceElementIdMap* Owner = nullptr;
 
    UInstancedStaticMeshComponent* Component = nullptr;
 
#if WITH_EDITORONLY_DATA
    TObjectPtr<USMInstanceElementIdMapTransactor> Transactor = nullptr;
#endif  // WITH_EDITORONLY_DATA
 
    TMap<int32, uint64> InstanceIndexToIdMap;
    TMap<uint64, int32> InstanceIdToIndexMap;
    uint64 NextInstanceId = 1;
};
 
class FSMInstanceElementIdMap : public FGCObject
{
public:
    static ENGINE_API FSMInstanceElementIdMap& Get();
 
    ENGINE_API ~FSMInstanceElementIdMap();
 
    DECLARE_MULTICAST_DELEGATE_ThreeParams(FOnInstanceRemapped, const FSMInstanceElementId& /*SMInstanceElementId*/, int32 /*PreviousInstanceIndex*/, int32 /*InstanceIndex*/);
    FOnInstanceRemapped& OnInstanceRemapped()
    {
        return OnInstanceRemappedDelegate;
    }
 
    DECLARE_MULTICAST_DELEGATE_TwoParams(FOnInstancePreRemoval, const FSMInstanceElementId& /*SMInstanceElementId*/, int32 /*InstanceIndex*/);
    FOnInstancePreRemoval& OnInstancePreRemoval()
    {
        return OnInstancePreRemovalDelegate;
    }
 
    DECLARE_MULTICAST_DELEGATE_TwoParams(FOnInstanceRemoved, const FSMInstanceElementId& /*SMInstanceElementId*/, int32 /*InstanceIndex*/);
    FOnInstanceRemoved& OnInstanceRemoved()
    {
        return OnInstanceRemovedDelegate;
    }
 
    ENGINE_API FSMInstanceId GetSMInstanceIdFromSMInstanceElementId(const FSMInstanceElementId& InSMInstanceElementId);
 
    ENGINE_API FSMInstanceElementId GetSMInstanceElementIdFromSMInstanceId(const FSMInstanceId& InSMInstanceId, const bool bAllowCreate = true);
 
    ENGINE_API TArray<FSMInstanceElementId> GetSMInstanceElementIdsForComponent(UInstancedStaticMeshComponent* InComponent) const;
 
    ENGINE_API void OnComponentReplaced(UInstancedStaticMeshComponent* InOldComponent, UInstancedStaticMeshComponent* InNewComponent);
 
public:
    //~ FGCObject interface
    ENGINE_API virtual void AddReferencedObjects(FReferenceCollector& Collector) override;
    virtual FString GetReferencerName() const override
    {
        return TEXT("FSMInstanceElementIdMap");
    }
 
public:
    ENGINE_API void SerializeIdMappings(FSMInstanceElementIdMapEntry* InEntry, FArchive& Ar);
 
private:
    ENGINE_API void OnInstanceIndexUpdated(UInstancedStaticMeshComponent* InComponent, TArrayView<const FInstancedStaticMeshDelegates::FInstanceIndexUpdateData> InIndexUpdates);
 
    ENGINE_API void ClearInstanceData_NoLock(UInstancedStaticMeshComponent* InComponent, FSMInstanceElementIdMapEntry& InEntry);
 
#if WITH_EDITOR
    ENGINE_API void OnObjectModified(UObject* InObject);
#endif  // WITH_EDITOR
 
    ENGINE_API void RegisterCallbacks();
 
    ENGINE_API void UnregisterCallbacks();
 
    mutable FCriticalSection ISMComponentsCS;
    TMap<UInstancedStaticMeshComponent*, TSharedPtr<FSMInstanceElementIdMapEntry>> ISMComponents;
 
    FOnInstanceRemapped OnInstanceRemappedDelegate;
 
    FOnInstancePreRemoval OnInstancePreRemovalDelegate;
    FOnInstanceRemoved OnInstanceRemovedDelegate;
 
    FDelegateHandle OnInstanceIndexUpdatedHandle;
#if WITH_EDITOR
    FDelegateHandle OnObjectModifiedHandle;
#endif
};
 
UCLASS(Transient)
class USMInstanceElementIdMapTransactor : public UObject
{
    GENERATED_BODY()
 
public:
    USMInstanceElementIdMapTransactor();
 
#if WITH_EDITORONLY_DATA
    void SetOwnerEntry(FSMInstanceElementIdMapEntry* InOwnerEntry)
    {
        OwnerEntry = InOwnerEntry;
    }
 
    //~ UObject interface
    virtual void Serialize(FArchive& Ar) override;
 
private:
    FSMInstanceElementIdMapEntry* OwnerEntry = nullptr;
#endif  // WITH_EDITORONLY_DATA
};