MeshFilterParameters Class Reference

Class containing a set of parameters for the mesh filtration functionality. More...

Types

enum class  MESH_FILTER
 Lists available mesh filtering intensities. More...
 

Functions

 MeshFilterParameters (MESH_FILTER mesh_filtering=MESH_FILTER::LOW)
 Default constructor. More...
 
void set (MESH_FILTER mesh_filtering=MESH_FILTER::LOW)
 Sets the filtering intensity. More...
 
bool save (String filename)
 Saves the current set of parameters into a file to be reloaded with the load() method. More...
 
bool load (String filename)
 Loads a set of parameters from the values contained in a previously saved file. More...
 

Attributes

MESH_FILTER filtering = MESH_FILTER::LOW
 Filtering intensity. More...
 

Detailed Description

Class containing a set of parameters for the mesh filtration functionality.

The default constructor sets all parameters to their default settings.

Note
Parameters can be adjusted by the user.

Constructor and Destructor

◆ MeshFilterParameters()

MeshFilterParameters ( MESH_FILTER  mesh_filtering = MESH_FILTER::LOW)
inline

Default constructor.

All the parameters are set to their default values.

Functions

◆ set()

void set ( MESH_FILTER  mesh_filtering = MESH_FILTER::LOW)
inline

Sets the filtering intensity.

Parameters
mesh_filtering: Desired sl::MeshFilterParameters::MESH_FILTER.

◆ save()

bool save ( String  filename)

Saves the current set of parameters into a file to be reloaded with the load() method.

Parameters
filename: Name of the file which will be created to store the parameters.
Returns
True if the file was successfully saved, otherwise false.
Warning
For security reasons, the file must not already exist.
In case a file already exists, the method will return false and existing file will not be updated.

◆ load()

bool load ( String  filename)

Loads a set of parameters from the values contained in a previously saved file.

Parameters
filename: Path to the file from which the parameters will be loaded.
Returns
True if the file was successfully loaded, otherwise false.

Variables

◆ filtering

Filtering intensity.