1. Epic GamesDeveloper
  3. FParticleSystemSceneProxy

FParticleSystemSceneProxy

Scene Proxies

Unreal Engine C++ API Reference > Runtime > Engine

Inheritance Hierarchy

References

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

Syntax

class FParticleSystemSceneProxy : public FPrimitiveSceneProxy

Remarks

Scene Proxies

Variables

  Type Name Description
Protected variable uint8: 1 bCastShadow  
Protected variable uint8: 1 bManagingSignificance  
Protected variable FColoredMaterialRenderProxy * DeselectedWireframeMaterialInstance  
Protected variable FParticleDynamicData * DynamicData  
Protected variable TArray< FDynamicEmitterDataBase * > DynamicDataForThisFrame  
Protected variable TEnumAsByte< ERHIFeatureLevel::Type > FeatureLevel  
Protected variable int32 FirstFreeMeshBatch  
Protected variable FParticleDynamicData * LastDynamicData  
Protected variable int32 LastFramePreRendered From ViewFamily.FrameNumber
Protected variable int32 LODMethod  
Protected variable FMaterialRelevance MaterialRelevance  
Protected variable TIndirectArray< FMeshBatch, TInlineAllocator< 4 > > MeshBatchPool Pool for holding FMeshBatches to reduce allocations.
Public variable TArray< int32 > MeshEmitterLODIndices Persistent proxy storage for mesh emitter LODs; need to store these here, because GDME needs to calc the index, but VF needs to be init'ed with the correct LOD, and DynamicData goes away every frame
Protected variable AActor * Owner  
Protected variable float PendingLODDistance  
Public variable FParticlePerfStatsContext PerfStatContext  
Protected variable int32 VisualizeLODIndex  
Protected variable TUniformBuffer< FPrimitiveUniformShaderParameters > WorldSpacePrimitiveUniformBuffer The primitive's uniform buffer. Mutable because it is cached state during GetDynamicMeshElements.
Protected variable uint32 WorldSpaceUBHash  

Constructors

  Type Name Description
Public function  

FParticleSystemSceneProxy ( UParticleSystemComponent* Component,
FParticleDynamicData* InDynamicData,
bool bCanBeOccluded
)

 Initialization constructor.

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Protected function void Allows dynamic emitter data to create render thread resources.
Public function void

DetermineLODDistance ( const FSceneView* View,
int32 FrameNumber
)

  
Public function Const uint32  
Public function Const bool  
Public function Const const FColoredMaterialRenderProxy *  
Public function FParticleDynamicData *  
Public function Const ERHIFeatureLevel::Type  
Public function FParticleDynamicData *  
Public function Const const FMaterialRelevance &  
Public function Const void

GetObjectPositionAndScale ( const FSceneView& View,
FVector2D& ObjectNDCPosition,
FVector2D& ObjectMacroUVScales
)

 Object position in post projection space.
Public function Const float  
Public function FMeshBatch * Gets a mesh batch from the pool.
Public function Const int32  
Public function Const FRHIUniformBuffer *  
Public function Const FMatrix While this isn't good OO design, access to everything is made public.
Public function void Called when the rendering thread removes the dynamic data from the scene.
Protected function void Allows dynamic emitter data to release render thread resources.
Public function void

SetLastDynamicData ( FParticleDynamicData* InLastDynamicData
)

  
Public function void

SetVisualizeLODIndex ( int32 InVisualizeLODIndex
)

  
Public function void

UpdateData ( FParticleDynamicData* NewDynamicData
)

  
Public function void  
Public function Const void Called by dynamic emitter data during initialization to make sure the world space primitive uniform buffer is up-to-date.

Overridden from FPrimitiveSceneProxy

  Type Name Description
Public function Virtual Const bool  
Public function Virtual void Called when the rendering thread adds the proxy to the scene.
Public function Virtual Const void

GatherSimpleLights ( const FSceneViewFamily& ViewFamily,
FSimpleLightArray& OutParticleLights
)

 Gathers simple lights for this emitter.
Public function Virtual Const FBoxSphereBounds Return the custom occlusion bounds for this scene proxy.
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 uint32 Every derived class should override these functions
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 Returns whether the proxy utilizes custom occlusion bounds or not
Public function Virtual void Called to notify the proxy when its transform has been updated.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page