1 /*   EXTRAITS DE LA LICENCE
2 	Copyright CEA, contributeurs : Luc BILLARD et Damien
3 	CALISTE, laboratoire L_Sim, (2001-2005)
4 
5 	Adresse mèl :
6 	BILLARD, non joignable par mèl ;
7 	CALISTE, damien P caliste AT cea P fr.
8 
9 	Ce logiciel est un programme informatique servant à visualiser des
10 	structures atomiques dans un rendu pseudo-3D.
11 
12 	Ce logiciel est régi par la licence CeCILL soumise au droit français et
13 	respectant les principes de diffusion des logiciels libres. Vous pouvez
14 	utiliser, modifier et/ou redistribuer ce programme sous les conditions
15 	de la licence CeCILL telle que diffusée par le CEA, le CNRS et l'INRIA
16 	sur le site "http://www.cecill.info".
17 
18 	Le fait que vous puissiez accéder à cet en-tête signifie que vous avez
19 	pris connaissance de la licence CeCILL, et que vous en avez accepté les
20 	termes (cf. le fichier Documentation/licence.fr.txt fourni avec ce logiciel).
21 */
22 
23 /*   LICENCE SUM UP
24 	Copyright CEA, contributors : Luc BILLARD et Damien
25 	CALISTE, laboratoire L_Sim, (2001-2005)
26 
27 	E-mail address:
28 	BILLARD, not reachable any more ;
29 	CALISTE, damien P caliste AT cea P fr.
30 
31 	This software is a computer program whose purpose is to visualize atomic
32 	configurations in 3D.
33 
34 	This software is governed by the CeCILL  license under French law and
35 	abiding by the rules of distribution of free software.  You can  use,
36 	modify and/ or redistribute the software under the terms of the CeCILL
37 	license as circulated by CEA, CNRS and INRIA at the following URL
38 	"http://www.cecill.info".
39 
40 	The fact that you are presently reading this means that you have had
41 	knowledge of the CeCILL license and that you accept its terms. You can
42 	find a copy of this licence shipped with this software at Documentation/licence.en.txt.
43 */
44 #ifndef VISU_DUMP_H
45 #define VISU_DUMP_H
46 
47 #include <glib.h>
48 #include <glib-object.h>
49 
50 #include "visu_tools.h"
51 #include "coreTools/toolFileFormat.h"
52 #include "visu_data.h"
53 
54 G_BEGIN_DECLS
55 
56 /**
57  * VISU_TYPE_DUMP:
58  *
59  * Return the associated #GType to the VisuDump objects.
60  */
61 #define VISU_TYPE_DUMP         (visu_dump_get_type ())
62 /**
63  * VISU_DUMP:
64  * @obj: the widget to cast.
65  *
66  * Cast the given object to a #VisuDump object.
67  */
68 #define VISU_DUMP(obj)         (G_TYPE_CHECK_INSTANCE_CAST ((obj), VISU_TYPE_DUMP, VisuDump))
69 /**
70  * VISU_DUMP_CLASS:
71  * @klass: the class to cast.
72  *
73  * Cast the given class to a #VisuDumpClass object.
74  */
75 #define VISU_DUMP_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), VISU_TYPE_DUMP, VisuDumpClass))
76 /**
77  * VISU_IS_DUMP:
78  * @obj: the object to test.
79  *
80  * Return if the given object is a valid #VisuDump object.
81  */
82 #define VISU_IS_DUMP(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), VISU_TYPE_DUMP))
83 /**
84  * VISU_IS_DUMP_CLASS:
85  * @klass: the class to test.
86  *
87  * Return if the given class is a valid #VisuDumpClass class.
88  */
89 #define VISU_IS_DUMP_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), VISU_TYPE_DUMP))
90 /**
91  * VISU_DUMP_GET_CLASS:
92  * @obj: the widget to get the class of.
93  *
94  * Get the class of the given object.
95  */
96 #define VISU_DUMP_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS(obj, VISU_TYPE_DUMP, VisuDumpClass))
97 
98 typedef struct _VisuDump VisuDump;
99 struct _VisuDump
100 {
101   ToolFileFormat parent;
102 };
103 /**
104  * VisuDumpClass:
105  * @parent: the parent class.
106  *
107  * An opaque structure.
108  */
109 typedef struct _VisuDumpClass VisuDumpClass;
110 struct _VisuDumpClass
111 {
112   ToolFileFormatClass parent;
113 };
114 
115 /**
116  * visu_dump_get_type
117  *
118  * #GType are unique numbers to identify objects.
119  *
120  * Returns: the #GType associated with #VisuDump objects.
121  */
122 GType visu_dump_get_type(void);
123 
124 /**
125  * VISU_DUMP_ERROR: (skip)
126  *
127  * Internal function for error handling.
128  */
129 #define VISU_DUMP_ERROR visu_dump_getQuark()
130 GQuark visu_dump_getQuark();
131 /**
132  * VisuDumpErrorFlag:
133  * @DUMP_ERROR_OPENGL: Error with OpenGL dumping.
134  * @DUMP_ERROR_FILE: Error when opening.
135  * @DUMP_ERROR_ENCODE: Wrongness when computing the encoding format.
136  *
137  * These are flags used when dumping to a file.
138  */
139 typedef enum
140   {
141     DUMP_ERROR_OPENGL,
142     DUMP_ERROR_FILE,
143     DUMP_ERROR_ENCODE
144   } VisuDumpErrorFlag;
145 
146 
147 /**
148  * VisuDumpInitFunc: (skip)
149  *
150  * This protoype defines initializing function for dumping extension.
151  * Create such a function and add its name in the list #listInitDumpModuleFunc
152  * defined in dumpModules/externalDumpModules.h thus the new dumping extension
153  * will be initialized on startup.
154  *
155  * Returns: a newly allocated #VisuDump.
156  */
157 typedef const VisuDump* (*VisuDumpInitFunc) ();
158 
159 GList* visu_dump_pool_getAllModules();
160 gint visu_dump_getNModules();
161 void visu_dump_pool_finalize(void);
162 
163 /**
164  * visu_dump_abort:
165  * @obj: an object ;
166  * @data: some data.
167  *
168  * Does nothing for the moment.
169  */
170 void visu_dump_abort(GObject *obj, gpointer data);
171 
172 G_END_DECLS
173 
174 #endif
175