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 45 #ifndef MARKS_H 46 #define MARKS_H 47 48 #include "infos.h" 49 #include <iface_nodemasker.h> 50 #include <renderingMethods/iface_nodeArrayRenderer.h> 51 #include <openGLFunctions/interactive.h> 52 53 /** 54 * VisuGlExtMarksStatus: 55 * @MARKS_STATUS_KEEP: do not change the status of the mark ; 56 * @MARKS_STATUS_TOGGLE: change the status of the mark ; 57 * @MARKS_STATUS_SET: set the mark on ; 58 * @MARKS_STATUS_UNSET: unset a mark. 59 * 60 * Possible parameters to change mark status, see 61 * visu_gl_ext_marks_setHighlightedList() for instance. 62 * 63 * Since: 3.6 64 */ 65 typedef enum 66 { 67 MARKS_STATUS_KEEP, 68 MARKS_STATUS_TOGGLE, 69 MARKS_STATUS_SET, 70 MARKS_STATUS_UNSET 71 } VisuGlExtMarksStatus; 72 /** 73 * VisuGlExtMarksHidingModes: 74 * @HIDE_NONE: don't hide nodes. 75 * @HIDE_HIGHLIGHT: hide highlighted nodes. 76 * @HIDE_NON_HIGHLIGHT: hide all non-highlighted nodes. 77 * 78 * Possible parameters used by visu_gl_ext_marks_setHidingMode(). 79 * 80 * Since: 3.8 81 */ 82 typedef enum 83 { 84 HIDE_NONE, 85 HIDE_HIGHLIGHT, 86 HIDE_NON_HIGHLIGHT 87 } VisuGlExtMarksHidingModes; 88 89 /** 90 * VISU_TYPE_GL_EXT_MARKS: 91 * 92 * Return the associated #GType to the #VisuGlExtMarks objects. 93 * 94 * Since: 3.6 95 */ 96 #define VISU_TYPE_GL_EXT_MARKS (visu_gl_ext_marks_get_type()) 97 /** 98 * VISU_GL_EXT_MARKS: 99 * @obj: the widget to cast. 100 * 101 * Cast the given object to a #VisuGlExtMarks object. 102 * 103 * Since: 3.6 104 */ 105 #define VISU_GL_EXT_MARKS(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), VISU_TYPE_GL_EXT_MARKS, VisuGlExtMarks)) 106 /** 107 * VISU_GL_EXT_MARKS_CLASS: 108 * @obj: the class to cast. 109 * 110 * Cast the given class to a #VisuGlExtMarks object. 111 * 112 * Since: 3.6 113 */ 114 #define VISU_GL_EXT_MARKS_CLASS(obj) (G_TYPE_CHECK_CLASS_CAST((obj), VISU_GL_EXT_MARKS, VisuGlExtMarksClass)) 115 /** 116 * VISU_IS_GL_EXT_MARKS: 117 * @obj: the object to test. 118 * 119 * Return if the given object is a valid #VisuGlExtMarks object. 120 * 121 * Since: 3.6 122 */ 123 #define VISU_IS_GL_EXT_MARKS(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), VISU_TYPE_GL_EXT_MARKS)) 124 /** 125 * VISU_IS_GL_EXT_MARKS_CLASS: 126 * @obj: the class to test. 127 * 128 * Return if the given class is a valid #VisuGlExtMarksClass class. 129 * 130 * Since: 3.6 131 */ 132 #define VISU_IS_GL_EXT_MARKS_CLASS(obj) (G_TYPE_CHECK_CLASS_TYPE((obj), VISU_TYPE_GL_EXT_MARKS)) 133 /** 134 * VISU_GL_EXT_MARKS_GET_CLASS: 135 * @obj: the widget to get the class of. 136 * 137 * Get the class of the given object. 138 * 139 * Since: 3.6 140 */ 141 #define VISU_GL_EXT_MARKS_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), VISU_TYPE_GL_EXT_MARKS, VisuGlExtMarksClass)) 142 143 typedef struct _VisuGlExtMarks VisuGlExtMarks; 144 typedef struct _VisuGlExtMarksClass VisuGlExtMarksClass; 145 typedef struct _VisuGlExtMarksPrivate VisuGlExtMarksPrivate; 146 147 /** 148 * VisuGlExtMarks: 149 * 150 * All fields are private. 151 * 152 * Since: 3.6 153 */ 154 struct _VisuGlExtMarks 155 { 156 VisuGlExt parent; 157 158 VisuGlExtMarksPrivate *priv; 159 }; 160 161 /** 162 * VisuGlExtMarksClass: 163 * @parent: the parent class. 164 * 165 * An opaque structure defining the class of a #VisuGlExtMarks objects. 166 * 167 * Since: 3.6 168 */ 169 struct _VisuGlExtMarksClass 170 { 171 VisuGlExtClass parent; 172 }; 173 174 /** 175 * visu_gl_ext_marks_get_type: 176 * 177 * Internal routine to get #VISU_TYPE_GL_EXT_MARKS value. 178 * 179 * Since: 3.6 180 */ 181 GType visu_gl_ext_marks_get_type(void); 182 183 VisuGlExtMarks* visu_gl_ext_marks_new(const gchar *name); 184 185 void visu_gl_ext_marks_setDataRenderer(VisuGlExtMarks *marks, VisuNodeArrayRenderer *renderer); 186 void visu_gl_ext_marks_setInteractive(VisuGlExtMarks *marks, VisuInteractive *inter); 187 188 gboolean visu_gl_ext_marks_setHighlight(VisuGlExtMarks *marks, GArray *nodes, 189 VisuGlExtMarksStatus status); 190 gboolean visu_gl_ext_marks_unHighlight(VisuGlExtMarks *marks); 191 GArray* visu_gl_ext_marks_getHighlighted(const VisuGlExtMarks *marks); 192 gboolean visu_gl_ext_marks_setInfos(VisuGlExtMarks *marks, guint nodeId, gboolean status); 193 gboolean visu_gl_ext_marks_getActive(VisuGlExtMarks *marks, guint nodeId); 194 gboolean visu_gl_ext_marks_getHighlightStatus(VisuGlExtMarks *marks, guint nodeId); 195 gboolean visu_gl_ext_marks_setDrawValues(VisuGlExtMarks *marks, gboolean status); 196 gboolean visu_gl_ext_marks_removeMeasures(VisuGlExtMarks *marks, gint nodeId); 197 198 gboolean visu_gl_ext_marks_parseXMLFile(VisuGlExtMarks *marks, const gchar* filename, 199 GList **infos, VisuGlExtInfosDrawId *drawingMode, 200 guint *drawingInfos, GError **error); 201 gboolean visu_gl_ext_marks_exportXMLFile(VisuGlExtMarks *marks, const gchar* filename, 202 GArray *nodes, VisuGlExtInfosDrawId drawingMode, 203 guint drawingInfos, GError **error); 204 gchar* visu_gl_ext_marks_getMeasurementStrings(VisuGlExtMarks *marks); 205 gchar* visu_gl_ext_marks_getMeasurementLabels(VisuGlExtMarks *marks); 206 VisuGlExt* visu_gl_ext_marks_getInternalList(VisuGlExtMarks *marks); 207 208 VisuGlExtMarksHidingModes visu_gl_ext_marks_getHidingMode(const VisuGlExtMarks *marks); 209 gboolean visu_gl_ext_marks_setHidingMode(VisuGlExtMarks *marks, 210 VisuGlExtMarksHidingModes mode); 211 212 #endif 213