Classes and functions needed to create your own processes or call other processes. More...

Classes
class	mgx::UserCancelException

class	mgx::Process

struct	mgx::ProcessDefinition

Macros
#define	REGISTER_PROCESS(ClassName)

Typedefs
typedef QList< QStringList >	mgx::ParmChoiceList
	Type of the dictionary giving the list of possible strings for each argument. More...

Functions
mgx_EXPORT ProcessDefinition *	mgx::getProcessDefinition (const QString &processName)
	Retrieves the process definition from the name of the process. More...

mgx_EXPORT bool	mgx::getLastParms (const Process &proc, QStringList &parms)
	Get the parameters for a given process. More...

mgx_EXPORT bool	mgx::getDefaultParms (const Process &proc, QStringList &parms)
	Get the default parameters for a given process (i.e. the ones defined by the process) More...

mgx_EXPORT bool	mgx::saveDefaultParms (const Process &proc, const QStringList &parms)
	Save the default parameters in memory. More...

mgx_EXPORT bool	mgx::checkProcessParms (const Process &proc, const QStringList &parms, size_t *nbParms=0)
	Check if the parameters have enough defaults. More...

mgx_EXPORT bool	mgx::getLastParms (const QString &processName, QStringList &parms)
	Get the parameters for a given process. More...

mgx_EXPORT bool	mgx::getDefaultParms (const QString &processName, QStringList &parms)
	Get the default parameters for a given process (i.e. the ones defined by the process) More...

mgx_EXPORT bool	mgx::saveDefaultParms (const QString &processName, const QStringList &parms)
	Save the default parameters in memory. More...

mgx_EXPORT bool	mgx::checkProcessParms (const QString &processName, const QStringList &parms, size_t *nbParms=0)
	Check if the parameters have enough defaults. More...

mgx_EXPORT ProcessDefinition *	mgx::getProcessDefinition (const QString &processThread, const QString &processName)
	Get the definition of a process. More...

mgx_EXPORT QStringList	mgx::listProcesses ()
	Returns the list of names of the processes. More...

mgx_EXPORT bool	mgx::getProcessText (const QString &text, QString &tab, QString &folder, QString &name)
	Split process name into Tab/Folder/Name. More...

mgx_EXPORT bool	mgx::validProcessName (const QString &processName)
	Check if the `processName` exist in the list of processes. More...

mgx_EXPORT bool	mgx::stringToBool (const QString &string)
	Helper function converting a string into a boolean. More...

mgx_EXPORT bool	mgx::stringToWorkStore (const QString &string)
	Returns true if `string` correspond to the work store, false otherwise. More...

mgx_EXPORT bool	mgx::stringToMainStore (const QString &string)
	Returns true if `string` correspond to the main store, false otherwise. More...

QString	mgx::boolToString (bool b)
	Helper function converting a boolean into a string. More...

Signal methods. The signal can arise from a fluorescence intensity
projection, a curvature projection, or from another process. These methods specifies the range and the units.
static bool	mgx::Mesh::meshFromTriangles (vvGraph &S, const std::vector< vertex > &vertices, const std::vector< Point3i > &triangles, bool checkUnique=true)
	Create the mesh from a triangle list. More...

Detailed Description

Classes and functions needed to create your own processes or call other processes.

Macro Definition Documentation

◆ REGISTER_PROCESS

#define REGISTER_PROCESS ( ClassName )

Register ClassName as a process. It must inherit Process and have a constructor accepting a single Process.

Definition at line 863 of file Process.hpp.

Typedef Documentation

◆ ParmChoiceList

typedef QList<QStringList> mgx::ParmChoiceList

Type of the dictionary giving the list of possible strings for each argument.

If the choice is free, the position should just not be present in the dictionnary.

Definition at line 31 of file ProcessParms.hpp.

Function Documentation

◆ boolToString()

QString mgx::boolToString ( bool b )

inline

Helper function converting a boolean into a string.

Definition at line 945 of file Process.hpp.

◆ checkProcessParms() [1/2]

mgx_EXPORT bool mgx::checkProcessParms	(	const Process &	proc,
		const QStringList &	parms,
		size_t *	nbParms = `0`
	)

Check if the parameters have enough defaults.

◆ checkProcessParms() [2/2]

mgx_EXPORT bool mgx::checkProcessParms	(	const QString &	processName,
		const QStringList &	parms,
		size_t *	nbParms = `0`
	)

Check if the parameters have enough defaults.

◆ getDefaultParms() [1/2]

mgx_EXPORT bool mgx::getDefaultParms	(	const Process &	proc,
		QStringList &	parms
	)

Get the default parameters for a given process (i.e. the ones defined by the process)

◆ getDefaultParms() [2/2]

mgx_EXPORT bool mgx::getDefaultParms	(	const QString &	processName,
		QStringList &	parms
	)

Get the default parameters for a given process (i.e. the ones defined by the process)

◆ getLastParms() [1/2]

mgx_EXPORT bool mgx::getLastParms	(	const Process &	proc,
		QStringList &	parms
	)

Get the parameters for a given process.

◆ getLastParms() [2/2]

mgx_EXPORT bool mgx::getLastParms	(	const QString &	processName,
		QStringList &	parms
	)

Get the parameters for a given process.

◆ getProcessDefinition() [1/2]

mgx_EXPORT ProcessDefinition* mgx::getProcessDefinition ( const QString & processName )

Retrieves the process definition from the name of the process.

◆ getProcessDefinition() [2/2]

mgx_EXPORT ProcessDefinition* mgx::getProcessDefinition	(	const QString &	processThread,
		const QString &	processName
	)

Get the definition of a process.

◆ getProcessText()

mgx_EXPORT bool mgx::getProcessText	(	const QString &	text,
		QString &	tab,
		QString &	folder,
		QString &	name
	)

Split process name into Tab/Folder/Name.

◆ listProcesses()

mgx_EXPORT QStringList mgx::listProcesses ( )

Returns the list of names of the processes.

◆ meshFromTriangles()

static bool mgx::Mesh::meshFromTriangles	(	vvGraph &	S,
		const std::vector< vertex > &	vertices,
		const std::vector< Point3i > &	triangles,
		bool	checkUnique = `true`
	)

static

Create the mesh from a triangle list.

This function creates a graph from a triangle soup.

Note: The graph will not be cleared, the triangles will be added to the graph.

Parameters

S	Graph that will be updated.
vertices	List of vertices to insert in S, must be unique
triangles	List of triplet of indices in `vertices` defining triangles

Returns: true on success, false on failure

◆ saveDefaultParms() [1/2]

mgx_EXPORT bool mgx::saveDefaultParms	(	const Process &	proc,
		const QStringList &	parms
	)

Save the default parameters in memory.

◆ saveDefaultParms() [2/2]

mgx_EXPORT bool mgx::saveDefaultParms	(	const QString &	processName,
		const QStringList &	parms
	)

Save the default parameters in memory.

◆ stringToBool()

mgx_EXPORT bool mgx::stringToBool ( const QString & string )

Helper function converting a string into a boolean.

◆ stringToMainStore()

mgx_EXPORT bool mgx::stringToMainStore ( const QString & string )

Returns true if string correspond to the main store, false otherwise.

◆ stringToWorkStore()

mgx_EXPORT bool mgx::stringToWorkStore ( const QString & string )

Returns true if string correspond to the work store, false otherwise.

◆ validProcessName()

mgx_EXPORT bool mgx::validProcessName ( const QString & processName )

Check if the processName exist in the list of processes.

Classes

Macros

Typedefs

Functions

Signal methods. The signal can arise from a fluorescence intensity