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

Public Member Functions

 GeneralOffsetParameters (java.lang.foreign.MemorySegment ptr, boolean owned, java.lang.Object owner)
 GeneralOffsetParameters ()
 GeneralOffsetParameters (meshlib.GeneralOffsetParameters _other)
meshlib.GeneralOffsetParameters assignFromAnother (meshlib.GeneralOffsetParameters _other)
meshlib.OffsetMode mode ()
void setMode (meshlib.OffsetMode value)
java.lang.foreign.MemorySegment outSharpEdges ()
void setOutSharpEdges (meshlib.UndirectedEdgeBitSet value)
java.lang.foreign.MemorySegment outVoxelPerFace ()
void setOutVoxelPerFace (meshlib.Vector_MR_VoxelId_MR_FaceId value)
float minNewVertDev ()
void setMinNewVertDev (float value)
float maxNewRank2VertDev ()
void setMaxNewRank2VertDev (float value)
float maxNewRank3VertDev ()
void setMaxNewRank3VertDev (float value)
float maxOldVertPosCorrection ()
void setMaxOldVertPosCorrection (float value)
boolean voxelClamp ()
void setVoxelClamp (boolean value)
int maxDeletedComponentFaces ()
void setMaxDeletedComponentFaces (int value)
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 ()
meshlib.OffsetParameters upcastToOffsetParameters ()
meshlib.SharpOffsetParameters upcastToSharpOffsetParameters ()
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.GeneralOffsetParameters staticDowncastFromBaseShellParameters (meshlib.BaseShellParameters object)
static meshlib.GeneralOffsetParameters staticDowncastFromOffsetParameters (meshlib.OffsetParameters object)
static meshlib.GeneralOffsetParameters staticDowncastFromSharpOffsetParameters (meshlib.SharpOffsetParameters 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

allows the user to select in the parameters which offset algorithm to call Generated from class MR::GeneralOffsetParameters. Base classes: Direct: (non-virtual) MR::SharpOffsetParameters Indirect: (non-virtual) MR::BaseShellParameters MR::OffsetParameters

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

Constructor & Destructor Documentation

◆ GeneralOffsetParameters() [1/3]

meshlib.GeneralOffsetParameters.GeneralOffsetParameters ( 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.

◆ GeneralOffsetParameters() [2/3]

meshlib.GeneralOffsetParameters.GeneralOffsetParameters ( )

Constructs an empty (default-constructed) instance.

Calls MR_GeneralOffsetParameters_DefaultConstruct().

◆ GeneralOffsetParameters() [3/3]

meshlib.GeneralOffsetParameters.GeneralOffsetParameters ( meshlib.GeneralOffsetParameters _other)

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

Calls MR_GeneralOffsetParameters_ConstructFromAnother().

Member Function Documentation

◆ assignFromAnother()

meshlib.GeneralOffsetParameters meshlib.GeneralOffsetParameters.assignFromAnother ( meshlib.GeneralOffsetParameters _other)

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

Calls MR_GeneralOffsetParameters_AssignFromAnother().

◆ callBack()

meshlib.std_function_bool_from_float meshlib.GeneralOffsetParameters.callBack ( )

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

Calls MR_GeneralOffsetParameters_Get_callBack().

◆ closeHolesInHoleWindingNumber()

boolean meshlib.GeneralOffsetParameters.closeHolesInHoleWindingNumber ( )

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

Calls MR_GeneralOffsetParameters_Get_closeHolesInHoleWindingNumber().

◆ fwn()

meshlib.std_shared_ptr_MR_IFastWindingNumber meshlib.GeneralOffsetParameters.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::GeneralOffsetParameters named fwn. The reference to this object might be preserved as the return value.

Calls MR_GeneralOffsetParameters_Get_fwn().

◆ maxDeletedComponentFaces()

int meshlib.GeneralOffsetParameters.maxDeletedComponentFaces ( )

if positive, then after sharpening every connected component with not more than this number of triangles intersecting a larger component is deleted; such tiny fragments appear near sharp creases Returns a pointer to a member variable of class MR::GeneralOffsetParameters named maxDeletedComponentFaces. The reference to this object might be preserved as the return value.

Calls MR_GeneralOffsetParameters_Get_maxDeletedComponentFaces().

◆ maxNewRank2VertDev()

float meshlib.GeneralOffsetParameters.maxNewRank2VertDev ( )

maximal surface deviation to introduce new rank 2 vertex (on intersection of 2 planes), measured in voxelSize Returns a pointer to a member variable of class MR::GeneralOffsetParameters named maxNewRank2VertDev. The reference to this object might be preserved as the return value.

Calls MR_GeneralOffsetParameters_Get_maxNewRank2VertDev().

◆ maxNewRank3VertDev()

float meshlib.GeneralOffsetParameters.maxNewRank3VertDev ( )

maximal surface deviation to introduce new rank 3 vertex (on intersection of 3 planes), measured in voxelSize Returns a pointer to a member variable of class MR::GeneralOffsetParameters named maxNewRank3VertDev. The reference to this object might be preserved as the return value.

Calls MR_GeneralOffsetParameters_Get_maxNewRank3VertDev().

◆ maxOldVertPosCorrection()

float meshlib.GeneralOffsetParameters.maxOldVertPosCorrection ( )

correct positions of the input vertices using reference mesh by not more than this distance, measured in voxelSize; big correction can be wrong and result from self-intersections in the reference mesh Returns a pointer to a member variable of class MR::GeneralOffsetParameters named maxOldVertPosCorrection. The reference to this object might be preserved as the return value.

Calls MR_GeneralOffsetParameters_Get_maxOldVertPosCorrection().

◆ memoryEfficient()

boolean meshlib.GeneralOffsetParameters.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::GeneralOffsetParameters named memoryEfficient. The reference to this object might be preserved as the return value.

Calls MR_GeneralOffsetParameters_Get_memoryEfficient().

◆ minNewVertDev()

float meshlib.GeneralOffsetParameters.minNewVertDev ( )

minimal surface deviation to introduce new vertex in a voxel, measured in voxelSize Returns a pointer to a member variable of class MR::GeneralOffsetParameters named minNewVertDev. The reference to this object might be preserved as the return value.

Calls MR_GeneralOffsetParameters_Get_minNewVertDev().

◆ mode()

meshlib.OffsetMode meshlib.GeneralOffsetParameters.mode ( )

Returns a pointer to a member variable of class MR::GeneralOffsetParameters named mode. The reference to this object might be preserved as the return value.

Calls MR_GeneralOffsetParameters_Get_mode().

◆ outSharpEdges()

java.lang.foreign.MemorySegment meshlib.GeneralOffsetParameters.outSharpEdges ( )

if non-null then created sharp edges will be saved here Returns a pointer to a member variable of class MR::GeneralOffsetParameters named outSharpEdges. The reference to this object might be preserved as the return value.

Calls MR_GeneralOffsetParameters_Get_outSharpEdges(). Some types are raw C types, see the C bindings for the details.

◆ outVoxelPerFace()

java.lang.foreign.MemorySegment meshlib.GeneralOffsetParameters.outVoxelPerFace ( )

if non-null then for each output mesh face maps its voxel id Returns a pointer to a member variable of class MR::GeneralOffsetParameters named outVoxelPerFace. The reference to this object might be preserved as the return value.

Calls MR_GeneralOffsetParameters_Get_outVoxelPerFace(). Some types are raw C types, see the C bindings for the details.

◆ setCallBack()

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

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

Calls MR_GeneralOffsetParameters_Set_callBack().

◆ setCloseHolesInHoleWindingNumber()

void meshlib.GeneralOffsetParameters.setCloseHolesInHoleWindingNumber ( boolean value)

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

Calls MR_GeneralOffsetParameters_Set_closeHolesInHoleWindingNumber().

◆ setFwn()

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

Calls MR_GeneralOffsetParameters_Set_fwn().

◆ setMaxDeletedComponentFaces()

void meshlib.GeneralOffsetParameters.setMaxDeletedComponentFaces ( int value)

if positive, then after sharpening every connected component with not more than this number of triangles intersecting a larger component is deleted; such tiny fragments appear near sharp creases Modifies a member variable of class MR::GeneralOffsetParameters named maxDeletedComponentFaces.

Calls MR_GeneralOffsetParameters_Set_maxDeletedComponentFaces().

◆ setMaxNewRank2VertDev()

void meshlib.GeneralOffsetParameters.setMaxNewRank2VertDev ( float value)

maximal surface deviation to introduce new rank 2 vertex (on intersection of 2 planes), measured in voxelSize Modifies a member variable of class MR::GeneralOffsetParameters named maxNewRank2VertDev.

Calls MR_GeneralOffsetParameters_Set_maxNewRank2VertDev().

◆ setMaxNewRank3VertDev()

void meshlib.GeneralOffsetParameters.setMaxNewRank3VertDev ( float value)

maximal surface deviation to introduce new rank 3 vertex (on intersection of 3 planes), measured in voxelSize Modifies a member variable of class MR::GeneralOffsetParameters named maxNewRank3VertDev.

Calls MR_GeneralOffsetParameters_Set_maxNewRank3VertDev().

◆ setMaxOldVertPosCorrection()

void meshlib.GeneralOffsetParameters.setMaxOldVertPosCorrection ( float value)

correct positions of the input vertices using reference mesh by not more than this distance, measured in voxelSize; big correction can be wrong and result from self-intersections in the reference mesh Modifies a member variable of class MR::GeneralOffsetParameters named maxOldVertPosCorrection.

Calls MR_GeneralOffsetParameters_Set_maxOldVertPosCorrection().

◆ setMemoryEfficient()

void meshlib.GeneralOffsetParameters.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::GeneralOffsetParameters named memoryEfficient.

Calls MR_GeneralOffsetParameters_Set_memoryEfficient().

◆ setMinNewVertDev()

void meshlib.GeneralOffsetParameters.setMinNewVertDev ( float value)

minimal surface deviation to introduce new vertex in a voxel, measured in voxelSize Modifies a member variable of class MR::GeneralOffsetParameters named minNewVertDev.

Calls MR_GeneralOffsetParameters_Set_minNewVertDev().

◆ setMode()

void meshlib.GeneralOffsetParameters.setMode ( meshlib.OffsetMode value)

Modifies a member variable of class MR::GeneralOffsetParameters named mode. The reference to the parameter value might be preserved in this object in element mode.

Calls MR_GeneralOffsetParameters_Set_mode().

◆ setOutSharpEdges()

void meshlib.GeneralOffsetParameters.setOutSharpEdges ( meshlib.UndirectedEdgeBitSet value)

if non-null then created sharp edges will be saved here Modifies a member variable of class MR::GeneralOffsetParameters named outSharpEdges. The reference to the parameter value might be preserved in this object in element outSharpEdges.

Calls MR_GeneralOffsetParameters_Set_outSharpEdges().

◆ setOutVoxelPerFace()

void meshlib.GeneralOffsetParameters.setOutVoxelPerFace ( meshlib.Vector_MR_VoxelId_MR_FaceId value)

if non-null then for each output mesh face maps its voxel id Modifies a member variable of class MR::GeneralOffsetParameters named outVoxelPerFace. The reference to the parameter value might be preserved in this object in element outVoxelPerFace.

Calls MR_GeneralOffsetParameters_Set_outVoxelPerFace().

◆ setSignDetectionMode()

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

Calls MR_GeneralOffsetParameters_Set_signDetectionMode().

◆ setVoxelClamp()

void meshlib.GeneralOffsetParameters.setVoxelClamp ( boolean value)

if true, the displacement of a new vertex from the average point is shortened to keep the vertex within its voxel's box (so the geometry of a voxel can never reach another one), and the in-plane elevation check is skipped Modifies a member variable of class MR::GeneralOffsetParameters named voxelClamp.

Calls MR_GeneralOffsetParameters_Set_voxelClamp().

◆ setVoxelSize()

void meshlib.GeneralOffsetParameters.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::GeneralOffsetParameters named voxelSize.

Calls MR_GeneralOffsetParameters_Set_voxelSize().

◆ setWindingNumberBeta()

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

Calls MR_GeneralOffsetParameters_Set_windingNumberBeta().

◆ setWindingNumberThreshold()

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

Calls MR_GeneralOffsetParameters_Set_windingNumberThreshold().

◆ signDetectionMode()

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

Calls MR_GeneralOffsetParameters_Get_signDetectionMode().

◆ staticDowncastFromBaseShellParameters()

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

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

Calls MR_GeneralOffsetParameters_MutableStaticDowncastFrom_MR_BaseShellParameters().

◆ staticDowncastFromOffsetParameters()

meshlib.GeneralOffsetParameters meshlib.GeneralOffsetParameters.staticDowncastFromOffsetParameters ( meshlib.OffsetParameters object)
static

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

Calls MR_GeneralOffsetParameters_MutableStaticDowncastFrom_MR_OffsetParameters().

◆ staticDowncastFromSharpOffsetParameters()

meshlib.GeneralOffsetParameters meshlib.GeneralOffsetParameters.staticDowncastFromSharpOffsetParameters ( meshlib.SharpOffsetParameters object)
static

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

Calls MR_GeneralOffsetParameters_MutableStaticDowncastFrom_MR_SharpOffsetParameters().

◆ upcastToBaseShellParameters()

meshlib.BaseShellParameters meshlib.GeneralOffsetParameters.upcastToBaseShellParameters ( )

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

Calls MR_GeneralOffsetParameters_MutableUpcastTo_MR_BaseShellParameters().

◆ upcastToOffsetParameters()

meshlib.OffsetParameters meshlib.GeneralOffsetParameters.upcastToOffsetParameters ( )

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

Calls MR_GeneralOffsetParameters_MutableUpcastTo_MR_OffsetParameters().

◆ upcastToSharpOffsetParameters()

meshlib.SharpOffsetParameters meshlib.GeneralOffsetParameters.upcastToSharpOffsetParameters ( )

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

Calls MR_GeneralOffsetParameters_MutableUpcastTo_MR_SharpOffsetParameters().

◆ voxelClamp()

boolean meshlib.GeneralOffsetParameters.voxelClamp ( )

if true, the displacement of a new vertex from the average point is shortened to keep the vertex within its voxel's box (so the geometry of a voxel can never reach another one), and the in-plane elevation check is skipped Returns a pointer to a member variable of class MR::GeneralOffsetParameters named voxelClamp. The reference to this object might be preserved as the return value.

Calls MR_GeneralOffsetParameters_Get_voxelClamp().

◆ voxelSize()

float meshlib.GeneralOffsetParameters.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::GeneralOffsetParameters named voxelSize. The reference to this object might be preserved as the return value.

Calls MR_GeneralOffsetParameters_Get_voxelSize().

◆ windingNumberBeta()

float meshlib.GeneralOffsetParameters.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::GeneralOffsetParameters named windingNumberBeta. The reference to this object might be preserved as the return value.

Calls MR_GeneralOffsetParameters_Get_windingNumberBeta().

◆ windingNumberThreshold()

float meshlib.GeneralOffsetParameters.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::GeneralOffsetParameters named windingNumberThreshold. The reference to this object might be preserved as the return value.

Calls MR_GeneralOffsetParameters_Get_windingNumberThreshold().


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