UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FVoronoiDiagramField Class Reference

#include <Voronoi.h>

Public Member Functions

 FVoronoiDiagramField ()=default
 
 FVoronoiDiagramField (const TArray< FVector > &SitesIn, const FBox &Bounds, double SquaredDistSkipPtThreshold=DBL_EPSILON)
 
void Initialize (const TArray< FVector > &SitesIn, const FBox &Bounds, double SquaredDistSkipPtThreshold=DBL_EPSILON)
 
 FVoronoiDiagramField (const FVoronoiDiagramField &Other)=delete
 
FVoronoiDiagramFieldoperator= (const FVoronoiDiagramField &Other)=delete
 
 FVoronoiDiagramField (FVoronoiDiagramField &&Other)=default
 
FVoronoiDiagramFieldoperator= (FVoronoiDiagramField &&Other)=default
 
FVoronoiComputeHelper GetComputeHelper () const
 
double DistanceToCellWall (const FVector &Sample, FVoronoiComputeHelper &ComputeHelper, double InvalidValue=TNumericLimits< double >::Lowest())
 
TPair< int32, int32ClosestTwoIDs (const FVector &Sample, FVoronoiComputeHelper &ComputeHelper)
 
double DistanceToClosest (const FVector &Sample, FVoronoiComputeHelper &ComputeHelper, double InvalidValue=TNumericLimits< double >::Lowest())
 
int32 ClosestID (const FVector &Sample, FVoronoiComputeHelper &ComputeHelper)
 

Detailed Description

Use a Voronoi diagram to support faster querying of Voronoi-like data from arbitrary sample points:

  • Distance to closest point
  • ID of closest point
  • IDs of closest two points
  • Distance to closest Voronoi cell boundary (not considering bounding box walls)

Note: Queries are only thread safe if each thread has its own FVoronoiComputeHelper

Constructor & Destructor Documentation

◆ FVoronoiDiagramField() [1/4]

FVoronoiDiagramField::FVoronoiDiagramField ( )
default

◆ FVoronoiDiagramField() [2/4]

FVoronoiDiagramField::FVoronoiDiagramField ( const TArray< FVector > &  SitesIn,
const FBox Bounds,
double  SquaredDistSkipPtThreshold = DBL_EPSILON 
)
inline

◆ FVoronoiDiagramField() [3/4]

FVoronoiDiagramField::FVoronoiDiagramField ( const FVoronoiDiagramField Other)
delete

◆ FVoronoiDiagramField() [4/4]

FVoronoiDiagramField::FVoronoiDiagramField ( FVoronoiDiagramField &&  Other)
default

Member Function Documentation

◆ ClosestID()

int32 FVoronoiDiagramField::ClosestID ( const FVector Sample,
FVoronoiComputeHelper ComputeHelper 
)
inline

◆ ClosestTwoIDs()

TPair< int32, int32 > FVoronoiDiagramField::ClosestTwoIDs ( const FVector Sample,
FVoronoiComputeHelper ComputeHelper 
)
inline

◆ DistanceToCellWall()

double FVoronoiDiagramField::DistanceToCellWall ( const FVector Sample,
FVoronoiComputeHelper ComputeHelper,
double  InvalidValue = TNumericLimits<double>::Lowest() 
)
inline

◆ DistanceToClosest()

double FVoronoiDiagramField::DistanceToClosest ( const FVector Sample,
FVoronoiComputeHelper ComputeHelper,
double  InvalidValue = TNumericLimits<double>::Lowest() 
)
inline

◆ GetComputeHelper()

FVoronoiComputeHelper FVoronoiDiagramField::GetComputeHelper ( ) const
inline

◆ Initialize()

void FVoronoiDiagramField::Initialize ( const TArray< FVector > &  SitesIn,
const FBox Bounds,
double  SquaredDistSkipPtThreshold = DBL_EPSILON 
)
inline

◆ operator=() [1/2]

FVoronoiDiagramField & FVoronoiDiagramField::operator= ( const FVoronoiDiagramField Other)
delete

◆ operator=() [2/2]

FVoronoiDiagramField & FVoronoiDiagramField::operator= ( FVoronoiDiagramField &&  Other)
default

The documentation for this class was generated from the following file: