MeshLib Rust Docs
Loading...
Searching...
No Matches
meshlib::DetectTunnelSettings Struct Reference
Inheritance diagram for meshlib::DetectTunnelSettings:

Public Member Functions

auto assign_from_another (_other:&meshlib::DetectTunnelSettings) -> &mut meshlib::DetectTunnelSettings
auto max_tunnel_length () const -> &f32
auto max_tunnel_length_mut () -> &mut f32
void set_max_tunnel_length (value:f32)
auto max_iters () const -> &core::ffi::c_int
auto max_iters_mut () -> &mut core::ffi::c_int
void set_max_iters (value:core::ffi::c_int)
auto metric () const -> &meshlib::std_function_float_from_MR_EdgeId
auto metric_mut () -> &mut meshlib::std_function_float_from_MR_EdgeId
void set_metric (value:&meshlib::std_function_float_from_MR_EdgeId)
auto build_co_loops () const -> &bool
auto build_co_loops_mut () -> &mut bool
void set_build_co_loops (value:bool)
auto filter_equivalent_co_loops () const -> &bool
auto filter_equivalent_co_loops_mut () -> &mut bool
void set_filter_equivalent_co_loops (value:bool)
auto loop_type () const -> &meshlib::TunnelLoopType
auto loop_type_mut () -> &mut meshlib::TunnelLoopType
void set_loop_type (value:meshlib::TunnelLoopType)
auto progress () const -> &meshlib::std_function_bool_from_float
auto progress_mut () -> &mut meshlib::std_function_bool_from_float
void set_progress (value:&meshlib::std_function_bool_from_float)

Static Public Member Functions

static auto new () -> meshlib::Owned< meshlib::DetectTunnelSettings >
static auto construct_from (maxTunnelLength:f32, maxIters:core::ffi::c_int, metric:&meshlib::std_function_float_from_MR_EdgeId, buildCoLoops:bool, filterEquivalentCoLoops:bool, loopType:meshlib::TunnelLoopType, progress:&meshlib::std_function_bool_from_float) -> meshlib::Owned< meshlib::DetectTunnelSettings >
static auto construct_from_another (_other:&meshlib::DetectTunnelSettings) -> meshlib::Owned< meshlib::DetectTunnelSettings >
Static Public Member Functions inherited from meshlib::CppClass
static void destroy (ptr:*mut Self)
Static Public Member Functions inherited from meshlib::CppCopy
static auto copy (ptr:*const Self) -> *mut Self

Detailed Description

Generated from class MR::DetectTunnelSettings.

Generated from class MR::DetectTunnelSettings. Heap-allocated instances are held in Owned<DetectTunnelSettings>.

Member Function Documentation

◆ assign_from_another()

auto meshlib::DetectTunnelSettings::assign_from_another ( _other:&meshlib::DetectTunnelSettings ) -> &mut meshlib::DetectTunnelSettings

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

Calls MR_DetectTunnelSettings_AssignFromAnother(). The reference to things referred to by the parameter _other (if any) might be preserved in this object.

◆ build_co_loops()

auto meshlib::DetectTunnelSettings::build_co_loops ( ) const -> &bool

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 Returns a pointer to a member variable of class MR::DetectTunnelSettings named buildCoLoops.

Calls MR_DetectTunnelSettings_Get_buildCoLoops(). The reference to this object might be preserved as the return value.

◆ build_co_loops_mut()

auto meshlib::DetectTunnelSettings::build_co_loops_mut ( ) -> &mut bool

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 Returns a mutable pointer to a member variable of class MR::DetectTunnelSettings named buildCoLoops.

Calls MR_DetectTunnelSettings_GetMutable_buildCoLoops(). The reference to this object might be preserved as the return value.

◆ construct_from()

auto meshlib::DetectTunnelSettings::construct_from ( maxTunnelLength:f32 ,
maxIters:core::ffi::c_int ,
metric:&meshlib::std_function_float_from_MR_EdgeId ,
buildCoLoops:bool ,
filterEquivalentCoLoops:bool ,
loopType:meshlib::TunnelLoopType ,
progress:&meshlib::std_function_bool_from_float  ) -> meshlib::Owned< meshlib::DetectTunnelSettings >
static

