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

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.

   
Name TMassLODCalculator
Type struct
Header File /Engine/Plugins/Runtime/MassGameplay/Source/MassLOD/Public/MassLODCalculator.h
Include Path #include "MassLODCalculator.h"

Syntax

template<typename FLODLogic>  
struct TMassLODCalculator : public FMassLODBaseLogic

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

TMassLODCalculator()

   MassLODCalculator.h  

Structs

Name Remarks
FMassLODRuntimeData  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool AdjustDistancesFromCount()

 Adjust LOD distances by clamping them to respect the maximum LOD count @Return true if any LOD distances clamping was done MassLODCalculator.h  

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 MassLODCalculator.h  

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 MassLODCalculator.h  

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 MassLODCalculator.h  

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 MassLODCalculator.h  

void DebugDisplayLOD ( FMassExecutionContext& Context,
TConstArrayView< TLODFragment > LODList,
TConstArrayView< TTransformFragment > LocationList,
UWorld* World
)

 Debug draw the current state of each agent as a color coded square @Param Context of the chunk execution @Param LODList is the fragment where calculation are stored @Param LocationList is the fragment transforms of the entities @Param World where the debug display should be drawn MassLODCalculator.h  

void DebugDisplaySignificantLOD ( FMassExecutionContext& Context,
TConstArrayView< TLODFragment > LODList,
TConstArrayView< TTransformFragment > LocationList,
UWorld* World,
float MaxLODSignificance
)

 Debug draw the current state of each agent as a color coded square, within MaxLODSignificance range @Param Context of the chunk execution @Param LODList is the fragment where calculation are stored @Param LocationList is the fragment transforms of the entities @Param World where the debug display should be drawn @Param MaxLODSignificance is the max allowed value of LODList[i].LODSignificance for an agent's state to debug draw MassLODCalculator.h  

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 MassLODCalculator.h  

float GetMaxLODDistance()

 Return the maximum distance at which the LOD will be turn off MassLODCalculator.h  

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) MassLODCalculator.h  

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 MassLODCalculator.h  

void VisLogLOD ( FMassExecutionContext& Context,
TConstArrayView< TLODFragment > LODList,
TConstArrayView< TTransformFragment > LocationList,
UObject* LogOwner
)

 Add Visual Log entries for the current state of each agent as a color coded location @Param Context of the chunk execution @Param LODList is the fragment where calculation are stored @Param LocationList is the fragment transforms of the entities @Param World where the debug display should be drawn MassLODCalculator.h  

void VisLogSignificantLOD ( FMassExecutionContext& Context,
TConstArrayView< TLODFragment > LODList,
TConstArrayView< TTransformFragment > LocationList,
UObject* LogOwner,
float MaxLODSignificance
)

 Add Visual Log entries for the current state of each agent as a color coded location, within MaxLODSignificance range @Param Context of the chunk execution @Param LODList is the fragment where calculation are stored @Param LocationList is the fragment transforms of the entities @Param World where the debug display should be drawn @Param MaxLODSignificance is the max allowed value of LODList[i].LODSignificance for an agent's state to vislog MassLODCalculator.h  

Protected

Name Remarks Include Path Unreal Specifiers

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

   MassLODCalculator.h  

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

   MassLODCalculator.h  

bool CalculateVisibility ( const bool bWasVisible,
const float DistanceToFrustum
) const

   MassLODCalculator.h  

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

   MassLODCalculator.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page