1. Epic GamesDeveloper
  3. FBaseDynamicMeshSceneProxy

FBaseDynamicMeshSceneProxy

[FBaseDynamicMeshSceneProxy](API\Runtime\GeometryFramework\Components\FBaseDynamicMeshSceneProxy) is an abstract base class for a Render Proxy for a [UBaseDynamicMeshComponent](API\Runtime\GeometryFramework\Components\UBaseDynamicMeshComponent), where the assumption is that mesh data will be stored in [FMeshRenderBufferSet](API\Runtime\GeometryFramework\Components\FMeshRenderBufferSet) instances

API > API/Runtime > API/Runtime/GeometryFramework > API/Runtime/GeometryFramework/Components

Inheritance Hierarchy

  • FPrimitiveSceneProxy
  • FBaseDynamicMeshSceneProxy

References

   
Module GeometryFramework
Header /Engine/Source/Runtime/GeometryFramework/Public/Components/BaseDynamicMeshSceneProxy.h
Include #include "Components/BaseDynamicMeshSceneProxy.h"

Syntax

class FBaseDynamicMeshSceneProxy : public FPrimitiveSceneProxy

Remarks

FBaseDynamicMeshSceneProxy is an abstract base class for a Render Proxy for a UBaseDynamicMeshComponent, where the assumption is that mesh data will be stored in FMeshRenderBufferSet instances

Variables

  Type Name Description
Protected variable TSet< FMeshRenderBufferSet * > AllocatedBufferSets Set of currently-allocated RenderBuffers.
Protected variable FCriticalSection AllocatedSetsLock Use to control access to AllocatedBufferSets
Protected variable bool bDistanceFieldValid  
Protected variable bool bEnableRaytracing Control raytracing support
Protected variable bool bEnableViewModeOverrides  
Protected variable bool bMeshCardsValid  
Protected variable bool bPreferStaticDrawPath Whether to try to use the static draw instead of dynamic draw path; note we may still use the dynamic path if collision or vertex color rendering is enabled
Protected variable TSharedPtr< FDistanceFieldVolumeData > DistanceField  
Protected variable TPimplPtr< FCardRepresentationData > MeshCards  
Public variable FMeshRenderBufferSetConversionUtil MeshRenderBufferSetConverter Utility to initialize and update the mesh render buffers from a mesh with overlays and holds all the settings required.
Public variable UBaseDynamicMeshComponent * ParentBaseComponent  

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Virtual FMeshRenderBufferSet * RenderBuffer management Allocates a set of render buffers.
Public function Virtual Const bool

AllowStaticDrawPath ( const FSceneView* View
)

 Whether to allow use of the static draw path. If false, the dynamic draw path will be used instead.
Public function Static TUniquePtr< FDistanceFieldVolumeData >

ComputeDistanceFieldForMesh ( const FDynamicMesh3& Mesh,
FProgressCancel& Progress,
float DistanceFieldResolutionScale,
bool bGenerateAsIfTwoSided
)

  
Public function Virtual Const void

DrawBatch ( FMeshElementCollector& Collector,
const FMeshRenderBufferSet& RenderBuffers,
const FDynamicMeshIndexBuffer32& IndexBuffer,
FMaterialRenderProxy* UseMaterial,
bool bWireframe,
ESceneDepthPriorityGroup DepthPriority,
int ViewIndex,
FDynamicPrimitiveUniformBuffer& DynamicPrimitiveUniformBuffer
)

 Draw a single-frame FMeshBatch for a FMeshRenderBufferSet
Public function Virtual void

DrawStaticElements ( FStaticPrimitiveDrawInterface* PDI
)

  
Public function Const void FBaseDynamicMeshSceneProxy API - subclasses must implement these functions Return set of active renderbuffers.
Protected function Virtual Const void

GetCollisionDynamicMeshElements ( TArray< FMeshRenderBufferSet* >& Buffers,
const FEngineShowFlags& EngineShowFlags,
bool bDrawCollisionView,
bool bDrawSimpleCollision,
bool bDrawComplexCollision,
bool bProxyIsSelected,
const TArray< const FSceneView* >& Views,
uint32 VisibilityMap,
FMeshElementCollector& Collector
)

 Helper called by GetDynamicMeshElements to process collision debug drawing
Public function Virtual Const void

GetDistanceFieldAtlasData ( const FDistanceFieldVolumeData*& OutDistanceFieldData,
float& SelfShadowBias
)

  
Public function Virtual Const void

GetDistanceFieldInstanceData ( TArray< FRenderTransform >& InstanceLocalToPrimitiveTransforms
)

  
Public function Virtual Const void

GetDynamicMeshElements ( const TArray< const FSceneView* >& Views,
const FSceneViewFamily& ViewFamily,
uint32 VisibilityMap,
FMeshElementCollector& Collector
)

 Render set of active RenderBuffers returned by GetActiveRenderBufferSets
Public function Static FMaterialRenderProxy *

GetEngineVertexColorMaterialProxy ( FMeshElementCollector& Collector,
const FEngineShowFlags& EngineShowFlags,
bool bProxyIsSelected,
bool bIsHovered
)

 FBaseDynamicMeshSceneProxy implementation If EngineShowFlags request vertex color rendering, returns the appropriate vertex color override material's render proxy.
Public function Virtual Const UMaterialInterface *

GetMaterial ( int32 k
)

 Safe GetMaterial function that will never return nullptr
Public function Virtual Const const FCardRepresentationData * Raytracing APIs Lumen APIs
Public function Virtual Const int32  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function void

InitializeBuffersFromOverlays ( FMeshRenderBufferSet* RenderBuffers,
const FDynamicMesh3* Mesh,
int NumTriangles,
TriangleEnumerable Enumerable,
const FDynamicMeshUVOverlay* UVOverlay,
const FDynamicMeshNormalOverlay* NormalOverlay,
const FDynamicMeshColorOverlay* ColorOverlay,
TFunctionRef< void(int, int, int, const FVector3f&, FVector3f&, FVector3f&)> TangentsFunc,
bool bTrackTriangles
)

 Initialize rendering buffers from given attribute overlays.
Public function void

InitializeBuffersFromOverlays ( FMeshRenderBufferSet* RenderBuffers,
const FDynamicMesh3* Mesh,
int NumTriangles,
TriangleEnumerable Enumerable,
const TArray< const FDynamicMeshUVOverlay*, UVOverlayListAllocator >& UVOverlays,
const FDynamicMeshNormalOverlay* NormalOverlay,
const FDynamicMeshColorOverlay* ColorOverlay,
TFunctionRef< void(int, int, int, const FVector3f&, FVector3f&, FVector3f&)> TangentsFunc,
bool bTrackTriangles
)

 Initialize rendering buffers from given attribute overlays.
Public function Const bool

IsCollisionView ( const FEngineShowFlags& EngineShowFlags,
bool& bDrawSimpleCollision,
bool& bDrawComplexCollision
)

  
Public function void

RecomputeRenderBufferTriangleIndexSets ( FMeshRenderBufferSet* RenderBuffers,
const FDynamicMesh3* Mesh
)

 RecomputeRenderBufferTriangleIndexSets re-sorts the existing set of triangles in a FMeshRenderBufferSet into primary and secondary index buffers.
Public function Virtual void Explicitly release a set of RenderBuffers
Public function void Set the collision data to use for debug drawing, or do nothing if debug drawing is not enabled.
Public function void

SetNewDistanceField ( TSharedPtr< FDistanceFieldVolumeData > NewDistanceField,
bool bInInitialize
)

  
Public function void

SetVerifyUsedMaterials ( const bool bState
)

 Set whether or not to validate mesh batch materials against the component materials.
Public function Virtual void This needs to be called if the set of active materials changes, otherwise the check in FPrimitiveSceneProxy::VerifyUsedMaterial() will fail if an override material is set, if materials change, etc, etc
Protected function void Helper to set lumen cards.
Public function void

UpdateSecondaryTriangleBuffer ( FMeshRenderBufferSet* RenderBuffers,
const FDynamicMesh3* Mesh,
bool bDuplicate
)

 Filter the triangles in a FMeshRenderBufferSet into the SecondaryIndexBuffer.
Public function void

UpdateVertexBuffersFromOverlays ( FMeshRenderBufferSet* RenderBuffers,
const FDynamicMesh3* Mesh,
int NumTriangles,
TriangleEnumerable Enumerable,
const FDynamicMeshNormalOverlay* NormalOverlay,
const FDynamicMeshColorOverlay* ColorOverlay,
TFunctionRef< void(int, int, int, const FVector3f&, FVector3f&, FVector3f&)> TangentsFunc,
bool bUpdatePositions,
bool bUpdateNormals,
bool bUpdateColors
)

 Update vertex positions/normals/colors of an existing set of render buffers.
Public function void

UpdateVertexUVBufferFromOverlays ( FMeshRenderBufferSet* RenderBuffers,
const FDynamicMesh3* Mesh,
int32 NumTriangles,
TriangleEnumerable Enumerable,
const TArray< const FDynamicMeshUVOverlay*, UVOverlayListAllocator >& UVOverlays
)

 Update vertex uvs of an existing set of render buffers.

Typedefs

Name Description
FIndex2i  
FIndex3i  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page