UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FSimpleElementCollector Class Reference

#include <SceneManagement.h>

+ Inheritance diagram for FSimpleElementCollector:

Classes

class  FAllocationInfo
 

Public Member Functions

ENGINE_API FSimpleElementCollector ()
 
ENGINE_API ~FSimpleElementCollector ()
 
virtual ENGINE_API void SetHitProxy (HHitProxy *HitProxy) override
 
virtual void AddReserveLines (uint8 DepthPriorityGroup, int32 NumLines, bool bDepthBiased=false, bool bThickLines=false) override
 
virtual ENGINE_API void DrawSprite (const FVector &Position, float SizeX, float SizeY, const FTexture *Sprite, const FLinearColor &Color, uint8 DepthPriorityGroup, float U, float UL, float V, float VL, uint8 BlendMode=SE_BLEND_Masked, float OpacityMaskRevVal=.5f) override
 
virtual ENGINE_API void DrawLine (const FVector &Start, const FVector &End, const FLinearColor &Color, uint8 DepthPriorityGroup, float Thickness=0.0f, float DepthBias=0.0f, bool bScreenSpace=false) override
 
virtual ENGINE_API void DrawTranslucentLine (const FVector &Start, const FVector &End, const FLinearColor &Color, uint8 DepthPriorityGroup, float Thickness=0.0f, float DepthBias=0.0f, bool bScreenSpace=false) override
 
virtual ENGINE_API void DrawPoint (const FVector &Position, const FLinearColor &Color, float PointSize, uint8 DepthPriorityGroup) override
 
virtual ENGINE_API void RegisterDynamicResource (FDynamicPrimitiveResource *DynamicResource) override
 
virtual bool IsHitTesting () override
 
virtual int32 DrawMesh (const FMeshBatch &Mesh) override
 
ENGINE_API void DrawBatchedElements (FRHICommandList &RHICmdList, const FMeshPassProcessorRenderState &DrawRenderState, const FSceneView &InView, EBlendModeFilter::Type Filter, ESceneDepthPriorityGroup DPG, uint32 NumInstances=1) const
 
ENGINE_API void AddAllocationInfo (FAllocationInfo &AllocationInfo) const
 
ENGINE_API void Reserve (const FAllocationInfo &AllocationInfo)
 
ENGINE_API void Append (FSimpleElementCollector &Other)
 
bool HasAnyPrimitives () const
 
bool HasPrimitives (ESceneDepthPriorityGroup DPG) const
 
- Public Member Functions inherited from FPrimitiveDrawInterface
 FPrimitiveDrawInterface (const FSceneView *InView)
 
virtual ~FPrimitiveDrawInterface ()
 

Public Attributes

FBatchedElements BatchedElements
 
FBatchedElements TopBatchedElements
 
- Public Attributes inherited from FPrimitiveDrawInterface
const FSceneViewView
 

Friends

class FMeshElementCollector
 

Detailed Description

Primitive draw interface implementation used to store primitives requested to be drawn when gathering dynamic mesh elements.

Constructor & Destructor Documentation

◆ FSimpleElementCollector()

FSimpleElementCollector::FSimpleElementCollector ( )

◆ ~FSimpleElementCollector()

FSimpleElementCollector::~FSimpleElementCollector ( )

Member Function Documentation

◆ AddAllocationInfo()

void FSimpleElementCollector::AddAllocationInfo ( FAllocationInfo AllocationInfo) const

Accumulates allocation info for use calling Reserve.

◆ AddReserveLines()

virtual void FSimpleElementCollector::AddReserveLines ( uint8  DepthPriorityGroup,
int32  NumLines,
bool  bDepthBiased = false,
bool  bThickLines = false 
)
inlineoverridevirtual

◆ Append()

void FSimpleElementCollector::Append ( FSimpleElementCollector Other)

Appends contents of another batched elements into this one and clears the other one.

◆ DrawBatchedElements()

void FSimpleElementCollector::DrawBatchedElements ( FRHICommandList RHICmdList,
const FMeshPassProcessorRenderState DrawRenderState,
const FSceneView InView,
EBlendModeFilter::Type  Filter,
ESceneDepthPriorityGroup  DPG,
uint32  NumInstances = 1 
) const

◆ DrawLine()

void FSimpleElementCollector::DrawLine ( const FVector Start,
const FVector End,
const FLinearColor Color,
uint8  DepthPriorityGroup,
float  Thickness = 0.0f,
float  DepthBias = 0.0f,
bool  bScreenSpace = false 
)
overridevirtual

◆ DrawMesh()

virtual int32 FSimpleElementCollector::DrawMesh ( const FMeshBatch Mesh)
inlineoverridevirtual

Draw a mesh element. This should only be called through the DrawMesh function.

Returns
Number of passes rendered for the mesh

Implements FPrimitiveDrawInterface.

◆ DrawPoint()

void FSimpleElementCollector::DrawPoint ( const FVector Position,
const FLinearColor Color,
float  PointSize,
uint8  DepthPriorityGroup 
)
overridevirtual

◆ DrawSprite()

void FSimpleElementCollector::DrawSprite ( const FVector Position,
float  SizeX,
float  SizeY,
const FTexture Sprite,
const FLinearColor Color,
uint8  DepthPriorityGroup,
float  U,
float  UL,
float  V,
float  VL,
uint8  BlendMode = SE_BLEND_Masked,
float  OpacityMaskRevVal = .5f 
)
overridevirtual

◆ DrawTranslucentLine()

void FSimpleElementCollector::DrawTranslucentLine ( const FVector Start,
const FVector End,
const FLinearColor Color,
uint8  DepthPriorityGroup,
float  Thickness = 0.0f,
float  DepthBias = 0.0f,
bool  bScreenSpace = false 
)
overridevirtual

◆ HasAnyPrimitives()

bool FSimpleElementCollector::HasAnyPrimitives ( ) const
inline

◆ HasPrimitives()

bool FSimpleElementCollector::HasPrimitives ( ESceneDepthPriorityGroup  DPG) const
inline

◆ IsHitTesting()

virtual bool FSimpleElementCollector::IsHitTesting ( )
inlineoverridevirtual

◆ RegisterDynamicResource()

void FSimpleElementCollector::RegisterDynamicResource ( FDynamicPrimitiveResource DynamicResource)
overridevirtual

◆ Reserve()

void FSimpleElementCollector::Reserve ( const FAllocationInfo AllocationInfo)

Reserves memory for all containers.

◆ SetHitProxy()

void FSimpleElementCollector::SetHitProxy ( HHitProxy HitProxy)
overridevirtual

Friends And Related Symbol Documentation

◆ FMeshElementCollector

Member Data Documentation

◆ BatchedElements

FBatchedElements FSimpleElementCollector::BatchedElements

The batched simple elements.

◆ TopBatchedElements

FBatchedElements FSimpleElementCollector::TopBatchedElements

The documentation for this class was generated from the following files: