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

Public Member Functions

auto assign_from_another (_other:&meshlib::OffsetParameters) -> &mut meshlib::OffsetParameters
auto sign_detection_mode () const -> &meshlib::SignDetectionMode
auto sign_detection_mode_mut () -> &mut meshlib::SignDetectionMode
void set_sign_detection_mode (value:meshlib::SignDetectionMode)
auto close_holes_in_hole_winding_number () const -> &bool
auto close_holes_in_hole_winding_number_mut () -> &mut bool
void set_close_holes_in_hole_winding_number (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 fwn () const -> &meshlib::std_shared_ptr_MR_IFastWindingNumber
auto fwn_mut () -> &mut meshlib::std_shared_ptr_MR_IFastWindingNumber
void set_fwn (value:&meshlib::std_shared_ptr_MR_IFastWindingNumber)
auto memory_efficient () const -> &bool
auto memory_efficient_mut () -> &mut bool
void set_memory_efficient (value:bool)
auto voxel_size () const -> &f32
auto voxel_size_mut () -> &mut f32
void set_voxel_size (value:f32)
auto call_back () const -> &meshlib::std_function_bool_from_float
auto call_back_mut () -> &mut meshlib::std_function_bool_from_float
void set_call_back (value:&meshlib::std_function_bool_from_float)
auto upcast_to_base_shell_parameters () const -> &meshlib::BaseShellParameters
auto upcast_to_base_shell_parameters_mut () -> &mut meshlib::BaseShellParameters

Static Public Member Functions

static auto new () -> meshlib::Owned< meshlib::OffsetParameters >
static auto construct_from_another (_other:&meshlib::OffsetParameters) -> meshlib::Owned< meshlib::OffsetParameters >
static auto static_downcast_from_base_shell_parameters (object:&meshlib::BaseShellParameters) -> &Self
static auto static_downcast_from_base_shell_parameters_mut (object:&mut meshlib::BaseShellParameters) -> &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

Generated from class MR::OffsetParameters. Base classes: Direct: (non-virtual) MR::BaseShellParameters Derived classes: Direct: (non-virtual) MR::SharpOffsetParameters Indirect: (non-virtual) MR::GeneralOffsetParameters

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

Member Function Documentation

◆ assign_from_another()

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

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

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

◆ call_back()

auto meshlib::OffsetParameters::call_back ( ) const -> &meshlib::std_function_bool_from_float

Progress callback Returns a pointer to a member variable of class MR::OffsetParameters named callBack.

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

◆ call_back_mut()

auto meshlib::OffsetParameters::call_back_mut ( ) -> &mut meshlib::std_function_bool_from_float

Progress callback Returns a mutable pointer to a member variable of class MR::OffsetParameters named callBack.

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

◆ close_holes_in_hole_winding_number()

auto meshlib::OffsetParameters::close_holes_in_hole_winding_number ( ) const -> &bool

whether to construct closed mesh in signMode = SignDetectionModeShort::HoleWindingNumber Returns a pointer to a member variable of class MR::OffsetParameters named closeHolesInHoleWindingNumber.

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

◆ close_holes_in_hole_winding_number_mut()

auto meshlib::OffsetParameters::close_holes_in_hole_winding_number_mut ( ) -> &mut bool

whether to construct closed mesh in signMode = SignDetectionModeShort::HoleWindingNumber Returns a mutable pointer to a member variable of class MR::OffsetParameters named closeHolesInHoleWindingNumber.

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

◆ construct_from_another()

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

Generated from constructor MR::OffsetParameters::OffsetParameters.

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

◆ fwn()

auto meshlib::OffsetParameters::fwn ( ) const -> &meshlib::std_shared_ptr_MR_IFastWindingNumber

defines particular implementation of IFastWindingNumber interface that will compute windings. If it is not specified, default FastWindingNumber is used this only used if signDetectionMode == SignDetectionMode::HoleWindingRule, otherwise it is ignored providing this will disable memoryEfficient (as if memoryEfficient == false) Returns a pointer to a member variable of class MR::OffsetParameters named fwn.

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

◆ fwn_mut()

auto meshlib::OffsetParameters::fwn_mut ( ) -> &mut meshlib::std_shared_ptr_MR_IFastWindingNumber

defines particular implementation of IFastWindingNumber interface that will compute windings. If it is not specified, default FastWindingNumber is used this only used if signDetectionMode == SignDetectionMode::HoleWindingRule, otherwise it is ignored providing this will disable memoryEfficient (as if memoryEfficient == false) Returns a mutable pointer to a member variable of class MR::OffsetParameters named fwn.

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

◆ memory_efficient()

auto meshlib::OffsetParameters::memory_efficient ( ) const -> &bool

use FunctionVolume for voxel grid representation:

  • memory consumption for voxel storage is approx. (dims.z / (2 * thread_count)) lesser
  • computations are about 15% slower (because some z-layers are computed twice) this setting is ignored (as if memoryEfficient == false) if a) signDetectionMode = SignDetectionMode::OpenVDB, or b) fwn is provided (CUDA computations require full memory storage) used only by mcOffsetMesh and sharpOffsetMesh methods Returns a pointer to a member variable of class MR::OffsetParameters named memoryEfficient.

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

