MeshLib C# Docs
Loading...
Searching...
No Matches
MR.Const_DecimateSettings Class Reference
+ Inheritance diagram for MR.Const_DecimateSettings:

Classes

struct  _Underlying
 

Public Member Functions

virtual void Dispose ()
 
unsafe Const_DecimateSettings ()
 Constructs an empty (default-constructed) instance.
 
unsafe Const_DecimateSettings (MR.DecimateStrategy strategy, float maxError, float maxEdgeLen, float maxBdShift, float maxTriangleAspectRatio, float criticalTriAspectRatio, float tinyEdgeLength, float stabilizer, bool angleWeightedDistToPlane, bool optimizeVertexPos, int maxDeletedVertices, int maxDeletedFaces, MR.FaceBitSet? region, MR.UndirectedEdgeBitSet? notFlippable, bool collapseNearNotFlippable, MR.UndirectedEdgeBitSet? edgesToCollapse, MR.Phmap.FlatHashMap_MRUndirectedEdgeId_MRUndirectedEdgeId? twinMap, bool touchNearBdEdges, bool touchBdVerts, MR.VertBitSet? bdVerts, float maxAngleChange, MR.Std._ByValue_Function_BoolFuncFromMREdgeIdConstMRVector3fRef preCollapse, MR.Std._ByValue_Function_VoidFuncFromMRUndirectedEdgeIdFloatRefMRVector3fRef adjustCollapse, MR.Std._ByValue_Function_VoidFuncFromMREdgeIdMREdgeId onEdgeDel, MR.Vector_MRQuadraticForm3f_MRVertId? vertForms, bool packMesh, MR.Std._ByValue_Function_BoolFuncFromFloat progressCallback, int subdivideParts, bool decimateBetweenParts, MR.Std.Vector_MRFaceBitSet? partFaces, int minFacesInPart)
 Constructs MR.DecimateSettings elementwise.
 
unsafe Const_DecimateSettings (MR._ByValue_DecimateSettings _other)
 Generated from constructor MR.DecimateSettings.DecimateSettings.
 

Protected Member Functions

virtual unsafe void Dispose (bool disposing)
 

Properties

unsafe MR.DecimateStrategy strategy [get]
 
unsafe float maxError [get]
 
unsafe float maxEdgeLen [get]
 Maximal possible edge length created during decimation.
 
unsafe float maxBdShift [get]
 Maximal shift of a boundary during one edge collapse.
 
unsafe float maxTriangleAspectRatio [get]
 Maximal possible aspect ratio of a triangle introduced during decimation.
 
unsafe float criticalTriAspectRatio [get]
 
unsafe float tinyEdgeLength [get]
 edges not longer than this value will be collapsed even if it results in appearance of a triangle with high aspect ratio
 
unsafe float stabilizer [get]
 
unsafe bool angleWeightedDistToPlane [get]
 
unsafe bool optimizeVertexPos [get]
 
unsafe int maxDeletedVertices [get]
 Limit on the number of deleted vertices.
 
unsafe int maxDeletedFaces [get]
 Limit on the number of deleted faces.
 
unsafe MR.? FaceBitSet region [get]
 Region on mesh to be decimated, it is updated during the operation.
 
unsafe MR.? UndirectedEdgeBitSet notFlippable [get]
 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.
 
unsafe bool collapseNearNotFlippable [get]
 
unsafe MR.? UndirectedEdgeBitSet edgesToCollapse [get]
 
unsafe MR.Phmap.? FlatHashMap_MRUndirectedEdgeId_MRUndirectedEdgeId twinMap [get]
 
unsafe bool touchNearBdEdges [get]
 Whether to allow collapsing or flipping edges having at least one vertex on (region) boundary.
 
unsafe bool touchBdVerts [get]
 
unsafe MR.? VertBitSet bdVerts [get]
 
unsafe float maxAngleChange [get]
 
unsafe MR.Std.Const_Function_BoolFuncFromMREdgeIdConstMRVector3fRef preCollapse [get]
 The user can provide this optional callback that is invoked immediately before edge collapse;.
 
unsafe MR.Std.Const_Function_VoidFuncFromMRUndirectedEdgeIdFloatRefMRVector3fRef adjustCollapse [get]
 The user can provide this optional callback for adjusting error introduced by this edge collapse and the collapse position.
 
unsafe MR.Std.Const_Function_VoidFuncFromMREdgeIdMREdgeId onEdgeDel [get]
 
unsafe MR.? Vector_MRQuadraticForm3f_MRVertId vertForms [get]
 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.
 
unsafe bool packMesh [get]
 whether to pack mesh at the end
 
unsafe MR.Std.Const_Function_BoolFuncFromFloat progressCallback [get]
 callback to report algorithm progress and cancel it by user request
 
unsafe int subdivideParts [get]
 
unsafe bool decimateBetweenParts [get]
 
unsafe MR.Std.? Vector_MRFaceBitSet partFaces [get]
 
unsafe int minFacesInPart [get]
 minimum number of faces in one subdivision part for ( subdivideParts > 1 ) mode
 
- Properties inherited from MR.Misc.Object< Const_DecimateSettings >
virtual bool _IsOwning [get]
 Returns true if this is an owning instance, and when disposed, will destroy the underlying C++ instance. If false, we assume that the underlying C++ instance will live long enough.
 

Additional Inherited Members

- Protected Attributes inherited from MR.Misc.Object< Const_DecimateSettings >
bool _IsOwningVal
 

Property Documentation

◆ adjustCollapse

unsafe MR.Std.Const_Function_VoidFuncFromMRUndirectedEdgeIdFloatRefMRVector3fRef MR.Const_DecimateSettings.adjustCollapse
get

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.

◆ angleWeightedDistToPlane

unsafe bool MR.Const_DecimateSettings.angleWeightedDistToPlane
get

if false, then quadratic error metric is equal to the sum of distances to the planes of original mesh triangles; if true, then the sum is weighted, and the weight is equal to the angle of adjacent triangle at the vertex divided on PI (to get one after summing all 3 vertices of the triangle)

◆ bdVerts

unsafe MR.? VertBitSet MR.Const_DecimateSettings.bdVerts
get

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; the algorithm updates this set if it packs the mesh

◆ collapseNearNotFlippable

unsafe bool MR.Const_DecimateSettings.collapseNearNotFlippable
get

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

◆ criticalTriAspectRatio

unsafe float MR.Const_DecimateSettings.criticalTriAspectRatio
get

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

unsafe bool MR.Const_DecimateSettings.decimateBetweenParts
get

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

unsafe MR.? UndirectedEdgeBitSet MR.Const_DecimateSettings.edgesToCollapse
get

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

unsafe float MR.Const_DecimateSettings.maxAngleChange
get

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)

◆ maxError

unsafe float MR.Const_DecimateSettings.maxError
get

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

◆ onEdgeDel

unsafe MR.Std.Const_Function_VoidFuncFromMREdgeIdMREdgeId MR.Const_DecimateSettings.onEdgeDel
get

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

unsafe bool MR.Const_DecimateSettings.optimizeVertexPos
get

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

◆ partFaces

unsafe MR.Std.? Vector_MRFaceBitSet MR.Const_DecimateSettings.partFaces
get

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

unsafe MR.Std.Const_Function_BoolFuncFromMREdgeIdConstMRVector3fRef MR.Const_DecimateSettings.preCollapse
get

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

◆ stabilizer

unsafe float MR.Const_DecimateSettings.stabilizer
get

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

◆ subdivideParts

unsafe int MR.Const_DecimateSettings.subdivideParts
get

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

◆ touchBdVerts

unsafe bool MR.Const_DecimateSettings.touchBdVerts
get

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

◆ twinMap

unsafe MR.Phmap.? FlatHashMap_MRUndirectedEdgeId_MRUndirectedEdgeId MR.Const_DecimateSettings.twinMap
get

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


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