1. Epic GamesDeveloper
  3. TMassLODCalculator

TMassLODCalculator

Helper struct to calculate LOD for each agent and maximize count per LOD Requires TViewerInfoFragment fragment collected by the [TMassLODCollector](API\Plugins\MassLOD\TMassLODCollector).

API > API/Plugins > API/Plugins/MassLOD

Inheritance Hierarchy

References

   
Module MassLOD
Header /Engine/Plugins/Runtime/MassGameplay/Source/MassLOD/Public/MassLODCalculator.h
Include #include "MassLODCalculator.h"

Syntax

template<typename FLODLogic>  
struct TMassLODCalculator : public FMassLODBaseLogic

Remarks

Helper struct to calculate LOD for each agent and maximize count per LOD Requires TViewerInfoFragment fragment collected by the TMassLODCollector. Stores information in TLODFragment fragment.

Variables

  Type Name Description
Protected variable TStaticArray< float, EMassLOD::Max > BaseBucketSize The size of each subdivision per LOD (LOD Size/MaxBucketsPerLOD)
Protected variable TStaticArray< float, EMassLOD::Max > BaseLODDistance LOD distances
Protected variable float BufferHysteresisOnDistanceRatio Ratio for Buffer Distance Hysteresis
Protected variable TStaticArray< int32, EMassLOD::Max > LODMaxCount MaxCount total
Protected variable TStaticArray< int32, EMassLOD::Max > LODMaxCountPerViewer MaxCount total per viewers
Protected variable float MaxLODDistance Maximum LOD Distance
Protected variable FMassLODRuntimeData RuntimeData Runtime data for LOD calculation
Protected variable TArray< FMassLODRuntimeData > RuntimeDataPerViewer Runtime data for each viewer specific LOD calculation, used only when bMaximizeCountPerViewer is true
Protected variable TStaticArray< float, EMassLOD::Max > VisibleBucketSize  
Protected variable float VisibleDistanceToFrustum How far away from frustum does this entities are considered visible
Protected variable float VisibleDistanceToFrustumWithHysteresis Once visible how much further than distance to frustum does the entities need to be before being consider not visible
Protected variable TStaticArray< float, EMassLOD::Max > VisibleLODDistance  

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Protected function Const float

AccumulateCountInRuntimeData ( const EMassLOD::Type LOD,
const float ViewerDistanceSq,
const bool bIsVisible,
FMassLODRuntimeData& Data
)

  
Public function bool Adjust LOD distances by clamping them to respect the maximum LOD count @Return true if any LOD distances clamping was done
Protected function Const bool

AdjustDistancesFromCountForRuntimeData ( const TStaticArray< int32, EMassLOD::Max >& MaxCount,
FMassLODRuntimeData& RuntimeData
)

  
Public function void

AdjustLODFromCount ( FMassExecutionContext& Context,
TConstArrayView< TViewerInfoFragment > ViewersInfoList,
TArrayView< TLODFragment > LODList
)

 Adjust LOD from newly adjusted distances, only needed to be called when AdjustDistancesFromCount return true, called for each entity chunks Use next method when FLODLogic::bStoreInfoPerViewer is enabled @Param Context of the chunk execution @Param ViewersInfoList is the source information fragment for LOD calculation @Param LODList is the fragment where calculation are stored
Public function void

AdjustLODFromCount ( FMassExecutionContext& Context,
TConstArrayView< TViewerInfoFragment > ViewersInfoList,
TArrayView< TLODFragment > LODList,
TConstArrayView< TPerViewerInfoFragment > PerViewerInfoList
)

 Adjust LOD from newly adjusted distances, only needed to be called when AdjustDistancesFromCount return true, called for each entity chunks Use this version when FLODLogic::bStoreInfoPerViewer is enabled It calculates a LOD per viewer and needs information per viewer via PerViewerInfoList fragments @Param Context of the chunk execution @Param ViewersInfoList is the source information fragment for LOD calculation @Param LODList is the fragment where calculation are stored @Param PerViewerInfoList is the Per viewer source information
Public function void

CalculateLOD ( FMassExecutionContext& Context,
TConstArrayView< TViewerInfoFragment > ViewersInfoList,
TArrayView< TLODFragment > LODList
)

 Calculate LOD, called for each entity chunks Use next method when FLODLogic::bStoreInfoPerViewer is enabled @Param Context of the chunk execution @Param ViewersInfoList is the source information fragment for LOD calculation @Param LODList is the fragment where calculation are stored
Public function void

CalculateLOD ( FMassExecutionContext& Context,
TConstArrayView< TViewerInfoFragment > ViewersInfoList,
TArrayView< TLODFragment > LODList,
TConstArrayView< TPerViewerInfoFragment > PerViewerInfoList
)

 Calculate LOD, called for each entity chunks Use this version when FLODLogic::bStoreInfoPerViewer is enabled It calculates a LOD per viewer and needs information per viewer via PerViewerInfoList fragments @Param Context of the chunk execution @Param ViewersInfoList is the source information fragment for LOD calculation @Param LODList is the fragment where calculation are stored @Param PerViewerInfoList is the Per viewer source information
Protected function Const bool

CalculateVisibility ( const bool bWasVisible,
const float DistanceToFrustum
)

  
Protected function Const EMassLOD::Type

ComputeLODFromSettings ( const EMassLOD::Type PrevLOD,
const float DistanceToViewerSq,
const bool bIsVisible,
bool* bIsInAVisibleRange,
const FMassLODRuntimeData& Data
)

  
Public function void

ForceOffLOD ( FMassExecutionContext& Context,
TArrayView< TLODFragment > LODList
)

 Turn Off all LOD, called for each entity chunks @Param Context of the chunk execution @Param LODList is the fragment where calculation are stored
Public function Const float Return the maximum distance at which the LOD will be turn off
Public function void

Initialize ( const float InBaseLODDistance,
const float InBufferHysteresisOnDistanceRatio,
const int32 InLODMaxCount,
const int32 InLODMaxCountPerViewer,
const float InVisibleDistanceToFrustum,
const float InVisibleDistanceToFrustumHysteresis,
const float InVisibleLODDistance
)

 Initializes the LOD calculator, needed to be called once at initialization time @Param InBaseLODDistance distances used to calculate LOD @Param InBufferHysteresisOnFOVRatio distance hysteresis used to calculate LOD @Param InLODMaxCount the maximum count for each LOD - Supports nullptr being passed in now and will put INT_MAX everywhere by default @Param InLODMaxCountPerViewer the maximum count for each LOD per viewer (Only when FLODLogic::bMaximizeCountPerViewer is enabled) @Param InVisibleDistanceToFrustum is the distance from the frustum to start considering this entity is visible (Only when FLODLogic::bDoVisibilityLogic is enabled) @Param InVisibleDistanceToFrustumHysteresis once visible, what extra distance the entity need to be before considered not visible anymore (Only when FLODLogic::bDoVisibilityLogic is enabled) @Param InVisibleLODDistance the maximum count for each LOD per viewer (Only when FLODLogic::bDoVisibilityLogic is enabled)
Public function void

PrepareExecution ( TConstArrayView< FViewerInfo > Viewers
)

 Prepares execution for the current frame, needed to be called before every execution @Param Viewers is the array of all the known viewers

Classes

  Type Name Description
Protected struct FMassLODRuntimeData    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page