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

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
Public variable bool bApplyVertexColorRemapping If true, VertexColorRemappingFunc is called on Vertex Colors provided from Mesh to remap them to a different color
Protected variable bool bEnableRaytracing Control raytracing support
Protected variable bool bEnableViewModeOverrides  
Public variable bool bIgnoreVertexColors If true, vertex colors on the FDynamicMesh will be ignored
Public variable bool bUsePerTriangleColor If true, a per-triangle color is used to set vertex colors
Public variable bool bUsePerTriangleNormals If true, a facet normals are used instead of mesh normals
Public variable bool bUseSecondaryTriBuffers If true, populate secondary buffers using SecondaryTriFilterFunc
Public variable EDynamicMeshVertexColorTransformMode ColorSpaceTransformMode Color Space Transform/Conversion applied to Vertex Colors provided from Mesh Color Overlay Attribute Color Space Conversion is applied after any Vertex Color Remapping.
Public variable FColor ConstantVertexColor Constant color assigned to vertices if no other vertex color is specified
Public variable UBaseDynamicMeshComponent * ParentBaseComponent  
Public variable TFunction< FColor(const FDynamicMesh3 *, int)> PerTriangleColorFunc Per-triangle color function. Only called if bUsePerTriangleColor=true
Public variable TUniqueFunction< bool(const FDynamicMesh3 *, int32)> SecondaryTriFilterFunc Filter predicate for secondary triangle index buffer. Only called if bUseSecondaryTriBuffers=true
Public variable TUniqueFunction< void(FVector4f &)> VertexColorRemappingFunc Vertex color remapping function.

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 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 Const void FBaseDynamicMeshSceneProxy API - subclasses must implement these functions Return set of active renderbuffers.
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 int32  
Public function FColor

GetOverlayColorAsFColor ( const FDynamicMeshColorOverlay* ColorOverlay,
int32 ElementID
)

  
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 void 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

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
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.

Overridden from FPrimitiveSceneProxy

  Type Name Description
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

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