MeshBooleanOperationsAlgorithm Class Reference

#include <ImFusion/Mesh/MeshBooleanOperationsAlgorithm.h>

Algorithm for performing boolean operations on meshes. More...

Inheritance diagram for MeshBooleanOperationsAlgorithm:

Detailed Description

Algorithm for performing boolean operations on meshes.

Meshes must be watertight. The algorithm internally will only check if the meshes are manifold and closed but it will not check for self-intersections. When in doubt, use Mesh::isSelfIntersecting

Public Types
enum	Mode { UNION = 0 , DIFFERENCE , INTERSECTION }
	Enumeration listing supported boolean operations. More...
enum class	StatusExt { NonManifoldInput = static_cast<int>(Status::User) + 1 , EmptyOutput }
	Enumeration listing possible errors during the computation. More...
Public Types inherited from Algorithm
enum	Status {   Unknown = -1 , Success = 0 , Error = 1 , InvalidInput ,   IncompleteInput , OutOfMemoryHost , OutOfMemoryGPU , UnsupportedGPU ,   UnknownAction , AbortedByUser , User = 1000 }
	Status codes. More...

Public Member Functions
	MeshBooleanOperationsAlgorithm (Mesh *mesh1, Mesh *mesh2)
	Constructor.
	MeshBooleanOperationsAlgorithm (const Mesh *mesh1, const Mesh *mesh2)
	~MeshBooleanOperationsAlgorithm () override
	Destructor.
void	compute () override
	Execute the algorithm.
OwningDataList	takeOutput () override
	Return any new Data that was created by the Algorithm during the last call to compute().
void	configure (const Properties *p) override
	Configure this object instance by de-serializing the given Properties.
void	configuration (Properties *p) const override
	Serialize the current object configuration into the given Properties object.
void	setMode (const Mode &mode)
	Set computation mode.
Mode	mode () const
	Get computation mode.
void	setCreateNewMesh (bool create)
	Specify whether the new mesh should be created.
bool	createNewMesh () const
	Returns true if the new mesh should be created, returns false if the result of the computation should be assigned to the first mesh (i.e.
void	setFirstMesh (int mesh)
	Specify which mesh should be the first one.
int	firstMesh () const
	Returns 0 if the first input mesh should be the first one (when calculating difference between two meshes), returns 1 if the second input mesh should be the first one.
const std::vector< Mesh * >	inputMeshes () const
Public Member Functions inherited from Algorithm
	Algorithm ()
	Default constructor will registers a single "compute" action that calls compute() and returns status().
virtual void	setProgress (Progress *progress)
	Sets a Progress interface the algorithm can use to notify observers about its computing progress.
Progress *	progress () const
	Returns the progress interface if set.
virtual int	status () const
	Indicates the status of the last call to compute().
virtual bool	survivesDataDeletion (const Data *) const
	Indicates whether the algorithm can handle (partial) deletion of the specified data, by default this checks whether the data is in the input list.
const FactoryInfo &	factoryInfo () const
	Returns the record describing how this Algorithm was instantiated by the AlgorithmFactory.
void	setFactoryInfo (const FactoryInfo &value)
	Sets the record describing how this Algorithm was instantiated by the AlgorithmFactory.
Status	runAction (const std::string &id)
	Run the action with name id if it exists.
const std::vector< Action > &	actions ()
	Get a mapping from Action id to Action as registered in this algorithm.
Public Member Functions inherited from Configurable
virtual void	configureDefaults ()
	Retrieve the properties of this object, replaces values with their defaults and sets it again.
void	registerParameter (ParameterBase *param)
	Register the given Parameter or SubProperty, so that it will be configured during configure()/configuration().
void	unregisterParameter (const ParameterBase *param)
	Remove the given Parameter or SubProperty from the list of registered parameters.
	Configurable (const Configurable &rhs)
	Configurable (Configurable &&rhs) noexcept
Configurable &	operator= (const Configurable &)
Configurable &	operator= (Configurable &&) noexcept

Static Public Member Functions
static bool	createCompatible (const DataList &data, Algorithm **a=0)
Static Public Member Functions inherited from Algorithm
static bool	createCompatible (const DataList &data, Algorithm **a=nullptr)
	Factory function to check algorithm compatibility with input data and optionally instantiate it.

Additional Inherited Members
Public Attributes inherited from Algorithm
Signal	signalOutputChanged
	Signal should be emitted by Algorithms when their output/result has changed.
Signal	signalParametersChanged
	Signal should be emitted by Algorithms when their parameter configuration has changed.
Public Attributes inherited from Configurable
Signal	signalParametersChanged
	Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted.
Protected Member Functions inherited from Algorithm
void	loadDefaults ()
void	registerAction (const std::string &id, const std::string &guiName, const std::function< Algorithm::Status(void)> &action)
	Register an action to be run via runAction.
template<typename D>
void	registerAction (const std::string &id, const std::string &guiName, Algorithm::Status(D::*action)(void))
	Template version of runAction that can be used with a pointer to a member function.
void	registerAction (const Action &action)
	Register an action.
Protected Attributes inherited from Algorithm
std::string	m_name
	Algorithm name.
Progress *	m_progress = nullptr
	Non-owing pointer to a progress interface. May be a nullptr.
FactoryInfo	m_factoryInfo = {}
	Record describing how this algorithm was instantiated by the AlgorithmFactory.
int	m_status = Status::Unknown
	Algorithm status after last call to compute()
std::vector< Action >	m_actions
	Map of key given by the id of the action, of the available actions of this algorithm.
Protected Attributes inherited from Configurable
std::vector< Param >	m_params
	List of all registered Parameter and SubProperty instances.

Member Enumeration Documentation

Mode

enum Mode

Enumeration listing supported boolean operations.

Enumerator
UNION	Compute union between first and second mesh.
DIFFERENCE	Subtract second from first mesh.
INTERSECTION	Extract portion common to both, first and second mesh.

StatusExt

enum class StatusExt

strong

Enumeration listing possible errors during the computation.

Enumerator
NonManifoldInput	At least one of the input meshes is non-manifold.
EmptyOutput	The boolean operation applied to meshes resulted in an empty mesh.

Member Function Documentation

compute()

void compute ( )

overridevirtual

Execute the algorithm.

Implements Algorithm.

takeOutput()

OwningDataList takeOutput ( )

overridevirtual

Return any new Data that was created by the Algorithm during the last call to compute().

The default implementation will return an empty list.

Note

Since ownership of the data is transferred, you can call this method only once between calls to compute().

Reimplemented from Algorithm.

configure()

void configure ( const Properties * p )

overridevirtual

Configure this object instance by de-serializing the given Properties.

The default implementation will do so automatically for all registered Parameter and SubProperty instances.

See also

configuration() for the inverse functionality

Reimplemented from Configurable.

configuration()

void configuration ( Properties * p ) const

overridevirtual

Serialize the current object configuration into the given Properties object.

The default implementation will do so automatically for all registered Parameter and SubProperty instances.

See also

configure() for the inverse functionality

Reimplemented from Configurable.

createNewMesh()

bool createNewMesh ( ) const

inline

Returns true if the new mesh should be created, returns false if the result of the computation should be assigned to the first mesh (i.e.

to the mesh m_firstMesh)

---

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

• ImFusion/Mesh/MeshBooleanOperationsAlgorithm.h