1. Epic GamesDeveloper
  3. FStaticMeshSceneProxy

FStaticMeshSceneProxy

A static mesh component scene proxy.

API > API/Runtime > API/Runtime/Engine

A static mesh component scene proxy.

   
Name FStaticMeshSceneProxy
Type class
Header File /Engine/Source/Runtime/Engine/Public/StaticMeshSceneProxy.h
Include Path #include "StaticMeshSceneProxy.h"

Syntax

class FStaticMeshSceneProxy : public FPrimitiveSceneProxy

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

FStaticMeshSceneProxy ( UStaticMeshComponent* Component,
bool bForceLODsShareStaticLighting
)

 Initialization constructor. StaticMeshSceneProxy.h  

FStaticMeshSceneProxy ( const FStaticMeshSceneProxyDesc& InDesc,
bool bForceLODsShareStaticLighting
)

 Initialization constructor. StaticMeshSceneProxy.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FStaticMeshSceneProxy()

   StaticMeshSceneProxy.h  

Classes

Name Remarks
FLODInfo Information used by the proxy about a single LOD of the mesh.
FRayTracingLODInfo Information used by the proxy about a single ray tracing proxy LOD of the mesh.

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
MeshPaintTextureDescriptor FUintVector2   StaticMeshSceneProxy.h  
MeshPaintTextureResource FTextureResource *   StaticMeshSceneProxy.h  
StaticMesh const UStaticMesh *   StaticMeshSceneProxy.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

SIZE_T GetAllocatedSize()

   StaticMeshSceneProxy.h  

virtual bool GetCollisionMeshElement ( int32 LODIndex,
int32 BatchIndex,
int32 ElementIndex,
uint8 InDepthPriorityGroup,
const FMaterialRenderProxy* RenderProxy,
FMeshBatch& OutMeshBatch
) const

 Sets up a collision FMeshBatch for a specific LOD and element. StaticMeshSceneProxy.h  

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

   StaticMeshSceneProxy.h  

FLODMask GetLODMask ( const FSceneView* View
) const

 Returns the LOD mask for a view, this is like the ordinary LOD but can return two values for dither fading StaticMeshSceneProxy.h  

virtual bool GetMaterialTextureScales ( int32 LODIndex,
int32 SectionIndex,
const FMaterialRenderProxy* MaterialRenderProxy,
FVector4f* OneOverScales,
FIntVector4* UVChannelIndices
) const

   StaticMeshSceneProxy.h  

virtual bool GetMeshElement ( int32 LODIndex,
int32 BatchIndex,
int32 SectionIndex,
uint8 InDepthPriorityGroup,
bool bUseSelectionOutline,
bool bAllowPreCulledIndices,
FMeshBatch& OutMeshBatch
) const

 Sets up a FMeshBatch for a specific LOD and element. StaticMeshSceneProxy.h  

virtual int32 GetNumMeshBatches()

 Gets the number of mesh batches required to represent the proxy, aside from section needs. StaticMeshSceneProxy.h  

virtual bool GetRayTracingMeshElement ( int32 LODIndex,
int32 BatchIndex,
int32 SectionIndex,
uint8 InDepthPriorityGroup,
FMeshBatch& OutMeshBatch
) const

 Sets up a ray tracing FMeshBatch for a specific LOD. StaticMeshSceneProxy.h  

float GetScreenSize ( int32 LODIndex
) const

 Returns the display factor for the given LOD level StaticMeshSceneProxy.h  

virtual bool GetShadowMeshElement ( int32 LODIndex,
int32 BatchIndex,
uint8 InDepthPriorityGroup,
FMeshBatch& OutMeshBatch,
bool bDitheredLODTransition
) const

 Sets up a shadow FMeshBatch for a specific LOD. StaticMeshSceneProxy.h  

virtual bool GetWireframeMeshElement ( int32 LODIndex,
int32 BatchIndex,
const FMaterialRenderProxy* WireframeRenderProxy,
uint8 InDepthPriorityGroup,
bool bAllowPreCulledIndices,
FMeshBatch& OutMeshBatch
) const

 Sets up a wireframe FMeshBatch for a specific LOD. StaticMeshSceneProxy.h  

virtual void SetEvaluateWorldPositionOffsetInRayTracing ( FRHICommandListBase& RHICmdList,
bool bEvaluate
)

   StaticMeshSceneProxy.h  

Overridden from FPrimitiveSceneProxy

Name Remarks Include Path Unreal Specifiers

virtual bool AllowInstanceCullingOcclusionQueries()

   StaticMeshSceneProxy.h  

virtual bool CanApplyStreamableRenderAssetScaleFactor()

   StaticMeshSceneProxy.h  

virtual bool CanBeOccluded()

   StaticMeshSceneProxy.h  

virtual HHitProxy * CreateHitProxies ( IPrimitiveComponent* ComponentInterface,
TArray< TRefCountPtr< HHitProxy > >& OutHitProxies
)

 Creates the hit proxies are used when DrawDynamicElements is called. Called in the game thread. StaticMeshSceneProxy.h  

virtual HHitProxy * CreateHitProxies ( UPrimitiveComponent* Component,
TArray< TRefCountPtr< HHitProxy > >& OutHitProxies
)

 All FPrimitiveSceneProxy derived classes can decide to fully override the HHitProxy creation, or add their own and call any of their base classes to add theirs. StaticMeshSceneProxy.h  

virtual void CreateRenderThreadResources ( FRHICommandListBase& RHICmdList
)

 Called when the rendering thread adds the proxy to the scene. StaticMeshSceneProxy.h  
