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
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>geometry</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="ch06.html" title="Extra functionalities">
<link rel="prev" href="v-sim-pot2surf.html" title="pot2surf">
<link rel="next" href="v-sim-vibration.html" title="vibration">
<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="v-sim-pot2surf.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch06.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></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="v-sim-vibration.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#v-sim-geometry.synopsis" class="shortcut">Top</a>
|
<a href="#v-sim-geometry.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="geometry">
<a name="v-sim-geometry"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="v-sim-geometry.top_of_page"></a>geometry</span></h2>
<p>geometry — different routines to do high level geometry
studies on a box or a set of boxes.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="v-sim-geometry.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">typedef <a class="link" href="v-sim-geometry.html#VisuPathes" title="VisuPathes">VisuPathes</a>;
<a class="link" href="v-sim-geometry.html#VisuPathes" title="VisuPathes"><span class="returnvalue">VisuPathes</span></a>* <a class="link" href="v-sim-geometry.html#visu-pathes-new" title="visu_pathes_new ()">visu_pathes_new</a> (<em class="parameter"><code><span class="type">float</span> translation[3]</code></em>);
<span class="returnvalue">void</span> <a class="link" href="v-sim-geometry.html#visu-pathes-free" title="visu_pathes_free ()">visu_pathes_free</a> (<em class="parameter"><code><a class="link" href="v-sim-geometry.html#VisuPathes" title="VisuPathes"><span class="type">VisuPathes</span></a> *pathes</code></em>);
<span class="returnvalue">void</span> <a class="link" href="v-sim-geometry.html#visu-pathes-empty" title="visu_pathes_empty ()">visu_pathes_empty</a> (<em class="parameter"><code><a class="link" href="v-sim-geometry.html#VisuPathes" title="VisuPathes"><span class="type">VisuPathes</span></a> *pathes</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="v-sim-geometry.html#visu-pathes-addFromDiff" title="visu_pathes_addFromDiff ()">visu_pathes_addFromDiff</a> (<em class="parameter"><code><a class="link" href="v-sim-geometry.html#VisuPathes" title="VisuPathes"><span class="type">VisuPathes</span></a> *pathes</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *data</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="v-sim-geometry.html#visu-pathes-addNodeStep" title="visu_pathes_addNodeStep ()">visu_pathes_addNodeStep</a> (<em class="parameter"><code><a class="link" href="v-sim-geometry.html#VisuPathes" title="VisuPathes"><span class="type">VisuPathes</span></a> *pathes</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> time</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> nodeId</code></em>,
<em class="parameter"><code><span class="type">float</span> xyz[3]</code></em>,
<em class="parameter"><code><span class="type">float</span> dxyz[3]</code></em>,
<em class="parameter"><code><span class="type">float</span> energy</code></em>);
<span class="returnvalue">void</span> <a class="link" href="v-sim-geometry.html#visu-pathes-pinPositions" title="visu_pathes_pinPositions ()">visu_pathes_pinPositions</a> (<em class="parameter"><code><a class="link" href="v-sim-geometry.html#VisuPathes" title="VisuPathes"><span class="type">VisuPathes</span></a> *pathes</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *data</code></em>);
<span class="returnvalue">void</span> <a class="link" href="v-sim-geometry.html#visu-pathes-draw" title="visu_pathes_draw ()">visu_pathes_draw</a> (<em class="parameter"><code><a class="link" href="v-sim-geometry.html#VisuPathes" title="VisuPathes"><span class="type">VisuPathes</span></a> *pathes</code></em>);
<span class="returnvalue">void</span> <a class="link" href="v-sim-geometry.html#visu-pathes-constrainInBox" title="visu_pathes_constrainInBox ()">visu_pathes_constrainInBox</a> (<em class="parameter"><code><a class="link" href="v-sim-geometry.html#VisuPathes" title="VisuPathes"><span class="type">VisuPathes</span></a> *pathes</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *data</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="v-sim-geometry.html#visu-pathes-exportToXML" title="visu_pathes_exportToXML ()">visu_pathes_exportToXML</a> (<em class="parameter"><code>const <a class="link" href="v-sim-geometry.html#VisuPathes" title="VisuPathes"><span class="type">VisuPathes</span></a> *pathes</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="v-sim-geometry.html#visu-pathes-parseFromXML" title="visu_pathes_parseFromXML ()">visu_pathes_parseFromXML</a> (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-geometry.html#VisuPathes" title="VisuPathes"><span class="type">VisuPathes</span></a> *pathes</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<span class="returnvalue">void</span> <a class="link" href="v-sim-geometry.html#visu-pathes-setTranslation" title="visu_pathes_setTranslation ()">visu_pathes_setTranslation</a> (<em class="parameter"><code><a class="link" href="v-sim-geometry.html#VisuPathes" title="VisuPathes"><span class="type">VisuPathes</span></a> *pathes</code></em>,
<em class="parameter"><code><span class="type">float</span> cartCoord[3]</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="v-sim-geometry.html#visu-pathes-setShade" title="visu_pathes_setShade ()">visu_pathes_setShade</a> (<em class="parameter"><code><a class="link" href="v-sim-geometry.html#VisuPathes" title="VisuPathes"><span class="type">VisuPathes</span></a> *pathes</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-toolShade.html#Shade" title="Shade"><span class="type">Shade</span></a> *shade</code></em>);
<a class="link" href="v-sim-toolShade.html#Shade" title="Shade"><span class="returnvalue">Shade</span></a>* <a class="link" href="v-sim-geometry.html#visu-pathes-getShade" title="visu_pathes_getShade ()">visu_pathes_getShade</a> (<em class="parameter"><code><a class="link" href="v-sim-geometry.html#VisuPathes" title="VisuPathes"><span class="type">VisuPathes</span></a> *pathes</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> <a class="link" href="v-sim-geometry.html#visu-pathes-getLength" title="visu_pathes_getLength ()">visu_pathes_getLength</a> (<em class="parameter"><code><a class="link" href="v-sim-geometry.html#VisuPathes" title="VisuPathes"><span class="type">VisuPathes</span></a> *pathes</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="v-sim-geometry.html#visu-geodiff-new" title="visu_geodiff_new ()">visu_geodiff_new</a> (<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *dataRef</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *data</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> reorder</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="v-sim-geometry.html#visu-geodiff-setActive" title="visu_geodiff_setActive ()">visu_geodiff_setActive</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> value</code></em>);
<span class="returnvalue">void</span> <a class="link" href="v-sim-geometry.html#visu-geodiff-rebuildList" title="visu_geodiff_rebuildList ()">visu_geodiff_rebuildList</a> (<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *dataObj</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="v-sim-geometry.html#visu-geodiff-hasData" title="visu_geodiff_hasData ()">visu_geodiff_hasData</a> (<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *data</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* <a class="link" href="v-sim-geometry.html#visu-geodiff-export" title="visu_geodiff_export ()">visu_geodiff_export</a> (<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *data</code></em>);
<span class="returnvalue">void</span> <a class="link" href="v-sim-geometry.html#visu-geodiff-getPeriodicDistance" title="visu_geodiff_getPeriodicDistance ()">visu_geodiff_getPeriodicDistance</a> (<em class="parameter"><code><span class="type">float</span> diff[3]</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *data</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-visu-nodes.html#VisuNode" title="VisuNode"><span class="type">VisuNode</span></a> *node1</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-visu-nodes.html#VisuNode" title="VisuNode"><span class="type">VisuNode</span></a> *node2</code></em>);
<span class="returnvalue">void</span> <a class="link" href="v-sim-geometry.html#geometryInit" title="geometryInit ()">geometryInit</a> ();
</pre>
</div>
<div class="refsect1" title="Description">
<a name="v-sim-geometry.description"></a><h2>Description</h2>
<p>
</p>
<p>The first possibility of the <span class="type">geometry</span> section is to make a
two by two difference node position difference between two
<a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> objects. The <a class="link" href="v-sim-visu-nodes.html#VisuNode" title="VisuNode"><span class="type">VisuNode</span></a> positions are compared (number to number and
not closed equivalent to closed equivalent) and stored for
visualisation. The visualisation is done through small arrows
position on the currently visualised file.</p>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="v-sim-geometry.details"></a><h2>Details</h2>
<div class="refsect2" title="VisuPathes">
<a name="VisuPathes"></a><h3>VisuPathes</h3>
<pre class="programlisting">typedef struct VisuPathes_ VisuPathes;
</pre>
<p>
An opaque structure to save a set of pathes.
</p>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2" title="visu_pathes_new ()">
<a name="visu-pathes-new"></a><h3>visu_pathes_new ()</h3>
<pre class="programlisting"><a class="link" href="v-sim-geometry.html#VisuPathes" title="VisuPathes"><span class="returnvalue">VisuPathes</span></a>* visu_pathes_new (<em class="parameter"><code><span class="type">float</span> translation[3]</code></em>);</pre>
<p>
Create a new <a class="link" href="v-sim-geometry.html#VisuPathes" title="VisuPathes"><span class="type">VisuPathes</span></a> object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>translation</code></em> :</span></p></td>
<td>the current box translation (cartesian).
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the newly create object <a class="link" href="v-sim-geometry.html#VisuPathes" title="VisuPathes"><span class="type">VisuPathes</span></a>, to be freed with
<a class="link" href="v-sim-geometry.html#visu-pathes-free" title="visu_pathes_free ()"><code class="function">visu_pathes_free()</code></a>.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2" title="visu_pathes_free ()">
<a name="visu-pathes-free"></a><h3>visu_pathes_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> visu_pathes_free (<em class="parameter"><code><a class="link" href="v-sim-geometry.html#VisuPathes" title="VisuPathes"><span class="type">VisuPathes</span></a> *pathes</code></em>);</pre>
<p>
Free a set of pathes.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>pathes</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-geometry.html#VisuPathes" title="VisuPathes"><span class="type">VisuPathes</span></a> object.
</td>
</tr></tbody>
</table></div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2" title="visu_pathes_empty ()">
<a name="visu-pathes-empty"></a><h3>visu_pathes_empty ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> visu_pathes_empty (<em class="parameter"><code><a class="link" href="v-sim-geometry.html#VisuPathes" title="VisuPathes"><span class="type">VisuPathes</span></a> *pathes</code></em>);</pre>
<p>
Reinitialise internal values of a given <em class="parameter"><code>pathes</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>pathes</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-geometry.html#VisuPathes" title="VisuPathes"><span class="type">VisuPathes</span></a> object.
</td>
</tr></tbody>
</table></div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2" title="visu_pathes_addFromDiff ()">
<a name="visu-pathes-addFromDiff"></a><h3>visu_pathes_addFromDiff ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> visu_pathes_addFromDiff (<em class="parameter"><code><a class="link" href="v-sim-geometry.html#VisuPathes" title="VisuPathes"><span class="type">VisuPathes</span></a> *pathes</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *data</code></em>);</pre>
<p>
This routine read the geometry difference hold in <em class="parameter"><code>data</code></em> and add a
new step in the set of pathes. If new pathes are created, one
should call <a class="link" href="v-sim-geometry.html#visu-pathes-setTranslation" title="visu_pathes_setTranslation ()"><code class="function">visu_pathes_setTranslation()</code></a> to be sure that all
pathes are moved inside the box.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> object with a geometry difference (see
<a class="link" href="v-sim-geometry.html#visu-geodiff-new" title="visu_geodiff_new ()"><code class="function">visu_geodiff_new()</code></a>).
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>pathes</code></em> :</span></p></td>
<td>the set of pathes to extend.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if new pathes have been added.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2" title="visu_pathes_addNodeStep ()">
<a name="visu-pathes-addNodeStep"></a><h3>visu_pathes_addNodeStep ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> visu_pathes_addNodeStep (<em class="parameter"><code><a class="link" href="v-sim-geometry.html#VisuPathes" title="VisuPathes"><span class="type">VisuPathes</span></a> *pathes</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> time</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> nodeId</code></em>,
<em class="parameter"><code><span class="type">float</span> xyz[3]</code></em>,
<em class="parameter"><code><span class="type">float</span> dxyz[3]</code></em>,
<em class="parameter"><code><span class="type">float</span> energy</code></em>);</pre>
<p>
This routine expand the path for the given <em class="parameter"><code>nodeId</code></em> at position <em class="parameter"><code>xyz</code></em>
of <em class="parameter"><code>dxyz</code></em>. The <em class="parameter"><code>energy</code></em> value will be used only if
<a class="link" href="v-sim-geometry.html#visu-pathes-setShade" title="visu_pathes_setShade ()"><code class="function">visu_pathes_setShade()</code></a> is used with a non NULL <a class="link" href="v-sim-toolShade.html#Shade" title="Shade"><span class="type">Shade</span></a>. In that
case the <em class="parameter"><code>energy</code></em> value will be used to colourise the provided path.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>pathes</code></em> :</span></p></td>
<td>a set of pathes.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>time</code></em> :</span></p></td>
<td>the flag that give the number of expansion to update.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>nodeId</code></em> :</span></p></td>
<td>the node to expand the path of.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>xyz</code></em> :</span></p></td>
<td>the current position of the path.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dxyz</code></em> :</span></p></td>
<td>the variation in the path.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>energy</code></em> :</span></p></td>
<td>the energy of the system.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if a new path is started.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2" title="visu_pathes_pinPositions ()">
<a name="visu-pathes-pinPositions"></a><h3>visu_pathes_pinPositions ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> visu_pathes_pinPositions (<em class="parameter"><code><a class="link" href="v-sim-geometry.html#VisuPathes" title="VisuPathes"><span class="type">VisuPathes</span></a> *pathes</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *data</code></em>);</pre>
<p>
Use the current positions of <em class="parameter"><code>data</code></em> to extend <em class="parameter"><code>pathes</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>pathes</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-geometry.html#VisuPathes" title="VisuPathes"><span class="type">VisuPathes</span></a> object.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> object.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2" title="visu_pathes_draw ()">
<a name="visu-pathes-draw"></a><h3>visu_pathes_draw ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> visu_pathes_draw (<em class="parameter"><code><a class="link" href="v-sim-geometry.html#VisuPathes" title="VisuPathes"><span class="type">VisuPathes</span></a> *pathes</code></em>);</pre>
<p>
OpenGL calls to create the pathes.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>pathes</code></em> :</span></p></td>
<td>a set of pathes.
</td>
</tr></tbody>
</table></div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2" title="visu_pathes_constrainInBox ()">
<a name="visu-pathes-constrainInBox"></a><h3>visu_pathes_constrainInBox ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> visu_pathes_constrainInBox (<em class="parameter"><code><a class="link" href="v-sim-geometry.html#VisuPathes" title="VisuPathes"><span class="type">VisuPathes</span></a> *pathes</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *data</code></em>);</pre>
<p>
Modify the corrdinates of the path nodes to contraint them in a box
(when applying translations for instance).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>pathes</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-geometry.html#VisuPathes" title="VisuPathes"><span class="type">VisuPathes</span></a> object.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> object.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2" title="visu_pathes_exportToXML ()">
<a name="visu-pathes-exportToXML"></a><h3>visu_pathes_exportToXML ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> visu_pathes_exportToXML (<em class="parameter"><code>const <a class="link" href="v-sim-geometry.html#VisuPathes" title="VisuPathes"><span class="type">VisuPathes</span></a> *pathes</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Write an XML file with the description of the given <em class="parameter"><code>pathes</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>pathes</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-geometry.html#VisuPathes" title="VisuPathes"><span class="type">VisuPathes</span></a> object.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
<td>a location on disk.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>a pointer on an error.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if no error.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2" title="visu_pathes_parseFromXML ()">
<a name="visu-pathes-parseFromXML"></a><h3>visu_pathes_parseFromXML ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> visu_pathes_parseFromXML (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-geometry.html#VisuPathes" title="VisuPathes"><span class="type">VisuPathes</span></a> *pathes</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Read an XML containing a description of <em class="parameter"><code>pathes</code></em>. <em class="parameter"><code>pathes</code></em> is newly
created on success and should be freed with <a class="link" href="v-sim-geometry.html#visu-pathes-free" title="visu_pathes_free ()"><code class="function">visu_pathes_free()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
<td>a location on disk.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>pathes</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-geometry.html#VisuPathes" title="VisuPathes"><span class="type">VisuPathes</span></a> object.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>a pointer on an error.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2" title="visu_pathes_setTranslation ()">
<a name="visu-pathes-setTranslation"></a><h3>visu_pathes_setTranslation ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> visu_pathes_setTranslation (<em class="parameter"><code><a class="link" href="v-sim-geometry.html#VisuPathes" title="VisuPathes"><span class="type">VisuPathes</span></a> *pathes</code></em>,
<em class="parameter"><code><span class="type">float</span> cartCoord[3]</code></em>);</pre>
<p>
Change the translation of the path, stored in cartesian
coordinates.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>pathes</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-geometry.html#VisuPathes" title="VisuPathes"><span class="type">VisuPathes</span></a> object.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cartCoord</code></em> :</span></p></td>
<td>three floats.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2" title="visu_pathes_setShade ()">
<a name="visu-pathes-setShade"></a><h3>visu_pathes_setShade ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> visu_pathes_setShade (<em class="parameter"><code><a class="link" href="v-sim-geometry.html#VisuPathes" title="VisuPathes"><span class="type">VisuPathes</span></a> *pathes</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-toolShade.html#Shade" title="Shade"><span class="type">Shade</span></a> *shade</code></em>);</pre>
<p>
Set the colourisation scheme for the path.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>pathes</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-geometry.html#VisuPathes" title="VisuPathes"><span class="type">VisuPathes</span></a> object.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>shade</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-toolShade.html#Shade" title="Shade"><span class="type">Shade</span></a> object.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE is the scheme is changed.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2" title="visu_pathes_getShade ()">
<a name="visu-pathes-getShade"></a><h3>visu_pathes_getShade ()</h3>
<pre class="programlisting"><a class="link" href="v-sim-toolShade.html#Shade" title="Shade"><span class="returnvalue">Shade</span></a>* visu_pathes_getShade (<em class="parameter"><code><a class="link" href="v-sim-geometry.html#VisuPathes" title="VisuPathes"><span class="type">VisuPathes</span></a> *pathes</code></em>);</pre>
<p>
The pathes are drawn with a colourisation scheme.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>pathes</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-geometry.html#VisuPathes" title="VisuPathes"><span class="type">VisuPathes</span></a> object.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the <a class="link" href="v-sim-toolShade.html#Shade" title="Shade"><span class="type">Shade</span></a> used by the <em class="parameter"><code>pathes</code></em>.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2" title="visu_pathes_getLength ()">
<a name="visu-pathes-getLength"></a><h3>visu_pathes_getLength ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> visu_pathes_getLength (<em class="parameter"><code><a class="link" href="v-sim-geometry.html#VisuPathes" title="VisuPathes"><span class="type">VisuPathes</span></a> *pathes</code></em>);</pre>
<p>
Get the number of steps stored in a <a class="link" href="v-sim-geometry.html#VisuPathes" title="VisuPathes"><span class="type">VisuPathes</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>pathes</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-geometry.html#VisuPathes" title="VisuPathes"><span class="type">VisuPathes</span></a> object.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the number of steps.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2" title="visu_geodiff_new ()">
<a name="visu-geodiff-new"></a><h3>visu_geodiff_new ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> visu_geodiff_new (<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *dataRef</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *data</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> reorder</code></em>);</pre>
<p>
Compare the position of each <a class="link" href="v-sim-visu-nodes.html#VisuNode" title="VisuNode"><span class="type">VisuNode</span></a> of <em class="parameter"><code>dataRef</code></em> and <em class="parameter"><code>data</code></em>,
the result is store as a property of <em class="parameter"><code>data</code></em> and can be visualise
using <a class="link" href="v-sim-geometry.html#visu-geodiff-setActive" title="visu_geodiff_setActive ()"><code class="function">visu_geodiff_setActive()</code></a>. If <em class="parameter"><code>reorder</code></em> is TRUE, the nodes in
<em class="parameter"><code>data</code></em> will be modified to follow the ordering of <em class="parameter"><code>dataRef</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>dataRef</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> object ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>another <a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> object.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>reorder</code></em> :</span></p></td>
<td>a boolean.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if a difference is possible (same number of nodes).
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.5</p>
</div>
<hr>
<div class="refsect2" title="visu_geodiff_setActive ()">
<a name="visu-geodiff-setActive"></a><h3>visu_geodiff_setActive ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> visu_geodiff_setActive (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> value</code></em>);</pre>
<p>
Visualise or not a geometry difference that has been previously
obtained using <a class="link" href="v-sim-geometry.html#visu-geodiff-new" title="visu_geodiff_new ()"><code class="function">visu_geodiff_new()</code></a>. The representation is done via
arrows positioned on nodes.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>a boolean.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if the status of the geometry difference changed.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.5</p>
</div>
<hr>
<div class="refsect2" title="visu_geodiff_rebuildList ()">
<a name="visu-geodiff-rebuildList"></a><h3>visu_geodiff_rebuildList ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> visu_geodiff_rebuildList (<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *dataObj</code></em>);</pre>
<p>
Create the OpenGL list holding the representation of a geometry
difference.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>dataObj</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> containing a geometry diff.
</td>
</tr></tbody>
</table></div>
<p class="since">Since 3.5</p>
</div>
<hr>
<div class="refsect2" title="visu_geodiff_hasData ()">
<a name="visu-geodiff-hasData"></a><h3>visu_geodiff_hasData ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> visu_geodiff_hasData (<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *data</code></em>);</pre>
<p>
A set coordinate differences can be associated to a <a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> using <a class="link" href="v-sim-geometry.html#visu-geodiff-new" title="visu_geodiff_new ()"><code class="function">visu_geodiff_new()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> object.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if the given <em class="parameter"><code>data</code></em> has a set of differences associated.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2" title="visu_geodiff_export ()">
<a name="visu-geodiff-export"></a><h3>visu_geodiff_export ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* visu_geodiff_export (<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *data</code></em>);</pre>
<p>
Create a string with differences of coordinates stored in <em class="parameter"><code>data</code></em> in
cartesian coordinates.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> object.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a new string that should be freed after use.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2" title="visu_geodiff_getPeriodicDistance ()">
<a name="visu-geodiff-getPeriodicDistance"></a><h3>visu_geodiff_getPeriodicDistance ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> visu_geodiff_getPeriodicDistance (<em class="parameter"><code><span class="type">float</span> diff[3]</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *data</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-visu-nodes.html#VisuNode" title="VisuNode"><span class="type">VisuNode</span></a> *node1</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-visu-nodes.html#VisuNode" title="VisuNode"><span class="type">VisuNode</span></a> *node2</code></em>);</pre>
<p>
Compute the shortest distance between <em class="parameter"><code>node1</code></em> and <em class="parameter"><code>node2</code></em> of <em class="parameter"><code>data</code></em>
taking into account the periodic boundary conditions.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>diff</code></em> :</span></p></td>
<td>a location to store the shift.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> object.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>node1</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-visu-nodes.html#VisuNode" title="VisuNode"><span class="type">VisuNode</span></a> object.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>node2</code></em> :</span></p></td>
<td>another <a class="link" href="v-sim-visu-nodes.html#VisuNode" title="VisuNode"><span class="type">VisuNode</span></a> object.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.5</p>
</div>
<hr>
<div class="refsect2" title="geometryInit ()">
<a name="geometryInit"></a><h3>geometryInit ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> geometryInit ();</pre>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.14</div>
</body>
</html>
|
