1. Epic GamesDeveloper
  3. FNiagaraWorldManager

FNiagaraWorldManager

Manager class for any data relating to a particular world.

API > API/Plugins > API/Plugins/Niagara

Inheritance Hierarchy

References

   
Module Niagara
Header /Engine/Plugins/FX/Niagara/Source/Niagara/Public/NiagaraWorldManager.h
Include #include "NiagaraWorldManager.h"

Syntax

class FNiagaraWorldManager : public FGCObject

Remarks

Manager class for any data relating to a particular world.

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void Objects added here will have a strong reference held.
Public function void

CalculateScalabilityState ( UNiagaraSystem* System,
const FNiagaraSystemScalabilitySettings& ScalabilitySettings,
UNiagaraEffectType* EffectType,
FVector Location,
bool bIsPreCull,
float WorstGlobalBudgetUse,
FNiagaraScalabilityState& OutState
)

  
Public function void

CalculateScalabilityState ( UNiagaraSystem* System,
const FNiagaraSystemScalabilitySettings& ScalabilitySettings,
UNiagaraEffectType* EffectType,
UNiagaraComponent* Component,
bool bIsPreCull,
float WorstGlobalBudgetUse,
FNiagaraScalabilityState& OutState
)

  
Public function void  
Public function Static void  
Public function void  
Public function void  
Public function void  
Public function void Dump details about what's inside the world manager.
Public function void  
Public function T &  
Public function Static void

EnqueueGlobalDeferredCallback ( TFunction< void()>&& Callback
)

 This is a threadsafe queue which will execute on the game thread.
Public function UNiagaraDataChannelHandler *  
Public function void

FlushComputeAndDeferredQueues ( bool bWaitForGPU
)

 Flush the compute simulation queue and any deferred actions.
Public function void

ForAllSystemSimulations ( TAction Func
)

  
Public function Static void

ForAllWorldManagers ( TAction Func
)

  
Public function Static FNiagaraWorldManager *

Get ( const UWorld* World
)

  
Public function Const TArrayView< const FNiagaraCachedViewInfo >  
Public function UNiagaraComponentPool *  
Public function UNiagaraCullProxyComponent *  
Public function FNiagaraDataChannelManager &  
Public function Const ENiagaraDebugPlaybackMode  
Public function Const float  
Public function FNiagaraDeferredMethodQueue &  
Public function Const FVector::FReal

GetLODDistance ( FVector Location
)

 Returns the distance to the nearest viewpoint to the give location. Used for a distance on which to base LODs.
Public function UNiagaraParameterCollectionInstance *  
Public function Static ENiagaraScalabilityCullingMode  
Public function FNiagaraSystemSimulationRef

GetSystemSimulation ( ETickingGroup TickGroup,
UNiagaraSystem* System
)

  
Public function UWorld *  
Public function Const UWorld *  
Public function void

Init ( UWorld* InWorld
)

  
Public function void

InitDataChannel ( const UNiagaraDataChannel* Channel,
bool bForce
)

  
Public function Static bool

IsComponentLocalPlayerLinked ( const USceneComponent* Component
)

 Is this component in anyway linked to the local player.
Public function void  
Public function void  
Public function UObject *
ObjectPoolGetOrCreate

( UClass* Class,
bool& bIsExistingObject
)

 Will create a new object or return one from the pool.
Public function T *
ObjectPoolGetOrCreate

( bool& bIsExistingObject
)

  
Public function UObject *  
Public function T *  
Public function void Returns an object to the pool You are expected to do any unregistering of the component and ensuring no references are held.
Public function Static void Gamethread callback to cleanup references to the given ComputeDispatchInterface before it gets deleted on the renderthread.
Public function void

OnPostWorldCleanup ( bool bSessionEnded,
bool bCleanupResources
)

  
Public function Static void  
Public function Static void  
Public function Static void  
Public function void  
Public function void  
Public function void

OnWorldCleanup ( bool bSessionEnded,
bool bCleanupResources
)

  
Public function void

PostActorTick ( float DeltaSeconds
)

 Called after all actor tick groups are complete.
Public function void  
Public function void  
Public function void

PreActorTick ( ELevelTick InLevelTick,
float InDeltaSeconds
)

  
Public function void  
Public function void  
Public function void Called before we run end of frame updates, allows us to wait on async work.
Public function void  
Public function void  
Public function Static void  
Public function const T &  
Public function void  
Public function void  
Public function void  
Public function void Removes an object from the WM references.
Public function Static void  
Public function void  
Public function void

SetDebugPlaybackRate ( float Rate
)

  
Public function Static void  
Public function void

SetTickGroupPriority ( const int32 NiagaraTickGroupIndex,
const bool bHighPriority
)

  
Public function bool Should we cull an instance of this system at the passed location before it's even been spawned?
Public function bool

ShouldPreCull ( UNiagaraSystem* System,
FVector Location
)

  
Public function void

SortedSignificanceCull ( UNiagaraEffectType* EffectType,
UNiagaraComponent* Component,
const FNiagaraSystemScalabilitySettings& ScalabilitySettings,
float Significance,
int32& EffectTypeInstCount,
uint16& SystemInstCount,
FNiagaraScalabilityState& OutState
)

  
Public function void

Tick ( ETickingGroup TickGroup,
float DeltaSeconds,
ELevelTick TickType,
ENamedThreads::Type CurrentThread,
const FGraphEventRef& MyCompletionGraphEvent
)

  
Public function void

TickStart ( float DeltaSeconds
)

 Called at the very beginning of world ticking.
Public function void  
Public function void

UpdateScalabilityManagers ( float DeltaSeconds,
bool bNewSpawnsOnly
)

  
Public function void Waits for all currently in flight async work to be completed.

Overridden from FGCObject

  Type Name Description
Public function Virtual void Pure virtual that must be overloaded by the inheriting class.
Public function Virtual Const FString Overload this method to report a name for your referencer

Constants

Name Description
bInvalidateCachedSystemScalabilityData  
OnPostWorldCleanupHandle  
OnPreWorldFinishDestroyHandle  
OnWorldBeginTearDownHandle  
OnWorldCleanupHandle  
OnWorldInitHandle  
OnWorldPreActorTickHandle  
OnWorldPreSendAllEndOfFrameUpdatesHandle  
PostGCHandle  
PostReachabilityAnalysisHandle  
PreGCBeginDestroyHandle  
PreGCHandle  
ScalabilityCullingMode A global flag for all scalability culling
TickWorldHandle  
TickWorldStartHandle  
ViewTargetChangedHandle  
WorldManagers  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page