MeshLib Documentation
Loading...
Searching...
No Matches
MR::DecimateSettings Struct Reference

Parameters structure for MR::decimateMesh. More...

#include <MRMeshDecimate.h>

Public Attributes

DecimateStrategy strategy = DecimateStrategy::MinimizeError
 
float maxError = FLT_MAX
 
float maxEdgeLen = FLT_MAX
 Maximal possible edge length created during decimation.
 
float maxBdShift = FLT_MAX
 Maximal shift of a boundary during one edge collapse.
 
float maxTriangleAspectRatio = 20
 Maximal possible aspect ratio of a triangle introduced during decimation.
 
float criticalTriAspectRatio = FLT_MAX
 
float tinyEdgeLength = -1
 edges not longer than this value will be collapsed even if it results in appearance of a triangle with high aspect ratio
 
float stabilizer = 0.001f
 
bool optimizeVertexPos = true
 
int maxDeletedVertices = INT_MAX
 Limit on the number of deleted vertices.
 
int maxDeletedFaces = INT_MAX
 Limit on the number of deleted faces.
 
FaceBitSet * region = nullptr
 Region on mesh to be decimated, it is updated during the operation.
 
UndirectedEdgeBitSet * notFlippable = nullptr
 Edges specified by this bit-set will never be flipped, but they can be collapsed or replaced during collapse of nearby edges so it is updated during the operation.
 
bool collapseNearNotFlippable = false
 
UndirectedEdgeBitSet * edgesToCollapse = nullptr
 
UndirectedEdgeHashMaptwinMap = nullptr
 
bool touchNearBdEdges = true
 Whether to allow collapsing or flipping edges having at least one vertex on (region) boundary.
 
bool touchBdVerts = true
 
const VertBitSet * bdVerts = nullptr
 
float maxAngleChange = -1
 
PreCollapseCallback preCollapse
 The user can provide this optional callback that is invoked immediately before edge collapse;.
 
std::function< void(UndirectedEdgeId ue, float &collapseErrorSq, Vector3f &collapsePos)> adjustCollapse
 The user can provide this optional callback for adjusting error introduced by this edge collapse and the collapse position.
 
std::function< void(EdgeId del, EdgeId rem)> onEdgeDel
 
Vector< QuadraticForm3f, VertId > * vertForms = nullptr
 If not null, then vertex quadratic forms are stored there; if on input the vector is not empty then initialization is skipped in favor of values from there; on output: quadratic form for each remaining vertex is returned there.
 
bool packMesh = false
 whether to pack mesh at the end
 
ProgressCallback progressCallback
 callback to report algorithm progress and cancel it by user request
 
int subdivideParts = 1
 
bool decimateBetweenParts = true
 
std::vector< FaceBitSet > * partFaces = nullptr
 
int minFacesInPart = 0
 minimum number of faces in one subdivision part for ( subdivideParts > 1 ) mode
 

Detailed Description

Parameters structure for MR::decimateMesh.

See also
decimateMesh

Member Data Documentation

◆ adjustCollapse

std::function<void( UndirectedEdgeId ue, float & collapseErrorSq, Vector3f & collapsePos )> MR::DecimateSettings::adjustCollapse

The user can provide this optional callback for adjusting error introduced by this edge collapse and the collapse position.

On input the callback gets the squared error and position computed by standard means, and callback can modify any of them. The larger the error, the later this edge will be collapsed. This callback can be called from many threads in parallel and must be thread-safe. This callback can be called many times for each edge before real collapsing, and it is important to make the same adjustment.

◆ bdVerts

const VertBitSet* MR::DecimateSettings::bdVerts = nullptr

if touchNearBdEdges=false or touchBdVerts=false then the algorithm needs to know about all boundary vertices; if the pointer is not null then boundary vertices detection is replaced with testing values in this bit-set

◆ collapseNearNotFlippable

bool MR::DecimateSettings::collapseNearNotFlippable = false

Whether to allow collapse of edges incident to notFlippable edges, which can move vertices of notFlippable edges unless they are fixed

◆ criticalTriAspectRatio

float MR::DecimateSettings::criticalTriAspectRatio = FLT_MAX

the algorithm will ignore dihedral angle check if one of triangles had aspect ratio equal or more than this value; and the algorithm will permit temporary increase in aspect ratio after collapse, if before collapse one of the triangles had larger aspect ratio

◆ decimateBetweenParts

bool MR::DecimateSettings::decimateBetweenParts = true

After parallel decimation of all mesh parts is done, whether to perform final decimation of whole mesh region to eliminate small edges near the border of individual parts

◆ edgesToCollapse

UndirectedEdgeBitSet* MR::DecimateSettings::edgesToCollapse = nullptr

If pointer is not null, then only edges from here can be collapsed (and some nearby edges can disappear); the algorithm updates this map during collapses, removing or replacing elements

◆ maxAngleChange

float MR::DecimateSettings::maxAngleChange = -1

