1. Epic GamesDeveloper
  3. TBasicBlockedDenseGrid3

TBasicBlockedDenseGrid3

[TBasicBlockedDenseGrid3](API\Runtime\GeometryCore\Spatial\TBasicBlockedDenseGrid3) represents a 3D blocked uniform grid.

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, int32 BlockSize_>  
class TBasicBlockedDenseGrid3 : public UE::Geometry::TBlockedGrid3Layout< BlockSize_ >

Remarks

TBasicBlockedDenseGrid3 represents a 3D blocked uniform grid.

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.

Block-level default values are returned when querying a grid cell in an unallocated block.

For multi-threaded applications consider using the derived classes TBlockedDenseGrid3 which manages internal locks, or TBlockedGrid3 with your own lock provider.

Variables

  Type Name Description
Protected variable TArray< FBlock3 > Blocks  
Protected variable ElemType DefaultValue The value to use to initialize new blocks

Constructors

  Type Name Description
Public function   Create empty grid
Public function  

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

 Create grid with specified domain.

Functions

  Type Name Description
Protected function bool

AllocateTopologyUnionImpl ( const OtherGridType& OtherGrid
)

  
Protected function Const const FBlock3 &

GetBlock ( int32 Index
)

  
Protected function FBlock3 &

GetBlock ( int32 Index
)

 Skip range checks in non-debug builds
Public function Const int32  
Public function Const ElemType

GetValue ( int32 I,
int32 J,
int32 K
)

  
Public function Const ElemType

GetValue ( const FVector3i& CellIJK
)

  
Protected function Const bool

IsBlockAllocated ( const FBlock3& Block
)

  
Protected function Const bool

IsBlockAllocated ( const int32 BlockIndex
)

  
Public function bool

PreAllocateFromSourceGrid ( const TBasicBlockedDenseGrid3< OtherElemType, BlockSize >& SourceGrid
)

 Pre-allocate the grid blocks that also exist in SourceGrid of the same dimensions.
Public function void

ProcessValue ( const FVector3i& CellIJK,
ProcessFunc Func
)

 Call an external lambda with a reference to the grid value at CellIJK.
Public function void

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

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

ReadValue ( int32 I,
int32 J,
int32 K
)

  
Protected function Const ElemType

ReadValue ( const int32& BlockIndex,
const int32& LocalIndex
)

  
Protected function ElemType

ReadValueWithLock ( const int32& BlockIndex,
const int32& LocalIndex,
FCriticalSection* CriticalSection
)

  
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

SetValue ( const FVector3i& CellIJK,
ElemType NewValue
)

 Set the grid value at CellIJK
Public function void

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

 Set the grid value at (I,J,K)
Protected function BlockData3Type &

TouchBlockData ( const int32 BlockIndex
)

 Return a reference to the block data buffer associated with the specified block, allocating if needed
Protected function void

WriteValue ( const int32& BlockIndex,
const int32& LocalIndex,
FuncType Func
)

 Write methods
Protected function void

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

  
Protected function void

WriteValueWithLock ( const int32& BlockIndex,
const int32& LocalIndex,
FuncType Func,
FCriticalSection* CriticalSection
)

  

Classes

  Type Name Description
Protected struct FBlock3 A default value and a pointer to a block that will be allocated on first write.  

Typedefs

Name Description
BlockData3Type  
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