1. Epic GamesDeveloper
  3. FMeshSurfacePointSampling

FMeshSurfacePointSampling

[FMeshSurfacePointSampling](API\Runtime\GeometryCore\FMeshSurfacePointSampling) computes oriented point samples on the surface of a Mesh using various sampling strategies, with controls over sample spacing.

API > API/Runtime > API/Runtime/GeometryCore

FMeshSurfacePointSampling computes oriented point samples on the surface of a Mesh using various sampling strategies, with controls over sample spacing.

   
Name FMeshSurfacePointSampling
Type class
Header File /Engine/Source/Runtime/GeometryCore/Public/Sampling/MeshSurfacePointSampling.h
Include Path #include "Sampling/MeshSurfacePointSampling.h"

Syntax

class FMeshSurfacePointSampling

Enums

Public

Name Remarks
EInterpretWeightMode Control how active Weights are used to affect point radius
ESizeDistribution Controls the distribution of sample radii

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
BarycentricCoords TArray< FVector3d > Barycentric Coordinates of each Sample Point in it's respective Triangle. Sampling/MeshSurfacePointSampling.h  
bComputeBarycentrics bool If true, barycentric coordinates output array will be populated Sampling/MeshSurfacePointSampling.h  
bInvertWeights bool If true, weights are inverted Sampling/MeshSurfacePointSampling.h  
bUseVertexWeights bool Control whether VertexWeights (if valid) will be interpolated to modulate sampling Sampling/MeshSurfacePointSampling.h  
InterpretWeightMode EInterpretWeightMode Active weight interpretation mode Sampling/MeshSurfacePointSampling.h  
MaxSampleRadius double Parameters for non-uniform / variable-radius sampling. Sampling/MeshSurfacePointSampling.h  
MaxSamples uint32 Maximum number of samples requested. If 0 or default value, mesh will be maximally sampled Sampling/MeshSurfacePointSampling.h  
MaxSubSamplePoints int32 Safety threshold for maximum number of points in subsampling. Sampling/MeshSurfacePointSampling.h  
Radii TArray< double > Radius of each Sample Point, length is the same as Samples array Sampling/MeshSurfacePointSampling.h  
RandomSeed int32 Random Seed used to initialize sampling strategies Sampling/MeshSurfacePointSampling.h  
Result FGeometryResult TODO: when MaxSamples is set, it would be useful to be able to use Weight to modulate positional distribution instead of radius, (or both!) Outputs Result of last computation Sampling/MeshSurfacePointSampling.h  
SampleRadius double Basic sampling parameters Desired "radius" of sample points. Sampling/MeshSurfacePointSampling.h  
Samples TArray< FFrame3d > Oriented Sample Points on the mesh surface. Sampling/MeshSurfacePointSampling.h  
SamplingMethodVersion int32 If < 0, the latest, recommended sampling methods will be used. Sampling/MeshSurfacePointSampling.h  
SizeDistribution ESizeDistribution Active Size Distribution mode Sampling/MeshSurfacePointSampling.h  
SizeDistributionPower double Used to define how extreme the Size Distribution shift is. Valid range is [1,10] Sampling/MeshSurfacePointSampling.h  
SubSampleDensity double Density of subsampling used in Poisson strategy. Sampling/MeshSurfacePointSampling.h  
TriangleIDs TArray< int32 > Triangle that contains each Sample Point, length is the same as Samples array Sampling/MeshSurfacePointSampling.h  
VertexWeights TArray< double > Per-vertex weights, size must be == Max Vertex Index of input Mesh Sampling/MeshSurfacePointSampling.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ComputePoissonSampling ( const FDynamicMesh3& Mesh,
FProgressCancel* Progress
)

 Compute an approximate Poisson sampling of the mesh, either uniform or non-uniform depending on the settings above. Sampling/MeshSurfacePointSampling.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page