UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::Geometry::FNegativeSpaceSampleSettings Struct Reference

#include <ConvexDecomposition3.h>

Public Types

enum class  ESampleMethod : uint8 { Uniform , VoxelSearch , NavigableVoxelSearch }
 
enum class  EConfigDefaults : uint8 { Latest }
 

Public Member Functions

 FNegativeSpaceSampleSettings ()=default
 
 FNegativeSpaceSampleSettings (int32 TargetNumSamples, double MinSpacing, double ReduceRadiusMargin)
 
void ApplyDefaults (EConfigDefaults Settings=EConfigDefaults::Latest)
 
double GetAppliedScaleFactor () const
 
void Rescale (double ScaleFactor)
 
void SetResultTransform (FTransform InResultTransform)
 
FTransform GetResultTransform () const
 
void Sanitize ()
 
double ObstacleDistance (const FVector3d &LocalPos) const
 

Public Attributes

ESampleMethod SampleMethod = ESampleMethod::Uniform
 
int32 TargetNumSamples = 30
 
double MinSpacing = 3.0
 
bool bAllowSamplesInsideSpheres = false
 
double ReduceRadiusMargin = 3.0
 
double MinRadius = 10.0
 
bool bRequireSearchSampleCoverage = false
 
bool bOnlyConnectedToHull = false
 
int32 MaxVoxelsPerDim = 128
 
bool bDeterministic = true
 
double MarchingCubesGridScale = .5
 
bool bAllowSamplesInsideMesh = false
 
double VoxelExpandBoundsFactor = 1.0
 
TFunction< double(FVector Pos)> OptionalObstacleSDF
 
TFunction< double(const FDynamicMesh3 &Mesh, int32 NearTID, FVector3d QueryPos)> CustomRadiusMarginScale
 
double MinCustomMarginScale = 1.0
 

Member Enumeration Documentation

◆ EConfigDefaults

◆ ESampleMethod

Enumerator
Uniform 
VoxelSearch 
NavigableVoxelSearch 

Constructor & Destructor Documentation

◆ FNegativeSpaceSampleSettings() [1/2]

UE::Geometry::FNegativeSpaceSampleSettings::FNegativeSpaceSampleSettings ( )
default

◆ FNegativeSpaceSampleSettings() [2/2]

UE::Geometry::FNegativeSpaceSampleSettings::FNegativeSpaceSampleSettings ( int32  TargetNumSamples,
double  MinSpacing,
double  ReduceRadiusMargin 
)
inline

Member Function Documentation

◆ ApplyDefaults()

void UE::Geometry::FNegativeSpaceSampleSettings::ApplyDefaults ( EConfigDefaults  Settings = EConfigDefaults::Latest)
inline

◆ GetAppliedScaleFactor()

double UE::Geometry::FNegativeSpaceSampleSettings::GetAppliedScaleFactor ( ) const
inline

◆ GetResultTransform()

FTransform UE::Geometry::FNegativeSpaceSampleSettings::GetResultTransform ( ) const
inline

◆ ObstacleDistance()

double UE::Geometry::FNegativeSpaceSampleSettings::ObstacleDistance ( const FVector3d LocalPos) const
inline

◆ Rescale()

void UE::Geometry::FNegativeSpaceSampleSettings::Rescale ( double  ScaleFactor)
inline

◆ Sanitize()

void UE::Geometry::FNegativeSpaceSampleSettings::Sanitize ( )
inline

◆ SetResultTransform()

void UE::Geometry::FNegativeSpaceSampleSettings::SetResultTransform ( FTransform  InResultTransform)
inline

Member Data Documentation

◆ bAllowSamplesInsideMesh

bool UE::Geometry::FNegativeSpaceSampleSettings::bAllowSamplesInsideMesh = false

◆ bAllowSamplesInsideSpheres

bool UE::Geometry::FNegativeSpaceSampleSettings::bAllowSamplesInsideSpheres = false

◆ bDeterministic

bool UE::Geometry::FNegativeSpaceSampleSettings::bDeterministic = true

◆ bOnlyConnectedToHull

bool UE::Geometry::FNegativeSpaceSampleSettings::bOnlyConnectedToHull = false

◆ bRequireSearchSampleCoverage

bool UE::Geometry::FNegativeSpaceSampleSettings::bRequireSearchSampleCoverage = false

◆ CustomRadiusMarginScale

TFunction<double(const FDynamicMesh3& Mesh, int32 NearTID, FVector3d QueryPos)> UE::Geometry::FNegativeSpaceSampleSettings::CustomRadiusMarginScale

◆ MarchingCubesGridScale

double UE::Geometry::FNegativeSpaceSampleSettings::MarchingCubesGridScale = .5

◆ MaxVoxelsPerDim

int32 UE::Geometry::FNegativeSpaceSampleSettings::MaxVoxelsPerDim = 128

◆ MinCustomMarginScale

double UE::Geometry::FNegativeSpaceSampleSettings::MinCustomMarginScale = 1.0

◆ MinRadius

double UE::Geometry::FNegativeSpaceSampleSettings::MinRadius = 10.0

◆ MinSpacing

double UE::Geometry::FNegativeSpaceSampleSettings::MinSpacing = 3.0

◆ OptionalObstacleSDF

TFunction<double(FVector Pos)> UE::Geometry::FNegativeSpaceSampleSettings::OptionalObstacleSDF

◆ ReduceRadiusMargin

double UE::Geometry::FNegativeSpaceSampleSettings::ReduceRadiusMargin = 3.0

◆ SampleMethod

ESampleMethod UE::Geometry::FNegativeSpaceSampleSettings::SampleMethod = ESampleMethod::Uniform

◆ TargetNumSamples

int32 UE::Geometry::FNegativeSpaceSampleSettings::TargetNumSamples = 30

◆ VoxelExpandBoundsFactor

double UE::Geometry::FNegativeSpaceSampleSettings::VoxelExpandBoundsFactor = 1.0

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