ISMInstanceDataSceneProxy.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "InstanceDataSceneProxy.h"
#include "Containers/StridedView.h"
#include "RHIShaderPlatform.h"
#include "RHIFeatureLevel.h"
 
class FOpaqueHitProxyContainer;
class FStaticMeshInstanceBuffer;
class FStaticMeshInstanceData;
class FISMInstanceUpdateChangeSet;
class HHitProxy;
 
DECLARE_LOG_CATEGORY_EXTERN(LogInstanceProxy, Log, All)
 
 
struct FISMPrecomputedSpatialHashData
{
    TArray<FInstanceSceneDataBuffers::FCompressedSpatialHashItem> Hashes;
    TArray<int32> ProxyIndexToComponentIndexRemap;
};
 
class FISMCInstanceDataSceneProxy : public FInstanceDataSceneProxy
{
public:
    FISMCInstanceDataSceneProxy(FStaticShaderPlatform InShaderPlatform, ERHIFeatureLevel::Type InFeatureLevel);
 
    inline const FInstanceSceneDataBuffers& GetData() const { return InstanceSceneDataBuffers; }
 
    //void BuildLegacyData();
 
    virtual void Update(FISMInstanceUpdateChangeSet&& ChangeSet);
    virtual void Build(FISMInstanceUpdateChangeSet&& ChangeSet);
 
    virtual void BuildFromLegacyData(TUniquePtr<FStaticMeshInstanceData> &&ExternalLegacyData, const FRenderBounds &InstanceLocalBounds, TArray<int32> &&InLegacyInstanceReorderTable) {};
 
    virtual void UpdatePrimitiveTransform(FISMInstanceUpdateChangeSet&& ChangeSet) { check(false); }
 
    inline bool CheckPlatformFeatureLevel(FStaticShaderPlatform InShaderPlatform, ERHIFeatureLevel::Type InFeatureLevel) { return ShaderPlatform == InShaderPlatform && InFeatureLevel == FeatureLevel; }
 
    virtual FInstanceDataUpdateTaskInfo *GetUpdateTaskInfo() { return &InstanceDataUpdateTaskInfo; }
 
    ENGINE_API void DebugDrawInstanceChanges(FPrimitiveDrawInterface* DebugPDI, ESceneDepthPriorityGroup SceneDepthPriorityGroup);
 
    ENGINE_API static FVector3f GetLocalBoundsPadExtent(const FRenderTransform& LocalToWorld, float PadAmount);
 
    using FISMPrecomputedSpatialHashDataPtr = TSharedPtr<const FISMPrecomputedSpatialHashData, ESPMode::ThreadSafe>;
protected:
    void BuildFromOptimizedDataBuffers(FISMInstanceUpdateChangeSet& ChangeSet, FInstanceIdIndexMap &OutInstanceIdIndexMap, FInstanceSceneDataBuffers::FWriteView &OutData);
 
    // Update the InstanceIdIndexMap given the change set.
    template <typename IndexRemapType>
    void UpdateIdMapping(FISMInstanceUpdateChangeSet& ChangeSet, const IndexRemapType &IndexRemap);
 
    template <typename IndexRemapType>
    void ApplyDataChanges(FISMInstanceUpdateChangeSet &ChangeSet, const IndexRemapType &IndexRemap, int32 PostUpdateNumInstances, FInstanceSceneDataBuffers::FWriteView &ProxyData);
    
    template <typename IndexRemapType>
    void ApplyAttributeChanges(FISMInstanceUpdateChangeSet &ChangeSet, const IndexRemapType &IndexRemap, FInstanceSceneDataBuffers::FWriteView &ProxyData);
 
    void TestAndApplyInstanceBufferSizeFixup(int32 PostUpdateNumInstances);
 
    FStaticShaderPlatform ShaderPlatform;
    ERHIFeatureLevel::Type FeatureLevel;
    bool bUseLegacyRenderingPath = false;
 
 
    // Id allocation tracking
    TBitArray<> ValidInstanceIdMask; // redundant, unsure if we need a copy of that, except insofar as to be able to scan the valid ones quicky? IdToIndexMap has the same info.
    FInstanceIdIndexMap InstanceIdIndexMap;
 
    FInstanceDataUpdateTaskInfo InstanceDataUpdateTaskInfo;
    // True when it has never been updated before.
    bool bIsNew = true;
    // This should be set when constructing for a static primitive that wants pre-built instances.
    bool bBuildOptimized = false;
#if WITH_EDITOR
    TPimplPtr<FOpaqueHitProxyContainer> HitProxyContainer;
#endif
 
    friend class FPrimitiveInstanceDataManager;
 
    FISMPrecomputedSpatialHashDataPtr PrecomputedOptimizationData;
};
 
class FISMCInstanceDataSceneProxyLegacyReordered : public FISMCInstanceDataSceneProxy
{
public:
    FISMCInstanceDataSceneProxyLegacyReordered(FStaticShaderPlatform InShaderPlatform, ERHIFeatureLevel::Type InFeatureLevel, bool bInLegacyReordered);
 
    virtual void Update(FISMInstanceUpdateChangeSet&& ChangeSet) override;
    virtual void Build(FISMInstanceUpdateChangeSet&& ChangeSet) override;
    virtual void BuildFromLegacyData(TUniquePtr<FStaticMeshInstanceData> &&InExternalLegacyData, const FRenderBounds &InstanceLocalBounds, TArray<int32> &&InLegacyInstanceReorderTable) override;
    virtual void UpdatePrimitiveTransform(FISMInstanceUpdateChangeSet&& ChangeSet) override;
 
protected:
    void UpdateInstancesTransforms(FInstanceSceneDataBuffers::FWriteView &ProxyData, const FStaticMeshInstanceData &LegacyInstanceData);
 
    TArray<int32> LegacyInstanceReorderTable;
    bool bLegacyReordered = false;
    // Must hang on to this to be able to suppor primitive transform changes, otherwise we have no access to the original instance transforms.
    // We could potentially pull out and store those explicitly instead as we don't need to retain all the other garbage.
    TUniquePtr<FStaticMeshInstanceData> ExternalLegacyData;
};
 
 
class FISMCInstanceDataSceneProxyNoGPUScene : public FISMCInstanceDataSceneProxyLegacyReordered
{
public:
    FISMCInstanceDataSceneProxyNoGPUScene(FStaticShaderPlatform InShaderPlatform, ERHIFeatureLevel::Type InFeatureLevel, bool bInLegacyReordered);
    ~FISMCInstanceDataSceneProxyNoGPUScene();
 
    void ReleaseStaticMeshInstanceBuffer();
 
    virtual void Update(FISMInstanceUpdateChangeSet&& ChangeSet) override;
    virtual void Build(FISMInstanceUpdateChangeSet&& ChangeSet) override;
    virtual void BuildFromLegacyData(TUniquePtr<FStaticMeshInstanceData> &&ExternalLegacyData, const FRenderBounds &InstanceLocalBounds, TArray<int32> &&InLegacyInstanceReorderTable) override;
    virtual void UpdatePrimitiveTransform(FISMInstanceUpdateChangeSet&& ChangeSet) override;
 
    template <typename IndexRemapType>
    void ApplyDataChanges(FISMInstanceUpdateChangeSet &ChangeSet, const IndexRemapType &IndexRemap, int32 PostUpdateNumInstances, FInstanceSceneDataBuffers::FWriteView &ProxyData, FStaticMeshInstanceData &LegacyInstanceData);
 
    virtual ENGINE_API FStaticMeshInstanceBuffer* GetLegacyInstanceBuffer() override;
 
 
    TUniquePtr<FStaticMeshInstanceBuffer> LegacyInstanceBuffer;
};