1. Epic GamesDeveloper
  3. FNegativeSpaceSampleSettings

FNegativeSpaceSampleSettings

API > API/Runtime > API/Runtime/GeometryCore

   
Name FNegativeSpaceSampleSettings
Type struct
Header File /Engine/Source/Runtime/GeometryCore/Public/CompGeom/ConvexDecomposition3.h
Include Path #include "CompGeom/ConvexDecomposition3.h"

Syntax

struct FNegativeSpaceSampleSettings

Constructors

Name Remarks Include Path Unreal Specifiers
  CompGeom/ConvexDecomposition3.h  

FNegativeSpaceSampleSettings ( int32 TargetNumSamples,
double MinSpacing,
double ReduceRadiusMargin
)

   CompGeom/ConvexDecomposition3.h  

Enums

Public

Name Remarks
EConfigDefaults Enum to manage settings configurations for FNegativeSpaceSampleSettings.
ESampleMethod  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bAllowSamplesInsideMesh bool Whether to allow samples to be added inside the mesh, based on winding number. Can enabled for non-solid meshes; note the convex decomposition should then set bTreatAsSolid to false as well. CompGeom/ConvexDecomposition3.h  
bAllowSamplesInsideSpheres bool Whether to allow samples w/ center inside other negative space spheres. CompGeom/ConvexDecomposition3.h  
bDeterministic bool Attempt to keep negative space computation deterministic, at some additional runtime cost. CompGeom/ConvexDecomposition3.h  
bOnlyConnectedToHull bool Whether to only consider negative space that is connected to the bounding convex hull, i.e., to ignore hollow inner pockets of negative space that cannot be reached from the outside (for VoxelSearch and Navigable methods) CompGeom/ConvexDecomposition3.h  
bRequireSearchSampleCoverage bool Whether to require that all candidate sample locations identified by Voxel Search are covered by negative space samples, up to the specified Min Sample Spacing. CompGeom/ConvexDecomposition3.h  
CustomRadiusMarginScale TFunction< double(const FDynamicMesh3 &Mesh, int32 NearTID, FVector3d QueryPos)> Optional function to define a bias (scalar multiplier) for the ReduceRadiusMargin value, to support scaling the tolerance based on location or direction to surfaces. CompGeom/ConvexDecomposition3.h  
MarchingCubesGridScale double Scale factor for marching cubes grid used for VoxelSearch-based methods. CompGeom/ConvexDecomposition3.h  
MaxVoxelsPerDim int32 Maximum number of voxels to use per dimension, when performing VoxelSearch. CompGeom/ConvexDecomposition3.h  
MinCustomMarginScale double Margin scales should be between this value and 1.0. CompGeom/ConvexDecomposition3.h  
MinRadius double Ignore spheres with smaller radius than this. CompGeom/ConvexDecomposition3.h  
MinSpacing double Minimum desired spacing between sampling spheres; not a strictly enforced bound. CompGeom/ConvexDecomposition3.h  
OptionalObstacleSDF TFunction< double(FVector Pos)> Optional function to define an obstacle SDF which the negative space should also stay out of. CompGeom/ConvexDecomposition3.h  
ReduceRadiusMargin double Space to allow between spheres and actual surface. CompGeom/ConvexDecomposition3.h  
SampleMethod ESampleMethod Method used to place samples. CompGeom/ConvexDecomposition3.h  
TargetNumSamples int32 Target number of spheres to use to cover negative space. Intended as a rough guide; actual number used may be larger or smaller. CompGeom/ConvexDecomposition3.h  
VoxelExpandBoundsFactor double How much to expand the bounding box used for voxel search algorithms. CompGeom/ConvexDecomposition3.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
AppliedScaleFactor double Track how the settings have been rescaled. CompGeom/ConvexDecomposition3.h  
ResultTransform FTransform Track how to transform back to the original space. CompGeom/ConvexDecomposition3.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ApplyDefaults ( EConfigDefaults Settings
)

 Note: Class member default values are held fixed to avoid changing results for existing callers Use this method to request newer, recommended defaults CompGeom/ConvexDecomposition3.h  

double GetAppliedScaleFactor()

   CompGeom/ConvexDecomposition3.h  

FTransform GetResultTransform()

   CompGeom/ConvexDecomposition3.h  

double ObstacleDistance ( const FVector3d& LocalPos
) const

 Helper to evaluate OptionalObstacleSDF for local positions CompGeom/ConvexDecomposition3.h  

void Rescale ( double ScaleFactor
)

   CompGeom/ConvexDecomposition3.h  

void Sanitize()

 Make sure the settings values are in valid ranges. CompGeom/ConvexDecomposition3.h  

void SetResultTransform ( FTransform InResultTransform
)

   CompGeom/ConvexDecomposition3.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page