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 BOX_H
45 #define BOX_H
46 
47 #include "frame.h"
48 
49 #include <visu_extension.h>
50 #include <visu_box.h>
51 #include <openGLFunctions/view.h>
52 #include "iface_lined.h"
53 
54 /**
55  * VISU_TYPE_GL_EXT_BOX:
56  *
57  * return the type of #VisuGlExtBox.
58  *
59  * Since: 3.7
60  */
61 #define VISU_TYPE_GL_EXT_BOX	     (visu_gl_ext_box_get_type ())
62 /**
63  * VISU_GL_EXT_BOX:
64  * @obj: a #GObject to cast.
65  *
66  * Cast the given @obj into #VisuGlExtBox type.
67  *
68  * Since: 3.7
69  */
70 #define VISU_GL_EXT_BOX(obj)	     (G_TYPE_CHECK_INSTANCE_CAST(obj, VISU_TYPE_GL_EXT_BOX, VisuGlExtBox))
71 /**
72  * VISU_GL_EXT_BOX_CLASS:
73  * @klass: a #GObjectClass to cast.
74  *
75  * Cast the given @klass into #VisuGlExtBoxClass.
76  *
77  * Since: 3.7
78  */
79 #define VISU_GL_EXT_BOX_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST(klass, VISU_TYPE_GL_EXT_BOX, VisuGlExtBoxClass))
80 /**
81  * VISU_IS_GL_EXT_BOX:
82  * @obj: a #GObject to test.
83  *
84  * Test if the given @ogj is of the type of #VisuGlExtBox object.
85  *
86  * Since: 3.7
87  */
88 #define VISU_IS_GL_EXT_BOX(obj)    (G_TYPE_CHECK_INSTANCE_TYPE(obj, VISU_TYPE_GL_EXT_BOX))
89 /**
90  * VISU_IS_GL_EXT_BOX_CLASS:
91  * @klass: a #GObjectClass to test.
92  *
93  * Test if the given @klass is of the type of #VisuGlExtBoxClass class.
94  *
95  * Since: 3.7
96  */
97 #define VISU_IS_GL_EXT_BOX_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE(klass, VISU_TYPE_GL_EXT_BOX))
98 /**
99  * VISU_GL_EXT_BOX_GET_CLASS:
100  * @obj: a #GObject to get the class of.
101  *
102  * It returns the class of the given @obj.
103  *
104  * Since: 3.7
105  */
106 #define VISU_GL_EXT_BOX_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS(obj, VISU_TYPE_GL_EXT_BOX, VisuGlExtBoxClass))
107 
108 typedef struct _VisuGlExtBox        VisuGlExtBox;
109 typedef struct _VisuGlExtBoxPrivate VisuGlExtBoxPrivate;
110 typedef struct _VisuGlExtBoxClass   VisuGlExtBoxClass;
111 
112 /**
113  * VisuGlExtBox:
114  *
115  * An opaque structure.
116  *
117  * Since: 3.7
118  */
119 struct _VisuGlExtBox
120 {
121   VisuGlExt parent;
122 
123   VisuGlExtBoxPrivate *priv;
124 };
125 
126 /**
127  * VisuGlExtBoxClass:
128  * @parent: the parent class;
129  *
130  * A short way to identify #_VisuGlExtBoxClass structure.
131  *
132  * Since: 3.7
133  */
134 struct _VisuGlExtBoxClass
135 {
136   VisuGlExtClass parent;
137 };
138 
139 /**
140  * visu_gl_ext_box_get_type:
141  *
142  * This method returns the type of #VisuGlExtBox, use
143  * VISU_TYPE_GL_EXT_BOX instead.
144  *
145  * Since: 3.7
146  *
147  * Returns: the type of #VisuGlExtBox.
148  */
149 GType visu_gl_ext_box_get_type(void);
150 
151 /**
152  * VISU_GL_EXT_BOX_ID:
153  *
154  * The id used to identify this extension, see
155  * visu_gl_ext_rebuild() for instance.
156  */
157 #define VISU_GL_EXT_BOX_ID "Box"
158 
159 VisuGlExtBox* visu_gl_ext_box_new(const gchar *name);
160 gboolean visu_gl_ext_box_setBox(VisuGlExtBox *box, VisuBox *boxObj);
161 gboolean visu_gl_ext_box_setBasis(VisuGlExtBox *box, float orig[3], float mat[3][3]);
162 
163 gboolean visu_gl_ext_box_setSideRGB(VisuGlExtBox *box, float rgba[4], int mask);
164 gboolean visu_gl_ext_box_setExpandStipple(VisuGlExtBox *box, guint16 stipple);
165 
166 float* visu_gl_ext_box_getSideRGB(VisuGlExtBox *box);
167 guint16 visu_gl_ext_box_getExpandStipple(VisuGlExtBox *box);
168 
169 #endif
170