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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Part I. Core</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="V_Sim API - Reference Manual">
<link rel="up" href="index.html" title="V_Sim API - Reference Manual">
<link rel="prev" href="index.html" title="V_Sim API - Reference Manual">
<link rel="next" href="VisuObject.html" title="VisuObject">
<meta name="generator" content="GTK-Doc V1.14 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
<td><a accesskey="p" href="index.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td> </td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">V_Sim API - Reference Manual</th>
<td><a accesskey="n" href="VisuObject.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr></table>
<div class="part" title="Part I. Core">
<div class="titlepage"><div><div><h1 class="title">
<a name="core"></a>Part I. Core</h1></div></div></div>
<div class="partintro" title="Core">
<div></div>
<p>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".</p>
<p>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.</p>
<div class="toc">
<p><b>Table of Contents</b></p>
<dl>
<dt>
<span class="refentrytitle"><a href="VisuObject.html">VisuObject</a></span><span class="refpurpose"> — A general object to store the signals.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="v-sim-visu-commandLine.html">visu_commandLine</a></span><span class="refpurpose"> — All methods needed to parse options from the
command line.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="v-sim-visu-basic.html">visu_basic</a></span><span class="refpurpose"> — Main functions of V_Sim (except graphical
ones).</span>
</dt>
<dt>
<span class="refentrytitle"><a href="v-sim-visu-elements.html">visu_elements</a></span><span class="refpurpose"> — defines methods to create and acccess to
<a class="link" href="v-sim-visu-elements.html#VisuElement"><span class="type">VisuElement</span></a>.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="v-sim-visu-nodes.html">visu_nodes</a></span><span class="refpurpose"> — Defines the elementary structure to store
informations about an element in a box.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="v-sim-visu-data.html">visu_data</a></span><span class="refpurpose"> — Give methods to store and manage data from
input file(s).</span>
</dt>
<dt>
<span class="refentrytitle"><a href="v-sim-opengl.html">opengl</a></span><span class="refpurpose"> — This part is responsible for the pseudo3D
rendering through OpenGl and gives methods to adapt the view.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="VisuRendering.html">VisuRendering</a></span><span class="refpurpose"> — Methods to create and add new rendering
methods.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="v-sim-visu-configFile.html">visu_configFile</a></span><span class="refpurpose"> — Defines methods to access (read/write) to
config files and to create different entries.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="v-sim-visu-extension.html">visu_extension</a></span><span class="refpurpose"> — All objects drawn by V_Sim are defined in by a
<a class="link" href="v-sim-visu-extension.html#VisuExtension" title="VisuExtension"><span class="type">VisuExtension</span></a> object</span>
</dt>
<dt>
<span class="refentrytitle"><a href="v-sim-visu-pairs.html">visu_pairs</a></span><span class="refpurpose"> — V_Sim can draw link between nodes. This part
defines a pair object and interface to draw pairs.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="v-sim-visu-dump.html">visu_dump</a></span><span class="refpurpose"> — Some resources to add the ability to export the
rendered data to an other format (usually image format).</span>
</dt>
<dt>
<span class="refentrytitle"><a href="v-sim-visu-plugins.html">visu_plugins</a></span><span class="refpurpose"> — Introduces the basic handling of plug-ins.</span>
</dt>
<dt><span class="chapter"><a href="ch01.html">Core tools</a></span></dt>
<dd><dl>
<dt>
<span class="refentrytitle"><a href="v-sim-toolOptions.html">toolOptions</a></span><span class="refpurpose"> — A convienent wrapper around GHashTable that can support types.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="v-sim-toolMatrix.html">toolMatrix</a></span><span class="refpurpose"> — Defines basic handlings on matrix.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="v-sim-toolConfigFile.html">toolConfigFile</a></span><span class="refpurpose"> — Generic read methods of the configuration files
are defined here.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="v-sim-toolFortran.html">toolFortran</a></span><span class="refpurpose"> — Introduces routines to read the binary Fortran data format.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="v-sim-toolPhysic.html">toolPhysic</a></span><span class="refpurpose"> — introduce physical values for the chemical species.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="v-sim-toolColor.html">toolColor</a></span><span class="refpurpose"> — Simple handling and storage of RGBA colours.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="v-sim-toolShade.html">toolShade</a></span><span class="refpurpose"> — Shades are color gradients.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="v-sim-toolFileFormat.html">toolFileFormat</a></span><span class="refpurpose"> — Describes file format objects (name patterns,
description, properties...).</span>
</dt>
</dl></dd>
<dt><span class="chapter"><a href="ch02.html">Rendering methods</a></span></dt>
<dd><dl>
<dt>
<span class="refentrytitle"><a href="v-sim-renderingAtomic.html">renderingAtomic</a></span><span class="refpurpose"> — A rendering method to draw atoms positioned in
a box.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="v-sim-renderingAtomic-d3.html">renderingAtomic_d3</a></span><span class="refpurpose"> — Method to load d3 position file.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="v-sim-renderingAtomic-ascii.html">renderingAtomic_ascii</a></span><span class="refpurpose"> — Method to load ascii position file.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="v-sim-atomic-xyz.html">atomic_xyz</a></span><span class="refpurpose"> — Method to load ascii position file.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="v-sim-renderingSpin.html">renderingSpin</a></span><span class="refpurpose"> — A module able to represent atoms by their
position and spin.</span>
</dt>
</dl></dd>
<dt><span class="chapter"><a href="ch03.html">OpenGL tools</a></span></dt>
<dd><dl>
<dt>
<span class="refentrytitle"><a href="v-sim-renderingMode.html">renderingMode</a></span><span class="refpurpose"> — Controls the way OpenGL renders objects.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="v-sim-light.html">light</a></span><span class="refpurpose"> — Controls the use of lights in the rendering
window.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="v-sim-text.html">text</a></span><span class="refpurpose"> — Enables capabilities to write some text on rendering screen.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="v-sim-view.html">view</a></span><span class="refpurpose"> — Defines all necessary informations for the
rendering of a view.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="v-sim-interactive.html">interactive</a></span><span class="refpurpose"> — Gives tools to interact with the rendered
area.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="v-sim-objectList.html">objectList</a></span><span class="refpurpose"> — Gives storage for ids used by OpenGL lists and
provides primitive routine for common drawing operations
(distances, torus...).</span>
</dt>
</dl></dd>
<dt><span class="chapter"><a href="ch04.html">Pairs extensions</a></span></dt>
<dd><dl>
<dt>
<span class="refentrytitle"><a href="v-sim-cylinder.html">cylinder</a></span><span class="refpurpose"> — Gives methods to draw cylinders as OpenGl
objects pairing two elements.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="v-sim-wire.html">wire</a></span><span class="refpurpose"> — Gives methods to draw lines as OpenGl objects
pairing two elements.</span>
</dt>
</dl></dd>
<dt><span class="chapter"><a href="ch05.html">OpenGL specific extensions</a></span></dt>
<dd><dl>
<dt>
<span class="refentrytitle"><a href="v-sim-box.html">box</a></span><span class="refpurpose"> — Draw a bounding box around nodes.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="v-sim-axes.html">axes</a></span><span class="refpurpose"> — Defines methods to draw axes.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="v-sim-extInfos.html">extInfos</a></span><span class="refpurpose"> — give the capability to draw some information
near each node.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="v-sim-scale.html">scale</a></span><span class="refpurpose"> — Draw an arrow with a label.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="v-sim-fogAndBGColor.html">fogAndBGColor</a></span><span class="refpurpose"> — Handle the background colour and the fog.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="v-sim-legend.html">legend</a></span><span class="refpurpose"> — Draw a frame with the representation of each
atom species, its name and the number of elements.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="v-sim-marks.html">marks</a></span><span class="refpurpose"> — Draw features on nodes, like measurement marks
or highlights.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="v-sim-rings.html">rings</a></span><span class="refpurpose"> — an extension to highlight closed rings in a structure.</span>
</dt>
</dl></dd>
<dt><span class="chapter"><a href="ch06.html">Extra functionalities</a></span></dt>
<dd><dl>
<dt>
<span class="refentrytitle"><a href="v-sim-dataFile.html">dataFile</a></span><span class="refpurpose"> — Adds a possibility to colorize nodes depending
on data read in an input file.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="v-sim-dataNode.html">dataNode</a></span><span class="refpurpose"> — Extends capabilities of node properties.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="v-sim-extraNode.html">extraNode</a></span><span class="refpurpose"> — add further characteristics to the nodes.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="v-sim-plane.html">plane</a></span><span class="refpurpose"> — Adds capabilities to draw and handle planes.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="v-sim-scalarFields.html">scalarFields</a></span><span class="refpurpose"> — Gives capabilities to load a scalar field.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="v-sim-isoline.html">isoline</a></span><span class="refpurpose"> — handle the drawing and the computation of
isolines.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="v-sim-surfaces.html">surfaces</a></span><span class="refpurpose"> — Supports loading of .surf files and drawing of
surfaces through OpenGL.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="v-sim-surfaces-points.html">surfaces_points</a></span><span class="refpurpose"> — Define a structure to store a set of triangles
defining a surface.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="v-sim-surfaces-resources.html">surfaces_resources</a></span><span class="refpurpose"> — Define the rendering parameters of a surface.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="v-sim-pot2surf.html">pot2surf</a></span><span class="refpurpose"> — Creates surfaces from scalar fields.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="v-sim-geometry.html">geometry</a></span><span class="refpurpose"> — different routines to do high level geometry
studies on a box or a set of boxes.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="v-sim-vibration.html">vibration</a></span><span class="refpurpose"> — Add a support to animate the node positions
with a phonon frequency.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="v-sim-map.html">map</a></span><span class="refpurpose"> — Describe how to handle and draw coloured map on
a plane from a density field.</span>
</dt>
</dl></dd>
<dt><span class="chapter"><a href="ch07.html">OS dependancy and rendering window backend</a></span></dt>
<dd><dl>
<dt>
<span class="refentrytitle"><a href="v-sim-visu-actionInterface.html">visu_actionInterface</a></span><span class="refpurpose"> — Interface for defining actions and events.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="v-sim-visu-openGL.html">visu_openGL</a></span><span class="refpurpose"> — Define the OS dependent routines related to
OpenGL.</span>
</dt>
</dl></dd>
<dt><span class="chapter"><a href="ch08.html">Methods to export to other formats</a></span></dt>
<dd><dl>
<dt>
<span class="refentrytitle"><a href="v-sim-dumpThroughGdkPixbuf.html">dumpThroughGdkPixbuf</a></span><span class="refpurpose"> — add an export capability into PNG and JPG files.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="v-sim-dumpToGif.html">dumpToGif</a></span><span class="refpurpose"> — add an export capability into GIF files.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="v-sim-dumpToAscii.html">dumpToAscii</a></span><span class="refpurpose"> — add an export capability of current positions.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="v-sim-dumpToTiff.html">dumpToTiff</a></span><span class="refpurpose"> — add an export capability into TIFF files.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="v-sim-dumpToXyz.html">dumpToXyz</a></span><span class="refpurpose"> — add an export capability of current positions.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="v-sim-dumpToPsAndPdf.html">dumpToPsAndPdf</a></span><span class="refpurpose"> — add an export capability into PS and PDF files
(encapsulating bitmaps).</span>
</dt>
<dt>
<span class="refentrytitle"><a href="v-sim-dumpToSVG.html">dumpToSVG</a></span><span class="refpurpose"> — add an export capability into SVG files.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="v-sim-dumpToABINIT.html">dumpToABINIT</a></span><span class="refpurpose"> — add an export capability of current positions
in ABINIT format.</span>
</dt>
</dl></dd>
</dl>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.14</div>
</body>
</html>
|
