1. Epic GamesDeveloper
  3. FGrid2D

FGrid2D

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/FSquare2DGridHelper

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

Syntax

struct FGrid2D

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

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

   WorldPartition/RuntimeSpatialHash/RuntimeSpatialHashGridHelper.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
CellSize int64   WorldPartition/RuntimeSpatialHash/RuntimeSpatialHashGridHelper.h  
GridSize int64   WorldPartition/RuntimeSpatialHash/RuntimeSpatialHashGridHelper.h  
Origin FVector2D   WorldPartition/RuntimeSpatialHash/RuntimeSpatialHashGridHelper.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

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

   WorldPartition/RuntimeSpatialHash/RuntimeSpatialHashGridHelper.h  

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

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

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

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

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

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

bool GetCellBounds ( int64 InIndex,
FBox2D& OutBounds
) const

 Returns the cell bounds WorldPartition/RuntimeSpatialHash/RuntimeSpatialHashGridHelper.h  

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

 Returns the cell bounds WorldPartition/RuntimeSpatialHash/RuntimeSpatialHashGridHelper.h  

bool GetCellCoords ( const FVector2D& InPos,
FGridCellCoord2& OutCoords
) const

 Returns the cell coordinates of the provided position WorldPartition/RuntimeSpatialHash/RuntimeSpatialHashGridHelper.h  

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

 Returns the cells coordinates of the provided box WorldPartition/RuntimeSpatialHash/RuntimeSpatialHashGridHelper.h  

bool GetCellIndex ( const FGridCellCoord2& InCoords,
uint64& OutIndex
) const

 Returns the cell index of the provided coords WorldPartition/RuntimeSpatialHash/RuntimeSpatialHashGridHelper.h  

bool GetCellIndex ( const FVector& InPos,
uint64& OutIndex
) const

 Returns the cell index of the provided position WorldPartition/RuntimeSpatialHash/RuntimeSpatialHashGridHelper.h  

int32 GetNumIntersectingCells ( const FBox& InBox
) const

 Get the number of intersecting cells of the provided box WorldPartition/RuntimeSpatialHash/RuntimeSpatialHashGridHelper.h  

bool IsValidCoords ( const FGridCellCoord2& InCoords
) const

 Validate that the coordinates fit the grid size 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