MeshLib Java Docs
Loading...
Searching...
No Matches
meshlib.OffsetParameters Class Reference
Inheritance diagram for meshlib.OffsetParameters:

Public Member Functions

 OffsetParameters (java.lang.foreign.MemorySegment ptr, boolean owned, java.lang.Object owner)
 OffsetParameters ()
 OffsetParameters (meshlib.OffsetParameters _other)
meshlib.OffsetParameters assignFromAnother (meshlib.OffsetParameters _other)
meshlib.SignDetectionMode signDetectionMode ()
void setSignDetectionMode (meshlib.SignDetectionMode value)
boolean closeHolesInHoleWindingNumber ()
void setCloseHolesInHoleWindingNumber (boolean value)
float windingNumberThreshold ()
void setWindingNumberThreshold (float value)
float windingNumberBeta ()
void setWindingNumberBeta (float value)
meshlib.std_shared_ptr_MR_IFastWindingNumber fwn ()
void setFwn (meshlib.std_shared_ptr_MR_IFastWindingNumber value)
boolean memoryEfficient ()
void setMemoryEfficient (boolean value)
float voxelSize ()
void setVoxelSize (float value)
meshlib.std_function_bool_from_float callBack ()
void setCallBack (meshlib.std_function_bool_from_float value)
meshlib.BaseShellParameters upcastToBaseShellParameters ()
Public Member Functions inherited from meshlib.CppObject
final java.lang.foreign.MemorySegment rawPointer ()
final boolean isOwned ()
final void close ()
final java.lang.foreign.MemorySegment release ()

Static Public Member Functions

static meshlib.OffsetParameters staticDowncastFromBaseShellParameters (meshlib.BaseShellParameters object)

Additional Inherited Members

Protected Member Functions inherited from meshlib.CppObject
 CppObject (java.lang.foreign.MemorySegment ptr, java.util.function.Consumer< java.lang.foreign.MemorySegment > destroy, java.lang.Object owner)

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

Instances created here own their C++ objects, see CppObject.

Constructor & Destructor Documentation

◆ OffsetParameters() [1/3]

meshlib.OffsetParameters.OffsetParameters ( java.lang.foreign.MemorySegment ptr,
boolean owned,
java.lang.Object owner )

Wraps a pointer from the C bindings. If owned, the object is destroyed when the wrapper dies. owner is kept alive as long as this wrapper is. Not for normal use.

◆ OffsetParameters() [2/3]

meshlib.OffsetParameters.OffsetParameters ( )

Constructs an empty (default-constructed) instance.

Calls MR_OffsetParameters_DefaultConstruct().

◆ OffsetParameters() [3/3]

meshlib.OffsetParameters.OffsetParameters ( meshlib.OffsetParameters _other)

Generated from constructor MR::OffsetParameters::OffsetParameters. The reference to things referred to by the parameter _other (if any) might be preserved in the constructed object.

Calls MR_OffsetParameters_ConstructFromAnother().

Member Function Documentation

◆ assignFromAnother()

meshlib.OffsetParameters meshlib.OffsetParameters.assignFromAnother ( meshlib.OffsetParameters _other)

Generated from method MR::OffsetParameters::operator=. The reference to things referred to by the parameter _other (if any) might be preserved in this object.

Calls MR_OffsetParameters_AssignFromAnother().

◆ callBack()

meshlib.std_function_bool_from_float meshlib.OffsetParameters.callBack ( )

Progress callback Returns a pointer to a member variable of class MR::OffsetParameters named callBack. The reference to this object might be preserved as the return value.

Calls MR_OffsetParameters_Get_callBack().

◆ closeHolesInHoleWindingNumber()

boolean meshlib.OffsetParameters.closeHolesInHoleWindingNumber ( )

whether to construct closed mesh in signMode = SignDetectionModeShort.HoleWindingNumber Returns a pointer to a member variable of class MR::OffsetParameters named closeHolesInHoleWindingNumber. The reference to this object might be preserved as the return value.

Calls MR_OffsetParameters_Get_closeHolesInHoleWindingNumber().

◆ fwn()

meshlib.std_shared_ptr_MR_IFastWindingNumber meshlib.OffsetParameters.fwn ( )

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. The reference to this object might be preserved as the return value.

Calls MR_OffsetParameters_Get_fwn().

◆ memoryEfficient()

boolean meshlib.OffsetParameters.memoryEfficient ( )

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. The reference to this object might be preserved as the return value.

Calls MR_OffsetParameters_Get_memoryEfficient().

◆ setCallBack()

void meshlib.OffsetParameters.setCallBack ( meshlib.std_function_bool_from_float value)

Progress callback Modifies a member variable of class MR::OffsetParameters named callBack. The reference to the parameter value might be preserved in this object in element callBack.

Calls MR_OffsetParameters_Set_callBack().

◆ setCloseHolesInHoleWindingNumber()

void meshlib.OffsetParameters.setCloseHolesInHoleWindingNumber ( boolean value)

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

Calls MR_OffsetParameters_Set_closeHolesInHoleWindingNumber().

◆ setFwn()

void meshlib.OffsetParameters.setFwn ( meshlib.std_shared_ptr_MR_IFastWindingNumber value)

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. The reference to the parameter value might be preserved in this object in element fwn.

Calls MR_OffsetParameters_Set_fwn().

◆ setMemoryEfficient()

void meshlib.OffsetParameters.setMemoryEfficient ( boolean value)

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().

◆ setSignDetectionMode()

void meshlib.OffsetParameters.setSignDetectionMode ( meshlib.SignDetectionMode value)

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. The reference to the parameter value might be preserved in this object in element signDetectionMode.

Calls MR_OffsetParameters_Set_signDetectionMode().

◆ setVoxelSize()

void meshlib.OffsetParameters.setVoxelSize ( float value)

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().

◆ setWindingNumberBeta()

void meshlib.OffsetParameters.setWindingNumberBeta ( float value)

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().

◆ setWindingNumberThreshold()

void meshlib.OffsetParameters.setWindingNumberThreshold ( float value)

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().

◆ signDetectionMode()

meshlib.SignDetectionMode meshlib.OffsetParameters.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. The reference to this object might be preserved as the return value.

Calls MR_OffsetParameters_Get_signDetectionMode().

◆ staticDowncastFromBaseShellParameters()

meshlib.OffsetParameters meshlib.OffsetParameters.staticDowncastFromBaseShellParameters ( meshlib.BaseShellParameters object)
static

Static downcast from the base class MR::BaseShellParameters. Undefined behavior if the object isn't actually a OffsetParameters. The result refers to object.

Calls MR_OffsetParameters_MutableStaticDowncastFrom_MR_BaseShellParameters().

◆ upcastToBaseShellParameters()

meshlib.BaseShellParameters meshlib.OffsetParameters.upcastToBaseShellParameters ( )

Upcasts to the base class MR::BaseShellParameters. The result refers to this object.

Calls MR_OffsetParameters_MutableUpcastTo_MR_BaseShellParameters().

◆ voxelSize()

float meshlib.OffsetParameters.voxelSize ( )

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. The reference to this object might be preserved as the return value.

Calls MR_OffsetParameters_Get_voxelSize().

◆ windingNumberBeta()

float meshlib.OffsetParameters.windingNumberBeta ( )

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. The reference to this object might be preserved as the return value.

Calls MR_OffsetParameters_Get_windingNumberBeta().

◆ windingNumberThreshold()

float meshlib.OffsetParameters.windingNumberThreshold ( )

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. The reference to this object might be preserved as the return value.

Calls MR_OffsetParameters_Get_windingNumberThreshold().


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