1. Epic GamesDeveloper
  3. FSquare2DGridHelper

FSquare2DGridHelper

Square 2D grid helper

API > API/Runtime > API/Runtime/Engine

Square 2D grid helper

   
Name FSquare2DGridHelper
Type struct
Header File /Engine/Source/Runtime/Engine/Public/WorldPartition/RuntimeSpatialHash/RuntimeSpatialHashGridHelper.h
Include Path #include "WorldPartition/RuntimeSpatialHash/RuntimeSpatialHashGridHelper.h"

Syntax

struct FSquare2DGridHelper

Constructors

Name Remarks Include Path Unreal Specifiers

FSquare2DGridHelper ( const FBox& InWorldBounds,
const FVector& InOrigin,
int64 InCellSize
)

   WorldPartition/RuntimeSpatialHash/RuntimeSpatialHashGridHelper.h  

FSquare2DGridHelper ( const FBox& InWorldBounds,
const FVector& InOrigin,
int64 InCellSize,
bool bUseAlignedGridLevels
)

   WorldPartition/RuntimeSpatialHash/RuntimeSpatialHashGridHelper.h  

Structs

Name Remarks
FGrid2D  
FGridLevel  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
CellSize int64   WorldPartition/RuntimeSpatialHash/RuntimeSpatialHashGridHelper.h  
Levels TArray< FGridLevel >   WorldPartition/RuntimeSpatialHash/RuntimeSpatialHashGridHelper.h  
Origin FVector   WorldPartition/RuntimeSpatialHash/RuntimeSpatialHashGridHelper.h  
WorldBounds FBox   WorldPartition/RuntimeSpatialHash/RuntimeSpatialHashGridHelper.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ForEachCells ( TFunctionRef< void(const FSquare2DGridHelper::FGridLevel::FGridCell&)> InOperation
) const

 Runs a function on all cells. WorldPartition/RuntimeSpatialHash/RuntimeSpatialHashGridHelper.h  

int32 ForEachIntersectingCells ( const FBox& InBox,
TFunctionRef< void(const FGridCellCoord&)> InOperation,
int32 InStartLevel
) const

 Runs a function on all intersecting cells for the provided box WorldPartition/RuntimeSpatialHash/RuntimeSpatialHashGridHelper.h  

int32 ForEachIntersectingCells ( const FSphere& InSphere,
TFunctionRef< void(const FGridCellCoord&)> InOperation,
int32 InStartLevel
) const

 Runs a function on all intersecting cells for the provided sphere WorldPartition/RuntimeSpatialHash/RuntimeSpatialHashGridHelper.h  

int32 ForEachIntersectingCells ( const FSphericalSector& InShape,
TFunctionRef< void(const FGridCellCoord&)> InOperation,
int32 InStartLevel
) const

 Runs a function on all intersecting cells for the provided spherical sector WorldPartition/RuntimeSpatialHash/RuntimeSpatialHashGridHelper.h  
Returns the always loaded (top level) cell. WorldPartition/RuntimeSpatialHash/RuntimeSpatialHashGridHelper.h  
Returns the always loaded (top level) cell. WorldPartition/RuntimeSpatialHash/RuntimeSpatialHashGridHelper.h  

const FGridLevel::FGridCell & GetCell ( const FGridCellCoord& InCoords
) const

 Returns the cell at the given coord. WorldPartition/RuntimeSpatialHash/RuntimeSpatialHashGridHelper.h  

bool GetCellBounds ( const FGridCellCoord& InCoords,
FBox2D& OutBounds
) const

 Returns the cell bounds WorldPartition/RuntimeSpatialHash/RuntimeSpatialHashGridHelper.h  

bool GetCellGlobalCoords ( const FGridCellCoord& InCoords,
FGridCellCoord& OutGlobalCoords
) const

 Returns the cell global coordinates WorldPartition/RuntimeSpatialHash/RuntimeSpatialHashGridHelper.h  

FGridLevel & GetLowestLevel()

 Returns the lowest grid level. WorldPartition/RuntimeSpatialHash/RuntimeSpatialHashGridHelper.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page