1 /*   EXTRAITS DE LA LICENCE
2 	Copyright CEA, contributeurs : Damien
3 	CALISTE, laboratoire L_Sim, (2016-2019)
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, (2016-2019)
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 Documentation/licence.en.txt.
41 */
42 
43 #ifndef FRAGPROP_H
44 #define FRAGPROP_H
45 
46 #include <glib.h>
47 #include <glib-object.h>
48 
49 #include "nodeProp.h"
50 
51 G_BEGIN_DECLS
52 
53 /**
54  * VisuNodeFragment:
55  * @label: a label.
56  * @id: the fragment id for this label.
57  *
58  * Defines property for a given fragment.
59  *
60  * Since: 3.8
61  */
62 typedef struct _VisuNodeFragment VisuNodeFragment;
63 struct _VisuNodeFragment
64 {
65   gchar *label;
66   guint id;
67 };
68 
69 #define VISU_TYPE_NODE_FRAGMENT (visu_node_fragment_get_type())
70 GType   visu_node_fragment_get_type(void);
71 VisuNodeFragment* visu_node_fragment_new(const gchar *label, guint id);
72 
73 #define VISU_TYPE_NODE_VALUES_FRAG	      (visu_node_values_frag_get_type ())
74 #define VISU_NODE_VALUES_FRAG(obj)	      (G_TYPE_CHECK_INSTANCE_CAST(obj, VISU_TYPE_NODE_VALUES_FRAG, VisuNodeValuesFrag))
75 #define VISU_NODE_VALUES_FRAG_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST(klass, VISU_TYPE_NODE_VALUES_FRAG, VisuNodeValuesFragClass))
76 #define VISU_IS_NODE_VALUES_FRAG(obj)         (G_TYPE_CHECK_INSTANCE_TYPE(obj, VISU_TYPE_NODE_VALUES_FRAG))
77 #define VISU_IS_NODE_VALUES_FRAG_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE(klass, VISU_TYPE_NODE_VALUES_FRAG))
78 #define VISU_NODE_VALUES_FRAG_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS(obj, VISU_TYPE_NODE_VALUES_FRAG, VisuNodeValuesFragClass))
79 
80 /**
81  * VisuNodeValuesFragPrivate:
82  *
83  * Private data for #VisuNodeValuesFrag objects.
84  */
85 typedef struct _VisuNodeValuesFragPrivate VisuNodeValuesFragPrivate;
86 
87 /**
88  * VisuNodeValuesFrag:
89  *
90  * Common name to refer to a #_VisuNodeValuesFrag.
91  */
92 typedef struct _VisuNodeValuesFrag VisuNodeValuesFrag;
93 struct _VisuNodeValuesFrag
94 {
95   VisuNodeValues parent;
96 
97   VisuNodeValuesFragPrivate *priv;
98 };
99 
100 /**
101  * VisuNodeValuesFragClass:
102  * @parent: private.
103  *
104  * Common name to refer to a #_VisuNodeValuesFragClass.
105  */
106 typedef struct _VisuNodeValuesFragClass VisuNodeValuesFragClass;
107 struct _VisuNodeValuesFragClass
108 {
109   VisuNodeValuesClass parent;
110 };
111 
112 /**
113  * visu_node_values_frag_get_type:
114  *
115  * This method returns the type of #VisuNodeValuesFrag, use
116  * VISU_TYPE_NODE_VALUES_FRAG instead.
117  *
118  * Since: 3.8
119  *
120  * Returns: the type of #VisuNodeValuesFrag.
121  */
122 GType visu_node_values_frag_get_type(void);
123 
124 VisuNodeValuesFrag* visu_node_values_frag_new(VisuNodeArray *arr,
125                                               const gchar *label);
126 
127 const VisuNodeFragment* visu_node_values_frag_getAt(VisuNodeValuesFrag *vect,
128                                                     const VisuNode *node);
129 const VisuNodeFragment* visu_node_values_frag_getAtIter(VisuNodeValuesFrag *vect,
130                                                         const VisuNodeValuesIter *iter);
131 
132 gboolean visu_node_values_frag_setAt(VisuNodeValuesFrag *vect,
133                                      const VisuNode *node,
134                                      const VisuNodeFragment *frag);
135 
136 GHashTable* visu_node_values_frag_getLabels(VisuNodeValuesFrag *frag);
137 
138 GArray* visu_node_values_frag_getNodeIds(const VisuNodeValuesFrag *frag,
139                                          const gchar *label);
140 
141 G_END_DECLS
142 
143 #endif
144