MeshLib Python Docs
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Static Protected Attributes | List of all members
mrmeshpy.OffsetParameters Class Reference
+ Inheritance diagram for mrmeshpy.OffsetParameters:

Public Member Functions

None __init__ (self)
 
None __init__ (self, OffsetParameters arg0)
 
bool closeHolesInHoleWindingNumber (self)
 
None closeHolesInHoleWindingNumber (self, bool arg1)
 
IFastWindingNumber fwn (self)
 
None fwn (self, IFastWindingNumber arg1)
 
bool memoryEfficient (self)
 
None memoryEfficient (self, bool arg1)
 
SignDetectionMode signDetectionMode (self)
 
None signDetectionMode (self, SignDetectionMode arg1)
 
float windingNumberBeta (self)
 
None windingNumberBeta (self, float arg1)
 
float windingNumberThreshold (self)
 
None windingNumberThreshold (self, float arg1)
 
- Public Member Functions inherited from mrmeshpy.BaseShellParameters
func_bool_from_float callBack (self)
 
None callBack (self, func_bool_from_float arg1)
 
float voxelSize (self)
 
None voxelSize (self, float arg1)
 

Static Public Member Functions

None __init__ (*args, **kwargs)
 
OffsetParameters operator (*args, **kwargs)
 
OffsetParameters operator (*args, **kwargs)
 

Static Protected Attributes

typing _offsetof_closeHolesInHoleWindingNumber = 44
 
typing _offsetof_fwn = 56
 
typing _offsetof_memoryEfficient = 72
 
typing _offsetof_signDetectionMode = 40
 
typing _offsetof_windingNumberBeta = 52
 
typing _offsetof_windingNumberThreshold = 48
 
- Static Protected Attributes inherited from mrmeshpy.BaseShellParameters
typing _offsetof_callBack = 8
 
typing _offsetof_voxelSize = 0
 

Detailed Description

Generated from:  MR::OffsetParameters

Constructor & Destructor Documentation

◆ __init__() [1/3]

None mrmeshpy.OffsetParameters.__init__ ( * args,
** kwargs )
static

Reimplemented from mrmeshpy.BaseShellParameters.

Reimplemented in mrmeshpy.GeneralOffsetParameters, mrmeshpy.GeneralOffsetParameters, mrmeshpy.GeneralOffsetParameters, mrmeshpy.SharpOffsetParameters, mrmeshpy.SharpOffsetParameters, and mrmeshpy.SharpOffsetParameters.

◆ __init__() [2/3]

None mrmeshpy.OffsetParameters.__init__ ( self)

Reimplemented from mrmeshpy.BaseShellParameters.

Reimplemented in mrmeshpy.GeneralOffsetParameters, mrmeshpy.GeneralOffsetParameters, mrmeshpy.GeneralOffsetParameters, mrmeshpy.SharpOffsetParameters, mrmeshpy.SharpOffsetParameters, and mrmeshpy.SharpOffsetParameters.

◆ __init__() [3/3]

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

Reimplemented from mrmeshpy.BaseShellParameters.

Reimplemented in mrmeshpy.GeneralOffsetParameters, mrmeshpy.GeneralOffsetParameters, mrmeshpy.GeneralOffsetParameters, mrmeshpy.SharpOffsetParameters, mrmeshpy.SharpOffsetParameters, and mrmeshpy.SharpOffsetParameters.

Member Function Documentation

◆ closeHolesInHoleWindingNumber() [1/2]

bool mrmeshpy.OffsetParameters.closeHolesInHoleWindingNumber ( self) 
whether to construct closed mesh in signMode = SignDetectionModeShort::HoleWindingNumber

◆ closeHolesInHoleWindingNumber() [2/2]

None mrmeshpy.OffsetParameters.closeHolesInHoleWindingNumber ( self,
bool arg1 )

◆ fwn() [1/2]

IFastWindingNumber mrmeshpy.OffsetParameters.fwn ( self) 
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)

◆ fwn() [2/2]

None mrmeshpy.OffsetParameters.fwn ( self,
IFastWindingNumber arg1 )

◆ memoryEfficient() [1/2]

bool mrmeshpy.OffsetParameters.memoryEfficient ( self) 
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) \\ref fwn is provided (CUDA computations require full memory storage)
used only by \\ref mcOffsetMesh and \\ref sharpOffsetMesh methods

◆ memoryEfficient() [2/2]

None mrmeshpy.OffsetParameters.memoryEfficient ( self,
bool arg1 )

◆ operator() [1/2]

OffsetParameters mrmeshpy.OffsetParameters.operator ( * args,
** kwargs )
static

Reimplemented from mrmeshpy.BaseShellParameters.

Reimplemented in mrmeshpy.GeneralOffsetParameters, mrmeshpy.GeneralOffsetParameters, mrmeshpy.SharpOffsetParameters, and mrmeshpy.SharpOffsetParameters.

◆ operator() [2/2]

OffsetParameters mrmeshpy.OffsetParameters.operator ( * args,
** kwargs )
static

Reimplemented from mrmeshpy.BaseShellParameters.

Reimplemented in mrmeshpy.GeneralOffsetParameters, mrmeshpy.GeneralOffsetParameters, mrmeshpy.SharpOffsetParameters, and mrmeshpy.SharpOffsetParameters.

◆ signDetectionMode() [1/2]

SignDetectionMode mrmeshpy.OffsetParameters.signDetectionMode ( self) 
determines the method to compute distance sign

◆ signDetectionMode() [2/2]

None mrmeshpy.OffsetParameters.signDetectionMode ( self,
SignDetectionMode arg1 )

◆ windingNumberBeta() [1/2]

float mrmeshpy.OffsetParameters.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.OffsetParameters.windingNumberBeta ( self,
float arg1 )

◆ windingNumberThreshold() [1/2]

float mrmeshpy.OffsetParameters.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.OffsetParameters.windingNumberThreshold ( self,
float arg1 )

Member Data Documentation

◆ _offsetof_closeHolesInHoleWindingNumber

typing mrmeshpy.OffsetParameters._offsetof_closeHolesInHoleWindingNumber = 44
staticprotected

◆ _offsetof_fwn

typing mrmeshpy.OffsetParameters._offsetof_fwn = 56
staticprotected

◆ _offsetof_memoryEfficient

typing mrmeshpy.OffsetParameters._offsetof_memoryEfficient = 72
staticprotected

◆ _offsetof_signDetectionMode

typing mrmeshpy.OffsetParameters._offsetof_signDetectionMode = 40
staticprotected

◆ _offsetof_windingNumberBeta

typing mrmeshpy.OffsetParameters._offsetof_windingNumberBeta = 52
staticprotected

◆ _offsetof_windingNumberThreshold

typing mrmeshpy.OffsetParameters._offsetof_windingNumberThreshold = 48
staticprotected
The documentation for this class was generated from the following file: