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

Public Member Functions

 ToolPathParams (java.lang.foreign.MemorySegment ptr, boolean owned, java.lang.Object owner)
 ToolPathParams ()
 ToolPathParams (float millRadius, float voxelSize, float sectionStep, float critTransitionLength, float plungeLength, float retractLength, float plungeFeed, float retractFeed, float baseFeed, float safeZ, meshlib.BypassDirection bypassDir, meshlib.AffineXf3f xf, boolean flatTool, meshlib.std_function_bool_from_float cb, float toolpathExpansion, meshlib.std_vector_std_vector_MR_Vector3f isolines, meshlib.std_vector_std_vector_MR_Vector3f startContours, meshlib.std_vector_MR_Vector3f startVertices, meshlib.MeshPart offsetMesh)
 ToolPathParams (meshlib.ToolPathParams _other)
meshlib.ToolPathParams assignFromAnother (meshlib.ToolPathParams _other)
float millRadius ()
void setMillRadius (float value)
float voxelSize ()
void setVoxelSize (float value)
float sectionStep ()
void setSectionStep (float value)
float critTransitionLength ()
void setCritTransitionLength (float value)
float plungeLength ()
void setPlungeLength (float value)
float retractLength ()
void setRetractLength (float value)
float plungeFeed ()
void setPlungeFeed (float value)
float retractFeed ()
void setRetractFeed (float value)
float baseFeed ()
void setBaseFeed (float value)
float safeZ ()
void setSafeZ (float value)
meshlib.BypassDirection bypassDir ()
void setBypassDir (meshlib.BypassDirection value)
java.lang.foreign.MemorySegment xf ()
void setXf (meshlib.AffineXf3f value)
boolean flatTool ()
void setFlatTool (boolean value)
meshlib.std_function_bool_from_float cb ()
void setCb (meshlib.std_function_bool_from_float value)
float toolpathExpansion ()
void setToolpathExpansion (float value)
java.lang.foreign.MemorySegment isolines ()
void setIsolines (meshlib.std_vector_std_vector_MR_Vector3f value)
java.lang.foreign.MemorySegment startContours ()
void setStartContours (meshlib.std_vector_std_vector_MR_Vector3f value)
java.lang.foreign.MemorySegment startVertices ()
void setStartVertices (meshlib.std_vector_MR_Vector3f value)
java.lang.foreign.MemorySegment offsetMesh ()
void setOffsetMesh (meshlib.MeshPart 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

Parameters shared by all tool path generation functions Generated from class MR::ToolPathParams. Derived classes: Direct: (non-virtual) MR::ConstantCuspParams

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

Constructor & Destructor Documentation

◆ ToolPathParams() [1/4]

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

◆ ToolPathParams() [2/4]

meshlib.ToolPathParams.ToolPathParams ( )

Constructs an empty (default-constructed) instance.

Calls MR_ToolPathParams_DefaultConstruct().

◆ ToolPathParams() [3/4]

meshlib.ToolPathParams.ToolPathParams ( float millRadius,
float voxelSize,
float sectionStep,
float critTransitionLength,
float plungeLength,
float retractLength,
float plungeFeed,
float retractFeed,
float baseFeed,
float safeZ,
meshlib.BypassDirection bypassDir,
meshlib.AffineXf3f xf,
boolean flatTool,
meshlib.std_function_bool_from_float cb,
float toolpathExpansion,
meshlib.std_vector_std_vector_MR_Vector3f isolines,
meshlib.std_vector_std_vector_MR_Vector3f startContours,
meshlib.std_vector_MR_Vector3f startVertices,
meshlib.MeshPart offsetMesh )

Constructs MR::ToolPathParams elementwise. The reference to the parameter bypassDir might be preserved in the constructed object. The reference to the parameter xf might be preserved in the constructed object. The reference to the parameter cb might be preserved in the constructed object. The reference to the parameter isolines might be preserved in the constructed object. The reference to the parameter startContours might be preserved in the constructed object. The reference to the parameter startVertices might be preserved in the constructed object. The reference to the parameter offsetMesh might be preserved in the constructed object.

Calls MR_ToolPathParams_ConstructFrom().

◆ ToolPathParams() [4/4]

meshlib.ToolPathParams.ToolPathParams ( meshlib.ToolPathParams _other)

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

Calls MR_ToolPathParams_ConstructFromAnother().

Member Function Documentation

◆ assignFromAnother()

meshlib.ToolPathParams meshlib.ToolPathParams.assignFromAnother ( meshlib.ToolPathParams _other)

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

Calls MR_ToolPathParams_AssignFromAnother().

◆ baseFeed()

float meshlib.ToolPathParams.baseFeed ( )

speed of regular milling Returns a pointer to a member variable of class MR::ToolPathParams named baseFeed. The reference to this object might be preserved as the return value.

Calls MR_ToolPathParams_Get_baseFeed().

◆ bypassDir()

meshlib.BypassDirection meshlib.ToolPathParams.bypassDir ( )

which direction isolines or sections should be passed in Returns a pointer to a member variable of class MR::ToolPathParams named bypassDir. The reference to this object might be preserved as the return value.

Calls MR_ToolPathParams_Get_bypassDir().

◆ cb()

meshlib.std_function_bool_from_float meshlib.ToolPathParams.cb ( )

callback for reporting on progress Returns a pointer to a member variable of class MR::ToolPathParams named cb. The reference to this object might be preserved as the return value.

Calls MR_ToolPathParams_Get_cb().

◆ critTransitionLength()

float meshlib.ToolPathParams.critTransitionLength ( )

if distance to the next section is smaller than it, transition will be performed along the surface; otherwise transition will be through the safe plane Returns a pointer to a member variable of class MR::ToolPathParams named critTransitionLength. The reference to this object might be preserved as the return value.

Calls MR_ToolPathParams_Get_critTransitionLength().

◆ flatTool()

boolean meshlib.ToolPathParams.flatTool ( )

if true then a tool path for a flat milling tool will be generated Returns a pointer to a member variable of class MR::ToolPathParams named flatTool. The reference to this object might be preserved as the return value.

Calls MR_ToolPathParams_Get_flatTool().

◆ isolines()

java.lang.foreign.MemorySegment meshlib.ToolPathParams.isolines ( )

optional output, stores isolines without transits Returns a pointer to a member variable of class MR::ToolPathParams named isolines. The reference to this object might be preserved as the return value.

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

◆ millRadius()

float meshlib.ToolPathParams.millRadius ( )

radius of the milling tool Returns a pointer to a member variable of class MR::ToolPathParams named millRadius. The reference to this object might be preserved as the return value.

Calls MR_ToolPathParams_Get_millRadius().

◆ offsetMesh()

java.lang.foreign.MemorySegment meshlib.ToolPathParams.offsetMesh ( )

optional pre-computed offset mesh; if null, it will be computed internally Returns a pointer to a member variable of class MR::ToolPathParams named offsetMesh. The reference to this object might be preserved as the return value.

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

◆ plungeFeed()

float meshlib.ToolPathParams.plungeFeed ( )

speed of slow movement down Returns a pointer to a member variable of class MR::ToolPathParams named plungeFeed. The reference to this object might be preserved as the return value.

Calls MR_ToolPathParams_Get_plungeFeed().

◆ plungeLength()

float meshlib.ToolPathParams.plungeLength ( )

when the mill is moving down, it will be slowed down in this distance from mesh Returns a pointer to a member variable of class MR::ToolPathParams named plungeLength. The reference to this object might be preserved as the return value.

Calls MR_ToolPathParams_Get_plungeLength().

◆ retractFeed()

float meshlib.ToolPathParams.retractFeed ( )

speed of slow movement up Returns a pointer to a member variable of class MR::ToolPathParams named retractFeed. The reference to this object might be preserved as the return value.

Calls MR_ToolPathParams_Get_retractFeed().

◆ retractLength()

float meshlib.ToolPathParams.retractLength ( )

when the mill is moving up, it will be slowed down in this distance from mesh Returns a pointer to a member variable of class MR::ToolPathParams named retractLength. The reference to this object might be preserved as the return value.

Calls MR_ToolPathParams_Get_retractLength().

◆ safeZ()

float meshlib.ToolPathParams.safeZ ( )

z-coordinate of plane where tool can move in any direction without touching the object Returns a pointer to a member variable of class MR::ToolPathParams named safeZ. The reference to this object might be preserved as the return value.

Calls MR_ToolPathParams_Get_safeZ().

◆ sectionStep()

float meshlib.ToolPathParams.sectionStep ( )

distance between sections built along Z axis; in Constant Cusp mode sectionStep should be bigger than voxelSize (x1.2 or more is recommended) Returns a pointer to a member variable of class MR::ToolPathParams named sectionStep. The reference to this object might be preserved as the return value.

Calls MR_ToolPathParams_Get_sectionStep().

◆ setBaseFeed()

void meshlib.ToolPathParams.setBaseFeed ( float value)

speed of regular milling Modifies a member variable of class MR::ToolPathParams named baseFeed.

Calls MR_ToolPathParams_Set_baseFeed().

◆ setBypassDir()

void meshlib.ToolPathParams.setBypassDir ( meshlib.BypassDirection value)

which direction isolines or sections should be passed in Modifies a member variable of class MR::ToolPathParams named bypassDir. The reference to the parameter value might be preserved in this object in element bypassDir.

Calls MR_ToolPathParams_Set_bypassDir().

◆ setCb()

void meshlib.ToolPathParams.setCb ( meshlib.std_function_bool_from_float value)

callback for reporting on progress Modifies a member variable of class MR::ToolPathParams named cb. The reference to the parameter value might be preserved in this object in element cb.

Calls MR_ToolPathParams_Set_cb().

◆ setCritTransitionLength()

void meshlib.ToolPathParams.setCritTransitionLength ( float value)

if distance to the next section is smaller than it, transition will be performed along the surface; otherwise transition will be through the safe plane Modifies a member variable of class MR::ToolPathParams named critTransitionLength.

Calls MR_ToolPathParams_Set_critTransitionLength().

◆ setFlatTool()

void meshlib.ToolPathParams.setFlatTool ( boolean value)

if true then a tool path for a flat milling tool will be generated Modifies a member variable of class MR::ToolPathParams named flatTool.

Calls MR_ToolPathParams_Set_flatTool().

◆ setIsolines()

void meshlib.ToolPathParams.setIsolines ( meshlib.std_vector_std_vector_MR_Vector3f value)

optional output, stores isolines without transits Modifies a member variable of class MR::ToolPathParams named isolines. The reference to the parameter value might be preserved in this object in element isolines.

Calls MR_ToolPathParams_Set_isolines().

◆ setMillRadius()

void meshlib.ToolPathParams.setMillRadius ( float value)

radius of the milling tool Modifies a member variable of class MR::ToolPathParams named millRadius.

Calls MR_ToolPathParams_Set_millRadius().

◆ setOffsetMesh()

void meshlib.ToolPathParams.setOffsetMesh ( meshlib.MeshPart value)

optional pre-computed offset mesh; if null, it will be computed internally Modifies a member variable of class MR::ToolPathParams named offsetMesh. The reference to the parameter value might be preserved in this object in element offsetMesh.

Calls MR_ToolPathParams_Set_offsetMesh().

◆ setPlungeFeed()

void meshlib.ToolPathParams.setPlungeFeed ( float value)

speed of slow movement down Modifies a member variable of class MR::ToolPathParams named plungeFeed.

Calls MR_ToolPathParams_Set_plungeFeed().

◆ setPlungeLength()

void meshlib.ToolPathParams.setPlungeLength ( float value)

when the mill is moving down, it will be slowed down in this distance from mesh Modifies a member variable of class MR::ToolPathParams named plungeLength.

Calls MR_ToolPathParams_Set_plungeLength().

◆ setRetractFeed()

void meshlib.ToolPathParams.setRetractFeed ( float value)

speed of slow movement up Modifies a member variable of class MR::ToolPathParams named retractFeed.

Calls MR_ToolPathParams_Set_retractFeed().

◆ setRetractLength()

void meshlib.ToolPathParams.setRetractLength ( float value)

when the mill is moving up, it will be slowed down in this distance from mesh Modifies a member variable of class MR::ToolPathParams named retractLength.

Calls MR_ToolPathParams_Set_retractLength().

◆ setSafeZ()

void meshlib.ToolPathParams.setSafeZ ( float value)

z-coordinate of plane where tool can move in any direction without touching the object Modifies a member variable of class MR::ToolPathParams named safeZ.

Calls MR_ToolPathParams_Set_safeZ().

◆ setSectionStep()

void meshlib.ToolPathParams.setSectionStep ( float value)

distance between sections built along Z axis; in Constant Cusp mode sectionStep should be bigger than voxelSize (x1.2 or more is recommended) Modifies a member variable of class MR::ToolPathParams named sectionStep.

Calls MR_ToolPathParams_Set_sectionStep().

◆ setStartContours()

void meshlib.ToolPathParams.setStartContours ( meshlib.std_vector_std_vector_MR_Vector3f value)

optional output, polyline containing start vertices for isolines Modifies a member variable of class MR::ToolPathParams named startContours. The reference to the parameter value might be preserved in this object in element startContours.

Calls MR_ToolPathParams_Set_startContours().

◆ setStartVertices()

void meshlib.ToolPathParams.setStartVertices ( meshlib.std_vector_MR_Vector3f value)

start vertices on the offset mesh used for calculating isolines Modifies a member variable of class MR::ToolPathParams named startVertices. The reference to the parameter value might be preserved in this object in element startVertices.

Calls MR_ToolPathParams_Set_startVertices().

◆ setToolpathExpansion()

void meshlib.ToolPathParams.setToolpathExpansion ( float value)

if > 0 - expand the trajectory creation area and create toolpath to mill excess material to make empty areas; the area has the shape of a box; lacing specific only Modifies a member variable of class MR::ToolPathParams named toolpathExpansion.

Calls MR_ToolPathParams_Set_toolpathExpansion().

◆ setVoxelSize()

void meshlib.ToolPathParams.setVoxelSize ( float value)

size of voxel needed to offset mesh Modifies a member variable of class MR::ToolPathParams named voxelSize.

Calls MR_ToolPathParams_Set_voxelSize().

◆ setXf()

void meshlib.ToolPathParams.setXf ( meshlib.AffineXf3f value)

mesh can be transformed using xf parameter Modifies a member variable of class MR::ToolPathParams named xf. The reference to the parameter value might be preserved in this object in element xf.

Calls MR_ToolPathParams_Set_xf().

◆ startContours()

java.lang.foreign.MemorySegment meshlib.ToolPathParams.startContours ( )

optional output, polyline containing start vertices for isolines Returns a pointer to a member variable of class MR::ToolPathParams named startContours. The reference to this object might be preserved as the return value.

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

◆ startVertices()

java.lang.foreign.MemorySegment meshlib.ToolPathParams.startVertices ( )

start vertices on the offset mesh used for calculating isolines Returns a pointer to a member variable of class MR::ToolPathParams named startVertices. The reference to this object might be preserved as the return value.

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

◆ toolpathExpansion()

float meshlib.ToolPathParams.toolpathExpansion ( )

if > 0 - expand the trajectory creation area and create toolpath to mill excess material to make empty areas; the area has the shape of a box; lacing specific only Returns a pointer to a member variable of class MR::ToolPathParams named toolpathExpansion. The reference to this object might be preserved as the return value.

Calls MR_ToolPathParams_Get_toolpathExpansion().

◆ voxelSize()

float meshlib.ToolPathParams.voxelSize ( )

size of voxel needed to offset mesh Returns a pointer to a member variable of class MR::ToolPathParams named voxelSize. The reference to this object might be preserved as the return value.

Calls MR_ToolPathParams_Get_voxelSize().

◆ xf()

java.lang.foreign.MemorySegment meshlib.ToolPathParams.xf ( )

mesh can be transformed using xf parameter Returns a pointer to a member variable of class MR::ToolPathParams named xf. The reference to this object might be preserved as the return value.

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


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