1. Epic GamesDeveloper
  3. TBlockedDenseGrid3

TBlockedDenseGrid3

TBlockedDenseGrid adds thread-safe access functions to the 3D blocked uniform grid, [TBasicBlockedDenseGrid3](API\Runtime\GeometryCore\Spatial\TBasicBlockedDenseGrid3).

API > API/Runtime > API/Runtime/GeometryCore > API/Runtime/GeometryCore/Spatial

Inheritance Hierarchy

References

   
Module GeometryCore
Header /Engine/Source/Runtime/GeometryCore/Public/Spatial/BlockedDenseGrid3.h
Include #include "Spatial/BlockedDenseGrid3.h"

Syntax

template<typename ElemType>  
class TBlockedDenseGrid3 : public UE::Geometry::TBasicBlockedDenseGrid3< ElemType, 32 >

Remarks

TBlockedDenseGrid adds thread-safe access functions to the 3D blocked uniform grid, TBasicBlockedDenseGrid3. Blocked grid is extended by adding internally owned locks for each data block.

The grid is allocated in BlockSize^3 blocks on-demand (BlockSize is a compile-time constant) allowing very large grids to be used without having to pre-allocate all the memory, eg for sparse/narrow-band use cases.

For multi-threaded applications where memory is a premium, consider using TBlockedGrid3 (above) as it gives better control over the individual blocks and allows the caller to manage the lifetime of any locks used.

Variables

  Type Name Description
Protected variable TArray< FCriticalSection > BlockLocks  

Constructors

  Type Name Description
Public function   Create empty grid
Public function  

TBlockedDenseGrid3 ( int32 DimI,
int32 DimJ,
int32 DimK,
ElemType InitialValue
)

 Create grid with specified domain.

Functions

  Type Name Description
Protected function FCriticalSection *

GetBlockLock ( int32 Index
)

 Skip range checks in non-debug builds
Public function ElemType

GetValueThreadSafe ( int32 I,
int32 J,
int32 K
)

  
Public function ElemType

GetValueThreadSafe ( const FVector3i& CellIJK
)

  
Public function Const bool

IsValidIndex ( FVector3i CellIJK
)

  
Public function void

ProcessValueThreadSafe ( int32 I,
int32 J,
int32 K,
ProcessFunc Func
)

 Call an external lambda with a reference to the grid value at (I,J,K).
Public function void

ProcessValueThreadSafe ( const FVector3i& CellIJK,
ProcessFunc Func
)

 Call an external lambda with a reference to the grid value at CellIJK.
Protected function ElemType

ReadValueThreadSafe ( int32 I,
int32 J,
int32 K
)

  
Public function void

Reset ()

 Discard all allocated blocks but retain grid dimensions
Public function void

Reset ( int32 DimI,
int32 DimJ,
int32 DimK,
ElemType InitialValue
)

 Reconfigure the grid to have the target dimensions and default value.
Public function void

Resize ( int32 DimI,
int32 DimJ,
int32 DimK
)

 Reconfigure the grid to have the target dimensions.
Public function void

SetValueThreadSafe ( const FVector3i& CellIJK,
ElemType NewValue
)

 Set the grid value at CellIJK, with internal locking, so it is safe to call this from multiple read & write threads
Public function void

SetValueThreadSafe ( int32 I,
int32 J,
int32 K,
ElemType NewValue
)

 Set the grid value at (I,J,K), with internal locking, so it is safe to call this from multiple read & write threads
Public function Const FVector3i

ToIndex ( int64 LinearIndex
)

 Convert a grid cell id to CellIJK coordinates
Public function Const int64

ToLinear ( const FVector3i& IJK
)

 Convert grid CellIJK coordinates to a linear ID, note this id is independent of the actual internal data storage.
Public function Const int64

ToLinear ( int32 X,
int32 Y,
int32 Z
)

 Convert grid CellIJK coordinates to a linear ID, note this id is independent of the actual internal data storage.
Protected function void

WriteValueThreadSafe ( int32 I,
int32 J,
int32 K,
FuncType Func
)

  

Typedefs

Name Description
BlockData3Type  
BlockedDenseGridType  
BlockedGrid3LayoutType  

Constants

Name Description
BlockElemCount  
BlockSize  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page