1. Epic GamesDeveloper
  3. FGrid2D

FGrid2D

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/WorldPartition > API/Runtime/Engine/WorldPartition/RuntimeSpatialHash > API/Runtime/Engine/WorldPartition/RuntimeSpatialHash/FSquare2DGridHelper

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Public/WorldPartition/RuntimeSpatialHash/RuntimeSpatialHashGridHelper.h
Include #include "WorldPartition/RuntimeSpatialHash/RuntimeSpatialHashGridHelper.h"

Syntax

struct FGrid2D

Variables

  Type Name Description
Public variable int64 CellSize  
Public variable int64 GridSize  
Public variable FVector2D Origin  

Constructors

  Type Name Description
Public function  

FGrid2D ( const FVector2D& InOrigin,
int64 InCellSize,
int64 InGridSize
)

  

Functions

  Type Name Description
Public function Const int32

ForEachIntersectingCells ( const FBox& InBox,
TFunctionRef< void(const FGridCellCoord2&)> InOperation
)

  
Public function Const int32

ForEachIntersectingCells ( const FSphere& InSphere,
TFunctionRef< void(const FGridCellCoord2&)> InOperation
)

 Runs a function on all intersecting cells for the provided sphere
Public function Const int32

ForEachIntersectingCells ( const FSphericalSector& InShape,
TFunctionRef< void(const FGridCellCoord2&)> InOperation
)

 Runs a function on all intersecting cells for the provided spherical sector
Public function Const int32

ForEachIntersectingCellsBreakable ( const FBox& InBox,
TFunctionRef< bool(const FGridCellCoord2&)> InOperation
)

 Runs a function on all intersecting cells for the provided box
Public function Const bool

GetCellBounds ( int64 InIndex,
FBox2D& OutBounds
)

 Returns the cell bounds
Public function Const bool

GetCellBounds ( const FGridCellCoord2& InCoords,
FBox2D& OutBounds,
bool bCheckIsValidCoord
)

 Returns the cell bounds
Public function Const bool

GetCellCoords ( const FVector2D& InPos,
FGridCellCoord2& OutCoords
)

 Returns the cell coordinates of the provided position
Public function Const bool

GetCellCoords ( const FBox2D& InBounds2D,
FGridCellCoord2& OutMinCellCoords,
FGridCellCoord2& OutMaxCellCoords
)

 Returns the cells coordinates of the provided box
Public function Const bool

GetCellIndex ( const FGridCellCoord2& InCoords,
uint64& OutIndex
)

 Returns the cell index of the provided coords
Public function Const bool

GetCellIndex ( const FVector& InPos,
uint64& OutIndex
)

 Returns the cell index of the provided position
Public function Const int32

GetNumIntersectingCells ( const FBox& InBox
)

 Get the number of intersecting cells of the provided box
Public function Const bool

IsValidCoords ( const FGridCellCoord2& InCoords
)

 Validate that the coordinates fit the grid size

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page