Permit edge flips (in addition to collapsing) to improve Delone quality of the mesh if it does not change dihedral angle more than on this value (negative value prohibits any edge flips)

◆ maxBdShift

float MR::DecimateSettings::maxBdShift = FLT_MAX

Maximal shift of a boundary during one edge collapse.

◆ maxDeletedFaces

int MR::DecimateSettings::maxDeletedFaces = INT_MAX

Limit on the number of deleted faces.

◆ maxDeletedVertices

int MR::DecimateSettings::maxDeletedVertices = INT_MAX

Limit on the number of deleted vertices.

◆ maxEdgeLen

float MR::DecimateSettings::maxEdgeLen = FLT_MAX

Maximal possible edge length created during decimation.

◆ maxError

float MR::DecimateSettings::maxError = FLT_MAX

for DecimateStrategy::MinimizeError: stop the decimation as soon as the estimated distance deviation from the original mesh is more than this value for DecimateStrategy::ShortestEdgeFirst only: stop the decimation as soon as the shortest edge in the mesh is greater than this value

◆ maxTriangleAspectRatio

float MR::DecimateSettings::maxTriangleAspectRatio = 20

Maximal possible aspect ratio of a triangle introduced during decimation.

◆ minFacesInPart

int MR::DecimateSettings::minFacesInPart = 0

minimum number of faces in one subdivision part for ( subdivideParts > 1 ) mode

◆ notFlippable

UndirectedEdgeBitSet* MR::DecimateSettings::notFlippable = nullptr

Edges specified by this bit-set will never be flipped, but they can be collapsed or replaced during collapse of nearby edges so it is updated during the operation.

◆ onEdgeDel

std::function<void( EdgeId del, EdgeId rem )> MR::DecimateSettings::onEdgeDel

this function is called each time edge (del) is deleted; if valid (rem) is given then dest(del) = dest(rem) and their origins are in different ends of collapsing edge, (rem) shall take the place of (del)

◆ optimizeVertexPos

bool MR::DecimateSettings::optimizeVertexPos = true

if true then after each edge collapse the position of remaining vertex is optimized to minimize local shape change, if false then the edge is collapsed in one of its vertices, which keeps its position

◆ packMesh

bool MR::DecimateSettings::packMesh = false

whether to pack mesh at the end

◆ partFaces

std::vector<FaceBitSet>* MR::DecimateSettings::partFaces = nullptr

if not null, then it contains the faces of each subdivision part on input, which must not overlap, and after decimation of all parts, the region inside each part is put here; decimateBetweenParts=true or packMesh=true are not compatible with this option

◆ preCollapse

PreCollapseCallback MR::DecimateSettings::preCollapse

The user can provide this optional callback that is invoked immediately before edge collapse;.

It receives the edge being collapsed: its destination vertex will disappear, and its origin vertex will get new position (provided as the second argument) after collapse; If the callback returns false, then the collapse is prohibited

◆ progressCallback

ProgressCallback MR::DecimateSettings::progressCallback

callback to report algorithm progress and cancel it by user request

◆ region

FaceBitSet* MR::DecimateSettings::region = nullptr

Region on mesh to be decimated, it is updated during the operation.

◆ stabilizer

float MR::DecimateSettings::stabilizer = 0.001f

Small stabilizer is important to achieve good results on completely planar mesh parts, if your mesh is not-planer everywhere, then you can set it to zero

◆ strategy

DecimateStrategy MR::DecimateSettings::strategy = DecimateStrategy::MinimizeError

◆ subdivideParts

int MR::DecimateSettings::subdivideParts = 1

If this value is more than 1, then virtually subdivides the mesh on given number of parts to process them in parallel (using many threads); IMPORTANT: please call mesh.packOptimally() before calling decimating with subdivideParts > 1, otherwise performance will be bad

◆ tinyEdgeLength

float MR::DecimateSettings::tinyEdgeLength = -1

edges not longer than this value will be collapsed even if it results in appearance of a triangle with high aspect ratio

◆ touchBdVerts

bool MR::DecimateSettings::touchBdVerts = true

touchBdVerts=true: allow moving and eliminating boundary vertices during edge collapses; touchBdVerts=false: allow only collapsing an edge having only one boundary vertex in that vertex, so position and count of boundary vertices do not change; this setting is ignored if touchNearBdEdges=false

◆ touchNearBdEdges

bool MR::DecimateSettings::touchNearBdEdges = true

Whether to allow collapsing or flipping edges having at least one vertex on (region) boundary.

◆ twinMap

UndirectedEdgeHashMap* MR::DecimateSettings::twinMap = nullptr

if an edge present as a key in this map is flipped or collapsed, then same happens to the value-edge (with same collapse position); the algorithm updates this map during collapses, removing or replacing elements

◆ vertForms

Vector<QuadraticForm3f, VertId>* MR::DecimateSettings::vertForms = nullptr

If not null, then vertex quadratic forms are stored there; if on input the vector is not empty then initialization is skipped in favor of values from there; on output: quadratic form for each remaining vertex is returned there.


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