Called when the rendering thread removes the proxy from the scene. StaticMeshSceneProxy.h  
Draws the primitive's static elements. StaticMeshSceneProxy.h  

virtual uint8 GetCurrentFirstLODIdx_RenderThread()

   StaticMeshSceneProxy.h  

virtual FDesiredLODLevel GetDesiredLODLevel_RenderThread ( const FSceneView* View
) const

   StaticMeshSceneProxy.h  

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

 Gathers the primitive's dynamic mesh elements. StaticMeshSceneProxy.h  

virtual bool GetInstanceWorldPositionOffsetDisableDistance ( float& OutWPODisableDistance
) const

 Retrieves the per-instance world position offset disable distance StaticMeshSceneProxy.h  

virtual void GetLCIs ( FLCIArray& LCIs
)

   StaticMeshSceneProxy.h  

virtual int32 GetLightMapCoordinateIndex ()

 Get the lightmap UV coordinate index for this primitive. StaticMeshSceneProxy.h  

virtual void GetLightRelevance ( const FLightSceneProxy* LightSceneProxy,
bool& bDynamic,
bool& bRelevant,
bool& bLightMapped,
bool& bShadowMapped
) const

 Determines the relevance of this primitive's elements to the given light. StaticMeshSceneProxy.h  

virtual int32 GetLOD ( const FSceneView* View
) const

 Returns the LOD that the primitive will render at for this view. StaticMeshSceneProxy.h  

virtual uint32 GetMemoryFootprint()

 Every derived class should override these functions StaticMeshSceneProxy.h  

virtual const FCardRepresentationData * GetMeshCardRepresentation()

   StaticMeshSceneProxy.h  

virtual void GetMeshDescription ( int32 LODIndex,
TArray< FMeshBatch >& OutMeshElements
) const

 Gathers a description of the mesh elements to be rendered for the given LOD index, without consideration for views. StaticMeshSceneProxy.h  

virtual FUintVector2 GetMeshPaintTextureDescriptor()

   StaticMeshSceneProxy.h  

virtual bool GetMeshUVDensities ( int32 LODIndex,
int32 SectionIndex,
FVector4& WorldUVDensities
) const

 Get mesh UV density for a LOD-section. StaticMeshSceneProxy.h  

virtual bool GetPrimitiveDistance ( int32 LODIndex,
int32 SectionIndex,
const FVector& ViewOrigin,
float& PrimitiveDistance
) const

 Get primitive distance to view origin for a given LOD-section. StaticMeshSceneProxy.h  

virtual void GetStreamableRenderAssetInfo ( const FBoxSphereBounds& InPrimitiveBounds,
TArray< FStreamingRenderAssetPrimitiveInfo >& OutStreamableRenderAssets
) const

   StaticMeshSceneProxy.h  

virtual SIZE_T GetTypeHash()

 Return a type (or subtype) specific hash for sorting purposes StaticMeshSceneProxy.h  

virtual FPrimitiveViewRelevance GetViewRelevance ( const FSceneView* View
) const

 Determines the relevance of this primitive's elements to the given view. StaticMeshSceneProxy.h  

virtual bool HasDistanceFieldRepresentation()

   StaticMeshSceneProxy.h  

virtual bool HasDynamicIndirectShadowCasterRepresentation()

   StaticMeshSceneProxy.h  

virtual bool IsCullingReversedByComponent()

   StaticMeshSceneProxy.h  

virtual bool IsUsingDistanceCullFade()

   StaticMeshSceneProxy.h  

virtual bool StaticMeshHasPendingStreaming()

   StaticMeshSceneProxy.h  

Protected

Name Remarks Include Path Unreal Specifiers

uint8 GetCurrentFirstLODIdx_Internal()

 Only call on render thread timeline StaticMeshSceneProxy.h  

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

   StaticMeshSceneProxy.h  

bool IsReversedCullingNeeded ( bool bUseReversedIndices
) const

 Returns whether this mesh needs reverse culling when using reversed indices. StaticMeshSceneProxy.h  

uint32 SetMeshElementGeometrySource ( int32 LODIndex,
int32 ElementIndex,
bool bWireframe,
bool bUseInversedIndices,
bool bAllowPreCulledIndices,
const FVertexFactory* VertexFactory,
FMeshBatch& OutMeshElement
) const

   StaticMeshSceneProxy.h  

uint32 SetMeshElementGeometrySource ( const FStaticMeshSection& Section,
const FRawStaticIndexBuffer& IndexBuffer,
const FAdditionalStaticMeshIndexBuffers* AdditionalIndexBuffers,
const FVertexFactory* VertexFactory,
bool bWireframe,
bool bUseInversedIndices,
FMeshBatch& OutMeshElement
) const

 Configures mesh batch vertex / index state. Returns the number of primitives used in the element. StaticMeshSceneProxy.h  

void SetMeshElementScreenSize ( int32 LODIndex,
bool bDitheredLODTransition,
FMeshBatch& OutMeshBatch
) const

 Sets the screen size on a mesh element. StaticMeshSceneProxy.h  

bool ShouldRenderBackFaces()

 Returns whether this mesh should render back-faces instead of front-faces - either with reversed indices or reversed cull mode StaticMeshSceneProxy.h  

Overridden from FPrimitiveSceneProxy

Name Remarks Include Path Unreal Specifiers

virtual void OnEvaluateWorldPositionOffsetChanged_RenderThread()

 Allows child implementations to do render-thread work when bEvaluateWorldPositionOffset changes StaticMeshSceneProxy.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page