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
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>plane</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-extraNode.html" title="extraNode">
<link rel="next" href="v-sim-scalarFields.html" title="scalarFields">
<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-extraNode.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-scalarFields.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-plane.synopsis" class="shortcut">Top</a>
|
<a href="#v-sim-plane.description" class="shortcut">Description</a>
|
<a href="#v-sim-plane.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#v-sim-plane.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry" title="plane">
<a name="v-sim-plane"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="v-sim-plane.top_of_page"></a>plane</span></h2>
<p>plane — Adds capabilities to draw and handle planes.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="v-sim-plane.synopsis"></a><h2>Synopsis</h2>
<a name="Plane"></a><pre class="synopsis">#define <a class="link" href="v-sim-plane.html#PLANE-TYPE:CAPS" title="PLANE_TYPE">PLANE_TYPE</a>
#define <a class="link" href="v-sim-plane.html#PLANE:CAPS" title="PLANE()">PLANE</a> (obj)
#define <a class="link" href="v-sim-plane.html#PLANE-CLASS:CAPS" title="PLANE_CLASS()">PLANE_CLASS</a> (klass)
#define <a class="link" href="v-sim-plane.html#IS-PLANE-TYPE:CAPS" title="IS_PLANE_TYPE()">IS_PLANE_TYPE</a> (obj)
#define <a class="link" href="v-sim-plane.html#IS-PLANE-CLASS:CAPS" title="IS_PLANE_CLASS()">IS_PLANE_CLASS</a> (klass)
#define <a class="link" href="v-sim-plane.html#PLANE-GET-CLASS:CAPS" title="PLANE_GET_CLASS()">PLANE_GET_CLASS</a> (obj)
typedef <a class="link" href="v-sim-plane.html#PlaneClass" title="PlaneClass">PlaneClass</a>;
<a class="link" href="v-sim-plane.html#Plane-struct" title="Plane">Plane</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-plane.html#plane-get-type" title="plane_get_type ()">plane_get_type</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
enum <a class="link" href="v-sim-plane.html#Plane-hidingMode" title="enum Plane_hidingMode">Plane_hidingMode</a>;
#define <a class="link" href="v-sim-plane.html#PLANE-SIDE-PLUS:CAPS" title="PLANE_SIDE_PLUS">PLANE_SIDE_PLUS</a>
#define <a class="link" href="v-sim-plane.html#PLANE-SIDE-MINUS:CAPS" title="PLANE_SIDE_MINUS">PLANE_SIDE_MINUS</a>
#define <a class="link" href="v-sim-plane.html#PLANE-SIDE-NONE:CAPS" title="PLANE_SIDE_NONE">PLANE_SIDE_NONE</a>
<a class="link" href="v-sim-plane.html#Plane"><span class="returnvalue">Plane</span></a>* <a class="link" href="v-sim-plane.html#planeNew" title="planeNew ()">planeNew</a> (<em class="parameter"><code><span class="type">float</span> vertices[8][3]</code></em>,
<em class="parameter"><code><span class="type">float</span> vect[3]</code></em>,
<em class="parameter"><code><span class="type">float</span> dist</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-toolColor.html#ToolColor" title="ToolColor"><span class="type">ToolColor</span></a> *color</code></em>);
<a class="link" href="v-sim-plane.html#Plane"><span class="returnvalue">Plane</span></a>* <a class="link" href="v-sim-plane.html#planeNew-undefined" title="planeNew_undefined ()">planeNew_undefined</a> (<em class="parameter"><code><span class="type">void</span></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-plane.html#planeSet-normalVector" title="planeSet_normalVector ()">planeSet_normalVector</a> (<em class="parameter"><code><a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> *plane</code></em>,
<em class="parameter"><code><span class="type">float</span> vect[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-plane.html#planeSet-distanceFromOrigin" title="planeSet_distanceFromOrigin ()">planeSet_distanceFromOrigin</a> (<em class="parameter"><code><a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> *plane</code></em>,
<em class="parameter"><code><span class="type">float</span> dist</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-plane.html#planeSet-color" title="planeSet_color ()">planeSet_color</a> (<em class="parameter"><code><a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> *plane</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-toolColor.html#ToolColor" title="ToolColor"><span class="type">ToolColor</span></a> *color</code></em>);
<span class="returnvalue">void</span> <a class="link" href="v-sim-plane.html#planeSet-box" title="planeSet_box ()">planeSet_box</a> (<em class="parameter"><code><a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> *plane</code></em>,
<em class="parameter"><code><span class="type">float</span> vertices[8][3]</code></em>);
<span class="returnvalue">int</span> <a class="link" href="v-sim-plane.html#planeShowHide" title="planeShowHide ()">planeShowHide</a> (<em class="parameter"><code><a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> *plane</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *visuData</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> hide</code></em>,
<em class="parameter"><code><span class="type">float</span> side</code></em>);
<span class="returnvalue">void</span> <a class="link" href="v-sim-plane.html#planeDraw" title="planeDraw ()">planeDraw</a> (<em class="parameter"><code><a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> *plane</code></em>);
<span class="returnvalue">void</span> <a class="link" href="v-sim-plane.html#planeGet-basis" title="planeGet_basis ()">planeGet_basis</a> (<em class="parameter"><code><a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> *plane</code></em>,
<em class="parameter"><code><span class="type">float</span> xyz[2][3]</code></em>,
<em class="parameter"><code><span class="type">float</span> center[3]</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a>* <a class="link" href="v-sim-plane.html#planeGet-intersection" title="planeGet_intersection ()">planeGet_intersection</a> (<em class="parameter"><code><a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> *plane</code></em>);
<span class="returnvalue">float</span>* <a class="link" href="v-sim-plane.html#planeGet-reducedIntersection" title="planeGet_reducedIntersection ()">planeGet_reducedIntersection</a> (<em class="parameter"><code><a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> *plane</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> *nVals</code></em>);
<span class="returnvalue">void</span> <a class="link" href="v-sim-plane.html#planeGet-nVectUser" title="planeGet_nVectUser ()">planeGet_nVectUser</a> (<em class="parameter"><code><a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> *plane</code></em>,
<em class="parameter"><code><span class="type">float</span> *vect</code></em>);
<span class="returnvalue">void</span> <a class="link" href="v-sim-plane.html#planeGet-nVect" title="planeGet_nVect ()">planeGet_nVect</a> (<em class="parameter"><code><a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> *plane</code></em>,
<em class="parameter"><code><span class="type">float</span> *vect</code></em>);
<span class="returnvalue">void</span> <a class="link" href="v-sim-plane.html#planeGet-distanceFromOrigin" title="planeGet_distanceFromOrigin ()">planeGet_distanceFromOrigin</a> (<em class="parameter"><code><a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> *plane</code></em>,
<em class="parameter"><code><span class="type">float</span> *dist</code></em>);
<span class="returnvalue">void</span> <a class="link" href="v-sim-plane.html#planeGet-color" title="planeGet_color ()">planeGet_color</a> (<em class="parameter"><code><a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> *plane</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-toolColor.html#ToolColor" title="ToolColor"><span class="type">ToolColor</span></a> **color</code></em>);
<span class="returnvalue">int</span> <a class="link" href="v-sim-plane.html#planeSet-hiddenState" title="planeSet_hiddenState ()">planeSet_hiddenState</a> (<em class="parameter"><code><a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> *plane</code></em>,
<em class="parameter"><code><span class="type">int</span> side</code></em>);
<span class="returnvalue">int</span> <a class="link" href="v-sim-plane.html#planeGet-hiddenState" title="planeGet_hiddenState ()">planeGet_hiddenState</a> (<em class="parameter"><code><a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> *plane</code></em>);
<span class="returnvalue">int</span> <a class="link" href="v-sim-plane.html#planeSet-rendered" title="planeSet_rendered ()">planeSet_rendered</a> (<em class="parameter"><code><a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> *plane</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> rendered</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-plane.html#planeGet-rendered" title="planeGet_rendered ()">planeGet_rendered</a> (<em class="parameter"><code><a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> *plane</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-plane.html#planeGet-cross" title="planeGet_cross ()">planeGet_cross</a> (<em class="parameter"><code><a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> *plane</code></em>,
<em class="parameter"><code><span class="type">float</span> pointA[3]</code></em>,
<em class="parameter"><code><span class="type">float</span> pointB[3]</code></em>,
<em class="parameter"><code><span class="type">float</span> *lambda</code></em>);
<span class="returnvalue">void</span> <a class="link" href="v-sim-plane.html#planesDraw-list" title="planesDraw_list ()">planesDraw_list</a> (<em class="parameter"><code><a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> **list</code></em>,
<em class="parameter"><code><span class="type">int</span> openGLId</code></em>);
<span class="returnvalue">int</span> <a class="link" href="v-sim-plane.html#planeShowHide-all" title="planeShowHide_all ()">planeShowHide_all</a> (<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *visuData</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> **listOfPlanes</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-plane.html#planesGet-visibility" title="planesGet_visibility ()">planesGet_visibility</a> (<em class="parameter"><code><a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> **listOfPlanes</code></em>,
<em class="parameter"><code><span class="type">float</span> point[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-plane.html#planesGet-intersection" title="planesGet_intersection ()">planesGet_intersection</a> (<em class="parameter"><code><a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> **listOfPlanes</code></em>,
<em class="parameter"><code><span class="type">float</span> pointA[3]</code></em>,
<em class="parameter"><code><span class="type">float</span> pointB[3]</code></em>,
<em class="parameter"><code><span class="type">float</span> inter[3]</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> inside</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-plane.html#planesGet-orderedIntersections" title="planesGet_orderedIntersections ()">planesGet_orderedIntersections</a> (<em class="parameter"><code><span class="type">int</span> nPlanes</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> **listOfPlanes</code></em>,
<em class="parameter"><code><span class="type">float</span> pointA[3]</code></em>,
<em class="parameter"><code><span class="type">float</span> pointB[3]</code></em>,
<em class="parameter"><code><span class="type">float</span> *inter</code></em>,
<em class="parameter"><code><span class="type">int</span> *index</code></em>);
<span class="returnvalue">int</span> <a class="link" href="v-sim-plane.html#planeSet-hidingMode" title="planeSet_hidingMode ()">planeSet_hidingMode</a> (<em class="parameter"><code><a class="link" href="v-sim-plane.html#Plane-hidingMode" title="enum Plane_hidingMode"><span class="type">Plane_hidingMode</span></a> mode</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-plane.html#planesParse-XMLFile" title="planesParse_XMLFile ()">planesParse_XMLFile</a> (<em class="parameter"><code><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-plane.html#Plane"><span class="type">Plane</span></a> ***list</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-plane.html#planesExport-XMLFile" title="planesExport_XMLFile ()">planesExport_XMLFile</a> (<em class="parameter"><code><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-plane.html#Plane"><span class="type">Plane</span></a> **list</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>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="v-sim-plane.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>
+----Plane
</pre>
</div>
<div class="refsect1" title="Signals">
<a name="v-sim-plane.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="v-sim-plane.html#Plane-moved" title='The "moved" signal'>moved</a>" : Run Last / No Recursion / No Hooks
</pre>
</div>
<div class="refsect1" title="Description">
<a name="v-sim-plane.description"></a><h2>Description</h2>
<p>
</p>
<p>A <a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> is a GObject. It is defined by its normal vector and
the distance of the plane with the origin (see
<a class="link" href="v-sim-plane.html#planeSet-normalVector" title="planeSet_normalVector ()"><code class="function">planeSet_normalVector()</code></a> and <a class="link" href="v-sim-plane.html#planeSet-distanceFromOrigin" title="planeSet_distanceFromOrigin ()"><code class="function">planeSet_distanceFromOrigin()</code></a>). When
these informations are given and an <a class="link" href="v-sim-view.html#VisuOpenGLView" title="VisuOpenGLView"><span class="type">VisuOpenGLView</span></a> is used to render
the plane, V_Sim computes the intersections of the plane with the
bounding box (see <a class="link" href="v-sim-plane.html#planeGet-intersection" title="planeGet_intersection ()"><code class="function">planeGet_intersection()</code></a>).</p>
<p>
</p>
<p>Planes can be used to hide nodes defining their
<a class="link" href="v-sim-plane.html#planeSet-hiddenState" title="planeSet_hiddenState ()"><code class="function">planeSet_hiddenState()</code></a> and <a class="link" href="v-sim-plane.html#planeSet-hidingMode" title="planeSet_hidingMode ()"><code class="function">planeSet_hidingMode()</code></a>. A list of planes
can also be exported or imported from an XML file using
<a class="link" href="v-sim-plane.html#planesExport-XMLFile" title="planesExport_XMLFile ()"><code class="function">planesExport_XMLFile()</code></a> and <a class="link" href="v-sim-plane.html#planesParse-XMLFile" title="planesParse_XMLFile ()"><code class="function">planesParse_XMLFile()</code></a>.</p>
<p>
</p>
<p>Planes can have transparency but the support of it is limited
to one plane. If several planes are drawn with transparency, they
may hide each other because of the implementation of transparency
in OpenGL (planes are treated as single polygons).</p>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="v-sim-plane.details"></a><h2>Details</h2>
<div class="refsect2" title="PLANE_TYPE">
<a name="PLANE-TYPE:CAPS"></a><h3>PLANE_TYPE</h3>
<pre class="programlisting">#define PLANE_TYPE (plane_get_type ())
</pre>
<p>
return the type of <a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a>.
</p>
</div>
<hr>
<div class="refsect2" title="PLANE()">
<a name="PLANE:CAPS"></a><h3>PLANE()</h3>
<pre class="programlisting">#define PLANE(obj) (G_TYPE_CHECK_INSTANCE_CAST(obj, PLANE_TYPE, Plane))
</pre>
<p>
Cast the given <em class="parameter"><code>obj</code></em> into <a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</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="PLANE_CLASS()">
<a name="PLANE-CLASS:CAPS"></a><h3>PLANE_CLASS()</h3>
<pre class="programlisting">#define PLANE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST(klass, PLANE_TYPE, PlaneClass))
</pre>
<p>
Cast the given <em class="parameter"><code>klass</code></em> into <a class="link" href="v-sim-plane.html#PlaneClass" title="PlaneClass"><span class="type">PlaneClass</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_PLANE_TYPE()">
<a name="IS-PLANE-TYPE:CAPS"></a><h3>IS_PLANE_TYPE()</h3>
<pre class="programlisting">#define IS_PLANE_TYPE(obj) (G_TYPE_CHECK_INSTANCE_TYPE(obj, PLANE_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-plane.html#Plane"><span class="type">Plane</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_PLANE_CLASS()">
<a name="IS-PLANE-CLASS:CAPS"></a><h3>IS_PLANE_CLASS()</h3>
<pre class="programlisting">#define IS_PLANE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE(klass, PLANE_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-plane.html#PlaneClass" title="PlaneClass"><span class="type">PlaneClass</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="PLANE_GET_CLASS()">
<a name="PLANE-GET-CLASS:CAPS"></a><h3>PLANE_GET_CLASS()</h3>
<pre class="programlisting">#define PLANE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS(obj, PLANE_TYPE, PlaneClass))
</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="PlaneClass">
<a name="PlaneClass"></a><h3>PlaneClass</h3>
<pre class="programlisting">typedef struct PlaneClass_struct PlaneClass;
</pre>
<p>
An opaque structure.
</p>
</div>
<hr>
<div class="refsect2" title="Plane">
<a name="Plane-struct"></a><h3>Plane</h3>
<pre class="programlisting">typedef struct _Plane Plane;</pre>
<p>
All fields are private, use the access routines.
</p>
</div>
<hr>
<div class="refsect2" title="plane_get_type ()">
<a name="plane-get-type"></a><h3>plane_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> plane_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-plane.html#Plane"><span class="type">Plane</span></a>, use PLANE_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-plane.html#Plane"><span class="type">Plane</span></a>.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="enum Plane_hidingMode">
<a name="Plane-hidingMode"></a><h3>enum Plane_hidingMode</h3>
<pre class="programlisting">typedef enum
{
plane_hideUnion,
plane_hideInter,
plane_nbHidingMode
} Plane_hidingMode;
</pre>
<p>
Enum used to address different hiding modes. See <a class="link" href="v-sim-plane.html#planeSet-hidingMode" title="planeSet_hidingMode ()"><code class="function">planeSet_hidingMode()</code></a> for
further details.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="plane-hideUnion"></a><span class="term"><code class="literal">plane_hideUnion</code></span></p></td>
<td>element are masked if one plane at least mask it ;
</td>
</tr>
<tr>
<td><p><a name="plane-hideInter"></a><span class="term"><code class="literal">plane_hideInter</code></span></p></td>
<td>element are masked if all planes mask it ;
</td>
</tr>
<tr>
<td><p><a name="plane-nbHidingMode"></a><span class="term"><code class="literal">plane_nbHidingMode</code></span></p></td>
<td>number of masking possibilities.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="PLANE_SIDE_PLUS">
<a name="PLANE-SIDE-PLUS:CAPS"></a><h3>PLANE_SIDE_PLUS</h3>
<pre class="programlisting">#define PLANE_SIDE_PLUS +1
</pre>
<p>
This is a key that defines which side is hidden by the plane. For
this value, the side is the one pointed by the normal vector.
</p>
</div>
<hr>
<div class="refsect2" title="PLANE_SIDE_MINUS">
<a name="PLANE-SIDE-MINUS:CAPS"></a><h3>PLANE_SIDE_MINUS</h3>
<pre class="programlisting">#define PLANE_SIDE_MINUS -1
</pre>
<p>
This is a key that defines which side is hidden by the plane. For
this value, the side is the one at the opposite of the one pointed
by the normal vector.
</p>
</div>
<hr>
<div class="refsect2" title="PLANE_SIDE_NONE">
<a name="PLANE-SIDE-NONE:CAPS"></a><h3>PLANE_SIDE_NONE</h3>
<pre class="programlisting">#define PLANE_SIDE_NONE 0
</pre>
<p>
This is a key that defines which side is hidden by the plane. For
this value, no node is hidden.
</p>
</div>
<hr>
<div class="refsect2" title="planeNew ()">
<a name="planeNew"></a><h3>planeNew ()</h3>
<pre class="programlisting"><a class="link" href="v-sim-plane.html#Plane"><span class="returnvalue">Plane</span></a>* planeNew (<em class="parameter"><code><span class="type">float</span> vertices[8][3]</code></em>,
<em class="parameter"><code><span class="type">float</span> vect[3]</code></em>,
<em class="parameter"><code><span class="type">float</span> dist</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-toolColor.html#ToolColor" title="ToolColor"><span class="type">ToolColor</span></a> *color</code></em>);</pre>
<p>
Create a plane with the specified attributes.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>vertices</code></em> :</span></p></td>
<td>the coordinates that describes the rendering box ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>vect</code></em> :</span></p></td>
<td>three values defining the normal vector (unitary or not) ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dist</code></em> :</span></p></td>
<td>the distance between origin and intersection of the plane and the
line made by origin and normal vector ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-toolColor.html#ToolColor" title="ToolColor"><span class="type">ToolColor</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a newly allocated <a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> structure.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="planeNew_undefined ()">
<a name="planeNew-undefined"></a><h3>planeNew_undefined ()</h3>
<pre class="programlisting"><a class="link" href="v-sim-plane.html#Plane"><span class="returnvalue">Plane</span></a>* planeNew_undefined (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Create a new plane with default values. This plane can't be
rendered directly and one needs to computes its intersection with
the bounding box before using <a href="v-sim-plane.html#planeComputeInter"><code class="function">planeComputeInter()</code></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> a newly allocated <a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> structure.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="planeSet_normalVector ()">
<a name="planeSet-normalVector"></a><h3>planeSet_normalVector ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> planeSet_normalVector (<em class="parameter"><code><a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> *plane</code></em>,
<em class="parameter"><code><span class="type">float</span> vect[3]</code></em>);</pre>
<p>
Change the normal vector defining the orientation of the plane.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>plane</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> object ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>vect</code></em> :</span></p></td>
<td>three values defining the normal vector (unitary or not).
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> 1 if the intersections should be recalculated by
a call to <a href="v-sim-plane.html#planeComputeInter"><code class="function">planeComputeInter()</code></a>, 0 if not. Or -1 if there is
an error.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="planeSet_distanceFromOrigin ()">
<a name="planeSet-distanceFromOrigin"></a><h3>planeSet_distanceFromOrigin ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> planeSet_distanceFromOrigin (<em class="parameter"><code><a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> *plane</code></em>,
<em class="parameter"><code><span class="type">float</span> dist</code></em>);</pre>
<p>
Change the position of the plane.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>plane</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> object ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dist</code></em> :</span></p></td>
<td>the distance between origin and intersection of the plane and the
line made by origin and normal vector.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> 1 if the intersections should be recalculated by
a call to <a href="v-sim-plane.html#planeComputeInter"><code class="function">planeComputeInter()</code></a>, 0 if not. Or -1 if there is
an error.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="planeSet_color ()">
<a name="planeSet-color"></a><h3>planeSet_color ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> planeSet_color (<em class="parameter"><code><a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> *plane</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-toolColor.html#ToolColor" title="ToolColor"><span class="type">ToolColor</span></a> *color</code></em>);</pre>
<p>
Change the color of the plane.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>plane</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> object ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-toolColor.html#ToolColor" title="ToolColor"><span class="type">ToolColor</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> 0 if everything went right.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="planeSet_box ()">
<a name="planeSet-box"></a><h3>planeSet_box ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> planeSet_box (<em class="parameter"><code><a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> *plane</code></em>,
<em class="parameter"><code><span class="type">float</span> vertices[8][3]</code></em>);</pre>
<p>
This method is used to fit <em class="parameter"><code>plane</code></em> in a box for rendering
purpose. It also computes the intersections between the bounding
box and the plane.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>plane</code></em> :</span></p></td>
<td>a Plane ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>vertices</code></em> :</span></p></td>
<td>the vertices that describe the rendering box.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2" title="planeShowHide ()">
<a name="planeShowHide"></a><h3>planeShowHide ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span> planeShowHide (<em class="parameter"><code><a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> *plane</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *visuData</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> hide</code></em>,
<em class="parameter"><code><span class="type">float</span> side</code></em>);</pre>
<p>
A call to this method change the visibility flag of all nodes of the given <a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a>.
Notice that this method makes a call to visu_data_createAllNodes if necessary.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>plane</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>visuData</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> which show or hide nodes to;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>hide</code></em> :</span></p></td>
<td>a boolean, TRUE to hide elements, FALSE to return them to visibility ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>side</code></em> :</span></p></td>
<td>give a positive number to hide elements in the same side that the normal vector,
a negative number will hide the other nodes.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> 1 if the calling method should ask for redraw, 0 otherwise.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="planeDraw ()">
<a name="planeDraw"></a><h3>planeDraw ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> planeDraw (<em class="parameter"><code><a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> *plane</code></em>);</pre>
<p>
Call OpenGL primitives to draw the plane.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>plane</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a>.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="planeGet_basis ()">
<a name="planeGet-basis"></a><h3>planeGet_basis ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> planeGet_basis (<em class="parameter"><code><a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> *plane</code></em>,
<em class="parameter"><code><span class="type">float</span> xyz[2][3]</code></em>,
<em class="parameter"><code><span class="type">float</span> center[3]</code></em>);</pre>
<p>
Stores the coordinates of barycentre of the plane in <em class="parameter"><code>center</code></em> and
provide coordinates of two orthogonal vector in the plane. The <a href="v-sim-plane.html#planeComputeInter"><code class="function">planeComputeInter()</code></a>
should have been called before.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>plane</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>xyz</code></em> :</span></p></td>
<td>two vectors.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>center</code></em> :</span></p></td>
<td>a point in cartesian coordinates.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="planeGet_intersection ()">
<a name="planeGet-intersection"></a><h3>planeGet_intersection ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a>* planeGet_intersection (<em class="parameter"><code><a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> *plane</code></em>);</pre>
<p>
The list of intersection between the plane and the box is made of
float[3]. The <a href="v-sim-plane.html#planeComputeInter"><code class="function">planeComputeInter()</code></a> should have been called before.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>plane</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a list of float[3] elements. This list is owned by V_Sim.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="planeGet_reducedIntersection ()">
<a name="planeGet-reducedIntersection"></a><h3>planeGet_reducedIntersection ()</h3>
<pre class="programlisting"><span class="returnvalue">float</span>* planeGet_reducedIntersection (<em class="parameter"><code><a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> *plane</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> *nVals</code></em>);</pre>
<p>
This routine returns the coordinates in the <em class="parameter"><code>plane</code></em> basis set of its
intersections with a box (see <a class="link" href="v-sim-plane.html#planeSet-box" title="planeSet_box ()"><code class="function">planeSet_box()</code></a>). The coordinates are
appended in the return array which length is stored in <em class="parameter"><code>nVals</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>plane</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> object.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>nVals</code></em> :</span></p></td>
<td>a location for an integer.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a newly allocated array of <em class="parameter"><code>nVals</code></em> * 2 values. Free it with
<a href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2" title="planeGet_nVectUser ()">
<a name="planeGet-nVectUser"></a><h3>planeGet_nVectUser ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> planeGet_nVectUser (<em class="parameter"><code><a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> *plane</code></em>,
<em class="parameter"><code><span class="type">float</span> *vect</code></em>);</pre>
<p>
Stores the coordinates of the normal vector in <em class="parameter"><code>vec</code></em> of the plane. It returns the values
given by the user, not the normalized vaues.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>plane</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>vect</code></em> :</span></p></td>
<td>an already alloacted (size 3) float array.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="planeGet_nVect ()">
<a name="planeGet-nVect"></a><h3>planeGet_nVect ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> planeGet_nVect (<em class="parameter"><code><a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> *plane</code></em>,
<em class="parameter"><code><span class="type">float</span> *vect</code></em>);</pre>
<p>
Stores the coordinates of the normal vector in <em class="parameter"><code>vect</code></em> of the plane.
It returns the normalized values.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>plane</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>vect</code></em> :</span></p></td>
<td>an already alloacted (size 3) float array.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="planeGet_distanceFromOrigin ()">
<a name="planeGet-distanceFromOrigin"></a><h3>planeGet_distanceFromOrigin ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> planeGet_distanceFromOrigin (<em class="parameter"><code><a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> *plane</code></em>,
<em class="parameter"><code><span class="type">float</span> *dist</code></em>);</pre>
<p>
Stores the distance of the plane to the origin.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>plane</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dist</code></em> :</span></p></td>
<td>a float location to store the value.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="planeGet_color ()">
<a name="planeGet-color"></a><h3>planeGet_color ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> planeGet_color (<em class="parameter"><code><a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> *plane</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-toolColor.html#ToolColor" title="ToolColor"><span class="type">ToolColor</span></a> **color</code></em>);</pre>
<p>
Stores the color of the plane.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>plane</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-toolColor.html#ToolColor" title="ToolColor"><span class="type">ToolColor</span></a> pointer location to store the value.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="planeSet_hiddenState ()">
<a name="planeSet-hiddenState"></a><h3>planeSet_hiddenState ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span> planeSet_hiddenState (<em class="parameter"><code><a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> *plane</code></em>,
<em class="parameter"><code><span class="type">int</span> side</code></em>);</pre>
<p>
The plane can hide the nodes on one of its side.
The <em class="parameter"><code>side</code></em> argument can be PLANE_SIDE_PLUS or PLANE_SIDE_MINUS or
PLANE_SIDE_NONE. It codes the side of the plane which hides the nodes.
If PLANE_SIDE_NONE is selected all nodes are rendered.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>plane</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>side</code></em> :</span></p></td>
<td>a key, <a class="link" href="v-sim-plane.html#PLANE-SIDE-NONE:CAPS" title="PLANE_SIDE_NONE"><span class="type">PLANE_SIDE_NONE</span></a>, <a class="link" href="v-sim-plane.html#PLANE-SIDE-PLUS:CAPS" title="PLANE_SIDE_PLUS"><span class="type">PLANE_SIDE_PLUS</span></a> or <a class="link" href="v-sim-plane.html#PLANE-SIDE-MINUS:CAPS" title="PLANE_SIDE_MINUS"><span class="type">PLANE_SIDE_MINUS</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> 1 if <a class="link" href="v-sim-plane.html#planeShowHide-all" title="planeShowHide_all ()"><code class="function">planeShowHide_all()</code></a> should be called.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="planeGet_hiddenState ()">
<a name="planeGet-hiddenState"></a><h3>planeGet_hiddenState ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span> planeGet_hiddenState (<em class="parameter"><code><a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> *plane</code></em>);</pre>
<p>
The plane can hide the nodes on one of its side. this
method get the status for the given <em class="parameter"><code>plane</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>plane</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the state, defined by PLANE_SIDE_PLUS or PLANE_SIDE_MINUS or
PLANE_SIDE_NONE.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="planeSet_rendered ()">
<a name="planeSet-rendered"></a><h3>planeSet_rendered ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span> planeSet_rendered (<em class="parameter"><code><a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> *plane</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> rendered</code></em>);</pre>
<p>
Change the visibility of the plane.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>plane</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>rendered</code></em> :</span></p></td>
<td>TRUE to make the plane drawable.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> 1 if <a class="link" href="v-sim-plane.html#planeShowHide-all" title="planeShowHide_all ()"><code class="function">planeShowHide_all()</code></a> should be called.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="planeGet_rendered ()">
<a name="planeGet-rendered"></a><h3>planeGet_rendered ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> planeGet_rendered (<em class="parameter"><code><a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> *plane</code></em>);</pre>
<p>
Get the visibility of a plane.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>plane</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if the plane is visible.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="planeGet_cross ()">
<a name="planeGet-cross"></a><h3>planeGet_cross ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> planeGet_cross (<em class="parameter"><code><a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> *plane</code></em>,
<em class="parameter"><code><span class="type">float</span> pointA[3]</code></em>,
<em class="parameter"><code><span class="type">float</span> pointB[3]</code></em>,
<em class="parameter"><code><span class="type">float</span> *lambda</code></em>);</pre>
<p>
Given the line [AB], it looks for an intersection with <em class="parameter"><code>plane</code></em>. If
lambda is provided, it gives the position of the intersection
(lambda = 0 means A, lambda = 1 means B).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>plane</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> object.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>pointA</code></em> :</span></p></td>
<td>a point.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>pointB</code></em> :</span></p></td>
<td>another point.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>lambda</code></em> :</span></p></td>
<td>a location to store a float (can be NULL).
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if any crossing point is found.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2" title="planesDraw_list ()">
<a name="planesDraw-list"></a><h3>planesDraw_list ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> planesDraw_list (<em class="parameter"><code><a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> **list</code></em>,
<em class="parameter"><code><span class="type">int</span> openGLId</code></em>);</pre>
<p>
Call OpenGL primitives to draw each plane of the given list. It's
a convenient wrapper around <a class="link" href="v-sim-plane.html#planeDraw" title="planeDraw ()"><code class="function">planeDraw()</code></a> for a list.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
<td>an array of <a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> (NULL terminated).
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>openGLId</code></em> :</span></p></td>
<td>the OpenGL list to draw to.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="planeShowHide_all ()">
<a name="planeShowHide-all"></a><h3>planeShowHide_all ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span> planeShowHide_all (<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *visuData</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> **listOfPlanes</code></em>);</pre>
<p>
This method test for each node if it is hidden or not by the
combination of all the given planes.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>visuData</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> which show or hide nodes to;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>listOfPlanes</code></em> :</span></p></td>
<td>an array of <a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a>, NULL terminated.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> 1 if <a class="link" href="v-sim-visu-data.html#visu-data-createAllNodes" title="visu_data_createAllNodes ()"><code class="function">visu_data_createAllNodes()</code></a> should be called.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="planesGet_visibility ()">
<a name="planesGet-visibility"></a><h3>planesGet_visibility ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> planesGet_visibility (<em class="parameter"><code><a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> **listOfPlanes</code></em>,
<em class="parameter"><code><span class="type">float</span> point[3]</code></em>);</pre>
<p>
Compute the visibility of the given <em class="parameter"><code>point</code></em>, following the masking scheme
of the given plane list.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>listOfPlanes</code></em> :</span></p></td>
<td>an array of <a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a>, NULL terminated ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>point</code></em> :</span></p></td>
<td>three cartesian coordinates.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if the point is not masked.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="planesGet_intersection ()">
<a name="planesGet-intersection"></a><h3>planesGet_intersection ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> planesGet_intersection (<em class="parameter"><code><a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> **listOfPlanes</code></em>,
<em class="parameter"><code><span class="type">float</span> pointA[3]</code></em>,
<em class="parameter"><code><span class="type">float</span> pointB[3]</code></em>,
<em class="parameter"><code><span class="type">float</span> inter[3]</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> inside</code></em>);</pre>
<p>
Compute the location of the intersection point of segment AB with list of
planes <em class="parameter"><code>listOfPlanes</code></em>. If there are several intersections, the closest to
point A is returned. If <em class="parameter"><code>inside</code></em> is TRUE, then the intersection
point must be within the line [AB].
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>listOfPlanes</code></em> :</span></p></td>
<td>an array of <a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a>, NULL terminated ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>pointA</code></em> :</span></p></td>
<td>three cartesian coordinates.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>pointB</code></em> :</span></p></td>
<td>three cartesian coordinates.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>inter</code></em> :</span></p></td>
<td>a location to store the intersection point.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>inside</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 there is an intersection.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="planesGet_orderedIntersections ()">
<a name="planesGet-orderedIntersections"></a><h3>planesGet_orderedIntersections ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> planesGet_orderedIntersections (<em class="parameter"><code><span class="type">int</span> nPlanes</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> **listOfPlanes</code></em>,
<em class="parameter"><code><span class="type">float</span> pointA[3]</code></em>,
<em class="parameter"><code><span class="type">float</span> pointB[3]</code></em>,
<em class="parameter"><code><span class="type">float</span> *inter</code></em>,
<em class="parameter"><code><span class="type">int</span> *index</code></em>);</pre>
<p>
Compute the location of the intersection points of segment AB with list of
planes <em class="parameter"><code>listOfPlanes</code></em>. If there are several intersections, they are ordered
by the proximity to point A.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>nPlanes</code></em> :</span></p></td>
<td>the number of planes (must be consistent with the number of
planes in listOfPlanes!)
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>listOfPlanes</code></em> :</span></p></td>
<td>an array of <a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a>, NULL terminated ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>pointA</code></em> :</span></p></td>
<td>three cartesian coordinates.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>pointB</code></em> :</span></p></td>
<td>three cartesian coordinates.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>inter</code></em> :</span></p></td>
<td>a pointer to the location to store the intersection points.
Supposing you know the number of intersection points !
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>index</code></em> :</span></p></td>
<td>a pointer to the location to store the indices of ordering
of the planes.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if the intersections are found.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="planeSet_hidingMode ()">
<a name="planeSet-hidingMode"></a><h3>planeSet_hidingMode ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span> planeSet_hidingMode (<em class="parameter"><code><a class="link" href="v-sim-plane.html#Plane-hidingMode" title="enum Plane_hidingMode"><span class="type">Plane_hidingMode</span></a> mode</code></em>);</pre>
<p>
This method is used to set the hiding mode flag. In union mode, elements
are not drwn if they are hidden by one plane at least. In intersection mode,
elements are only hidden if masked by all planes. This flag has no
relevence if <a class="link" href="v-sim-plane.html#planeShowHide" title="planeShowHide ()"><code class="function">planeShowHide()</code></a> is used, but only if <a class="link" href="v-sim-plane.html#planeShowHide-all" title="planeShowHide_all ()"><code class="function">planeShowHide_all()</code></a> is
called.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>mode</code></em> :</span></p></td>
<td>a value related to the hiding mode (look at the enum <a class="link" href="v-sim-plane.html#Plane-hidingMode" title="enum Plane_hidingMode"><span class="type">Plane_hidingMode</span></a>).
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> 1 if <a class="link" href="v-sim-plane.html#planeShowHide-all" title="planeShowHide_all ()"><code class="function">planeShowHide_all()</code></a> should be called.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="planesParse_XMLFile ()">
<a name="planesParse-XMLFile"></a><h3>planesParse_XMLFile ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> planesParse_XMLFile (<em class="parameter"><code><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-plane.html#Plane"><span class="type">Plane</span></a> ***list</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 the given file (syntax in XML) and create a list of planes. This list is an
allocated array that should be deallocated with <a href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>. This array has always
one argument, since it is NULL terminated.
</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>the file to parse ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
<td>a pointer to store the parsed list (will be allocated and NULL terminated) ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>a pointer to store the error (can be NULL).
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if everything goes right, if not and <em class="parameter"><code>error</code></em> (if not NULL)
is set and contains the message of the error.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="planesExport_XMLFile ()">
<a name="planesExport-XMLFile"></a><h3>planesExport_XMLFile ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> planesExport_XMLFile (<em class="parameter"><code><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-plane.html#Plane"><span class="type">Plane</span></a> **list</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>
Export in XML format the given list of planes to the given file.
</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>the file to export to ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
<td>an array (NULL terminated) to export ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>a pointer to store the error (can be NULL).
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if everything goes right, if not and <em class="parameter"><code>error</code></em> (if not NULL)
is set and contains the message of the error.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" title="Signal Details">
<a name="v-sim-plane.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2" title='The "moved" signal'>
<a name="Plane-moved"></a><h3>The <code class="literal">"moved"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> *plane,
<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 the plane position is changed
(either distance or normal).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>plane</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.3</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.14</div>
</body>
</html>
|
