MR.DetectTunnelSettings Class Reference

Generated from class MR.DetectTunnelSettings. This is the non-const half of the class. More...

Inheritance diagram for MR.DetectTunnelSettings:

Public Member Functions
unsafe	DetectTunnelSettings ()
	Constructs an empty (default-constructed) instance.
unsafe	DetectTunnelSettings (float maxTunnelLength, int maxIters, MR.Std._ByValue_Function_Float_From_MREdgeId metric, bool buildCoLoops, bool filterEquivalentCoLoops, MR.Std._ByValue_Function_Bool_From_Float progress)
	Constructs MR.DetectTunnelSettings elementwise.
unsafe	DetectTunnelSettings (MR._ByValue_DetectTunnelSettings _other)
	Generated from constructor MR.DetectTunnelSettings.DetectTunnelSettings.
	DetectTunnelSettings (Const_DetectTunnelSettings _other)
	Generated from constructor MR.DetectTunnelSettings.DetectTunnelSettings.
	DetectTunnelSettings (DetectTunnelSettings _other)
	Generated from constructor MR.DetectTunnelSettings.DetectTunnelSettings.
unsafe MR.DetectTunnelSettings	assign (MR._ByValue_DetectTunnelSettings _other)
	Generated from method MR::DetectTunnelSettings::operator=.
Public Member Functions inherited from MR.Const_DetectTunnelSettings
virtual void	Dispose ()
unsafe	Const_DetectTunnelSettings ()
	Constructs an empty (default-constructed) instance.
unsafe	Const_DetectTunnelSettings (float maxTunnelLength, int maxIters, MR.Std._ByValue_Function_Float_From_MREdgeId metric, bool buildCoLoops, bool filterEquivalentCoLoops, MR.Std._ByValue_Function_Bool_From_Float progress)
	Constructs MR.DetectTunnelSettings elementwise.
unsafe	Const_DetectTunnelSettings (MR._ByValue_DetectTunnelSettings _other)
	Generated from constructor MR.DetectTunnelSettings.DetectTunnelSettings.
	Const_DetectTunnelSettings (Const_DetectTunnelSettings _other)
	Generated from constructor MR.DetectTunnelSettings.DetectTunnelSettings.
	Const_DetectTunnelSettings (DetectTunnelSettings _other)
	Generated from constructor MR.DetectTunnelSettings.DetectTunnelSettings.

Properties
new unsafe ref float	maxTunnelLength [get]
	maximal euclidean length of tunnel loops to detect
new unsafe ref int	maxIters [get]
	maximal number of iterations to detect all tunnels; on a big mesh with many tunnels even one iteration can take a while
new unsafe MR.Std.Function_Float_From_MREdgeId	metric [get, protected set]
	edge metric that will be used in optimizations, if co-loops are enabled then this metric must be not-negative, if no metric is given then either discreteMinusAbsMeanCurvatureMetric (if buildCoLoops = false) or edgeLengthMetric (if buildCoLoops = true) will be used, using caching via edgeTableSymMetric function can improve the performance, especially in buildCoLoops = true mode
new unsafe ref bool	buildCoLoops [get]
	if true then for every basis loop, findSmallestMetricCoLoop will be called; it typically results in shorter tunnels found, but requires more time per iteration, and more iterations to find all tunnels
new unsafe ref bool	filterEquivalentCoLoops [get]
	if ( buildCoLoops ) then some tunnel loops can be equivalent (e.g. they cut the same handle twice), this option activates their filtering out, but it is very slow
new unsafe MR.Std.Function_Bool_From_Float	progress [get, protected set]
	to report algorithm progress and cancel from outside
Properties inherited from MR.Const_DetectTunnelSettings
unsafe float	maxTunnelLength [get]
	maximal euclidean length of tunnel loops to detect
unsafe int	maxIters [get]
	maximal number of iterations to detect all tunnels; on a big mesh with many tunnels even one iteration can take a while
unsafe MR.Std.Const_Function_Float_From_MREdgeId	metric [get, protected set]
	edge metric that will be used in optimizations, if co-loops are enabled then this metric must be not-negative, if no metric is given then either discreteMinusAbsMeanCurvatureMetric (if buildCoLoops = false) or edgeLengthMetric (if buildCoLoops = true) will be used, using caching via edgeTableSymMetric function can improve the performance, especially in buildCoLoops = true mode
