#include <SystemProcessSave.hpp>

Inheritance diagram for mgx::MeshSave:

Public Member Functions
	MeshSave (const Process &proc)

bool	run ()
	Runs the process. More...

bool	run (Mesh *mesh, const QString &filename, bool transform)
	Save a mesh. More...

QIcon	icon () const

bool	initialize (QWidget *parent)
	Initialize the process. More...

Public Member Functions inherited from mgx::Process
	Process (const Process &p)
	Copy constructor. More...

virtual	~Process ()
	Virtual destructor. More...

void	actingFile (const QString &filename, bool project_file=false)
	Method to be called anytime a file is acted on (i.e. More...

QString	actingFile () const
	Get the file currently defining the path of the system. More...

QString	pythonCall (const QStringList &parms) const
	Return the python call describing the current process. More...

int	stackCount () const
	Number of stacks available to the process. More...

Stack *	stack (int i)
	Returns the ith stack, or 0 if there is no such stack. More...

Stack *	currentStack ()
	Returns the current stack (i.e. More...

Stack *	otherStack ()
	Returns the other stack (i.e. More...

int	currentStackId () const
	Return the id (i.e. More...

int	otherStackId () const
	Return the id (i.e. More...

void	setCurrentStackId (int i)
	Change which stack is current. More...

bool	setCurrentStack (int id, const QString &store)

bool	takeSnapshot (QString filename, float overSampling=1.0f, int width=0, int height=0, int quality=95, bool expand_frustum=false)
	Save screen shot to a file. More...

bool	setStatus (const QString &msg, bool alsoPrint=true)
	Display a message in the status bar More...

bool	systemCommand (int command, const QStringList &parms)
	Run a system command. More...

MGXCamera *	camera ()
	Get the camera. More...

std::pair< stack_iterator, stack_iterator >	stacks ()
	Iterate over all the stacks. More...

std::pair< const_stack_iterator, const_stack_iterator >	stacks () const
	Iterate over all the stacks. More...

Stack *	addStack ()
	Add a new stack to the process. More...

bool	deleteStack (int i)
	Delete the stack of given id. More...

int	meshCount () const
	Returns the number of mesh available to the process. More...

Mesh *	mesh (int i)
	Returns the ith mesh. More...

Mesh *	currentMesh ()
	Returns the current mesh (i.e. More...

Mesh *	otherMesh ()
	Returns the other mesh (i.e. More...

int	currentMeshId () const
	Returns the id (i.e. More...

int	otherMeshId () const
	Returns the id (i.e. More...

void	setCurrentMeshId (int i)
	Change which mesh is current. More...

std::pair< mesh_iterator, mesh_iterator >	meshes ()
	Iterate over all the meshs. More...

std::pair< const_mesh_iterator, const_mesh_iterator >	meshes () const
	Iterate over all the meshs. More...

Mesh *	addMesh (const Stack *stack)
	Add a mesh to the process for the given stack. More...

bool	deleteMesh (int i)
	Remove a mesh from the process. More...

int	selectedLabel () const
	Get the current selected label. More...

void	setSelectedLabel (int label)
	Change the current selected label. More...

float	globalBrightness ()
	Return the current setting for the global brightness level. More...

float	globalContrast ()
	Return the current setting for the global contrast level. More...

void	setGlobalBrightness (float value)
	Change the current setting for the global brightness level. More...

void	setGlobalContrast (float value)
	Change the current setting for the global contrast level. More...

bool	meshSelection () const
	Returns if the user has mesh selection active. More...

bool	lineBorderSelection () const
	Returns is the user has line border selection active. More...

bool	updateState ()
	Update the Gui of MorphoGraphX. More...

bool	updateViewer ()
	Tell the viewer to redraw. More...

bool	loadView (const QString &fileName)
	Load viewfile. More...

bool	saveView (const QString &fileName)
	Save viewfile. More...

bool	setErrorMessage (const QString &str)
	Set an error message that will be displayed if the process returns false. More...

QString	errorMessage () const
	Get the current error message. More...

void	setWarningMessage (const QString &str)
	Set a warning message that will be displayed if the process returns true. More...

QString	warningMessage () const
	Get the current warning message. More...

void	userCancel () const
	Throw an exception informing the system that the user canceled the current process. More...

const QString &	file () const
	Get the name of the file that was used to load the current process (i.e. More...

Clip *	clip1 ()
	Return the object defining the first clipping region. More...

Clip *	clip2 ()
	Return the object defining the second clipping region. More...

Clip *	clip3 ()
	Return the object defining the third clipping region. More...

const Clip *	clip1 () const
	Return the object defining the first clipping region. More...

const Clip *	clip2 () const
	Return the object defining the second clipping region. More...

const Clip *	clip3 () const
	Return the object defining the third clipping region. More...

CuttingSurface *	cuttingSurface ()
	Return the cutting surface. More...

const CuttingSurface *	cuttingSurface () const
	Return the cutting surface. More...

Process *	makeProcess (const QString &processName)
	Creates a process object by name. More...

template<typename ProcessT >
bool	getProcess (const QString &processName, ProcessT *&p)
	Gets process. More...

bool	setCurrentParms ()
	Set the parms from the GUI. More...

bool	runProcess (Process &proc, QStringList &parms) throw ()
	Launch a process with generic arguments. More...

bool	runProcess (const QString &processName, QStringList &parms) throw ()
	Launch a process by name. More...

virtual bool	finalize (QWidget *)
	This is an optional method that is called from the main thread before the process is run. More...

CheckState	checkState ()
	Call this function and convert the result to a boolean. More...

Public Member Functions inherited from mgx::ProcessParms
	ProcessParms ()

virtual	~ProcessParms ()

QString	name () const
	Process name that is using the parameters. More...

QString	description () const
	Process description. More...

QStringList	parmNames () const
	List of named parameters. More...

QStringList	parmDescs () const
	List of parameters descriptions. More...

QStringList	parmDefaults () const
	List of default parms. More...

ParmChoiceList	parmChoice () const
	Allows the parameter to have a pick list in the GUI. More...

QIcon	icon () const
	Icon to use to represent the process in the GUI. More...

QString	parm (const QString &name) const
	Get a single parameter value by name. More...

const QStringList &	getParms ()
	Get the list of parameter values. More...

bool	setName (const QString &name)
	Set the name. More...

bool	setDesc (const QString &description)
	Set the description. More...

bool	addParm (const QString &parmName, const QString &desc, const QString &def, const QStringList &choices=QStringList())
	Add a parameter to the list. More...

bool	insertParm (const QString &parmName, const QString &desc, const QString &def, int pos, const QStringList &choices=QStringList())
	Insert a parameter to the list. More...

bool	setParm (const QString &parmName, const QString &parm)
	Set the parameter's value. More...

bool	setParms (const QStringList &parms)
	Set all the parameter values. More...

bool	setParmDesc (const QString &parmName, const QString &desc)
	Set the parameter's description. More...

bool	setParmDefault (const QString &parmName, const QString &def)
	Set the parameter's default value. More...

bool	setParmChoices (const QString &parmName, const QStringList &choices)
	Set the parameter's choices. More...

bool	setIcon (const QIcon &icon)
	Set the icon. More...

QStringList	parmList (const QString &key=QString()) const
	Return a list of parameter names. More...

Protected Slots
void	selectMeshFile ()

Protected Member Functions
QString	properFile (QString filename) const

void	setMeshFile (const QString &filename)

Point3d	savedPos (Point3d pos, bool transform, const Stack *stack)

bool	saveMesh (Mesh *mesh, const QString &filename, bool transform)

Protected Member Functions inherited from mgx::Process
bool	stackCheck (int checks, int which)
	Check stack properties. More...

bool	storeCheck (int checks, int which)
	Check store properties. More...

bool	meshCheck (int checks, int which)
	Check mesh properties. More...

QString	stackError (int checks, int which)
	Generate a standardised string describing how the stack should be to not generate an error. More...

QString	storeError (int checks, int which)
	Generate a standardised string describing how the store should be to not generate an error. More...

QString	meshError (int checks, int which)
	Generate a standardised string describing how the mesh should be to not generate an error. More...

Protected Attributes
QDialog *	dlg

Ui_SaveMeshDialog *	ui

Additional Inherited Members
Public Types inherited from mgx::Process
enum	ProcessAction { PROCESS_RUN, PROCESS_STEP, PROCESS_REWIND }
	Enumeration for process flow control. More...

enum	StackCheckType { STACK_ANY, STACK_NON_EMPTY, STACK_VISIBLE, STACK_EMPTY, STACK_SCALED, STACK_TRANSFORMED, STACK_NON_SCALED, STACK_NON_TRANSFORMED }
	Enumeration for the bitfield that identifies stack properties. More...

enum	StoreCheckType { STORE_ANY, STORE_NON_EMPTY, STORE_VISIBLE, STORE_EMPTY, STORE_LABEL, STORE_NON_LABEL, STORE_SCALED, STORE_TRANSFORMED, STORE_NON_SCALED, STORE_NON_TRANSFORMED, STORE_WORK, STORE_MAIN }
	Enumeration for the bitfield that identifies store properties. More...

enum	MeshCheckType { MESH_ANY, MESH_NON_EMPTY, MESH_VISIBLE, MESH_HEAT, MESH_LABEL, MESH_NORMAL, MESH_SIGNAL, MESH_TEXTURE, MESH_IMAGE, MESH_SHOW_MESH, MESH_SHOW_SURF, MESH_ALL, MESH_BORDER, MESH_CELLMAP, MESH_CELLS, MESH_IMG_TEX, MESH_SCALED, MESH_TRANSFORMED, MESH_EMPTY, MESH_NON_CELLS, MESH_NON_IMG_TEX, MESH_NON_SCALED, MESH_NON_TRANSFORMED, MESH_USE_PARENTS }
	Enumeration for the bitfield that identifies mesh properties. More...

enum	CheckType { CHECK_STACK, CHECK_STORE, CHECK_MESH }
	Enumeration of the type of checks that can be performed. More...

enum	CheckWhich { CHECK_CURRENT }

typedef std::vector< Stack * >::iterator	stack_iterator

typedef std::vector< Stack * >::const_iterator	const_stack_iterator

typedef std::vector< Mesh * >::iterator	mesh_iterator

typedef std::vector< Mesh * >::const_iterator	const_mesh_iterator

Signals inherited from mgx::Process
void	systemCommandGui (mgx::Process *, int, QStringList)

void	systemCommandProcess (mgx::Process *, int, QStringList)

Static Public Member Functions inherited from mgx::ProcessParms
static QStringList	booleanChoice ()
	Helper function that provides a list of choices for a boolean argument. More...

static QStringList	storeChoice ()
	Helper function that provides a list of choices for choosing from the main or work stack. More...

static QStringList	stackChoice ()
	Helper function that provides a list of choices for choosing between stack 1 and 2. More...

static QStringList	meshChoice ()
	Helper function that provides a list of choices for choosing between stack 1 and 2. More...

static QStringList	dimensionChoice ()
	Helper function that provides a list of choices for choosing the dimension. More...

static QStringList	dimChoice ()
	Helper function that provides a list of choices for choosing the dimension. More...

Public Attributes inherited from mgx::Process
PrivateProcess *	p

Static Public Attributes inherited from mgx::Process
static unsigned int	processVersion

static std::vector< Colorf > &	LabelColors

Detailed Description

Save a mesh into a INRIA or MGXM file.

Description of the MGXM file format

MGXM is a binary file format to store triangular meshes with all the data and meta-data used by MorphoGraphX.

There are a few versions, from 1.0 to 1.2. This version of MorphoGraphX will always generate MGXM files version 1.2.

Each MGXM file starts with the ASCII string MGXM followed by a space, the version number in ASCII and another space. For instance, for the current version, the file starts with the ASCII string "MGXM 1.2 ".

A binary header follows the version number. The header is made of:

Field	Size (bytes)	type	Version	Description
is_cells	1	bool	1.2	If true, the mesh represent 2D cells (see notes)
scale	1	bool	1.1	If true, the mesh has been scaled when saved
transform	1	bool	1.1	If true, the mesh has been transformed rigidly
signalLow	4	float	1.1	Lower value of the signal
signalHigh	4	float	1.1	Upper value of the signal
signalUnit	*	utf8	1.1	Text of the signal unit (see notes)
header_size	4	uint	1.0	Specified the size in bytes of extra data placed after the header
vertex_cnt	4	uint	1.0	Number of vertices in the mesh
vertex_size	4	uint	1.0	Size in bytes of the structure describing a vertex, minus 12.
edge_size	4	uint	1.0	Size in bytes of the structure describing an edge.

The description of the vertices follows the header. For each vertex, a structure of size vertex_size+12 is written. Only fields fitting in the given size are actually written, and any other data is ignored. Note that the first four field are always there!

Field	Size (bytes)	type	Description
Id	4	uint	Id of the vertex, used to reference it in other places in the file
X	4	float	X position of the vertex
Y	4	float	Y position of the vertex
Z	4	float	Z position of the vertex
label	4	uint	Label of the vertex
color	4	float	"Color" of the vertex (e.g. like signal, but scaled from 0 to 1)
signal	4	float	Signal of the vertex
type	1	char	type of vertex ‘'c’`for center and`'j'` for junction.
selected	1	bool	If true, the vertex is selected

Currently, the edges have no defined fields. For each vertex, the Id of the vertex is written, followed by a 32 bits unsigned integer for the number of neighbors, and the list of Id for each neighbor. Neighbors of a vertex are always written counter-clockwise.

Notes on UTF-8 strings

UTF-8 strings are written as: their size in bytes as a 32 bits unsigned integer, followed by the bytes themselves.

Notes on vertex labels

Vertex are labels to mark which cells they are part of. Boundary vertices are labeled with -1 or -2. -1 mark vertices between cells, and -2 vertices at the border of the whole mesh.

Notes on cell mesh

If the mesh is a cell mesh, then each cell has a unique labeled vertex on its center, surrounded by cell-boundary vertices, labels -1 or -2. In this case, labeled vertices have type ‘'c’and boundary vertices'j'`.

Definition at line 238 of file SystemProcessSave.hpp.

Constructor & Destructor Documentation

◆ MeshSave()

mgx::MeshSave::MeshSave ( const Process & proc )

inline

Definition at line 241 of file SystemProcessSave.hpp.

Member Function Documentation

◆ icon()

QIcon mgx::MeshSave::icon ( ) const

inline

Definition at line 259 of file SystemProcessSave.hpp.

◆ initialize()

bool mgx::MeshSave::initialize ( QWidget * )

virtual

Initialize the process.

Called from the main (GUI) thread before the process is run. If there is an active GUI, then parent will be set.

The process can use the method to update the argument list with a dialog. If the arguments are updates, the process should return true

Parameters

parent Pointer to the parent widget if there is an active GUI.

Returns: false if the process is not to run afterwards

Reimplemented from mgx::Process.

◆ properFile()

QString mgx::MeshSave::properFile ( QString filename ) const

protected

◆ run() [1/2]

bool mgx::MeshSave::run ( )

virtual

Runs the process.

Returns: false if process failed, true otherwise (FIXME: what kind of fail do we care about?)

Reimplemented from mgx::Process.

◆ run() [2/2]

bool mgx::MeshSave::run	(	Mesh *	mesh,
		const QString &	filename,
		bool	transform
	)

Save a mesh.

Parameters

mesh	Mesh to be saved
filename	File to save the mesh in. Its extension must be either .inr or .mgmx [aram transform Save the transformed positions

◆ savedPos()

Point3d mgx::MeshSave::savedPos	(	Point3d	pos,
		bool	transform,
		const Stack *	stack
	)

protected

◆ saveMesh()

bool mgx::MeshSave::saveMesh	(	Mesh *	mesh,
		const QString &	filename,
		bool	transform
	)

protected

◆ selectMeshFile

void mgx::MeshSave::selectMeshFile ( )

protectedslot

◆ setMeshFile()

void mgx::MeshSave::setMeshFile ( const QString & filename )

protected

Member Data Documentation

◆ dlg

QDialog* mgx::MeshSave::dlg

protected

Definition at line 272 of file SystemProcessSave.hpp.

◆ ui

Ui_SaveMeshDialog* mgx::MeshSave::ui

protected

Definition at line 273 of file SystemProcessSave.hpp.

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

src/SystemProcessSave.hpp

Public Member Functions

Protected Slots

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Description of the MGXM file format

Notes on UTF-8 strings

Notes on vertex labels

Notes on cell mesh

Constructor & Destructor Documentation

◆ MeshSave()

Member Function Documentation

◆ icon()

◆ initialize()

◆ properFile()

◆ run() [1/2]

◆ run() [2/2]

◆ savedPos()

◆ saveMesh()

◆ selectMeshFile

◆ setMeshFile()

Member Data Documentation

◆ dlg

◆ ui