Constructs MR::DetectTunnelSettings elementwise.

Calls MR_DetectTunnelSettings_ConstructFrom(). The reference to the parameter metric might be preserved in the constructed object. The reference to the parameter loopType might be preserved in the constructed object. The reference to the parameter progress might be preserved in the constructed object.

◆ construct_from_another()

auto meshlib::DetectTunnelSettings::construct_from_another ( _other:&meshlib::DetectTunnelSettings ) -> meshlib::Owned< meshlib::DetectTunnelSettings >
static

Generated from constructor MR::DetectTunnelSettings::DetectTunnelSettings.

Calls MR_DetectTunnelSettings_ConstructFromAnother(). The reference to things referred to by the parameter _other (if any) might be preserved in the constructed object.

◆ filter_equivalent_co_loops()

auto meshlib::DetectTunnelSettings::filter_equivalent_co_loops ( ) const -> &bool

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 Returns a pointer to a member variable of class MR::DetectTunnelSettings named filterEquivalentCoLoops.

Calls MR_DetectTunnelSettings_Get_filterEquivalentCoLoops(). The reference to this object might be preserved as the return value.

◆ filter_equivalent_co_loops_mut()

auto meshlib::DetectTunnelSettings::filter_equivalent_co_loops_mut ( ) -> &mut bool

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 Returns a mutable pointer to a member variable of class MR::DetectTunnelSettings named filterEquivalentCoLoops.

Calls MR_DetectTunnelSettings_GetMutable_filterEquivalentCoLoops(). The reference to this object might be preserved as the return value.

◆ loop_type()

auto meshlib::DetectTunnelSettings::loop_type ( ) const -> &meshlib::TunnelLoopType

selects what kind of loops to return Returns a pointer to a member variable of class MR::DetectTunnelSettings named loopType.

Calls MR_DetectTunnelSettings_Get_loopType(). The reference to this object might be preserved as the return value.

◆ loop_type_mut()

auto meshlib::DetectTunnelSettings::loop_type_mut ( ) -> &mut meshlib::TunnelLoopType

selects what kind of loops to return Returns a mutable pointer to a member variable of class MR::DetectTunnelSettings named loopType.

Calls MR_DetectTunnelSettings_GetMutable_loopType(). The reference to this object might be preserved as the return value.

◆ max_iters()

auto meshlib::DetectTunnelSettings::max_iters ( ) const -> &core::ffi::c_int

maximal number of iterations to detect all tunnels; on a big mesh with many tunnels even one iteration can take a while Returns a pointer to a member variable of class MR::DetectTunnelSettings named maxIters.

Calls MR_DetectTunnelSettings_Get_maxIters(). The reference to this object might be preserved as the return value.

◆ max_iters_mut()

auto meshlib::DetectTunnelSettings::max_iters_mut ( ) -> &mut core::ffi::c_int

maximal number of iterations to detect all tunnels; on a big mesh with many tunnels even one iteration can take a while Returns a mutable pointer to a member variable of class MR::DetectTunnelSettings named maxIters.

Calls MR_DetectTunnelSettings_GetMutable_maxIters(). The reference to this object might be preserved as the return value.

◆ max_tunnel_length()

auto meshlib::DetectTunnelSettings::max_tunnel_length ( ) const -> &f32

maximal euclidean length of tunnel loops to detect Returns a pointer to a member variable of class MR::DetectTunnelSettings named maxTunnelLength.

Calls MR_DetectTunnelSettings_Get_maxTunnelLength(). The reference to this object might be preserved as the return value.

◆ max_tunnel_length_mut()

auto meshlib::DetectTunnelSettings::max_tunnel_length_mut ( ) -> &mut f32

maximal euclidean length of tunnel loops to detect Returns a mutable pointer to a member variable of class MR::DetectTunnelSettings named maxTunnelLength.

Calls MR_DetectTunnelSettings_GetMutable_maxTunnelLength(). The reference to this object might be preserved as the return value.

◆ metric()

auto meshlib::DetectTunnelSettings::metric ( ) const -> &meshlib::std_function_float_from_MR_EdgeId

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 Returns a pointer to a member variable of class MR::DetectTunnelSettings named metric.

Calls MR_DetectTunnelSettings_Get_metric(). The reference to this object might be preserved as the return value.

◆ metric_mut()

auto meshlib::DetectTunnelSettings::metric_mut ( ) -> &mut meshlib::std_function_float_from_MR_EdgeId

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 Returns a mutable pointer to a member variable of class MR::DetectTunnelSettings named metric.

Calls MR_DetectTunnelSettings_GetMutable_metric(). The reference to this object might be preserved as the return value.

◆ new()

auto meshlib::DetectTunnelSettings::new ( ) -> meshlib::Owned< meshlib::DetectTunnelSettings >
static

Constructs an empty (default-constructed) instance.

Calls MR_DetectTunnelSettings_DefaultConstruct().

◆ progress()

auto meshlib::DetectTunnelSettings::progress ( ) const -> &meshlib::std_function_bool_from_float

to report algorithm progress and cancel from outside Returns a pointer to a member variable of class MR::DetectTunnelSettings named progress.

Calls MR_DetectTunnelSettings_Get_progress(). The reference to this object might be preserved as the return value.

◆ progress_mut()

auto meshlib::DetectTunnelSettings::progress_mut ( ) -> &mut meshlib::std_function_bool_from_float

to report algorithm progress and cancel from outside Returns a mutable pointer to a member variable of class MR::DetectTunnelSettings named progress.

Calls MR_DetectTunnelSettings_GetMutable_progress(). The reference to this object might be preserved as the return value.

◆ set_build_co_loops()

void meshlib::DetectTunnelSettings::set_build_co_loops ( value:bool )

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 Modifies a member variable of class MR::DetectTunnelSettings named buildCoLoops.

Calls MR_DetectTunnelSettings_Set_buildCoLoops().

◆ set_filter_equivalent_co_loops()

void meshlib::DetectTunnelSettings::set_filter_equivalent_co_loops ( value:bool )

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 Modifies a member variable of class MR::DetectTunnelSettings named filterEquivalentCoLoops.

Calls MR_DetectTunnelSettings_Set_filterEquivalentCoLoops().

◆ set_loop_type()

void meshlib::DetectTunnelSettings::set_loop_type ( value:meshlib::TunnelLoopType )

selects what kind of loops to return Modifies a member variable of class MR::DetectTunnelSettings named loopType.

Calls MR_DetectTunnelSettings_Set_loopType(). The reference to the parameter value might be preserved in this object in element loopType.

◆ set_max_iters()

void meshlib::DetectTunnelSettings::set_max_iters ( value:core::ffi::c_int )

maximal number of iterations to detect all tunnels; on a big mesh with many tunnels even one iteration can take a while Modifies a member variable of class MR::DetectTunnelSettings named maxIters.

Calls MR_DetectTunnelSettings_Set_maxIters().

◆ set_max_tunnel_length()

void meshlib::DetectTunnelSettings::set_max_tunnel_length ( value:f32 )

maximal euclidean length of tunnel loops to detect Modifies a member variable of class MR::DetectTunnelSettings named maxTunnelLength.

Calls MR_DetectTunnelSettings_Set_maxTunnelLength().

◆ set_metric()

void meshlib::DetectTunnelSettings::set_metric ( value:&meshlib::std_function_float_from_MR_EdgeId )

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 Modifies a member variable of class MR::DetectTunnelSettings named metric.

Calls MR_DetectTunnelSettings_Set_metric(). The reference to the parameter value might be preserved in this object in element metric.

◆ set_progress()

void meshlib::DetectTunnelSettings::set_progress ( value:&meshlib::std_function_bool_from_float )

to report algorithm progress and cancel from outside Modifies a member variable of class MR::DetectTunnelSettings named progress.

Calls MR_DetectTunnelSettings_Set_progress(). The reference to the parameter value might be preserved in this object in element progress.


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