MeshLib Python Docs
Loading...
Searching...
No Matches
mrmeshpy.DistanceToMeshOptions Class Reference
+ Inheritance diagram for mrmeshpy.DistanceToMeshOptions:

Public Member Functions

None __init__ (self)
 
None __init__ (self, DistanceToMeshOptions arg0)
 
None __init__ (self, float minDistSq, float maxDistSq, bool nullOutsideMinMax, float windingNumberThreshold, float windingNumberBeta)
 
float maxDistSq (self)
 
None maxDistSq (self, float arg1)
 
float minDistSq (self)
 
None minDistSq (self, float arg1)
 
bool nullOutsideMinMax (self)
 
None nullOutsideMinMax (self, bool arg1)
 
float windingNumberBeta (self)
 
None windingNumberBeta (self, float arg1)
 
float windingNumberThreshold (self)
 
None windingNumberThreshold (self, float arg1)
 

Static Protected Member Functions

 _pybind11_conduit_v1_ (*args, **kwargs)
 

Detailed Description

Generated from:  MR::DistanceToMeshOptions

options determining computation of distance from a point to a mesh

Constructor & Destructor Documentation

◆ __init__() [1/3]

None mrmeshpy.DistanceToMeshOptions.__init__ ( self)
Implicit default constructor.

Reimplemented in mrmeshpy.SignedDistanceToMeshOptions, and mrmeshpy.SignedDistanceToMeshOptions.

◆ __init__() [2/3]

None mrmeshpy.DistanceToMeshOptions.__init__ ( self,
DistanceToMeshOptions arg0 )
Implicit copy constructor.

Reimplemented in mrmeshpy.SignedDistanceToMeshOptions, and mrmeshpy.SignedDistanceToMeshOptions.

◆ __init__() [3/3]

None mrmeshpy.DistanceToMeshOptions.__init__ ( self,
float minDistSq,
float maxDistSq,
bool nullOutsideMinMax,
float windingNumberThreshold,
float windingNumberBeta )
Implicit aggregate constructor.

Reimplemented in mrmeshpy.SignedDistanceToMeshOptions, and mrmeshpy.SignedDistanceToMeshOptions.

Member Function Documentation

◆ _pybind11_conduit_v1_()

mrmeshpy.DistanceToMeshOptions._pybind11_conduit_v1_ ( * args,
** kwargs )
staticprotected

◆ maxDistSq() [1/2]

float mrmeshpy.DistanceToMeshOptions.maxDistSq ( self)
maximum squared distance from a point to mesh to be computed precisely

◆ maxDistSq() [2/2]

None mrmeshpy.DistanceToMeshOptions.maxDistSq ( self,
float arg1 )

◆ minDistSq() [1/2]

float mrmeshpy.DistanceToMeshOptions.minDistSq ( self)
minimum squared distance from a point to mesh to be computed precisely

◆ minDistSq() [2/2]

None mrmeshpy.DistanceToMeshOptions.minDistSq ( self,
float arg1 )

◆ nullOutsideMinMax() [1/2]

bool mrmeshpy.DistanceToMeshOptions.nullOutsideMinMax ( self)
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

◆ nullOutsideMinMax() [2/2]

None mrmeshpy.DistanceToMeshOptions.nullOutsideMinMax ( self,
bool arg1 )

◆ windingNumberBeta() [1/2]

float mrmeshpy.DistanceToMeshOptions.windingNumberBeta ( self)
only for SignDetectionMode::HoleWindingRule:
determines the precision of fast approximation: the more the better, minimum value is 1

◆ windingNumberBeta() [2/2]

None mrmeshpy.DistanceToMeshOptions.windingNumberBeta ( self,
float arg1 )

◆ windingNumberThreshold() [1/2]

float mrmeshpy.DistanceToMeshOptions.windingNumberThreshold ( self)
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

◆ windingNumberThreshold() [2/2]

None mrmeshpy.DistanceToMeshOptions.windingNumberThreshold ( self,
float arg1 )

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