UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
THierarchicalSpatialHashGrid< BlockTraitsType > Class Template Reference

#include <HierarchicalSpatialHashGrid.h>

Classes

struct  FCellBlock
 
struct  FHasher
 
struct  TFootprint
 

Public Types

using FBlockLoc = typename BlockTraitsType::FBlockLoc
 
using FLocation64 = RenderingSpatialHash::TLocation< int64 >
 
using FLocation32 = RenderingSpatialHash::TLocation< int32 >
 
using FLocation8 = RenderingSpatialHash::TLocation< int8 >
 
using FInt8Vector3 = UE::Math::TIntVector3< int8 >
 
using FFootprint64 = TFootprint< int64 >
 
using FFootprint32 = TFootprint< int32 >
 
using FFootprint8 = TFootprint< int8 >
 
using FSpatialHashMap = Experimental::TRobinHoodHashMap< FBlockLoc, FCellBlock, FHasher >
 
using FBlockId = Experimental::FHashElementId
 
using FHashElementId = Experimental::FHashElementId
 

Public Member Functions

 THierarchicalSpatialHashGrid ()=default
 
 THierarchicalSpatialHashGrid (double MinCellSize, double MaxCellSize)
 
void Empty ()
 
int32 GetMaxNumBlocks () const
 
double GetRecCellSize (int32 Level) const
 
FLocation64 ToCellLoc (int32 Level, const FVector &WorldPos) const
 
FFootprint64 CalcFootprintSphere (int32 Level, const FVector &Origin, double Radius) const
 
FFootprint64 CalcLevelAndFootprint (const FBoxSphereBounds &BoxSphereBounds) const
 
FLocation64 CalcLevelAndLocation (const FBoxSphereBounds &BoxSphereBounds) const
 
FLocation64 CalcLevelAndLocation (const FVector4d &Sphere) const
 
bool IsValidLevel (int32 Level) const
 
double GetLastLevelCellSize () const
 
double GetMaxCullingDistance () const
 
int32 NumLevels () const
 
FBox CalcCellBounds (const FLocation64 &CellLoc) const
 
FBox CalcBlockBounds (const FLocation64 &BlockLoc) const
 
FVector3d CalcBlockWorldPosition (const FLocation64 &BlockLoc) const
 
FVector3d CalcBlockWorldPosition (const FBlockLoc &BlockLoc) const
 
int32 GetFirstLevel () const
 
FCellBlock & GetBlockById (const FBlockId &BlockId)
 
const FCellBlock & GetBlockById (const FBlockId &BlockId) const
 
FBlockLoc GetBlockLocById (const FBlockId &BlockId) const
 
const FSpatialHashMap & GetHashMap () const
 
FSpatialHashMap & GetHashMap ()
 

Static Public Member Functions

static int32 CalcLevel (float Size)
 
static int32 CalcLevelFromRadius (float Radius)
 
static double GetCellSize (int32 Level)
 
static FFootprint64 CalcCellBlockFootprint (const FFootprint64 &Footprint)
 

Static Public Attributes

static constexpr int32 CellBlockDimLog2 = BlockTraitsType::CellBlockDimLog2
 
static constexpr int32 kMaxLevel = 64
 
static constexpr int32 NumCellsPerBlockLog2 = CellBlockDimLog2 * 3
 
static constexpr int32 CellBlockDim = 1 << CellBlockDimLog2
 
static constexpr uint32 LocalCellCoordMask = uint32(CellBlockDim) - 1U
 
static constexpr int32 CellBlockSize = CellBlockDim * CellBlockDim * CellBlockDim
 

Member Typedef Documentation

◆ FBlockId

template<typename BlockTraitsType >
using THierarchicalSpatialHashGrid< BlockTraitsType >::FBlockId = Experimental::FHashElementId

◆ FBlockLoc

template<typename BlockTraitsType >
using THierarchicalSpatialHashGrid< BlockTraitsType >::FBlockLoc = typename BlockTraitsType::FBlockLoc

◆ FFootprint32

template<typename BlockTraitsType >
using THierarchicalSpatialHashGrid< BlockTraitsType >::FFootprint32 = TFootprint<int32>

◆ FFootprint64

template<typename BlockTraitsType >
using THierarchicalSpatialHashGrid< BlockTraitsType >::FFootprint64 = TFootprint<int64>

◆ FFootprint8

template<typename BlockTraitsType >
using THierarchicalSpatialHashGrid< BlockTraitsType >::FFootprint8 = TFootprint<int8>

◆ FHashElementId

template<typename BlockTraitsType >
using THierarchicalSpatialHashGrid< BlockTraitsType >::FHashElementId = Experimental::FHashElementId

◆ FInt8Vector3

template<typename BlockTraitsType >
using THierarchicalSpatialHashGrid< BlockTraitsType >::FInt8Vector3 = UE::Math::TIntVector3<int8>

◆ FLocation32

template<typename BlockTraitsType >
using THierarchicalSpatialHashGrid< BlockTraitsType >::FLocation32 = RenderingSpatialHash::TLocation<int32>

◆ FLocation64

template<typename BlockTraitsType >
using THierarchicalSpatialHashGrid< BlockTraitsType >::FLocation64 = RenderingSpatialHash::TLocation<int64>

◆ FLocation8

template<typename BlockTraitsType >
using THierarchicalSpatialHashGrid< BlockTraitsType >::FLocation8 = RenderingSpatialHash::TLocation<int8>

◆ FSpatialHashMap

template<typename BlockTraitsType >
using THierarchicalSpatialHashGrid< BlockTraitsType >::FSpatialHashMap = Experimental::TRobinHoodHashMap<FBlockLoc, FCellBlock, FHasher>

Constructor & Destructor Documentation

◆ THierarchicalSpatialHashGrid() [1/2]

template<typename BlockTraitsType >
THierarchicalSpatialHashGrid< BlockTraitsType >::THierarchicalSpatialHashGrid ( )
default

◆ THierarchicalSpatialHashGrid() [2/2]

template<typename BlockTraitsType >
THierarchicalSpatialHashGrid< BlockTraitsType >::THierarchicalSpatialHashGrid ( double  MinCellSize,
double  MaxCellSize 
)
inline

Member Function Documentation

◆ CalcBlockBounds()

template<typename BlockTraitsType >
FBox THierarchicalSpatialHashGrid< BlockTraitsType >::CalcBlockBounds ( const FLocation64 &  BlockLoc) const
inline

◆ CalcBlockWorldPosition() [1/2]

template<typename BlockTraitsType >
FVector3d THierarchicalSpatialHashGrid< BlockTraitsType >::CalcBlockWorldPosition ( const FBlockLoc &  BlockLoc) const
inline

The reference location is always the minimum corner, unpadded by loose bounds expansion.

◆ CalcBlockWorldPosition() [2/2]

template<typename BlockTraitsType >
FVector3d THierarchicalSpatialHashGrid< BlockTraitsType >::CalcBlockWorldPosition ( const FLocation64 &  BlockLoc) const
inline

The reference location is always the minimum corner, unpadded by loose bounds expansion.

◆ CalcCellBlockFootprint()

template<typename BlockTraitsType >
static FFootprint64 THierarchicalSpatialHashGrid< BlockTraitsType >::CalcCellBlockFootprint ( const FFootprint64 &  Footprint)
inlinestatic

◆ CalcCellBounds()

template<typename BlockTraitsType >
FBox THierarchicalSpatialHashGrid< BlockTraitsType >::CalcCellBounds ( const FLocation64 &  CellLoc) const
inline

◆ CalcFootprintSphere()

template<typename BlockTraitsType >
FFootprint64 THierarchicalSpatialHashGrid< BlockTraitsType >::CalcFootprintSphere ( int32  Level,
const FVector &  Origin,
double  Radius 
) const
inline

◆ CalcLevel()

template<typename BlockTraitsType >
static int32 THierarchicalSpatialHashGrid< BlockTraitsType >::CalcLevel ( float  Size)
inlinestatic

◆ CalcLevelAndFootprint()

template<typename BlockTraitsType >
FFootprint64 THierarchicalSpatialHashGrid< BlockTraitsType >::CalcLevelAndFootprint ( const FBoxSphereBounds &  BoxSphereBounds) const
inline

◆ CalcLevelAndLocation() [1/2]

template<typename BlockTraitsType >
FLocation64 THierarchicalSpatialHashGrid< BlockTraitsType >::CalcLevelAndLocation ( const FBoxSphereBounds &  BoxSphereBounds) const
inline

◆ CalcLevelAndLocation() [2/2]

template<typename BlockTraitsType >
FLocation64 THierarchicalSpatialHashGrid< BlockTraitsType >::CalcLevelAndLocation ( const FVector4d &  Sphere) const
inline

◆ CalcLevelFromRadius()

template<typename BlockTraitsType >
static int32 THierarchicalSpatialHashGrid< BlockTraitsType >::CalcLevelFromRadius ( float  Radius)
inlinestatic