unsafe bool	buildCoLoops [get]
	if true then for every basis loop, findSmallestMetricCoLoop will be called; it typically results in shorter tunnels found, but requires more time per iteration, and more iterations to find all tunnels
unsafe bool	filterEquivalentCoLoops [get]
	if ( buildCoLoops ) then some tunnel loops can be equivalent (e.g. they cut the same handle twice), this option activates their filtering out, but it is very slow
unsafe MR.Std.Const_Function_Bool_From_Float	progress [get, protected set]
	to report algorithm progress and cancel from outside

Additional Inherited Members
Protected Member Functions inherited from MR.Const_DetectTunnelSettings
virtual unsafe void	Dispose (bool disposing)
Protected Attributes inherited from MR.Const_DetectTunnelSettings
unsafe float *	__ref_storage_maxTunnelLength
unsafe int *	__ref_storage_maxIters
unsafe bool *	__ref_storage_buildCoLoops
unsafe bool *	__ref_storage_filterEquivalentCoLoops

Detailed Description

Generated from class MR.DetectTunnelSettings. This is the non-const half of the class.

Constructor & Destructor Documentation

DetectTunnelSettings() [1/5]

unsafe MR.DetectTunnelSettings.DetectTunnelSettings ( )

inline

Constructs an empty (default-constructed) instance.

DetectTunnelSettings() [2/5]

unsafe MR.DetectTunnelSettings.DetectTunnelSettings ( float maxTunnelLength, int maxIters, MR.Std._ByValue_Function_Float_From_MREdgeId metric, bool buildCoLoops, bool filterEquivalentCoLoops, MR.Std._ByValue_Function_Bool_From_Float progress )

inline

Constructs MR.DetectTunnelSettings elementwise.

DetectTunnelSettings() [3/5]

unsafe MR.DetectTunnelSettings.DetectTunnelSettings ( MR._ByValue_DetectTunnelSettings _other )

inline

Generated from constructor MR.DetectTunnelSettings.DetectTunnelSettings.

DetectTunnelSettings() [4/5]

MR.DetectTunnelSettings.DetectTunnelSettings ( Const_DetectTunnelSettings _other )

inline

Generated from constructor MR.DetectTunnelSettings.DetectTunnelSettings.

DetectTunnelSettings() [5/5]

MR.DetectTunnelSettings.DetectTunnelSettings ( DetectTunnelSettings _other )

inline

Generated from constructor MR.DetectTunnelSettings.DetectTunnelSettings.

Member Function Documentation

assign()

unsafe MR.DetectTunnelSettings MR.DetectTunnelSettings.assign ( MR._ByValue_DetectTunnelSettings _other )

inline

Generated from method MR::DetectTunnelSettings::operator=.

Property Documentation

buildCoLoops

new unsafe ref bool MR.DetectTunnelSettings.buildCoLoops

get

if true then for every basis loop, findSmallestMetricCoLoop will be called; it typically results in shorter tunnels found, but requires more time per iteration, and more iterations to find all tunnels

filterEquivalentCoLoops

new unsafe ref bool MR.DetectTunnelSettings.filterEquivalentCoLoops

get

if ( buildCoLoops ) then some tunnel loops can be equivalent (e.g. they cut the same handle twice), this option activates their filtering out, but it is very slow

maxIters

new unsafe ref int MR.DetectTunnelSettings.maxIters

get

maximal number of iterations to detect all tunnels; on a big mesh with many tunnels even one iteration can take a while

maxTunnelLength

new unsafe ref float MR.DetectTunnelSettings.maxTunnelLength

get

maximal euclidean length of tunnel loops to detect

metric

new unsafe MR.Std.Function_Float_From_MREdgeId MR.DetectTunnelSettings.metric

getprotected set

edge metric that will be used in optimizations, if co-loops are enabled then this metric must be not-negative, if no metric is given then either discreteMinusAbsMeanCurvatureMetric (if buildCoLoops = false) or edgeLengthMetric (if buildCoLoops = true) will be used, using caching via edgeTableSymMetric function can improve the performance, especially in buildCoLoops = true mode

progress

new unsafe MR.Std.Function_Bool_From_Float MR.DetectTunnelSettings.progress

getprotected set

to report algorithm progress and cancel from outside

---

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

• MRTunnelDetector.cs