◆ memory_efficient_mut()

auto meshlib::OffsetParameters::memory_efficient_mut ( ) -> &mut bool

use FunctionVolume for voxel grid representation:

  • memory consumption for voxel storage is approx. (dims.z / (2 * thread_count)) lesser
  • computations are about 15% slower (because some z-layers are computed twice) this setting is ignored (as if memoryEfficient == false) if a) signDetectionMode = SignDetectionMode::OpenVDB, or b) fwn is provided (CUDA computations require full memory storage) used only by mcOffsetMesh and sharpOffsetMesh methods Returns a mutable pointer to a member variable of class MR::OffsetParameters named memoryEfficient.

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

◆ new()

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

Constructs an empty (default-constructed) instance.

Calls MR_OffsetParameters_DefaultConstruct().

◆ set_call_back()

void meshlib::OffsetParameters::set_call_back ( value:&meshlib::std_function_bool_from_float )

Progress callback Modifies a member variable of class MR::OffsetParameters named callBack.

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

◆ set_close_holes_in_hole_winding_number()

void meshlib::OffsetParameters::set_close_holes_in_hole_winding_number ( value:bool )

whether to construct closed mesh in signMode = SignDetectionModeShort::HoleWindingNumber Modifies a member variable of class MR::OffsetParameters named closeHolesInHoleWindingNumber.

Calls MR_OffsetParameters_Set_closeHolesInHoleWindingNumber().

◆ set_fwn()

void meshlib::OffsetParameters::set_fwn ( value:&meshlib::std_shared_ptr_MR_IFastWindingNumber )

defines particular implementation of IFastWindingNumber interface that will compute windings. If it is not specified, default FastWindingNumber is used this only used if signDetectionMode == SignDetectionMode::HoleWindingRule, otherwise it is ignored providing this will disable memoryEfficient (as if memoryEfficient == false) Modifies a member variable of class MR::OffsetParameters named fwn.

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

◆ set_memory_efficient()

void meshlib::OffsetParameters::set_memory_efficient ( value:bool )

use FunctionVolume for voxel grid representation:

  • memory consumption for voxel storage is approx. (dims.z / (2 * thread_count)) lesser
  • computations are about 15% slower (because some z-layers are computed twice) this setting is ignored (as if memoryEfficient == false) if a) signDetectionMode = SignDetectionMode::OpenVDB, or b) fwn is provided (CUDA computations require full memory storage) used only by mcOffsetMesh and sharpOffsetMesh methods Modifies a member variable of class MR::OffsetParameters named memoryEfficient.

Calls MR_OffsetParameters_Set_memoryEfficient().

◆ set_sign_detection_mode()

void meshlib::OffsetParameters::set_sign_detection_mode ( value:meshlib::SignDetectionMode )

determines the method to compute distance sign; offsetMesh implementing OffsetMode::Smooth supports only Unsigned, OpenVDB and HoleWindingRule here Modifies a member variable of class MR::OffsetParameters named signDetectionMode.

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

◆ set_voxel_size()

