1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
|
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
[
<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
]>
<book id="index">
<bookinfo>
<title>V_Sim API - Reference Manual</title>
<releaseinfo>for V_Sim <xi:include href="version" parse="text"/></releaseinfo>
</bookinfo>
<part id="core">
<title>Core</title>
<partintro>
<para>This is the program itself without the interface. Basically V_Sim allows the user to see in a pseudo 3D representation a list of elements known by their positions in space, all contained in a box. And it gives tools to rotate, zoom and retrieve informations on positions, angles and distances. The program is supposed to be modular and the programer can add new functions "easily".</para>
<para>There are three sections. The first section deals with all the main functions to handle with this modularity, with the 3D drawing... The second section gathers all the extensions that have been added to improve V_Sim in the rendering area. The third section deals with the different possibilities that exist for the user to render different kind of elements.</para>
</partintro>
<xi:include href="xml/visu_elements.xml"/>
<xi:include href="xml/visu_nodes.xml"/>
<xi:include href="xml/iface_boxed.xml"/>
<xi:include href="xml/iface_pointset.xml"/>
<xi:include href="xml/visu_data.xml"/>
<xi:include href="xml/visu_dataloadable.xml"/>
<xi:include href="xml/visu_dataatomic.xml"/>
<xi:include href="xml/visu_dataspin.xml"/>
<xi:include href="xml/visu_box.xml"/>
<xi:include href="xml/visu_glnodescene.xml"/>
<xi:include href="xml/view.xml"/>
<xi:include href="xml/interactive.xml"/>
<chapter>
<title>Main capabilities of V_Sim</title>
<para>Main capabilities.</para>
<xi:include href="xml/colorizer.xml"/>
<xi:include href="xml/shadedColorizer.xml"/>
<xi:include href="xml/dataFile.xml"/>
<xi:include href="xml/fragColorizer.xml"/>
<xi:include href="xml/vectColorizer.xml"/>
<xi:include href="xml/iface_sourceable.xml"/>
<xi:include href="xml/iface_maskable.xml"/>
<xi:include href="xml/iface_nodemasker.xml"/>
<xi:include href="xml/iface_dumpable.xml"/>
<xi:include href="xml/plane.xml"/>
<xi:include href="xml/planeset.xml"/>
<xi:include href="xml/geometry.xml"/>
<xi:include href="xml/gdiff.xml"/>
<xi:include href="xml/vibration.xml"/>
<xi:include href="xml/mover.xml"/>
<xi:include href="xml/translate.xml"/>
<xi:include href="xml/rotate.xml"/>
<xi:include href="xml/nodeList.xml"/>
</chapter>
<chapter>
<title>Node related method and properties</title>
<xi:include href="xml/neighbours.xml"/>
<xi:include href="xml/nodeProp.xml"/>
<xi:include href="xml/floatProp.xml"/>
<xi:include href="xml/stringProp.xml"/>
<xi:include href="xml/vectorProp.xml"/>
<xi:include href="xml/coordProp.xml"/>
<xi:include href="xml/typeProp.xml"/>
<xi:include href="xml/fragProp.xml"/>
<xi:include href="xml/shellProp.xml"/>
<xi:include href="xml/idProp.xml"/>
<xi:include href="xml/poleProp.xml"/>
</chapter>
<chapter>
<title>Scalar fields and surfaces</title>
<para>Main capabilities.</para>
<xi:include href="xml/scalarFields.xml"/>
<xi:include href="xml/scalarFieldSet.xml"/>
<xi:include href="xml/surfaces.xml"/>
<xi:include href="xml/map.xml"/>
<xi:include href="xml/isoline.xml"/>
<xi:include href="xml/surfaces_points.xml"/>
<xi:include href="xml/surfaces_resources.xml"/>
<xi:include href="xml/pot2surf.xml"/>
<xi:include href="xml/sfieldbinary.xml"/>
<xi:include href="xml/sfielddata.xml"/>
</chapter>
<chapter>
<title>Methods to read input files</title>
<para>Main purpose of V_Sim is to render some file describing positions and other informations n a graphical way. This is achieved implementing VisuRendering. Currently two methods exist, one draw spheres (or other geometric forms such as cubes) on defined positions. The other is a more specialised version of the former, adding a direction information on each position. This method is called SpinRendering and is usefull to render spin configurations.</para>
<xi:include href="xml/visu_dataloader.xml"/>
<xi:include href="xml/atomic_d3.xml"/>
<xi:include href="xml/atomic_ascii.xml"/>
<xi:include href="xml/atomic_xyz.xml"/>
<xi:include href="xml/atomic_yaml.xml"/>
</chapter>
<chapter>
<title>Methods to render nodes and pairs</title>
<para>Objects to draw nodes and pairs between nodes.</para>
<xi:include href="xml/elementRenderer.xml"/>
<xi:include href="xml/elementAtomic.xml"/>
<xi:include href="xml/elementSpin.xml"/>
<xi:include href="xml/spinMethod.xml"/>
<xi:include href="xml/iface_nodeArrayRenderer.xml"/>
<xi:include href="xml/cylinder_renderer.xml"/>
<xi:include href="xml/wire_renderer.xml"/>
</chapter>
<chapter>
<title>OpenGL drawing methods</title>
<para>All rendering is done via objects inherited from VisuExtension.</para>
<xi:include href="xml/visu_extension.xml"/>
<xi:include href="xml/visu_extset.xml"/>
<xi:include href="xml/iface_lined.xml"/>
<xi:include href="xml/nodes.xml"/>
<xi:include href="xml/pairs.xml"/>
<xi:include href="xml/frame.xml"/>
<xi:include href="xml/box.xml"/>
<xi:include href="xml/box_legend.xml"/>
<xi:include href="xml/axes.xml"/>
<xi:include href="xml/legend.xml"/>
<xi:include href="xml/shade.xml"/>
<xi:include href="xml/node_vectors.xml"/>
<xi:include href="xml/forces.xml"/>
<xi:include href="xml/geodiff.xml"/>
<xi:include href="xml/planes.xml"/>
<xi:include href="xml/surfs.xml"/>
<xi:include href="xml/maps.xml"/>
<xi:include href="xml/mapset.xml"/>
<xi:include href="xml/infos.xml"/>
<xi:include href="xml/scale.xml"/>
<xi:include href="xml/fogAndBGColor.xml"/>
<xi:include href="xml/marks.xml"/>
<xi:include href="xml/paths.xml"/>
<xi:include href="xml/vibrations.xml"/>
</chapter>
<chapter>
<title>Animating changes</title>
<xi:include href="xml/visu_animation.xml"/>
<xi:include href="xml/iface_animatable.xml"/>
</chapter>
<chapter>
<title>Dealing with pairs</title>
<para>Drawing pairs is done via external modules. For the moment, two modules exist to draw pairs : one draws flat lines between elements (colour and width are user-defined) and the other use cylinders to represents pairs (radius and colour also user-defined).</para>
<xi:include href="xml/visu_pairs.xml"/>
<xi:include href="xml/visu_pairset.xml"/>
<xi:include href="xml/iface_cylinder.xml"/>
<xi:include href="xml/iface_wire.xml"/>
<xi:include href="xml/link.xml"/>
<xi:include href="xml/linkRenderer.xml"/>
</chapter>
<chapter>
<title>Methods to export to other formats</title>
<xi:include href="xml/iface_dumpable.xml"/>
<xi:include href="xml/visu_dump.xml"/>
<xi:include href="xml/fileDump.xml"/>
<xi:include href="xml/glDump.xml"/>
<xi:include href="xml/dumpThroughGdkPixbuf.xml"/>
<!-- <xi:include href="xml/dumpToGif.xml"/> -->
<xi:include href="xml/dumpToAscii.xml"/>
<xi:include href="xml/dumpToTiff.xml"/>
<xi:include href="xml/dumpToXyz.xml"/>
<xi:include href="xml/dumpToPsAndPdf.xml"/>
<xi:include href="xml/dumpToSVG.xml"/>
<xi:include href="xml/dumpToABINIT.xml"/>
<xi:include href="xml/dumpToYaml.xml"/>
</chapter>
<chapter>
<title>Generic tools</title>
<para>There are differents tools that can be shared by every modules in V_Sim, such as file support, list of colors, common shades...</para>
<xi:include href="xml/toolOptions.xml"/>
<xi:include href="xml/toolPool.xml"/>
<xi:include href="xml/toolArray.xml"/>
<xi:include href="xml/toolMatrix.xml"/>
<xi:include href="xml/toolGl.xml"/>
<xi:include href="xml/toolConfigFile.xml"/>
<xi:include href="xml/toolFortran.xml"/>
<xi:include href="xml/toolPhysic.xml"/>
<xi:include href="xml/toolColor.xml"/>
<xi:include href="xml/toolShade.xml"/>
<xi:include href="xml/toolFileFormat.xml"/>
<xi:include href="xml/toolFiles.xml"/>
<xi:include href="xml/toolWriter.xml"/>
<xi:include href="xml/toolShape.xml"/>
</chapter>
<chapter>
<title>OpenGL tools</title>
<para>These little utilities are dealing with OpenGL. They are not essential to V_Sim but can add some nice features that can be shared between different modules.</para>
<xi:include href="xml/opengl.xml"/>
<xi:include href="xml/renderingMode.xml"/>
<xi:include href="xml/light.xml"/>
</chapter>
<chapter>
<title>Miscellaneous</title>
<para>Other methods, including OS dependancy and rendering window backend.</para>
<xi:include href="xml/finder.xml"/>
<xi:include href="xml/visu_configFile.xml"/>
<xi:include href="xml/visu_basic.xml"/>
<xi:include href="xml/visu_plugins.xml"/>
<xi:include href="xml/visu_commandLine.xml"/>
<xi:include href="xml/visu_actionInterface.xml"/>
<xi:include href="xml/toolDbg.xml"/>
</chapter>
<!-- <chapter>
<title>Plug-ins</title>
<para>This is official plugins description.</para>
<xi:include href="xml/nq_basic.xml"/>
<xi:include href="xml/nq_density.xml"/>
<xi:include href="xml/nq_structure.xml"/>
<xi:include href="xml/abinit.xml"/>
<xi:include href="xml/ab_symmetry.xml"/>
<xi:include href="xml/xsf.xml"/>
<xi:include href="xml/xsf_density.xml"/>
</chapter> -->
</part>
<part id="gtkInterface">
<title>Gtk interface</title>
<chapter>
<title>Main interface</title>
<xi:include href="xml/visu_gtk.xml"/>
<xi:include href="xml/gtk_main.xml"/>
<xi:include href="xml/gtk_interactive.xml"/>
<xi:include href="xml/gtk_pick.xml"/>
<xi:include href="xml/gtk_move.xml"/>
<xi:include href="xml/gtk_about.xml"/>
<xi:include href="xml/gtk_save.xml"/>
<xi:include href="xml/gtk_pairs.xml"/>
<xi:include href="xml/gtk_renderingWindowWidget.xml"/>
</chapter>
<chapter>
<title>Interface elements</title>
<xi:include href="xml/ui_axes.xml"/>
<xi:include href="xml/ui_box.xml"/>
<xi:include href="xml/ui_scale.xml"/>
<xi:include href="xml/ui_boxTransform.xml"/>
<xi:include href="xml/ui_planetree.xml"/>
<xi:include href="xml/ui_elements.xml"/>
<xi:include href="xml/ui_atomic.xml"/>
<xi:include href="xml/ui_spin.xml"/>
<xi:include href="xml/ui_link.xml"/>
<xi:include href="xml/ui_pairtree.xml"/>
</chapter>
<chapter>
<title>V_Sim specific widgets</title>
<xi:include href="xml/gtk_dumpDialogWidget.xml"/>
<xi:include href="xml/gtk_toolPanelWidget.xml"/>
<xi:include href="xml/gtk_numericalEntryWidget.xml"/>
<xi:include href="xml/gtk_valueIOWidget.xml"/>
<xi:include href="xml/gtk_colorComboBoxWidget.xml"/>
<xi:include href="xml/gtk_stippleComboBoxWidget.xml"/>
<xi:include href="xml/gtk_orientationChooser.xml"/>
<xi:include href="xml/gtk_shadeComboBoxWidget.xml"/>
<xi:include href="xml/gtk_lineObjectWidget.xml"/>
<xi:include href="xml/gtk_elementComboBox.xml"/>
<xi:include href="xml/gtk_curveWidget.xml"/>
<xi:include href="xml/gtk_dataChooser.xml"/>
<xi:include href="xml/gtk_fieldChooser.xml"/>
<xi:include href="xml/ui_properties.xml"/>
<xi:include href="xml/ui_selection.xml"/>
</chapter>
<chapter>
<title>Panel add-ons</title>
<xi:include href="xml/panelSurfaces.xml"/>
<xi:include href="xml/panelElements.xml"/>
<xi:include href="xml/panelMethod.xml"/>
<xi:include href="xml/panelPlanes.xml"/>
<xi:include href="xml/panelBrowser.xml"/>
<xi:include href="xml/panelVibration.xml"/>
<xi:include href="xml/panelDataFile.xml"/>
<xi:include href="xml/panelMap.xml"/>
<xi:include href="xml/panelFogBgColor.xml"/>
<xi:include href="xml/panelGeometry.xml"/>
<xi:include href="xml/panelOpenGL.xml"/>
<xi:include href="xml/panelSurfacesTools.xml"/>
<xi:include href="xml/panelAxes.xml"/>
<xi:include href="xml/panelConfig.xml"/>
<xi:include href="xml/gtkAtomic.xml"/>
<xi:include href="xml/gtkSpin.xml"/>
</chapter>
</part>
<part id="miscInfo">
<title>Additional information</title>
<chapter id="object-tree">
<title>Object Hierarchy</title>
<xi:include href="xml/tree_index.sgml"/>
</chapter>
<chapter id="api-3.1">
<title>New symbols in 3.1</title>
<xi:include href="xml/api-index-3.1.xml"><xi:fallback /></xi:include>
</chapter>
<chapter id="api-3.2">
<title>New symbols in 3.2</title>
<xi:include href="xml/api-index-3.2.xml"><xi:fallback /></xi:include>
</chapter>
<chapter id="api-3.3">
<title>New symbols in 3.3</title>
<xi:include href="xml/api-index-3.3.xml"><xi:fallback /></xi:include>
</chapter>
<chapter id="api-3.4">
<title>New symbols in 3.4</title>
<xi:include href="xml/api-index-3.4.xml"><xi:fallback /></xi:include>
</chapter>
<chapter id="api-3.5">
<title>New symbols in 3.5</title>
<xi:include href="xml/api-index-3.5.xml"><xi:fallback /></xi:include>
</chapter>
<chapter id="api-3.6">
<title>New symbols in 3.6</title>
<xi:include href="xml/api-index-3.6.xml"><xi:fallback /></xi:include>
</chapter>
<chapter id="api-3.7">
<title>New symbols in 3.7</title>
<xi:include href="xml/api-index-3.7.xml"><xi:fallback /></xi:include>
</chapter>
<chapter id="api-3.8">
<title>New symbols in 3.8</title>
<xi:include href="xml/api-index-3.8.xml"><xi:fallback /></xi:include>
</chapter>
<chapter id="api-3.9">
<title>New symbols in 3.9</title>
<xi:include href="xml/api-index-3.9.xml"><xi:fallback /></xi:include>
</chapter>
<xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
<xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
</part>
<index id="api-index-full">
<title>API Index</title>
<xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
<xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
</index>
</book>
|
