1 /*   EXTRAITS DE LA LICENCE
2 	Copyright CEA, contributeurs : Damien
3 	CALISTE, laboratoire L_Sim, (20016)
4 
5 	Adresse mèl :
6 	CALISTE, damien P caliste AT cea P fr.
7 
8 	Ce logiciel est un programme informatique servant à visualiser des
9 	structures atomiques dans un rendu pseudo-3D.
10 
11 	Ce logiciel est régi par la licence CeCILL soumise au droit français et
12 	respectant les principes de diffusion des logiciels libres. Vous pouvez
13 	utiliser, modifier et/ou redistribuer ce programme sous les conditions
14 	de la licence CeCILL telle que diffusée par le CEA, le CNRS et l'INRIA
15 	sur le site "http://www.cecill.info".
16 
17 	Le fait que vous puissiez accéder à cet en-tête signifie que vous avez
18 	pris connaissance de la licence CeCILL, et que vous en avez accepté les
19 	termes (cf. le fichier Documentation/licence.fr.txt fourni avec ce logiciel).
20 */
21 
22 /*   LICENCE SUM UP
23 	Copyright CEA, contributors : Damien
24 	CALISTE, laboratoire L_Sim, (20016)
25 
26 	E-mail address:
27 	CALISTE, damien P caliste AT cea P fr.
28 
29 	This software is a computer program whose purpose is to visualize atomic
30 	configurations in 3D.
31 
32 	This software is governed by the CeCILL  license under French law and
33 	abiding by the rules of distribution of free software.  You can  use,
34 	modify and/ or redistribute the software under the terms of the CeCILL
35 	license as circulated by CEA, CNRS and INRIA at the following URL
36 	"http://www.cecill.info".
37 
38 	The fact that you are presently reading this means that you have had
39 	knowledge of the CeCILL license and that you accept its terms. You can
40 	find a copy of this licence shipped with this software at COPYING.
41 */
42 #ifndef MAPSET_H
43 #define MAPSET_H
44 
45 #include "maps.h"
46 #include "shade.h"
47 
48 /**
49  * VISU_TYPE_GL_EXT_MAP_SET:
50  *
51  * return the type of #VisuGlExtMapSet.
52  *
53  * Since: 3.7
54  */
55 #define VISU_TYPE_GL_EXT_MAP_SET	     (visu_gl_ext_map_set_get_type ())
56 /**
57  * VISU_GL_EXT_MAP_SET:
58  * @obj: a #GObject to cast.
59  *
60  * Cast the given @obj into #VisuGlExtMapSet type.
61  *
62  * Since: 3.7
63  */
64 #define VISU_GL_EXT_MAP_SET(obj)	     (G_TYPE_CHECK_INSTANCE_CAST(obj, VISU_TYPE_GL_EXT_MAP_SET, VisuGlExtMapSet))
65 /**
66  * VISU_GL_EXT_MAP_SET_CLASS:
67  * @klass: a #GObjectClass to cast.
68  *
69  * Cast the given @klass into #VisuGlExtMapSetClass.
70  *
71  * Since: 3.7
72  */
73 #define VISU_GL_EXT_MAP_SET_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST(klass, VISU_TYPE_GL_EXT_MAP_SET, VisuGlExtMapSetClass))
74 /**
75  * VISU_IS_GL_EXT_MAP_SET:
76  * @obj: a #GObject to test.
77  *
78  * Test if the given @ogj is of the type of #VisuGlExtMapSet object.
79  *
80  * Since: 3.7
81  */
82 #define VISU_IS_GL_EXT_MAP_SET(obj)    (G_TYPE_CHECK_INSTANCE_TYPE(obj, VISU_TYPE_GL_EXT_MAP_SET))
83 /**
84  * VISU_IS_GL_EXT_MAP_SET_CLASS:
85  * @klass: a #GObjectClass to test.
86  *
87  * Test if the given @klass is of the type of #VisuGlExtMapSetClass class.
88  *
89  * Since: 3.7
90  */
91 #define VISU_IS_GL_EXT_MAP_SET_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE(klass, VISU_TYPE_GL_EXT_MAP_SET))
92 /**
93  * VISU_GL_EXT_MAP_SET_GET_CLASS:
94  * @obj: a #GObject to get the class of.
95  *
96  * It returns the class of the given @obj.
97  *
98  * Since: 3.7
99  */
100 #define VISU_GL_EXT_MAP_SET_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS(obj, VISU_TYPE_GL_EXT_MAP_SET, VisuGlExtMapSetClass))
101 
102 typedef struct _VisuGlExtMapSet        VisuGlExtMapSet;
103 typedef struct _VisuGlExtMapSetPrivate VisuGlExtMapSetPrivate;
104 typedef struct _VisuGlExtMapSetClass   VisuGlExtMapSetClass;
105 
106 struct _VisuGlExtMapSet
107 {
108   VisuGlExtMaps parent;
109 
110   VisuGlExtMapSetPrivate *priv;
111 };
112 
113 struct _VisuGlExtMapSetClass
114 {
115   VisuGlExtMapsClass parent;
116 };
117 
118 /**
119  * visu_gl_ext_map_set_get_type:
120  *
121  * This method returns the type of #VisuGlExtMapSet, use
122  * VISU_TYPE_GL_EXT_MAP_SET instead.
123  *
124  * Since: 3.8
125  *
126  * Returns: the type of #VisuGlExtMapSet.
127  */
128 GType visu_gl_ext_map_set_get_type(void);
129 
130 VisuGlExtMapSet* visu_gl_ext_map_set_new(const gchar *name);
131 VisuGlExtShade* visu_gl_ext_map_set_getLegend(VisuGlExtMapSet *mapSet);
132 
133 void visu_gl_ext_map_set_setField(VisuGlExtMapSet *mapSet, VisuScalarField *field);
134 
135 VisuMap* visu_gl_ext_map_set_addFromPlane(VisuGlExtMapSet *mapSet, VisuPlane *plane);
136 
137 void visu_gl_ext_map_set_setPlane(VisuGlExtMapSet *mapSet, VisuMap *map, VisuPlane *plane);
138 VisuPlane* visu_gl_ext_map_set_getPlane(VisuGlExtMapSet *mapSet, VisuMap *map);
139 
140 gboolean visu_gl_ext_map_set_setPrecision(VisuGlExtMapSet *mapSet, float prec);
141 gboolean visu_gl_ext_map_set_setShade(VisuGlExtMapSet *mapSet, ToolShade *shade);
142 gboolean visu_gl_ext_map_set_setLineColor(VisuGlExtMapSet *mapSet,
143                                           const ToolColor *color);
144 gboolean visu_gl_ext_map_set_setTransparent(VisuGlExtMapSet *mapSet, gboolean alpha);
145 
146 float visu_gl_ext_map_set_getPrecision(const VisuGlExtMapSet *mapSet);
147 gboolean visu_gl_ext_map_set_getTransparent(const VisuGlExtMapSet *mapSet);
148 
149 gboolean visu_gl_ext_map_set_setLines(VisuGlExtMapSet *mapSet, guint nLines);
150 gboolean visu_gl_ext_map_set_setScaling(VisuGlExtMapSet *mapSet, ToolMatrixScalingFlag scale);
151 gboolean visu_gl_ext_map_set_setScalingRange(VisuGlExtMapSet *mapSet, const float minMax[2]);
152 
153 gboolean visu_gl_ext_map_set_export(VisuGlExtMapSet *mapSet, VisuMap *map,
154                                     const gchar *filename, VisuMapExportFormat format,
155                                     GError **error);
156 
157 #endif
158