1. Epic GamesDeveloper
  3. TPointHashGrid3

TPointHashGrid3

Hash Grid for values associated with 3D points.

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

References

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

Syntax

template<typename PointDataType, typename RealType>  
class TPointHashGrid3

Remarks

Hash Grid for values associated with 3D points.

This class addresses the situation where you have a list of (point, point_data) and you would like to be able to do efficient proximity queries, i.e. find the nearest point_data for a given query point.

We don't store copies of the 3D points. You provide a point_data type. This could just be the integer index into your list for example, a pointer to something more complex, etc. Insert and Remove functions require you to pass in the 3D point for the point_data. To Update a point you need to know its old and new 3D coordinates.

Constructors

  Type Name Description
Public function  

TPointHashGrid3 ( RealType cellSize,
PointDataType InvalidValue
)

 Construct 3D hash grid

Functions

  Type Name Description
Public function Const void

EnumeratePointsInBall ( const TVector< RealType >& QueryPoint,
RealType Radius,
TFunctionRef< RealType(const PointDataType&)> DistanceSqFunc,
TFunctionRef< bool(PointDataType, double)> ProcessPointFunc,
TFunctionRef< bool(const PointDataType&)> IgnoreFunc
)

 Call ProcessPointFunc on all points in grid within a given sphere, or until the function returns false Note: Not thread-safe to update, remove or insert points during enumeration.
Public function Const TPair< PointDataType, RealType >

FindAnyInRadius ( const TVector< RealType >& QueryPoint,
RealType Radius,
TFunctionRef< RealType(const PointDataType&)> DistanceSqFunc,
TFunctionRef< bool(const PointDataType&)> IgnoreFunc
)

 Find any point within radius.
Public function Const TPair< PointDataType, RealType >

FindAnyInRadius ( const TVector< RealType >& QueryPoint,
RealType Radius,
TFunctionRef< RealType(const PointDataType&)> DistanceSqFunc
)

  
Public function Const TPair< PointDataType, RealType >

FindNearestInRadius ( const TVector< RealType >& QueryPoint,
RealType Radius,
TFunctionRef< RealType(const PointDataType&)> DistanceSqFunc
)

  
Public function Const TPair< PointDataType, RealType >

FindNearestInRadius ( const TVector< RealType >& QueryPoint,
RealType Radius,
TFunctionRef< RealType(const PointDataType&)> DistanceSqFunc,
TFunctionRef< bool(const PointDataType&)> IgnoreFunc
)

 Find nearest point within radius.
Public function Const int

FindPointsInBall ( const TVector< RealType >& QueryPoint,
RealType Radius,
TFunctionRef< RealType(const PointDataType&)> DistanceSqFunc,
TArray< PointDataType >& ResultsOut,
TFunctionRef< bool(const PointDataType&)> IgnoreFunc
)

 Find all points in grid within a given sphere.
Public function Const PointDataType Invalid grid value
Public function void

InsertPoint ( const PointDataType& Value,
const TVector< RealType >& Position
)

 Insert at given position. This function is thread-safe.
Public function void

InsertPointUnsafe ( const PointDataType& Value,
const TVector< RealType >& Position
)

 Insert at given position, without locking / thread-safety
Public function bool

IsCellEmpty ( const TVector< RealType >& Position
)

 Test if the cell containing Position is empty.
Public function bool

IsCellEmptyUnsafe ( const TVector< RealType >& Position
)

 Test if the whole cell containing Position is empty, without locking / thread-safety Can be used to skip a more expensive range search, in some cases.
Public function bool

RemovePoint ( const PointDataType& Value,
const TVector< RealType >& Position
)

 Remove at given position. This function is thread-safe.
Public function bool

RemovePointUnsafe ( const PointDataType& Value,
const TVector< RealType >& Position
)

 Remove at given position, without locking / thread-safety
Public function void

Reserve ( int32 Num
)

 Reserve space in the underlying hash map
Public function void

UpdatePoint ( const PointDataType& Value,
const TVector< RealType >& OldPosition,
const TVector< RealType >& NewPosition
)

 Move value from old to new position. This function is thread-safe.
Public function void

UpdatePointUnsafe ( const PointDataType& Value,
const TVector< RealType >& OldPosition,
const TVector< RealType >& NewPosition
)

 Move value from old to new position, without locking / thread-safety

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page