void meshlib::OffsetParameters::set_voxel_size ( value:f32 )

Size of voxel in grid conversions; The user is responsible for setting some positive value here Modifies a member variable of class MR::OffsetParameters named voxelSize.

Calls MR_OffsetParameters_Set_voxelSize().

◆ set_winding_number_beta()

void meshlib::OffsetParameters::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::OffsetParameters named windingNumberBeta.

Calls MR_OffsetParameters_Set_windingNumberBeta().

◆ set_winding_number_threshold()

void meshlib::OffsetParameters::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::OffsetParameters named windingNumberThreshold.

Calls MR_OffsetParameters_Set_windingNumberThreshold().

◆ sign_detection_mode()

auto meshlib::OffsetParameters::sign_detection_mode ( ) const -> &meshlib::SignDetectionMode

determines the method to compute distance sign; offsetMesh implementing OffsetMode::Smooth supports only Unsigned, OpenVDB and HoleWindingRule here Returns a pointer to a member variable of class MR::OffsetParameters named signDetectionMode.

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

◆ sign_detection_mode_mut()

auto meshlib::OffsetParameters::sign_detection_mode_mut ( ) -> &mut meshlib::SignDetectionMode

determines the method to compute distance sign; offsetMesh implementing OffsetMode::Smooth supports only Unsigned, OpenVDB and HoleWindingRule here Returns a mutable pointer to a member variable of class MR::OffsetParameters named signDetectionMode.

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

◆ static_downcast_from_base_shell_parameters()

auto meshlib::OffsetParameters::static_downcast_from_base_shell_parameters ( object:&meshlib::BaseShellParameters ) -> &Self
static

Static downcast from the base class MR::BaseShellParameters.

Calls MR_OffsetParameters_StaticDowncastFrom_MR_BaseShellParameters(). Undefined behavior if the object isn't actually a OffsetParameters.

Note
This function is unsafe.

◆ static_downcast_from_base_shell_parameters_mut()

auto meshlib::OffsetParameters::static_downcast_from_base_shell_parameters_mut ( object:&mut meshlib::BaseShellParameters ) -> &mut Self
static

Static downcast from the base class MR::BaseShellParameters.

Calls MR_OffsetParameters_MutableStaticDowncastFrom_MR_BaseShellParameters(). Undefined behavior if the object isn't actually a OffsetParameters.

Note
This function is unsafe.

◆ upcast_to_base_shell_parameters()

auto meshlib::OffsetParameters::upcast_to_base_shell_parameters ( ) const -> &meshlib::BaseShellParameters

Upcasts to the base class MR::BaseShellParameters.

Calls MR_OffsetParameters_UpcastTo_MR_BaseShellParameters().

◆ upcast_to_base_shell_parameters_mut()

auto meshlib::OffsetParameters::upcast_to_base_shell_parameters_mut ( ) -> &mut meshlib::BaseShellParameters

Upcasts to the base class MR::BaseShellParameters.

Calls MR_OffsetParameters_MutableUpcastTo_MR_BaseShellParameters().

◆ voxel_size()

auto meshlib::OffsetParameters::voxel_size ( ) const -> &f32

Size of voxel in grid conversions; The user is responsible for setting some positive value here Returns a pointer to a member variable of class MR::OffsetParameters named voxelSize.

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

◆ voxel_size_mut()

auto meshlib::OffsetParameters::voxel_size_mut ( ) -> &mut f32

Size of voxel in grid conversions; The user is responsible for setting some positive value here Returns a mutable pointer to a member variable of class MR::OffsetParameters named voxelSize.

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

◆ winding_number_beta()

auto meshlib::OffsetParameters::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::OffsetParameters named windingNumberBeta.

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

◆ winding_number_beta_mut()

auto meshlib::OffsetParameters::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::OffsetParameters named windingNumberBeta.

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

◆ winding_number_threshold()

auto meshlib::OffsetParameters::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::OffsetParameters named windingNumberThreshold.

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

◆ winding_number_threshold_mut()

auto meshlib::OffsetParameters::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::OffsetParameters named windingNumberThreshold.

Calls MR_OffsetParameters_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: