1 /*   EXTRAITS DE LA LICENCE
2 	Copyright CEA, contributeurs : Damien
3 	CALISTE, laboratoire L_Sim, (2017)
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, (2017)
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 SHELLPROP_H
44 #define SHELLPROP_H
45 
46 #include <glib.h>
47 #include <glib-object.h>
48 
49 #include "fragProp.h"
50 
51 G_BEGIN_DECLS
52 
53 /**
54  * VISU_TYPE_NODE_VALUES_SHELL:
55  *
56  * return the type of #VisuNodeValuesShell.
57  */
58 #define VISU_TYPE_NODE_VALUES_SHELL	     (visu_node_values_shell_get_type ())
59 /**
60  * VISU_NODE_VALUES_SHELL:
61  * @obj: a #GObject to cast.
62  *
63  * Cast the given @obj into #VisuNodeValuesShell type.
64  */
65 #define VISU_NODE_VALUES_SHELL(obj)	        (G_TYPE_CHECK_INSTANCE_CAST(obj, VISU_TYPE_NODE_VALUES_SHELL, VisuNodeValuesShell))
66 /**
67  * VISU_NODE_VALUES_SHELL_CLASS:
68  * @klass: a #GObjectClass to cast.
69  *
70  * Cast the given @klass into #VisuNodeValuesShellClass.
71  */
72 #define VISU_NODE_VALUES_SHELL_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST(klass, VISU_TYPE_NODE_VALUES_SHELL, VisuNodeValuesShellClass))
73 /**
74  * VISU_IS_NODE_VALUES_SHELL:
75  * @obj: a #GObject to test.
76  *
77  * Test if the given @ogj is of the type of #VisuNodeValuesShell object.
78  */
79 #define VISU_IS_NODE_VALUES_SHELL(obj)    (G_TYPE_CHECK_INSTANCE_TYPE(obj, VISU_TYPE_NODE_VALUES_SHELL))
80 /**
81  * VISU_IS_NODE_VALUES_SHELL_CLASS:
82  * @klass: a #GObjectClass to test.
83  *
84  * Test if the given @klass is of the type of #VisuNodeValuesShellClass class.
85  */
86 #define VISU_IS_NODE_VALUES_SHELL_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE(klass, VISU_TYPE_NODE_VALUES_SHELL))
87 /**
88  * VISU_NODE_VALUES_SHELL_GET_CLASS:
89  * @obj: a #GObject to get the class of.
90  *
91  * It returns the class of the given @obj.
92  */
93 #define VISU_NODE_VALUES_SHELL_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS(obj, VISU_TYPE_NODE_VALUES_SHELL, VisuNodeValuesShellClass))
94 
95 /**
96  * VisuNodeValuesShellPrivate:
97  *
98  * Private data for #VisuNodeValuesShell objects.
99  */
100 typedef struct _VisuNodeValuesShellPrivate VisuNodeValuesShellPrivate;
101 
102 /**
103  * VisuNodeValuesShell:
104  *
105  * Common name to refer to a #_VisuNodeValuesShell.
106  */
107 typedef struct _VisuNodeValuesShell VisuNodeValuesShell;
108 struct _VisuNodeValuesShell
109 {
110   VisuNodeValuesFrag parent;
111 
112   VisuNodeValuesShellPrivate *priv;
113 };
114 
115 /**
116  * VisuNodeValuesShellClass:
117  * @parent: private.
118  *
119  * Common name to refer to a #_VisuNodeValuesShellClass.
120  */
121 typedef struct _VisuNodeValuesShellClass VisuNodeValuesShellClass;
122 struct _VisuNodeValuesShellClass
123 {
124   VisuNodeValuesFragClass parent;
125 };
126 
127 /**
128  * visu_node_values_shell_get_type:
129  *
130  * This method returns the type of #VisuNodeValuesShell, use
131  * VISU_TYPE_NODE_VALUES_SHELL instead.
132  *
133  * Since: 3.8
134  *
135  * Returns: the type of #VisuNodeValuesShell.
136  */
137 GType visu_node_values_shell_get_type(void);
138 
139 VisuNodeValuesShell* visu_node_values_shell_new(VisuNodeArray *arr,
140                                                 const gchar *label);
141 
142 gboolean visu_node_values_shell_compute(VisuNodeValuesShell *shell,
143                                         guint id, gfloat factor);
144 
145 guint visu_node_values_shell_getLevel(VisuNodeValuesShell *shell);
146 gboolean visu_node_values_shell_setLevel(VisuNodeValuesShell *shell, guint level);
147 
148 gint visu_node_values_shell_getRoot(const VisuNodeValuesShell *shell);
149 
150 G_END_DECLS
151 
152 #endif
153