Detailed Description

Algorithm to convert a mesh to a point cloud.

Public Types
enum	ColorSource { TexturePreferred = 0 , ColorPreferred , Texture , Color }

enum	Mode { Vertex = 0 , Interior }

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
	MeshToPointCloudAlgorithm (const std::vector< Mesh * > &mesh)
	Main constructor.

	MeshToPointCloudAlgorithm (Mesh *mesh)

	~MeshToPointCloudAlgorithm () override
	Destructor.

void	setColorSource (ColorSource source)
	Set source for point cloud colors.

ColorSource	colorSource () const
	Get source for point cloud colors.

OwningDataList	takeOutput () override
	If new data was created, make it available here.

void	compute () override
	Execute the algorithm.

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	configure (const Properties *p)
	Configure this object instance by de-serializing the given Properties.

virtual void	configuration (Properties *p) const
	Serialize the current object configuration into the given Properties object.

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=nullptr)
	If data is compatible with algorithm return true. If a is not zero, create algorithm with input data.

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.

Public Attributes
Parameter< Mode >	p_samplingMode = {"mode", Vertex, this}

Parameter< ColorSource >	p_colorSource = {"colorSource", TexturePreferred, this}

Parameter< double >	p_density = {"density", 1.0, this}
	density determining the pixels per mm^3 in interior mode

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 Attributes
std::vector< Mesh * >	m_meshes

std::vector< std::unique_ptr< PointCloud > >	m_outPointClouds

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.

Additional Inherited Members
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.

Member Enumeration Documentation

◆ ColorSource

enum ColorSource

Enumerator
TexturePreferred	Take texture if present, color otherwise.
ColorPreferred	Take color if present, texture otherwise.
Texture	Only take texture.
Color	Only take color.

◆ Mode

enum Mode

Enumerator
Vertex	Points are taken from the mesh surface.
Interior	Points are sampled from within the mesh volume. To avoid the output being a subset of a regular grid, we add a pseudo-random offset to each point. For non-convex meshes, this can cause points to be slightly outside of the mesh.

Member Function Documentation

◆ setColorSource()

void setColorSource ( ColorSource source )

inline

Set source for point cloud colors.

Deprecated: "setColorSource() is deprecated. Please assign directly to 'p_colorSource' instead."

◆ colorSource()

ColorSource colorSource ( ) const

inline

Get source for point cloud colors.

Deprecated: "colorSource() is deprecated. Please access 'p_colorSource' directly."

◆ takeOutput()

OwningDataList takeOutput ( )

overridevirtual

If new data was created, make it available here.

Reimplemented from Algorithm.

◆ compute()

void compute ( )

overridevirtual

Execute the algorithm.

Implements Algorithm.

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

ImFusion/Base/MeshToPointCloudAlgorithm.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Additional Inherited Members