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

Public Member Functions

auto assign_from_another (_other:&meshlib::SignedDistanceToMeshOptions) -> &mut meshlib::SignedDistanceToMeshOptions
auto sign_mode () const -> &meshlib::SignDetectionMode
auto sign_mode_mut () -> &mut meshlib::SignDetectionMode
void set_sign_mode (value:meshlib::SignDetectionMode)
auto min_dist_sq () const -> &f32
auto min_dist_sq_mut () -> &mut f32
void set_min_dist_sq (value:f32)
auto max_dist_sq () const -> &f32
auto max_dist_sq_mut () -> &mut f32
void set_max_dist_sq (value:f32)
auto null_outside_min_max () const -> &bool
auto null_outside_min_max_mut () -> &mut bool
void set_null_outside_min_max (value:bool)
auto winding_number_threshold () const -> &f32
auto winding_number_threshold_mut () -> &mut f32
void set_winding_number_threshold (value:f32)
auto winding_number_beta () const -> &f32
auto winding_number_beta_mut () -> &mut f32
void set_winding_number_beta (value:f32)
auto upcast_to_distance_to_mesh_options () const -> &meshlib::DistanceToMeshOptions
auto upcast_to_distance_to_mesh_options_mut () -> &mut meshlib::DistanceToMeshOptions

Static Public Member Functions

static auto new () -> meshlib::Owned< meshlib::SignedDistanceToMeshOptions >
static auto construct_from_another (_other:&meshlib::SignedDistanceToMeshOptions) -> meshlib::Owned< meshlib::SignedDistanceToMeshOptions >
static auto static_downcast_from_distance_to_mesh_options (object:&meshlib::DistanceToMeshOptions) -> &Self
static auto static_downcast_from_distance_to_mesh_options_mut (object:&mut meshlib::DistanceToMeshOptions) -> &mut Self
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

options determining computation of signed distance from a point to a mesh Generated from class MR::SignedDistanceToMeshOptions. Base classes: Direct: (non-virtual) MR::DistanceToMeshOptions

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

Member Function Documentation

◆ assign_from_another()

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

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

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

◆ construct_from_another()

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

Generated from constructor MR::SignedDistanceToMeshOptions::SignedDistanceToMeshOptions.

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

◆ max_dist_sq()

auto meshlib::SignedDistanceToMeshOptions::max_dist_sq ( ) const -> &f32

maximum squared distance from a point to mesh to be computed precisely Returns a pointer to a member variable of class MR::SignedDistanceToMeshOptions named maxDistSq.

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

◆ max_dist_sq_mut()

auto meshlib::SignedDistanceToMeshOptions::max_dist_sq_mut ( ) -> &mut f32

maximum squared distance from a point to mesh to be computed precisely Returns a mutable pointer to a member variable of class MR::SignedDistanceToMeshOptions named maxDistSq.

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

◆ min_dist_sq()

auto meshlib::SignedDistanceToMeshOptions::min_dist_sq ( ) const -> &f32

minimum squared distance from a point to mesh to be computed precisely Returns a pointer to a member variable of class MR::SignedDistanceToMeshOptions named minDistSq.

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

◆ min_dist_sq_mut()

auto meshlib::SignedDistanceToMeshOptions::min_dist_sq_mut ( ) -> &mut f32

minimum squared distance from a point to mesh to be computed precisely Returns a mutable pointer to a member variable of class MR::SignedDistanceToMeshOptions named minDistSq.

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

◆ new()

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

Constructs an empty (default-constructed) instance.

Calls MR_SignedDistanceToMeshOptions_DefaultConstruct().

◆ null_outside_min_max()

auto meshlib::SignedDistanceToMeshOptions::null_outside_min_max ( ) const -> &bool

what to do if actual distance is outside [min, max) range: true - return std::nullopt for std::optional<float> or NaN for float, false - return approximate value of the distance (with correct sign in case of SignDetectionMode::HoleWindingRule); please note that in HoleWindingRule the sign can change even for too small or too large distances, so if you would like to get closed mesh from marching cubes, set false here Returns a pointer to a member variable of class MR::SignedDistanceToMeshOptions named nullOutsideMinMax.

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

◆ null_outside_min_max_mut()

auto meshlib::SignedDistanceToMeshOptions::null_outside_min_max_mut ( ) -> &mut bool

what to do if actual distance is outside [min, max) range: true - return std::nullopt for std::optional<float> or NaN for float, false - return approximate value of the distance (with correct sign in case of SignDetectionMode::HoleWindingRule); please note that in HoleWindingRule the sign can change even for too small or too large distances, so if you would like to get closed mesh from marching cubes, set false here Returns a mutable pointer to a member variable of class MR::SignedDistanceToMeshOptions named nullOutsideMinMax.

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

◆ set_max_dist_sq()

void meshlib::SignedDistanceToMeshOptions::set_max_dist_sq ( value:f32 )

maximum squared distance from a point to mesh to be computed precisely Modifies a member variable of class MR::SignedDistanceToMeshOptions named maxDistSq.

Calls MR_SignedDistanceToMeshOptions_Set_maxDistSq().

◆ set_min_dist_sq()

void meshlib::SignedDistanceToMeshOptions::set_min_dist_sq ( value:f32 )

minimum squared distance from a point to mesh to be computed precisely Modifies a member variable of class MR::SignedDistanceToMeshOptions named minDistSq.

Calls MR_SignedDistanceToMeshOptions_Set_minDistSq().

◆ set_null_outside_min_max()

void meshlib::SignedDistanceToMeshOptions::set_null_outside_min_max ( value:bool )

