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
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>interactive</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="ch03.html" title="OpenGL tools">
<link rel="prev" href="v-sim-view.html" title="view">
<link rel="next" href="v-sim-objectList.html" title="objectList">
<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-view.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch03.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-objectList.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-interactive.synopsis" class="shortcut">Top</a>
|
<a href="#v-sim-interactive.description" class="shortcut">Description</a>
|
<a href="#v-sim-interactive.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#v-sim-interactive.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry" title="interactive">
<a name="v-sim-interactive"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="v-sim-interactive.top_of_page"></a>interactive</span></h2>
<p>interactive — Gives tools to interact with the rendered
area.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="v-sim-interactive.synopsis"></a><h2>Synopsis</h2>
<a name="VisuInteractive"></a><pre class="synopsis">enum <a class="link" href="v-sim-interactive.html#VisuInteractiveMethod" title="enum VisuInteractiveMethod">VisuInteractiveMethod</a>;
enum <a class="link" href="v-sim-interactive.html#VisuInteractiveId" title="enum VisuInteractiveId">VisuInteractiveId</a>;
enum <a class="link" href="v-sim-interactive.html#VisuInteractivePick" title="enum VisuInteractivePick">VisuInteractivePick</a>;
enum <a class="link" href="v-sim-interactive.html#VisuInteractivePickError" title="enum VisuInteractivePickError">VisuInteractivePickError</a>;
#define <a class="link" href="v-sim-interactive.html#VISU-INTERACTIVE-TYPE:CAPS" title="VISU_INTERACTIVE_TYPE">VISU_INTERACTIVE_TYPE</a>
#define <a class="link" href="v-sim-interactive.html#VISU-INTERACTIVE:CAPS" title="VISU_INTERACTIVE()">VISU_INTERACTIVE</a> (obj)
#define <a class="link" href="v-sim-interactive.html#VISU-INTERACTIVE-CLASS:CAPS" title="VISU_INTERACTIVE_CLASS()">VISU_INTERACTIVE_CLASS</a> (klass)
#define <a class="link" href="v-sim-interactive.html#IS-VISU-INTERACTIVE:CAPS" title="IS_VISU_INTERACTIVE()">IS_VISU_INTERACTIVE</a> (obj)
#define <a class="link" href="v-sim-interactive.html#IS-VISU-INTERACTIVE-CLASS:CAPS" title="IS_VISU_INTERACTIVE_CLASS()">IS_VISU_INTERACTIVE_CLASS</a> (klass)
#define <a class="link" href="v-sim-interactive.html#VISU-INTERACTIVE-GET-CLASS:CAPS" title="VISU_INTERACTIVE_GET_CLASS()">VISU_INTERACTIVE_GET_CLASS</a> (obj)
<a class="link" href="v-sim-interactive.html#VisuInteractive-struct" title="VisuInteractive">VisuInteractive</a>;
<a class="link" href="v-sim-interactive.html#VisuInteractiveClass" title="VisuInteractiveClass">VisuInteractiveClass</a>;
<a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a> <a class="link" href="v-sim-interactive.html#visuInteractive-get-type" title="visuInteractive_get_type ()">visuInteractive_get_type</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span> <a class="link" href="v-sim-interactive.html#visuInteractiveClassSet-preferedObserveMethod" title="visuInteractiveClassSet_preferedObserveMethod ()">visuInteractiveClassSet_preferedObserveMethod</a>
(<em class="parameter"><code><a class="link" href="v-sim-interactive.html#VisuInteractiveMethod" title="enum VisuInteractiveMethod"><span class="type">VisuInteractiveMethod</span></a> method</code></em>);
<a class="link" href="v-sim-interactive.html#VisuInteractiveMethod" title="enum VisuInteractiveMethod"><span class="returnvalue">VisuInteractiveMethod</span></a> <a class="link" href="v-sim-interactive.html#visuInteractiveClassGet-preferedObserveMethod" title="visuInteractiveClassGet_preferedObserveMethod ()">visuInteractiveClassGet_preferedObserveMethod</a>
();
<a class="link" href="v-sim-interactive.html#VisuInteractive"><span class="returnvalue">VisuInteractive</span></a>* <a class="link" href="v-sim-interactive.html#visuInteractiveNew" title="visuInteractiveNew ()">visuInteractiveNew</a> (<em class="parameter"><code><a class="link" href="v-sim-interactive.html#VisuInteractiveId" title="enum VisuInteractiveId"><span class="type">VisuInteractiveId</span></a> type</code></em>);
<a class="link" href="v-sim-interactive.html#VisuInteractiveId" title="enum VisuInteractiveId"><span class="returnvalue">VisuInteractiveId</span></a> <a class="link" href="v-sim-interactive.html#visuInteractiveGet-type" title="visuInteractiveGet_type ()">visuInteractiveGet_type</a> (<em class="parameter"><code><a class="link" href="v-sim-interactive.html#VisuInteractive"><span class="type">VisuInteractive</span></a> *inter</code></em>);
<span class="returnvalue">void</span> <a class="link" href="v-sim-interactive.html#visuInteractiveHandle-event" title="visuInteractiveHandle_event ()">visuInteractiveHandle_event</a> (<em class="parameter"><code><a class="link" href="v-sim-interactive.html#VisuInteractive"><span class="type">VisuInteractive</span></a> *inter</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *dataObj</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-visu-actionInterface.html#SimplifiedEvents" title="SimplifiedEvents"><span class="type">SimplifiedEvents</span></a> *ev</code></em>);
<span class="returnvalue">void</span> <a class="link" href="v-sim-interactive.html#visuInteractiveSet-movingNodes" title="visuInteractiveSet_movingNodes ()">visuInteractiveSet_movingNodes</a> (<em class="parameter"><code><a class="link" href="v-sim-interactive.html#VisuInteractive"><span class="type">VisuInteractive</span></a> *inter</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *nodeIds</code></em>);
<span class="returnvalue">void</span> <a class="link" href="v-sim-interactive.html#visuInteractiveSet-movingAxe" title="visuInteractiveSet_movingAxe ()">visuInteractiveSet_movingAxe</a> (<em class="parameter"><code><a class="link" href="v-sim-interactive.html#VisuInteractive"><span class="type">VisuInteractive</span></a> *inter</code></em>,
<em class="parameter"><code><span class="type">float</span> axe[3]</code></em>);
<a class="link" href="v-sim-view.html#VisuOpenGLCamera" title="VisuOpenGLCamera"><span class="returnvalue">VisuOpenGLCamera</span></a>* <a class="link" href="v-sim-interactive.html#visuInteractivePop-savedCamera" title="visuInteractivePop_savedCamera ()">visuInteractivePop_savedCamera</a> (<em class="parameter"><code><a class="link" href="v-sim-interactive.html#VisuInteractive"><span class="type">VisuInteractive</span></a> *inter</code></em>);
<span class="returnvalue">void</span> <a class="link" href="v-sim-interactive.html#visuInteractivePush-savedCamera" title="visuInteractivePush_savedCamera ()">visuInteractivePush_savedCamera</a> (<em class="parameter"><code><a class="link" href="v-sim-interactive.html#VisuInteractive"><span class="type">VisuInteractive</span></a> *inter</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-view.html#VisuOpenGLCamera" title="VisuOpenGLCamera"><span class="type">VisuOpenGLCamera</span></a> *camera</code></em>);
<span class="returnvalue">void</span> <a class="link" href="v-sim-interactive.html#visuInteractiveGet-savedCameras" title="visuInteractiveGet_savedCameras ()">visuInteractiveGet_savedCameras</a> (<em class="parameter"><code><a class="link" href="v-sim-interactive.html#VisuInteractive"><span class="type">VisuInteractive</span></a> *inter</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> **cameras</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> **head</code></em>);
<span class="returnvalue">void</span> <a class="link" href="v-sim-interactive.html#visuInteractiveSet-references" title="visuInteractiveSet_references ()">visuInteractiveSet_references</a> (<em class="parameter"><code><a class="link" href="v-sim-interactive.html#VisuInteractive"><span class="type">VisuInteractive</span></a> *inter</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-interactive.html#VisuInteractive"><span class="type">VisuInteractive</span></a> *from</code></em>);
<span class="returnvalue">void</span> <a class="link" href="v-sim-interactive.html#getNodes2DCoordinates" title="getNodes2DCoordinates ()">getNodes2DCoordinates</a> (<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *dataObj</code></em>,
<em class="parameter"><code>unsigned <span class="type">int</span> *nodeIds</code></em>,
<em class="parameter"><code>unsigned <span class="type">int</span> nNodes</code></em>,
<em class="parameter"><code><span class="type">float</span> *coordinates2D</code></em>,
<em class="parameter"><code>unsigned <span class="type">int</span> *size</code></em>);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="v-sim-interactive.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----VisuInteractive
</pre>
</div>
<div class="refsect1" title="Signals">
<a name="v-sim-interactive.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="v-sim-interactive.html#VisuInteractive-move" title='The "move" signal'>move</a>" : Run Last / No Recursion / No Hooks
"<a class="link" href="v-sim-interactive.html#VisuInteractive-node-selection" title='The "node-selection" signal'>node-selection</a>" : Run Last / No Recursion
"<a class="link" href="v-sim-interactive.html#VisuInteractive-observe" title='The "observe" signal'>observe</a>" : Run Last / No Recursion
"<a class="link" href="v-sim-interactive.html#VisuInteractive-region-selection" title='The "region-selection" signal'>region-selection</a>" : Run Last / No Recursion / No Hooks
"<a class="link" href="v-sim-interactive.html#VisuInteractive-selection-error" title='The "selection-error" signal'>selection-error</a>" : Run Last / No Recursion / No Hooks
"<a class="link" href="v-sim-interactive.html#VisuInteractive-start-move" title='The "start-move" signal'>start-move</a>" : Run Last / No Recursion / No Hooks
"<a class="link" href="v-sim-interactive.html#VisuInteractive-stop" title='The "stop" signal'>stop</a>" : Run Last / No Recursion / No Hooks
</pre>
</div>
<div class="refsect1" title="Description">
<a name="v-sim-interactive.description"></a><h2>Description</h2>
<p>
</p>
<p>When one wants some interactions on the rendering area
(either from the mouse or from the keyboard), one should initialise
it using <a href="v-sim-interactive.html#openGLInteractiveInit-session"><code class="function">openGLInteractiveInit_session()</code></a>. Then, during the
interactive session, several modes have been implemented:
</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem"><p>
<a href="v-sim-interactive.html#openGLInteractiveBegin-mark"><code class="function">openGLInteractiveBegin_mark()</code></a>, is a mode where the mouse can select
a node and this nodes become highlighted.
</p></li>
<li class="listitem"><p>
<a href="v-sim-interactive.html#openGLInteractiveBegin-move"><code class="function">openGLInteractiveBegin_move()</code></a>, the mouse is then used to move
picked nodes. Moves are possible in the plane of the screen or
constrained along axis of the bounding box.
</p></li>
<li class="listitem"><p>
<a href="v-sim-interactive.html#openGLInteractiveBegin-observe"><code class="function">openGLInteractiveBegin_observe()</code></a>, in this mode, the mouse is used
to change the position of camera, its orientation and its zoom
characteristics.
</p></li>
<li class="listitem"><p>
<a href="v-sim-interactive.html#openGLInteractiveBegin-pick"><code class="function">openGLInteractiveBegin_pick()</code></a>, this mode is the most complex
picking mode. It can select atoms up to two references and measure
distances and angles.
</p></li>
<li class="listitem"><p>
<a href="v-sim-interactive.html#openGLInteractiveBegin-pickAndObserve"><code class="function">openGLInteractiveBegin_pickAndObserve()</code></a>, this mode is a simplified
mix of obervation and picking.
</p></li>
</ul></div>
<p>
The observe mode has two different moving algorithms that can be
changed using <a href="v-sim-interactive.html#openGLInteractiveSet-preferedObserveMethod"><code class="function">openGLInteractiveSet_preferedObserveMethod()</code></a>. The
first, called 'constrained' (cf. <a href="v-sim-interactive.html#OPENGL-OBSERVE-CONSTRAINED:CAPS"><span class="type">OPENGL_OBSERVE_CONSTRAINED</span></a>)
corresponds to movements along parallels and meridians. When the
mouse is moved along x axis, the camera raotates along a
parallel. When the camera is moved along y axis, the camera rotate
along a meridian. The top is always pointing to the north pole (in
fact, omega is always forced to 0 in this mode). This mode has a
'strange' behavior when the observer is near a pole: moving mouse
along x axis make the box rotates on itself. It is normal, because
movements on x axis is equivalent to movements on parallel and near
the poles, parallel are small circle around the z axis. This can be
unnatural in some occasion and the other mode, called 'walker' (see
<a href="v-sim-interactive.html#OPENGL-OBSERVE-WALKER:CAPS"><span class="type">OPENGL_OBSERVE_WALKER</span></a>) can be used instead of the 'constrained'
mode. In the former, the moving is done has if the observer was a
walking ant on a sphere : moving the mouse along y axis makes the
ant go on or forward ; and x axis movements makes the ant goes on
its left or on it right. This is a more natural way to move the box
but it has the inconvient that it is hard to return in a given
position (omega has never the right value).
</p>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="v-sim-interactive.details"></a><h2>Details</h2>
<div class="refsect2" title="enum VisuInteractiveMethod">
<a name="VisuInteractiveMethod"></a><h3>enum VisuInteractiveMethod</h3>
<pre class="programlisting">typedef enum
{
interactive_constrained,
interactive_walker
} VisuInteractiveMethod;
</pre>
<p>
Describes the different possible methods for observe moves.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="interactive-constrained"></a><span class="term"><code class="literal">interactive_constrained</code></span></p></td>
<td>the camera is moved keeping the north
pole up. The north pole is defined by the Z axis et periodic
boundary conditions and by normal to surface in surface conditions.
</td>
</tr>
<tr>
<td><p><a name="interactive-walker"></a><span class="term"><code class="literal">interactive_walker</code></span></p></td>
<td>the camera is moved following the mouse moves,
orienting the view as a walker would do along a sphere.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="enum VisuInteractiveId">
<a name="VisuInteractiveId"></a><h3>enum VisuInteractiveId</h3>
<pre class="programlisting">typedef enum
{
interactive_none,
interactive_observe,
interactive_measureAndObserve,
interactive_measure,
interactive_pick,
interactive_move,
interactive_mark
} VisuInteractiveId;
</pre>
<p>
These are the possible mouse interaction that are implemented.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="interactive-none"></a><span class="term"><code class="literal">interactive_none</code></span></p></td>
<td>no interaction ;
</td>
</tr>
<tr>
<td><p><a name="interactive-observe"></a><span class="term"><code class="literal">interactive_observe</code></span></p></td>
<td>interaction to rotate the view ;
</td>
</tr>
<tr>
<td><p><a name="interactive-measureAndObserve"></a><span class="term"><code class="literal">interactive_measureAndObserve</code></span></p></td>
<td>interaction to rotate the view and
access limited pick action on the right click ;
</td>
</tr>
<tr>
<td><p><a name="interactive-measure"></a><span class="term"><code class="literal">interactive_measure</code></span></p></td>
<td>interaction to pick and measure ;
</td>
</tr>
<tr>
<td><p><a name="interactive-pick"></a><span class="term"><code class="literal">interactive_pick</code></span></p></td>
<td>interaction to select node ;
</td>
</tr>
<tr>
<td><p><a name="interactive-move"></a><span class="term"><code class="literal">interactive_move</code></span></p></td>
<td>interaction to move nodes ;
</td>
</tr>
<tr>
<td><p><a name="interactive-mark"></a><span class="term"><code class="literal">interactive_mark</code></span></p></td>
<td>interaction to mark nodes.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="enum VisuInteractivePick">
<a name="VisuInteractivePick"></a><h3>enum VisuInteractivePick</h3>
<pre class="programlisting">typedef enum
{
PICK_NONE,
PICK_SELECTED,
PICK_DISTANCE,
PICK_ANGLE,
PICK_HIGHLIGHT,
PICK_REFERENCE_1,
PICK_UNREFERENCE_1,
PICK_REFERENCE_2,
PICK_UNREFERENCE_2,
PICK_INFORMATION,
PICK_REGION
} VisuInteractivePick;
</pre>
<p>
Possible significations of a click.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="PICK-NONE:CAPS"></a><span class="term"><code class="literal">PICK_NONE</code></span></p></td>
<td>click to void ;
</td>
</tr>
<tr>
<td><p><a name="PICK-SELECTED:CAPS"></a><span class="term"><code class="literal">PICK_SELECTED</code></span></p></td>
<td>click to select one node ;
</td>
</tr>
<tr>
<td><p><a name="PICK-DISTANCE:CAPS"></a><span class="term"><code class="literal">PICK_DISTANCE</code></span></p></td>
<td>click to measure a distance between two nodes ;
</td>
</tr>
<tr>
<td><p><a name="PICK-ANGLE:CAPS"></a><span class="term"><code class="literal">PICK_ANGLE</code></span></p></td>
<td>click to measure an angle ;
</td>
</tr>
<tr>
<td><p><a name="PICK-HIGHLIGHT:CAPS"></a><span class="term"><code class="literal">PICK_HIGHLIGHT</code></span></p></td>
<td>click to highlight a node ;
</td>
</tr>
<tr>
<td><p><a name="PICK-REFERENCE-1:CAPS"></a><span class="term"><code class="literal">PICK_REFERENCE_1</code></span></p></td>
<td>click to select a first reference ;
</td>
</tr>
<tr>
<td><p><a name="PICK-UNREFERENCE-1:CAPS"></a><span class="term"><code class="literal">PICK_UNREFERENCE_1</code></span></p></td>
<td>click to un-select a first reference ;
</td>
</tr>
<tr>
<td><p><a name="PICK-REFERENCE-2:CAPS"></a><span class="term"><code class="literal">PICK_REFERENCE_2</code></span></p></td>
<td>click to select a second reference ;
</td>
</tr>
<tr>
<td><p><a name="PICK-UNREFERENCE-2:CAPS"></a><span class="term"><code class="literal">PICK_UNREFERENCE_2</code></span></p></td>
<td>click to un-select a second reference ;
</td>
</tr>
<tr>
<td><p><a name="PICK-INFORMATION:CAPS"></a><span class="term"><code class="literal">PICK_INFORMATION</code></span></p></td>
<td>click to measure distances and angles around one
node ;
</td>
</tr>
<tr>
<td><p><a name="PICK-REGION:CAPS"></a><span class="term"><code class="literal">PICK_REGION</code></span></p></td>
<td>click to select a list of nodes.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="enum VisuInteractivePickError">
<a name="VisuInteractivePickError"></a><h3>enum VisuInteractivePickError</h3>
<pre class="programlisting">typedef enum
{
PICK_ERROR_NONE,
PICK_ERROR_NO_SELECTION,
PICK_ERROR_SAME_REF,
PICK_ERROR_REF1,
PICK_ERROR_REF2
} VisuInteractivePickError;
</pre>
<p>
Possible errors to occur when pick or measure.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="PICK-ERROR-NONE:CAPS"></a><span class="term"><code class="literal">PICK_ERROR_NONE</code></span></p></td>
<td>no error during click ;
</td>
</tr>
<tr>
<td><p><a name="PICK-ERROR-NO-SELECTION:CAPS"></a><span class="term"><code class="literal">PICK_ERROR_NO_SELECTION</code></span></p></td>
<td>click to sleect but nothing selected ;
</td>
</tr>
<tr>
<td><p><a name="PICK-ERROR-SAME-REF:CAPS"></a><span class="term"><code class="literal">PICK_ERROR_SAME_REF</code></span></p></td>
<td>click to set a reference but reference
already exists ;
</td>
</tr>
<tr>
<td><p><a name="PICK-ERROR-REF1:CAPS"></a><span class="term"><code class="literal">PICK_ERROR_REF1</code></span></p></td>
<td>click to select a first reference but impossible
to choose this one ;
</td>
</tr>
<tr>
<td><p><a name="PICK-ERROR-REF2:CAPS"></a><span class="term"><code class="literal">PICK_ERROR_REF2</code></span></p></td>
<td>the same for second reference.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="VISU_INTERACTIVE_TYPE">
<a name="VISU-INTERACTIVE-TYPE:CAPS"></a><h3>VISU_INTERACTIVE_TYPE</h3>
<pre class="programlisting">#define VISU_INTERACTIVE_TYPE (visuInteractive_get_type ())
</pre>
<p>
return the type of <a class="link" href="v-sim-interactive.html#VisuInteractive"><span class="type">VisuInteractive</span></a>.
</p>
</div>
<hr>
<div class="refsect2" title="VISU_INTERACTIVE()">
<a name="VISU-INTERACTIVE:CAPS"></a><h3>VISU_INTERACTIVE()</h3>
<pre class="programlisting">#define VISU_INTERACTIVE(obj) (G_TYPE_CHECK_INSTANCE_CAST(obj, VISU_INTERACTIVE_TYPE, VisuInteractive))
</pre>
<p>
Cast the given <em class="parameter"><code>obj</code></em> into <a class="link" href="v-sim-interactive.html#VisuInteractive"><span class="type">VisuInteractive</span></a> type.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> to cast.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="VISU_INTERACTIVE_CLASS()">
<a name="VISU-INTERACTIVE-CLASS:CAPS"></a><h3>VISU_INTERACTIVE_CLASS()</h3>
<pre class="programlisting">#define VISU_INTERACTIVE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST(klass, VISU_INTERACTIVE_TYPE, VisuInteractiveClass))
</pre>
<p>
Cast the given <em class="parameter"><code>klass</code></em> into <a class="link" href="v-sim-interactive.html#VisuInteractiveClass" title="VisuInteractiveClass"><span class="type">VisuInteractiveClass</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>klass</code></em> :</span></p></td>
<td>a <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> to cast.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="IS_VISU_INTERACTIVE()">
<a name="IS-VISU-INTERACTIVE:CAPS"></a><h3>IS_VISU_INTERACTIVE()</h3>
<pre class="programlisting">#define IS_VISU_INTERACTIVE(obj) (G_TYPE_CHECK_INSTANCE_TYPE(obj, VISU_INTERACTIVE_TYPE))
</pre>
<p>
Test if the given <em class="parameter"><code>ogj</code></em> is of the type of <a class="link" href="v-sim-interactive.html#VisuInteractive"><span class="type">VisuInteractive</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>obj</code></em> :</span></p></td>
<td>a <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> to test.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="IS_VISU_INTERACTIVE_CLASS()">
<a name="IS-VISU-INTERACTIVE-CLASS:CAPS"></a><h3>IS_VISU_INTERACTIVE_CLASS()</h3>
<pre class="programlisting">#define IS_VISU_INTERACTIVE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE(klass, VISU_INTERACTIVE_TYPE))
</pre>
<p>
Test if the given <em class="parameter"><code>klass</code></em> is of the type of <a class="link" href="v-sim-interactive.html#VisuInteractiveClass" title="VisuInteractiveClass"><span class="type">VisuInteractiveClass</span></a> class.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>klass</code></em> :</span></p></td>
<td>a <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> to test.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="VISU_INTERACTIVE_GET_CLASS()">
<a name="VISU-INTERACTIVE-GET-CLASS:CAPS"></a><h3>VISU_INTERACTIVE_GET_CLASS()</h3>
<pre class="programlisting">#define VISU_INTERACTIVE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS(obj, VISU_INTERACTIVE_TYPE, VisuInteractiveClass))
</pre>
<p>
It returns the class of the given <em class="parameter"><code>obj</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>obj</code></em> :</span></p></td>
<td>a <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> to get the class of.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="VisuInteractive">
<a name="VisuInteractive-struct"></a><h3>VisuInteractive</h3>
<pre class="programlisting">typedef struct _VisuInteractive VisuInteractive;</pre>
<p>
All fields are private.
</p>
</div>
<hr>
<div class="refsect2" title="VisuInteractiveClass">
<a name="VisuInteractiveClass"></a><h3>VisuInteractiveClass</h3>
<pre class="programlisting">typedef struct _VisuInteractiveClass VisuInteractiveClass;</pre>
<p>
An opaque structure representing the class of <a class="link" href="v-sim-interactive.html#VisuInteractive"><span class="type">VisuInteractive</span></a> objects.
</p>
</div>
<hr>
<div class="refsect2" title="visuInteractive_get_type ()">
<a name="visuInteractive-get-type"></a><h3>visuInteractive_get_type ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a> visuInteractive_get_type (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
This method returns the type of <a class="link" href="v-sim-interactive.html#VisuInteractive"><span class="type">VisuInteractive</span></a>, use VISU_INTERACTIVE_TYPE instead.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the type of <a class="link" href="v-sim-interactive.html#VisuInteractive"><span class="type">VisuInteractive</span></a>.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="visuInteractiveClassSet_preferedObserveMethod ()">
<a name="visuInteractiveClassSet-preferedObserveMethod"></a><h3>visuInteractiveClassSet_preferedObserveMethod ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> visuInteractiveClassSet_preferedObserveMethod
(<em class="parameter"><code><a class="link" href="v-sim-interactive.html#VisuInteractiveMethod" title="enum VisuInteractiveMethod"><span class="type">VisuInteractiveMethod</span></a> method</code></em>);</pre>
<p>
There are two methods to move the camera in a pick and observe sesion. These
two methods are described in the commentary of the keys <a href="v-sim-interactive.html#OPENGL-OBSERVE-CONSTRAINED:CAPS"><span class="type">OPENGL_OBSERVE_CONSTRAINED</span></a>
an d<a href="v-sim-interactive.html#OPENGL-OBSERVE-WALKER:CAPS"><span class="type">OPENGL_OBSERVE_WALKER</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>method</code></em> :</span></p></td>
<td>an integer that identify the method, see <a href="v-sim-interactive.html#OPENGL-OBSERVE-CONSTRAINED:CAPS"><span class="type">OPENGL_OBSERVE_CONSTRAINED</span></a>,
and <a href="v-sim-interactive.html#OPENGL-OBSERVE-WALKER:CAPS"><span class="type">OPENGL_OBSERVE_WALKER</span></a> flags.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="visuInteractiveClassGet_preferedObserveMethod ()">
<a name="visuInteractiveClassGet-preferedObserveMethod"></a><h3>visuInteractiveClassGet_preferedObserveMethod ()</h3>
<pre class="programlisting"><a class="link" href="v-sim-interactive.html#VisuInteractiveMethod" title="enum VisuInteractiveMethod"><span class="returnvalue">VisuInteractiveMethod</span></a> visuInteractiveClassGet_preferedObserveMethod
();</pre>
<p>
There are two methods to move the camera in a pick and observe sesion. These
two methods are described in the commentary of the keys <a href="v-sim-interactive.html#OPENGL-OBSERVE-CONSTRAINED:CAPS"><span class="type">OPENGL_OBSERVE_CONSTRAINED</span></a>
an d<a href="v-sim-interactive.html#OPENGL-OBSERVE-WALKER:CAPS"><span class="type">OPENGL_OBSERVE_WALKER</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> an integer that identify the method, see <a href="v-sim-interactive.html#OPENGL-OBSERVE-CONSTRAINED:CAPS"><span class="type">OPENGL_OBSERVE_CONSTRAINED</span></a>,
and <a href="v-sim-interactive.html#OPENGL-OBSERVE-WALKER:CAPS"><span class="type">OPENGL_OBSERVE_WALKER</span></a> flags.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="visuInteractiveNew ()">
<a name="visuInteractiveNew"></a><h3>visuInteractiveNew ()</h3>
<pre class="programlisting"><a class="link" href="v-sim-interactive.html#VisuInteractive"><span class="returnvalue">VisuInteractive</span></a>* visuInteractiveNew (<em class="parameter"><code><a class="link" href="v-sim-interactive.html#VisuInteractiveId" title="enum VisuInteractiveId"><span class="type">VisuInteractiveId</span></a> type</code></em>);</pre>
<p>
Creates a new interactive session of the given <em class="parameter"><code>type</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>type</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-interactive.html#VisuInteractiveId" title="enum VisuInteractiveId"><span class="type">VisuInteractiveId</span></a> flag.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a newly created object.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="visuInteractiveGet_type ()">
<a name="visuInteractiveGet-type"></a><h3>visuInteractiveGet_type ()</h3>
<pre class="programlisting"><a class="link" href="v-sim-interactive.html#VisuInteractiveId" title="enum VisuInteractiveId"><span class="returnvalue">VisuInteractiveId</span></a> visuInteractiveGet_type (<em class="parameter"><code><a class="link" href="v-sim-interactive.html#VisuInteractive"><span class="type">VisuInteractive</span></a> *inter</code></em>);</pre>
<p>
It returns the kind of interactive session.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>inter</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-interactive.html#VisuInteractive"><span class="type">VisuInteractive</span></a> object.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a <a class="link" href="v-sim-interactive.html#VisuInteractiveId" title="enum VisuInteractiveId"><span class="type">VisuInteractiveId</span></a> value.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="visuInteractiveHandle_event ()">
<a name="visuInteractiveHandle-event"></a><h3>visuInteractiveHandle_event ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> visuInteractiveHandle_event (<em class="parameter"><code><a class="link" href="v-sim-interactive.html#VisuInteractive"><span class="type">VisuInteractive</span></a> *inter</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *dataObj</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-visu-actionInterface.html#SimplifiedEvents" title="SimplifiedEvents"><span class="type">SimplifiedEvents</span></a> *ev</code></em>);</pre>
<p>
This routine should be called by the rendering window when some
event is raised on the rendering surface.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>inter</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-interactive.html#VisuInteractive"><span class="type">VisuInteractive</span></a> object ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dataObj</code></em> :</span></p></td>
<td>the <a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> object to interact with ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ev</code></em> :</span></p></td>
<td>a simplified event.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="visuInteractiveSet_movingNodes ()">
<a name="visuInteractiveSet-movingNodes"></a><h3>visuInteractiveSet_movingNodes ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> visuInteractiveSet_movingNodes (<em class="parameter"><code><a class="link" href="v-sim-interactive.html#VisuInteractive"><span class="type">VisuInteractive</span></a> *inter</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *nodeIds</code></em>);</pre>
<p>
Defines the nodes that should be moved if <em class="parameter"><code>inter</code></em> is a move
action session. The list is actually copied.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>inter</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-interactive.html#VisuInteractive"><span class="type">VisuInteractive</span></a> object.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>nodeIds</code></em> :</span></p></td>
<td>a list of node ids.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="visuInteractiveSet_movingAxe ()">
<a name="visuInteractiveSet-movingAxe"></a><h3>visuInteractiveSet_movingAxe ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> visuInteractiveSet_movingAxe (<em class="parameter"><code><a class="link" href="v-sim-interactive.html#VisuInteractive"><span class="type">VisuInteractive</span></a> *inter</code></em>,
<em class="parameter"><code><span class="type">float</span> axe[3]</code></em>);</pre>
<p>
Defines the axe that can be used to move along if <em class="parameter"><code>inter</code></em> is a move
action session.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>inter</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-interactive.html#VisuInteractive"><span class="type">VisuInteractive</span></a> object.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>axe</code></em> :</span></p></td>
<td>a direction.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="visuInteractivePop_savedCamera ()">
<a name="visuInteractivePop-savedCamera"></a><h3>visuInteractivePop_savedCamera ()</h3>
<pre class="programlisting"><a class="link" href="v-sim-view.html#VisuOpenGLCamera" title="VisuOpenGLCamera"><span class="returnvalue">VisuOpenGLCamera</span></a>* visuInteractivePop_savedCamera (<em class="parameter"><code><a class="link" href="v-sim-interactive.html#VisuInteractive"><span class="type">VisuInteractive</span></a> *inter</code></em>);</pre>
<p>
<em class="parameter"><code>inter</code></em> object stores camera settings as a ring. This routine goes
to the next camera in the ring and returns the current one. The
popped camera is not actually removed from the ring.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>inter</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-interactive.html#VisuInteractive"><span class="type">VisuInteractive</span></a> object.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a pointer to the previously current <a class="link" href="v-sim-view.html#VisuOpenGLCamera" title="VisuOpenGLCamera"><span class="type">VisuOpenGLCamera</span></a>. It
is owned by V_Sim and should not be touched.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2" title="visuInteractivePush_savedCamera ()">
<a name="visuInteractivePush-savedCamera"></a><h3>visuInteractivePush_savedCamera ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> visuInteractivePush_savedCamera (<em class="parameter"><code><a class="link" href="v-sim-interactive.html#VisuInteractive"><span class="type">VisuInteractive</span></a> *inter</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-view.html#VisuOpenGLCamera" title="VisuOpenGLCamera"><span class="type">VisuOpenGLCamera</span></a> *camera</code></em>);</pre>
<p>
<em class="parameter"><code>inter</code></em> object stores camera settings as a ring. The given <em class="parameter"><code>camera</code></em>
is copied in the ring if its values not already exist. The current camera
is set to this new one.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>inter</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-interactive.html#VisuInteractive"><span class="type">VisuInteractive</span></a> object.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>camera</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-view.html#VisuOpenGLCamera" title="VisuOpenGLCamera"><span class="type">VisuOpenGLCamera</span></a> object.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2" title="visuInteractiveGet_savedCameras ()">
<a name="visuInteractiveGet-savedCameras"></a><h3>visuInteractiveGet_savedCameras ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> visuInteractiveGet_savedCameras (<em class="parameter"><code><a class="link" href="v-sim-interactive.html#VisuInteractive"><span class="type">VisuInteractive</span></a> *inter</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> **cameras</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> **head</code></em>);</pre>
<p>
<em class="parameter"><code>inter</code></em> object stores camera settings as a ring. One can access the
set of saved cameras thanks to <em class="parameter"><code>cameras</code></em> or to the current position
in the ring thanks to <em class="parameter"><code>head</code></em>. <em class="parameter"><code>cameras</code></em> or <em class="parameter"><code>head</code></em> are not copied and
are owned by V_Sim. They should be considered read-only.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>inter</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-interactive.html#VisuInteractive"><span class="type">VisuInteractive</span></a> object.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cameras</code></em> :</span></p></td>
<td>a location to store a list of cameras.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>head</code></em> :</span></p></td>
<td>a location to store a list of cameras.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2" title="visuInteractiveSet_references ()">
<a name="visuInteractiveSet-references"></a><h3>visuInteractiveSet_references ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> visuInteractiveSet_references (<em class="parameter"><code><a class="link" href="v-sim-interactive.html#VisuInteractive"><span class="type">VisuInteractive</span></a> *inter</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-interactive.html#VisuInteractive"><span class="type">VisuInteractive</span></a> *from</code></em>);</pre>
<p>
Copies all node ids used as reference from <em class="parameter"><code>from</code></em> to <em class="parameter"><code>inter</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>inter</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-interactive.html#VisuInteractive"><span class="type">VisuInteractive</span></a> object.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>from</code></em> :</span></p></td>
<td>another <a class="link" href="v-sim-interactive.html#VisuInteractive"><span class="type">VisuInteractive</span></a> object.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="getNodes2DCoordinates ()">
<a name="getNodes2DCoordinates"></a><h3>getNodes2DCoordinates ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> getNodes2DCoordinates (<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *dataObj</code></em>,
<em class="parameter"><code>unsigned <span class="type">int</span> *nodeIds</code></em>,
<em class="parameter"><code>unsigned <span class="type">int</span> nNodes</code></em>,
<em class="parameter"><code><span class="type">float</span> *coordinates2D</code></em>,
<em class="parameter"><code>unsigned <span class="type">int</span> *size</code></em>);</pre>
<p>
From nodes ids, compute and store in <em class="parameter"><code>coordinates2D</code></em> their 2D coordinates.
</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> object ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>nodeIds</code></em> :</span></p></td>
<td>an array of <a class="link" href="v-sim-visu-nodes.html#VisuNode" title="VisuNode"><span class="type">VisuNode</span></a> ids ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>nNodes</code></em> :</span></p></td>
<td>the number of nodes in the array ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>coordinates2D</code></em> :</span></p></td>
<td>an array of nodes 2D coordinates ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
<td>the size of the coordinates array.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" title="Signal Details">
<a name="v-sim-interactive.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2" title='The "move" signal'>
<a name="VisuInteractive-move"></a><h3>The <code class="literal">"move"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="v-sim-interactive.html#VisuInteractive"><span class="type">VisuInteractive</span></a> *obj,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> nodes,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : Run Last / No Recursion / No Hooks</pre>
<p>
This signal is emitted each time a set of nodes are moved. The
corresponding nodes are stored in <em class="parameter"><code>nodes</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>obj</code></em> :</span></p></td>
<td>the object emitting the signal.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>nodes</code></em> :</span></p></td>
<td>an array of node ids.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2" title='The "node-selection" signal'>
<a name="VisuInteractive-node-selection"></a><h3>The <code class="literal">"node-selection"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="v-sim-interactive.html#VisuInteractive"><span class="type">VisuInteractive</span></a> *obj,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> kind,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> nodes,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : Run Last / No Recursion</pre>
<p>
This signal is emitted each time a single node selection succeed, providing the
kind in <em class="parameter"><code>kind</code></em> (see <a class="link" href="v-sim-interactive.html#VisuInteractivePick" title="enum VisuInteractivePick"><span class="type">VisuInteractivePick</span></a>). The corresponding nodes
are stored in <em class="parameter"><code>nodes</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>obj</code></em> :</span></p></td>
<td>the object emitting the signal.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>kind</code></em> :</span></p></td>
<td>a flag.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>nodes</code></em> :</span></p></td>
<td>an array of three node ids.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2" title='The "observe" signal'>
<a name="VisuInteractive-observe"></a><h3>The <code class="literal">"observe"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="v-sim-interactive.html#VisuInteractive"><span class="type">VisuInteractive</span></a> *obj,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> bool,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : Run Last / No Recursion</pre>
<p>
This signal is emitted each time an observe session is start
(<em class="parameter"><code>bool</code></em> is TRUE) or finished (<em class="parameter"><code>bool</code></em> is FALSE).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>the object emitting the signal.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>bool</code></em> :</span></p></td>
<td>a boolean.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2" title='The "region-selection" signal'>
<a name="VisuInteractive-region-selection"></a><h3>The <code class="literal">"region-selection"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="v-sim-interactive.html#VisuInteractive"><span class="type">VisuInteractive</span></a> *obj,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> nodes,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : Run Last / No Recursion / No Hooks</pre>
<p>
This signal is emitted each time a region selection succeed. The corresponding nodes
are stored in <em class="parameter"><code>nodes</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>obj</code></em> :</span></p></td>
<td>the object emitting the signal.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>nodes</code></em> :</span></p></td>
<td>an array of node ids.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2" title='The "selection-error" signal'>
<a name="VisuInteractive-selection-error"></a><h3>The <code class="literal">"selection-error"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="v-sim-interactive.html#VisuInteractive"><span class="type">VisuInteractive</span></a> *obj,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> err,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : Run Last / No Recursion / No Hooks</pre>
<p>
This signal is emitted each time a selection fails, providing the
error in <em class="parameter"><code>err</code></em> (see <a class="link" href="v-sim-interactive.html#VisuInteractivePickError" title="enum VisuInteractivePickError"><span class="type">VisuInteractivePickError</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>obj</code></em> :</span></p></td>
<td>the object emitting the signal.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td>
<td>an error value.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2" title='The "start-move" signal'>
<a name="VisuInteractive-start-move"></a><h3>The <code class="literal">"start-move"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="v-sim-interactive.html#VisuInteractive"><span class="type">VisuInteractive</span></a> *obj,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> nodes,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : Run Last / No Recursion / No Hooks</pre>
<p>
This signal is emitted each time a set of nodes are clicked to be
moved. The corresponding nodes are stored in <em class="parameter"><code>nodes</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>obj</code></em> :</span></p></td>
<td>the object emitting the signal.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>nodes</code></em> :</span></p></td>
<td>an array of node ids.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2" title='The "stop" signal'>
<a name="VisuInteractive-stop"></a><h3>The <code class="literal">"stop"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="v-sim-interactive.html#VisuInteractive"><span class="type">VisuInteractive</span></a> *obj,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : Run Last / No Recursion / No Hooks</pre>
<p>
This signal is emitted each time a set of nodes are stopped to be
moved.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>the object emitting the signal.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.6</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.14</div>
</body>
</html>
|
