UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FSpatialHashStreamingGrid Struct Reference

#include <WorldPartitionRuntimeSpatialHash.h>

Public Member Functions

ENGINE_API FSpatialHashStreamingGrid ()
 
ENGINE_API ~FSpatialHashStreamingGrid ()
 
 FSpatialHashStreamingGrid (const FSpatialHashStreamingGrid &Other)=delete
 
 FSpatialHashStreamingGrid (FSpatialHashStreamingGrid &&Other)=default
 
FSpatialHashStreamingGridoperator= (const FSpatialHashStreamingGrid &Other)=delete
 
FSpatialHashStreamingGridoperator= (FSpatialHashStreamingGrid &&Other)=default
 
ENGINE_API void InjectExternalStreamingObjectGrid (const FSpatialHashStreamingGrid &InExternalObjectStreamingGrid) const
 
ENGINE_API void RemoveExternalStreamingObjectGrid (const FSpatialHashStreamingGrid &InExternalObjectStreamingGrid) const
 
ENGINE_API bool InsertGridCell (UWorldPartitionRuntimeCell *InGridCell, const FGridCellCoord &InGridCellCoords)
 
ENGINE_API int64 GetCellSize (int32 Level) const
 
ENGINE_API void GetCells (const FWorldPartitionStreamingQuerySource &QuerySource, TSet< const UWorldPartitionRuntimeCell * > &OutCells, bool bEnableZCulling, FWorldPartitionQueryCache *QueryCache=nullptr) const
 
ENGINE_API void GetCells (const TArray< FWorldPartitionStreamingSource > &Sources, UWorldPartitionRuntimeHash::FStreamingSourceCells &OutActivateCells, UWorldPartitionRuntimeHash::FStreamingSourceCells &OutLoadCells, bool bEnableZCulling, const FWorldPartitionStreamingContext &Context) const
 
ENGINE_API void GetNonSpatiallyLoadedCells (TSet< const UWorldPartitionRuntimeCell * > &OutActivateCells, TSet< const UWorldPartitionRuntimeCell * > &OutLoadCells, const FWorldPartitionStreamingContext &Context) const
 
ENGINE_API void Draw2D (const class UWorldPartitionRuntimeSpatialHash *Owner, const FBox2D &Region2D, const FBox2D &GridScreenBounds, TFunctionRef< FVector2D(const FVector2D &, bool)> WorldToScreen, FWorldPartitionDraw2DContext &DrawContext) const
 
ENGINE_API void Draw3D (const class UWorldPartitionRuntimeSpatialHash *Owner, const TArray< FWorldPartitionStreamingSource > &Sources, const FTransform &Transform) const
 
ENGINE_API void ForEachRuntimeCell (TFunctionRef< bool(const UWorldPartitionRuntimeCell *)> Func) const
 
ENGINE_API const FSquare2DGridHelperGetGridHelper () const
 
ENGINE_API float GetLoadingRange () const
 
void GetCells (const TArray< FWorldPartitionStreamingSource > &Sources, UWorldPartitionRuntimeHash::FStreamingSourceCells &OutActivateCells, UWorldPartitionRuntimeHash::FStreamingSourceCells &OutLoadCells, bool bEnableZCulling) const
 
void GetNonSpatiallyLoadedCells (TSet< const UWorldPartitionRuntimeCell * > &OutActivateCells, TSet< const UWorldPartitionRuntimeCell * > &OutLoadCells) const
 

Public Attributes

FName GridName
 
FVector Origin
 
int32 CellSize
 
float LoadingRange
 
bool bBlockOnSlowStreaming
 
FLinearColor DebugColor
 
TArray< FSpatialHashStreamingGridLevelGridLevels
 
FBox WorldBounds
 
bool bClientOnlyVisible
 
int32 GridIndex
 
FSpatialHashSettings Settings
 

Detailed Description

Represents a PIE/Game streaming grid

Constructor & Destructor Documentation

◆ FSpatialHashStreamingGrid() [1/3]

FSpatialHashStreamingGrid::FSpatialHashStreamingGrid ( )

◆ ~FSpatialHashStreamingGrid()

FSpatialHashStreamingGrid::~FSpatialHashStreamingGrid ( )

◆ FSpatialHashStreamingGrid() [2/3]

FSpatialHashStreamingGrid::FSpatialHashStreamingGrid ( const FSpatialHashStreamingGrid Other)
delete

◆ FSpatialHashStreamingGrid() [3/3]

FSpatialHashStreamingGrid::FSpatialHashStreamingGrid ( FSpatialHashStreamingGrid &&  Other)
default

Member Function Documentation

◆ Draw2D()

void FSpatialHashStreamingGrid::Draw2D ( const class UWorldPartitionRuntimeSpatialHash Owner,
const FBox2D Region2D,
const FBox2D GridScreenBounds,
TFunctionRef< FVector2D(const FVector2D &, bool)>  WorldToScreen,
FWorldPartitionDraw2DContext DrawContext 
) const