what to do if actual distance is outside [min, max) range: true - return std::nullopt for std::optional<float> or NaN for float, false - return approximate value of the distance (with correct sign in case of SignDetectionMode::HoleWindingRule); please note that in HoleWindingRule the sign can change even for too small or too large distances, so if you would like to get closed mesh from marching cubes, set false here Modifies a member variable of class MR::SignedDistanceToMeshOptions named nullOutsideMinMax.

Calls MR_SignedDistanceToMeshOptions_Set_nullOutsideMinMax().

◆ set_sign_mode()

void meshlib::SignedDistanceToMeshOptions::set_sign_mode ( value:meshlib::SignDetectionMode )

the method to compute distance sign Modifies a member variable of class MR::SignedDistanceToMeshOptions named signMode.

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

◆ set_winding_number_beta()

void meshlib::SignedDistanceToMeshOptions::set_winding_number_beta ( value:f32 )

only for SignDetectionMode::HoleWindingRule: determines the precision of fast approximation: the more the better, minimum value is 1 Modifies a member variable of class MR::SignedDistanceToMeshOptions named windingNumberBeta.

Calls MR_SignedDistanceToMeshOptions_Set_windingNumberBeta().

◆ set_winding_number_threshold()

void meshlib::SignedDistanceToMeshOptions::set_winding_number_threshold ( value:f32 )

only for SignDetectionMode::HoleWindingRule: positive distance if winding number below or equal this threshold; ideal threshold: 0.5 for closed meshes; 0.0 for planar meshes Modifies a member variable of class MR::SignedDistanceToMeshOptions named windingNumberThreshold.

Calls MR_SignedDistanceToMeshOptions_Set_windingNumberThreshold().

◆ sign_mode()

auto meshlib::SignedDistanceToMeshOptions::sign_mode ( ) const -> &meshlib::SignDetectionMode

the method to compute distance sign Returns a pointer to a member variable of class MR::SignedDistanceToMeshOptions named signMode.

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

◆ sign_mode_mut()

auto meshlib::SignedDistanceToMeshOptions::sign_mode_mut ( ) -> &mut meshlib::SignDetectionMode

the method to compute distance sign Returns a mutable pointer to a member variable of class MR::SignedDistanceToMeshOptions named signMode.

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

◆ static_downcast_from_distance_to_mesh_options()

auto meshlib::SignedDistanceToMeshOptions::static_downcast_from_distance_to_mesh_options ( object:&meshlib::DistanceToMeshOptions ) -> &Self
static

Static downcast from the base class MR::DistanceToMeshOptions.

Calls MR_SignedDistanceToMeshOptions_StaticDowncastFrom_MR_DistanceToMeshOptions(). Undefined behavior if the object isn't actually a SignedDistanceToMeshOptions.

Note
This function is unsafe.

◆ static_downcast_from_distance_to_mesh_options_mut()

auto meshlib::SignedDistanceToMeshOptions::static_downcast_from_distance_to_mesh_options_mut ( object:&mut meshlib::DistanceToMeshOptions ) -> &mut Self
static

Static downcast from the base class MR::DistanceToMeshOptions.

Calls MR_SignedDistanceToMeshOptions_MutableStaticDowncastFrom_MR_DistanceToMeshOptions(). Undefined behavior if the object isn't actually a SignedDistanceToMeshOptions.

Note
This function is unsafe.

◆ upcast_to_distance_to_mesh_options()

auto meshlib::SignedDistanceToMeshOptions::upcast_to_distance_to_mesh_options ( ) const -> &meshlib::DistanceToMeshOptions

Upcasts to the base class MR::DistanceToMeshOptions.

Calls MR_SignedDistanceToMeshOptions_UpcastTo_MR_DistanceToMeshOptions().

◆ upcast_to_distance_to_mesh_options_mut()

auto meshlib::SignedDistanceToMeshOptions::upcast_to_distance_to_mesh_options_mut ( ) -> &mut meshlib::DistanceToMeshOptions

Upcasts to the base class MR::DistanceToMeshOptions.

Calls MR_SignedDistanceToMeshOptions_MutableUpcastTo_MR_DistanceToMeshOptions().

◆ winding_number_beta()

auto meshlib::SignedDistanceToMeshOptions::winding_number_beta ( ) const -> &f32

only for SignDetectionMode::HoleWindingRule: determines the precision of fast approximation: the more the better, minimum value is 1 Returns a pointer to a member variable of class MR::SignedDistanceToMeshOptions named windingNumberBeta.

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

◆ winding_number_beta_mut()

auto meshlib::SignedDistanceToMeshOptions::winding_number_beta_mut ( ) -> &mut f32

only for SignDetectionMode::HoleWindingRule: determines the precision of fast approximation: the more the better, minimum value is 1 Returns a mutable pointer to a member variable of class MR::SignedDistanceToMeshOptions named windingNumberBeta.

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

◆ winding_number_threshold()

auto meshlib::SignedDistanceToMeshOptions::winding_number_threshold ( ) const -> &f32

only for SignDetectionMode::HoleWindingRule: positive distance if winding number below or equal this threshold; ideal threshold: 0.5 for closed meshes; 0.0 for planar meshes Returns a pointer to a member variable of class MR::SignedDistanceToMeshOptions named windingNumberThreshold.

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

◆ winding_number_threshold_mut()

auto meshlib::SignedDistanceToMeshOptions::winding_number_threshold_mut ( ) -> &mut f32

only for SignDetectionMode::HoleWindingRule: positive distance if winding number below or equal this threshold; ideal threshold: 0.5 for closed meshes; 0.0 for planar meshes Returns a mutable pointer to a member variable of class MR::SignedDistanceToMeshOptions named windingNumberThreshold.

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


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