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

Public Member Functions

 DistanceToMeshOptions (java.lang.foreign.MemorySegment ptr, boolean owned, java.lang.Object owner)
 DistanceToMeshOptions ()
 DistanceToMeshOptions (float minDistSq, float maxDistSq, boolean nullOutsideMinMax, float windingNumberThreshold, float windingNumberBeta)
 DistanceToMeshOptions (meshlib.DistanceToMeshOptions _other)
meshlib.DistanceToMeshOptions assignFromAnother (meshlib.DistanceToMeshOptions _other)
float minDistSq ()
void setMinDistSq (float value)
float maxDistSq ()
void setMaxDistSq (float value)
boolean nullOutsideMinMax ()
void setNullOutsideMinMax (boolean value)
float windingNumberThreshold ()
void setWindingNumberThreshold (float value)
float windingNumberBeta ()
void setWindingNumberBeta (float value)
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 ()

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

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

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

Constructor & Destructor Documentation

◆ DistanceToMeshOptions() [1/4]

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

◆ DistanceToMeshOptions() [2/4]

meshlib.DistanceToMeshOptions.DistanceToMeshOptions ( )

Constructs an empty (default-constructed) instance.

Calls MR_DistanceToMeshOptions_DefaultConstruct().

◆ DistanceToMeshOptions() [3/4]

meshlib.DistanceToMeshOptions.DistanceToMeshOptions ( float minDistSq,
float maxDistSq,
boolean nullOutsideMinMax,
float windingNumberThreshold,
float windingNumberBeta )

Constructs MR::DistanceToMeshOptions elementwise.

Calls MR_DistanceToMeshOptions_ConstructFrom().

◆ DistanceToMeshOptions() [4/4]

meshlib.DistanceToMeshOptions.DistanceToMeshOptions ( meshlib.DistanceToMeshOptions _other)

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

Calls MR_DistanceToMeshOptions_ConstructFromAnother().

Member Function Documentation

◆ assignFromAnother()

meshlib.DistanceToMeshOptions meshlib.DistanceToMeshOptions.assignFromAnother ( meshlib.DistanceToMeshOptions _other)

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

Calls MR_DistanceToMeshOptions_AssignFromAnother().

◆ maxDistSq()

float meshlib.DistanceToMeshOptions.maxDistSq ( )

maximum squared distance from a point to mesh to be computed precisely Returns a pointer to a member variable of class MR::DistanceToMeshOptions named maxDistSq. The reference to this object might be preserved as the return value.

Calls MR_DistanceToMeshOptions_Get_maxDistSq().

◆ minDistSq()

float meshlib.DistanceToMeshOptions.minDistSq ( )

minimum squared distance from a point to mesh to be computed precisely Returns a pointer to a member variable of class MR::DistanceToMeshOptions named minDistSq. The reference to this object might be preserved as the return value.

Calls MR_DistanceToMeshOptions_Get_minDistSq().

◆ nullOutsideMinMax()

boolean meshlib.DistanceToMeshOptions.nullOutsideMinMax ( )

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

Calls MR_DistanceToMeshOptions_Get_nullOutsideMinMax().

◆ setMaxDistSq()

void meshlib.DistanceToMeshOptions.setMaxDistSq ( float value)

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

Calls MR_DistanceToMeshOptions_Set_maxDistSq().

◆ setMinDistSq()

void meshlib.DistanceToMeshOptions.setMinDistSq ( float value)

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

Calls MR_DistanceToMeshOptions_Set_minDistSq().

◆ setNullOutsideMinMax()

void meshlib.DistanceToMeshOptions.setNullOutsideMinMax ( boolean value)

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::DistanceToMeshOptions named nullOutsideMinMax.

Calls MR_DistanceToMeshOptions_Set_nullOutsideMinMax().

◆ setWindingNumberBeta()

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

Calls MR_DistanceToMeshOptions_Set_windingNumberBeta().

◆ setWindingNumberThreshold()

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

Calls MR_DistanceToMeshOptions_Set_windingNumberThreshold().

◆ windingNumberBeta()

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

Calls MR_DistanceToMeshOptions_Get_windingNumberBeta().

◆ windingNumberThreshold()

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

Calls MR_DistanceToMeshOptions_Get_windingNumberThreshold().


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