SkeletalMeshSceneProxy.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "PrimitiveSceneProxy.h"
#include "SkeletalMeshTypes.h"
#include "SkinningSceneExtensionProxy.h"
 
/*-----------------------------------------------------------------------------
FSkeletalMeshSceneProxy
-----------------------------------------------------------------------------*/
 
class FSkeletalMeshObject;
 
struct FSkinnedMeshSceneProxyDesc;
struct FSkelMeshRenderSection;
 
class FSkeletalMeshSceneProxy
    : public FPrimitiveSceneProxy
{
public:
    ENGINE_API SIZE_T GetTypeHash() const override;
 
    ENGINE_API FSkeletalMeshSceneProxy(const USkinnedMeshComponent* Component, FSkeletalMeshRenderData* InSkelMeshRenderData);
    UE_DEPRECATED(5.7, "Pass InClampedLODIndex to FSkeletalMeshSceneProxy constructor.")
    ENGINE_API FSkeletalMeshSceneProxy(const FSkinnedMeshSceneProxyDesc& InMeshDesc, FSkeletalMeshRenderData* InSkelMeshRenderData);
    ENGINE_API FSkeletalMeshSceneProxy(const FSkinnedMeshSceneProxyDesc& InMeshDesc, FSkeletalMeshRenderData* InSkelMeshRenderData, int32 InClampedLODIndex);
 
    ENGINE_API virtual ~FSkeletalMeshSceneProxy();
 
#if WITH_EDITOR
    ENGINE_API virtual HHitProxy* CreateHitProxies(UPrimitiveComponent* Component, TArray<TRefCountPtr<HHitProxy> >& OutHitProxies) override;
#endif
    ENGINE_API virtual void DrawStaticElements(FStaticPrimitiveDrawInterface* PDI) override;
    ENGINE_API virtual void GetDynamicMeshElements(const TArray<const FSceneView*>& Views, const FSceneViewFamily& ViewFamily, uint32 VisibilityMap, FMeshElementCollector& Collector) const override;
 
    ENGINE_API virtual const FCardRepresentationData* GetMeshCardRepresentation() const override;
 
    ENGINE_API virtual void CreateRenderThreadResources(FRHICommandListBase& RHICmdList) override;
    ENGINE_API virtual void DestroyRenderThreadResources() override;
 
#if RHI_RAYTRACING
    ENGINE_API virtual bool HasRayTracingRepresentation() const override;
 
    virtual bool IsRayTracingRelevant() const override { return true; }
 
    virtual bool IsRayTracingStaticRelevant() const override
    {
        return bRayTraceStatic;
    }
 
    ENGINE_API virtual RayTracing::FGeometryGroupHandle GetRayTracingGeometryGroupHandle() const override;
 
    ENGINE_API virtual TArray<FRayTracingGeometry*> GetStaticRayTracingGeometries() const override;
    ENGINE_API virtual ERayTracingPrimitiveFlags GetCachedRayTracingInstance(FRayTracingInstance& OutRayTracingInstance);
 
    ENGINE_API virtual void GetDynamicRayTracingInstances(FRayTracingInstanceCollector& Collector) override;
#endif // RHI_RAYTRACING
 
    ENGINE_API virtual FPrimitiveViewRelevance GetViewRelevance(const FSceneView* View) const override;
    ENGINE_API virtual bool CanBeOccluded() const override;
    ENGINE_API virtual bool IsUsingDistanceCullFade() const override;
    
    ENGINE_API virtual bool HasDynamicIndirectShadowCasterRepresentation() const override;
    ENGINE_API virtual void GetShadowShapes(FVector PreViewTranslation, TArray<FCapsuleShape3f>& OutCapsuleShapes) const override;
 
    virtual bool CanApplyStreamableRenderAssetScaleFactor() const override { return true; }
 
    virtual void GetPreSkinnedLocalBounds(FBoxSphereBounds& OutBounds) const override { OutBounds = PreSkinnedLocalBounds; }
 
    const TArray<uint16>& GetSortedShadowBoneIndices() const
    {
        return ShadowCapsuleBoneIndices;
    }
 
    ENGINE_API FSkinningSceneExtensionProxy* GetSkinningSceneExtensionProxy() const override;
 
    FSkeletalMeshObject* GetMeshObject() const
    {
        return MeshObject;
    }
 
    USkinnedAsset* GetSkinnedAsset() const
    {
        return SkinnedAsset;
    }
 
    ENGINE_API bool GetWorldMatrices( FMatrix& OutLocalToWorld, FMatrix& OutWorldToLocal ) const;
 
    ENGINE_API int32 GetCurrentLODIndex();
 
    ENGINE_API virtual void DebugDrawPhysicsAsset(int32 ViewIndex, FMeshElementCollector& Collector, const FEngineShowFlags& EngineShowFlags) const;
 
    ENGINE_API void DebugDrawSkeleton(int32 ViewIndex, FMeshElementCollector& Collector, const FEngineShowFlags& EngineShowFlags) const;
 
#if WITH_EDITOR
    ENGINE_API void DebugDrawPoseWatchSkeletons(int32 ViewIndex, FMeshElementCollector& Collector, const FEngineShowFlags& EngineShowFlags) const;
#endif
 
    virtual uint32 GetMemoryFootprint( void ) const override { return( sizeof( *this ) + GetAllocatedSize() ); }
    SIZE_T GetAllocatedSize( void ) const { return( FPrimitiveSceneProxy::GetAllocatedSize() + LODSections.GetAllocatedSize() ); }
 
    ENGINE_API void UpdateMorphMaterialUsage_GameThread(TArray<UMaterialInterface*>& MaterialUsingMorphTarget);
 
 
#if WITH_EDITORONLY_DATA
    ENGINE_API virtual bool GetPrimitiveDistance(int32 LODIndex, int32 SectionIndex, const FVector& ViewOrigin, float& PrimitiveDistance) const override;
    ENGINE_API virtual bool GetMeshUVDensities(int32 LODIndex, int32 SectionIndex, FVector4& WorldUVDensities) const override;
    ENGINE_API virtual bool GetMaterialTextureScales(int32 LODIndex, int32 SectionIndex, const FMaterialRenderProxy* MaterialRenderProxy, FVector4f* OneOverScales, FIntVector4* UVChannelIndices) const override;
#endif
 
    friend class FSkeletalMeshSectionIter;
 
    ENGINE_API virtual void OnTransformChanged(FRHICommandListBase& RHICmdList) override;
 
    virtual uint8 GetCurrentFirstLODIdx_RenderThread() const final override
    {
        return GetCurrentFirstLODIdx_Internal();
    }
 
    ENGINE_API virtual FDesiredLODLevel GetDesiredLODLevel_RenderThread(const FSceneView* View) const final override;
 
    ENGINE_API bool GetCachedGeometry(FRDGBuilder& GraphBuilder, struct FCachedGeometry& OutCachedGeometry) const;
 
    UE_DEPRECATED(5.6, "GetCachedGeometry now requires a GraphBuilder.")
    bool GetCachedGeometry(struct FCachedGeometry& OutCachedGeometry) const { return false; }
 
protected:
    AActor* Owner;
    FSkeletalMeshObject* MeshObject;
    USkinnedAsset* SkinnedAsset;
    TUniquePtr<FSkinningSceneExtensionProxy> SceneExtensionProxy;
    FSkeletalMeshRenderData* RenderData;
    int32 ClampedLODIndex;
    uint8  NumLODs = 1u;
 
#if !(UE_BUILD_SHIPPING || UE_BUILD_TEST)
    class UPhysicsAsset* PhysicsAssetForDebug;
#endif
 
    UMaterialInterface* OverlayMaterial;
    float OverlayMaterialMaxDrawDistance;
    TArray<TObjectPtr<UMaterialInterface>> MaterialSlotsOverlayMaterial;
 
public:
#if RHI_RAYTRACING
    bool bAnySegmentUsesWorldPositionOffset : 1;
#endif
 
protected:
    uint8 bForceWireframe : 1;
    uint8 bIsCPUSkinned : 1;
    uint8 bCanHighlightSelectedSections : 1;
    uint8 bRenderStatic:1;
#if RHI_RAYTRACING
    uint8 bRayTraceStatic : 1;
#endif
#if !(UE_BUILD_SHIPPING || UE_BUILD_TEST)
    uint8 bDrawDebugSkeleton:1;
#endif
    uint8 bAllowDynamicMeshBounds:1;
#if WITH_EDITOR
    bool bHasSelectedInstances = false;
#else
    static const bool bHasSelectedInstances = false;
#endif
    TEnumAsByte<ERHIFeatureLevel::Type> FeatureLevel;
 
    bool bMaterialsNeedMorphUsage_GameThread;
 
    FMaterialRelevance MaterialRelevance;
 
 
    struct FSectionElementInfo
    {
        FSectionElementInfo(UMaterialInterface* InMaterial, bool bInEnableShadowCasting, int32 InUseMaterialIndex, UMaterialInterface* InPerSectionOverlayMaterial)
        : Material( InMaterial )
        , bEnableShadowCasting( bInEnableShadowCasting )
        , UseMaterialIndex( InUseMaterialIndex )
#if WITH_EDITOR
        , HitProxy(NULL)
#endif
        , PerSectionOverlayMaterial(InPerSectionOverlayMaterial)
        {}
        
        UMaterialInterface* Material;
        
        bool bEnableShadowCasting;
        
        int32 UseMaterialIndex;
 
#if WITH_EDITOR
        HHitProxy* HitProxy;
#endif
 
        UMaterialInterface* PerSectionOverlayMaterial;
    };
 
    struct FLODSectionElements
    {
        TArray<FSectionElementInfo> SectionElements;
    };
    
    TArray<FLODSectionElements> LODSections;
 
    TArray<TPair<int32, FCapsuleShape>> ShadowCapsuleData;
    TArray<uint16> ShadowCapsuleBoneIndices;
 
    TSet<UMaterialInterface*> MaterialsInUse_GameThread;
    
    FBoxSphereBounds PreSkinnedLocalBounds;
 
    class FCardRepresentationData* CardRepresentationData = nullptr;
 
#if RHI_RAYTRACING
    RayTracing::FGeometryGroupHandle RayTracingGeometryGroupHandle = INDEX_NONE;
#endif
 
#if !(UE_BUILD_SHIPPING || UE_BUILD_TEST)
    TOptional<FLinearColor> DebugDrawColor;
#endif
 
#if WITH_EDITORONLY_DATA
    float StreamingDistanceMultiplier;
#endif
 
    ENGINE_API void GetDynamicElementsSection(const TArray<const FSceneView*>& Views, const FSceneViewFamily& ViewFamily, uint32 VisibilityMap,
                                    const FSkeletalMeshLODRenderData& LODData, const int32 LODIndex, const int32 SectionIndex, bool bSectionSelected,
                                   const FSectionElementInfo& SectionElementInfo, bool bInSelectable, FMeshElementCollector& Collector) const;
 
    ENGINE_API void GetMeshElementsConditionallySelectable(const TArray<const FSceneView*>& Views, const FSceneViewFamily& ViewFamily, bool bInSelectable, uint32 VisibilityMap, FMeshElementCollector& Collector) const;
 
    ENGINE_API uint8 GetCurrentFirstLODIdx_Internal() const;
 
    ENGINE_API void UpdateLumenCardsFromBounds();
 
private:
    ENGINE_API void CreateBaseMeshBatch(const FSceneView* View, const FSkeletalMeshLODRenderData& LODData, const int32 LODIndex, const int32 SectionIndex, const FSectionElementInfo& SectionElementInfo, FMeshBatch& Mesh, ESkinVertexFactoryMode VFMode = ESkinVertexFactoryMode::Default) const;
    
    ENGINE_API void GetStaticMeshBatch(
        const FSkeletalMeshLODRenderData& LODData,
        const int32 LODIndex,
        const FSkelMeshRenderSection& Section,
        const int32 SectionIndex,
        const FSectionElementInfo& SectionElementInfo,
        const FVertexFactory* VertexFactory,
        ESceneDepthPriorityGroup PrimitiveDPG,
        FMeshBatch& OutMeshBatch) const;
    ENGINE_API void GetOverlayMeshBatch(const FSkeletalMeshLODRenderData& LODData, UMaterialInterface* SectionOverlayMaterial, const FMeshBatch& MeshBatch, FMeshBatch& OutOverlayMeshBatch) const;
 
public:
#if WITH_EDITORONLY_DATA
    struct FPoseWatchDynamicData* PoseWatchDynamicData;
#endif
};