◆ Draw3D()

void FSpatialHashStreamingGrid::Draw3D ( const class UWorldPartitionRuntimeSpatialHash Owner,
const TArray< FWorldPartitionStreamingSource > &  Sources,
const FTransform Transform 
) const

◆ ForEachRuntimeCell()

void FSpatialHashStreamingGrid::ForEachRuntimeCell ( TFunctionRef< bool(const UWorldPartitionRuntimeCell *)>  Func) const

◆ GetCells() [1/3]

void FSpatialHashStreamingGrid::GetCells ( const FWorldPartitionStreamingQuerySource QuerySource,
TSet< const UWorldPartitionRuntimeCell * > &  OutCells,
bool  bEnableZCulling,
FWorldPartitionQueryCache QueryCache = nullptr 
) const

◆ GetCells() [2/3]

void FSpatialHashStreamingGrid::GetCells ( const TArray< FWorldPartitionStreamingSource > &  Sources,
UWorldPartitionRuntimeHash::FStreamingSourceCells OutActivateCells,
UWorldPartitionRuntimeHash::FStreamingSourceCells OutLoadCells,
bool  bEnableZCulling 
) const
inline

◆ GetCells() [3/3]

void FSpatialHashStreamingGrid::GetCells ( const TArray< FWorldPartitionStreamingSource > &  Sources,
UWorldPartitionRuntimeHash::FStreamingSourceCells OutActivateCells,
UWorldPartitionRuntimeHash::FStreamingSourceCells OutLoadCells,
bool  bEnableZCulling,
const FWorldPartitionStreamingContext Context 
) const

◆ GetCellSize()

int64 FSpatialHashStreamingGrid::GetCellSize ( int32  Level) const

◆ GetGridHelper()

const FSquare2DGridHelper & FSpatialHashStreamingGrid::GetGridHelper ( ) const

◆ GetLoadingRange()

float FSpatialHashStreamingGrid::GetLoadingRange ( ) const

◆ GetNonSpatiallyLoadedCells() [1/2]

void FSpatialHashStreamingGrid::GetNonSpatiallyLoadedCells ( TSet< const UWorldPartitionRuntimeCell * > &  OutActivateCells,
TSet< const UWorldPartitionRuntimeCell * > &  OutLoadCells 
) const
inline

◆ GetNonSpatiallyLoadedCells() [2/2]

void FSpatialHashStreamingGrid::GetNonSpatiallyLoadedCells ( TSet< const UWorldPartitionRuntimeCell * > &  OutActivateCells,
TSet< const UWorldPartitionRuntimeCell * > &  OutLoadCells,
const FWorldPartitionStreamingContext Context 
) const

◆ InjectExternalStreamingObjectGrid()

void FSpatialHashStreamingGrid::InjectExternalStreamingObjectGrid ( const FSpatialHashStreamingGrid InExternalObjectStreamingGrid) const

◆ InsertGridCell()

bool FSpatialHashStreamingGrid::InsertGridCell ( UWorldPartitionRuntimeCell InGridCell,
const FGridCellCoord InGridCellCoords 
)

◆ operator=() [1/2]

FSpatialHashStreamingGrid & FSpatialHashStreamingGrid::operator= ( const FSpatialHashStreamingGrid Other)
delete

◆ operator=() [2/2]

FSpatialHashStreamingGrid & FSpatialHashStreamingGrid::operator= ( FSpatialHashStreamingGrid &&  Other)
default

◆ RemoveExternalStreamingObjectGrid()

void FSpatialHashStreamingGrid::RemoveExternalStreamingObjectGrid ( const FSpatialHashStreamingGrid InExternalObjectStreamingGrid) const

Member Data Documentation

◆ bBlockOnSlowStreaming

bool FSpatialHashStreamingGrid::bBlockOnSlowStreaming

◆ bClientOnlyVisible

bool FSpatialHashStreamingGrid::bClientOnlyVisible

◆ CellSize

int32 FSpatialHashStreamingGrid::CellSize

◆ DebugColor

FLinearColor FSpatialHashStreamingGrid::DebugColor

◆ GridIndex

int32 FSpatialHashStreamingGrid::GridIndex

◆ GridLevels

TArray<FSpatialHashStreamingGridLevel> FSpatialHashStreamingGrid::GridLevels

◆ GridName

FName FSpatialHashStreamingGrid::GridName

◆ LoadingRange

float FSpatialHashStreamingGrid::LoadingRange

◆ Origin

FVector FSpatialHashStreamingGrid::Origin

◆ Settings

FSpatialHashSettings FSpatialHashStreamingGrid::Settings

◆ WorldBounds

FBox FSpatialHashStreamingGrid::WorldBounds

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