1. Epic GamesDeveloper
  3. FStaticMeshSceneProxy

FStaticMeshSceneProxy

A static mesh component scene proxy.

Unreal Engine C++ API Reference > Runtime > Engine

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Public/StaticMeshSceneProxy.h
Include #include "StaticMeshSceneProxy.h"

Syntax

class FStaticMeshSceneProxy : public FPrimitiveSceneProxy

Remarks

A static mesh component scene proxy.

Variables

  Type Name Description
Protected variable uint32: 1 bCastShadow  
Protected variable bool bPerSectionSelection Whether selection should be per section or per entire proxy.
Protected variable uint32: 1 bReverseCulling This primitive has culling reversed
Protected variable const FCardRepresentationData * CardRepresentationData  
Protected variable int32 ClampedMinLOD Minimum LOD index to use. Clamped to valid range [0, NumLODs - 1].
Protected variable const FDistanceFieldVolumeData * DistanceFieldData  
Protected variable int32 ForcedLodModel The forcedLOD set in the static mesh editor, copied from the mesh component
Protected variable uint8 HierarchicalLODIndex Hierarchical LOD Index used for rendering
Protected variable TArray< FLODInfo > LODs  
Protected variable int32 MaterialIndexPreview Index of the material to preview.
Protected variable FMaterialRelevance MaterialRelevance The view relevance for all the static mesh's materials.
Protected variable TArray< uint32 > MaterialStreamingRelativeBoxes Material bounds used for texture streaming.
Protected variable UMaterialInterface * OverlayMaterial  
Protected variable float OverlayMaterialMaxDrawDistance  
Protected variable FStaticMeshRenderData * RenderData  
Protected variable int32 SectionIndexPreview Index of the section to preview.
Protected variable float StreamingDistanceMultiplier The component streaming distance multiplier
Protected variable float StreamingTransformScale The cached GetTextureStreamingTransformScale
Protected variable float WPODisableDistance The distance at which to disable World Position Offset (0 = no max).

Constructors

  Type Name Description
Public function  

FStaticMeshSceneProxy ( UStaticMeshComponent* Component,
bool bForceLODsShareStaticLighting
)

 Initialization constructor.

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Const SIZE_T  
Public function Virtual Const bool

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

 Sets up a collision FMeshBatch for a specific LOD and element.
Protected function Const uint8 Only call on render thread timeline
Public function Virtual Const void

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

  
Public function Const FLODMask

GetLODMask ( const FSceneView* View
)

 Returns the LOD mask for a view, this is like the ordinary LOD but can return two values for dither fading
Public function Virtual Const bool

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

  
Public function Virtual Const bool

GetMeshElement ( int32 LODIndex,
int32 BatchIndex,
int32 ElementIndex,
uint8 InDepthPriorityGroup,
bool bUseSelectionOutline,
bool bAllowPreCulledIndices,
FMeshBatch& OutMeshBatch
)

 Sets up a FMeshBatch for a specific LOD and element.
Public function Virtual Const int32 Gets the number of mesh batches required to represent the proxy, aside from section needs.
Public function Const float

GetScreenSize ( int32 LODIndex
)

 Returns the display factor for the given LOD level
Public function Virtual Const bool

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

 Sets up a shadow FMeshBatch for a specific LOD.
Public function Virtual Const bool

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

 Sets up a wireframe FMeshBatch for a specific LOD.
Protected function Const bool

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

  
Protected function Const bool

IsReversedCullingNeeded ( bool bUseReversedIndices
)

 Returns whether this mesh needs reverse culling when using reversed indices.
Public function Virtual void  
Protected function Const uint32

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

 Configures mesh batch vertex / index state. Returns the number of primitives used in the element.
Protected function Const void

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

 Sets the screen size on a mesh element.
Protected function Const bool Returns whether this mesh should render back-faces instead of front-faces - either with reversed indices or reversed cull mode

Overridden from FPrimitiveSceneProxy

  Type Name Description
Public function Virtual Const bool  
Public function Virtual HHitProxy *

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

 Creates the hit proxies are used when DrawDynamicElements is called. Called in the game thread.
Public function Virtual void Called when the rendering thread adds the proxy to the scene.
Public function Virtual void Called when the rendering thread removes the proxy from the scene.
Public function Virtual void Draws the primitive's static elements.
Public function Virtual Const uint8  
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
)

 Gathers the primitive's dynamic mesh elements.
Public function Virtual Const bool

GetInstanceWorldPositionOffsetDisableDistance ( float& OutWPODisableDistance
)

 Retrieves the per-instance world position offset disable distance
Public function Virtual void

GetLCIs ( FLCIArray& LCIs
)

  
Public function Virtual Const int32 Get the lightmap UV coordinate index for this primitive.
Public function Virtual Const int32 Get the lightmap resolution for this primitive. Used in VMI_LightmapDensity.
Public function Virtual Const void

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

 Determines the relevance of this primitive's elements to the given light.
Public function Virtual Const int32

GetLOD ( const FSceneView* View
)

 Returns the LOD that the primitive will render at for this view.
Public function Virtual Const uint32 Every derived class should override these functions
Public function Virtual Const const FCardRepresentationData *  
Public function Virtual Const void

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

 Gathers a description of the mesh elements to be rendered for the given LOD index, without consideration for views.
Public function Virtual Const bool

GetMeshUVDensities ( int32 LODIndex,
int32 SectionIndex,
FVector4& WorldUVDensities
)

 Get mesh UV density for a LOD-section.
Public function Virtual Const bool

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

 Get primitive distance to view origin for a given LOD-section.
Public function Virtual Const SIZE_T Return a type (or subtype) specific hash for sorting purposes
Public function Virtual Const FPrimitiveViewRelevance

GetViewRelevance ( const FSceneView* View
)

 Determines the relevance of this primitive's elements to the given view.
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Protected function Virtual void Allows child implementations to do render-thread work when bEvaluateWorldPositionOffset changes
Public function Virtual Const bool  

Classes

  Type Name Description
Protected class FLODInfo Information used by the proxy about a single LOD of the mesh.  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page