◆ Empty()

template<typename BlockTraitsType >
void THierarchicalSpatialHashGrid< BlockTraitsType >::Empty ( )
inline

◆ GetBlockById() [1/2]

template<typename BlockTraitsType >
FCellBlock & THierarchicalSpatialHashGrid< BlockTraitsType >::GetBlockById ( const FBlockId &  BlockId)
inline

◆ GetBlockById() [2/2]

template<typename BlockTraitsType >
const FCellBlock & THierarchicalSpatialHashGrid< BlockTraitsType >::GetBlockById ( const FBlockId &  BlockId) const
inline

◆ GetBlockLocById()

template<typename BlockTraitsType >
FBlockLoc THierarchicalSpatialHashGrid< BlockTraitsType >::GetBlockLocById ( const FBlockId &  BlockId) const
inline

◆ GetCellSize()

template<typename BlockTraitsType >
static double THierarchicalSpatialHashGrid< BlockTraitsType >::GetCellSize ( int32  Level)
inlinestatic

◆ GetFirstLevel()

template<typename BlockTraitsType >
int32 THierarchicalSpatialHashGrid< BlockTraitsType >::GetFirstLevel ( ) const
inline

◆ GetHashMap() [1/2]

template<typename BlockTraitsType >
FSpatialHashMap & THierarchicalSpatialHashGrid< BlockTraitsType >::GetHashMap ( )
inline

◆ GetHashMap() [2/2]

template<typename BlockTraitsType >
const FSpatialHashMap & THierarchicalSpatialHashGrid< BlockTraitsType >::GetHashMap ( ) const
inline

◆ GetLastLevelCellSize()

template<typename BlockTraitsType >
double THierarchicalSpatialHashGrid< BlockTraitsType >::GetLastLevelCellSize ( ) const
inline

◆ GetMaxCullingDistance()

template<typename BlockTraitsType >
double THierarchicalSpatialHashGrid< BlockTraitsType >::GetMaxCullingDistance ( ) const
inline

◆ GetMaxNumBlocks()

template<typename BlockTraitsType >
int32 THierarchicalSpatialHashGrid< BlockTraitsType >::GetMaxNumBlocks ( ) const
inline

◆ GetRecCellSize()

template<typename BlockTraitsType >
double THierarchicalSpatialHashGrid< BlockTraitsType >::GetRecCellSize ( int32  Level) const
inline

◆ IsValidLevel()

template<typename BlockTraitsType >
bool THierarchicalSpatialHashGrid< BlockTraitsType >::IsValidLevel ( int32  Level) const
inline

◆ NumLevels()

template<typename BlockTraitsType >
int32 THierarchicalSpatialHashGrid< BlockTraitsType >::NumLevels ( ) const
inline

◆ ToCellLoc()

template<typename BlockTraitsType >
FLocation64 THierarchicalSpatialHashGrid< BlockTraitsType >::ToCellLoc ( int32  Level,
const FVector &  WorldPos 
) const
inline

Member Data Documentation

◆ CellBlockDim

template<typename BlockTraitsType >
constexpr int32 THierarchicalSpatialHashGrid< BlockTraitsType >::CellBlockDim = 1 << CellBlockDimLog2
staticconstexpr

◆ CellBlockDimLog2

template<typename BlockTraitsType >
constexpr int32 THierarchicalSpatialHashGrid< BlockTraitsType >::CellBlockDimLog2 = BlockTraitsType::CellBlockDimLog2
staticconstexpr

◆ CellBlockSize

template<typename BlockTraitsType >
constexpr int32 THierarchicalSpatialHashGrid< BlockTraitsType >::CellBlockSize = CellBlockDim * CellBlockDim * CellBlockDim
staticconstexpr

◆ kMaxLevel

template<typename BlockTraitsType >
constexpr int32 THierarchicalSpatialHashGrid< BlockTraitsType >::kMaxLevel = 64
staticconstexpr

◆ LocalCellCoordMask

template<typename BlockTraitsType >
constexpr uint32 THierarchicalSpatialHashGrid< BlockTraitsType >::LocalCellCoordMask = uint32(CellBlockDim) - 1U
staticconstexpr

◆ NumCellsPerBlockLog2

template<typename BlockTraitsType >
constexpr int32 THierarchicalSpatialHashGrid< BlockTraitsType >::NumCellsPerBlockLog2 = CellBlockDimLog2 * 3
staticconstexpr
The documentation for this class was generated from the following file: