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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>renderingSpin</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="ch02.html" title="Rendering methods">
<link rel="prev" href="v-sim-atomic-xyz.html" title="atomic_xyz">
<link rel="next" href="ch03.html" title="OpenGL tools">
<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-atomic-xyz.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch02.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="ch03.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-renderingSpin.synopsis" class="shortcut">Top</a>
|
<a href="#v-sim-renderingSpin.description" class="shortcut">Description</a>
|
<a href="#v-sim-renderingSpin.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#v-sim-renderingSpin.properties" class="shortcut">Properties</a>
|
<a href="#v-sim-renderingSpin.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry" title="renderingSpin">
<a name="v-sim-renderingSpin"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="v-sim-renderingSpin.top_of_page"></a>renderingSpin</span></h2>
<p>renderingSpin — A module able to represent atoms by their
position and spin.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="v-sim-renderingSpin.synopsis"></a><h2>Synopsis</h2>
<a name="VisuRenderingSpin"></a><pre class="synopsis">enum <a class="link" href="v-sim-renderingSpin.html#SpinDrawingPolicy" title="enum SpinDrawingPolicy">SpinDrawingPolicy</a>;
enum <a class="link" href="v-sim-renderingSpin.html#SpinModulusPolicy" title="enum SpinModulusPolicy">SpinModulusPolicy</a>;
enum <a class="link" href="v-sim-renderingSpin.html#VisuSpinShapeId" title="enum VisuSpinShapeId">VisuSpinShapeId</a>;
enum <a class="link" href="v-sim-renderingSpin.html#SpinFileType" title="enum SpinFileType">SpinFileType</a>;
#define <a class="link" href="v-sim-renderingSpin.html#SPINVALUES-ID:CAPS" title="SPINVALUES_ID">SPINVALUES_ID</a>
#define <a class="link" href="v-sim-renderingSpin.html#SPINMAXMODULUS-ID:CAPS" title="SPINMAXMODULUS_ID">SPINMAXMODULUS_ID</a>
#define <a class="link" href="v-sim-renderingSpin.html#VISU-RENDERING-SPIN-NAME:CAPS" title="VISU_RENDERING_SPIN_NAME">VISU_RENDERING_SPIN_NAME</a>
#define <a class="link" href="v-sim-renderingSpin.html#VISU-RENDERING-SPIN-TYPE:CAPS" title="VISU_RENDERING_SPIN_TYPE">VISU_RENDERING_SPIN_TYPE</a>
#define <a class="link" href="v-sim-renderingSpin.html#VISU-RENDERING-SPIN:CAPS" title="VISU_RENDERING_SPIN()">VISU_RENDERING_SPIN</a> (obj)
#define <a class="link" href="v-sim-renderingSpin.html#VISU-RENDERING-SPIN-CLASS:CAPS" title="VISU_RENDERING_SPIN_CLASS()">VISU_RENDERING_SPIN_CLASS</a> (klass)
#define <a class="link" href="v-sim-renderingSpin.html#IS-VISU-RENDERING-SPIN-TYPE:CAPS" title="IS_VISU_RENDERING_SPIN_TYPE()">IS_VISU_RENDERING_SPIN_TYPE</a> (obj)
#define <a class="link" href="v-sim-renderingSpin.html#IS-VISU-RENDERING-SPIN-CLASS:CAPS" title="IS_VISU_RENDERING_SPIN_CLASS()">IS_VISU_RENDERING_SPIN_CLASS</a> (klass)
#define <a class="link" href="v-sim-renderingSpin.html#VISU-RENDERING-SPIN-GET-CLASS:CAPS" title="VISU_RENDERING_SPIN_GET_CLASS()">VISU_RENDERING_SPIN_GET_CLASS</a> (obj)
<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-renderingSpin.html#visu-rendering-spin-get-type" title="visu_rendering_spin_get_type ()">visu_rendering_spin_get_type</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a class="link" href="v-sim-renderingSpin.html#VisuRenderingSpinPriv" title="VisuRenderingSpinPriv">VisuRenderingSpinPriv</a>;
<a class="link" href="v-sim-renderingSpin.html#VisuRenderingSpinClass" title="VisuRenderingSpinClass">VisuRenderingSpinClass</a>;
<a class="link" href="v-sim-renderingSpin.html#VisuRenderingSpin-struct" title="VisuRenderingSpin">VisuRenderingSpin</a>;
<a class="link" href="v-sim-renderingSpin.html#VisuRenderingSpin"><span class="returnvalue">VisuRenderingSpin</span></a>* <a class="link" href="v-sim-renderingSpin.html#visu-rendering-spin-new" title="visu_rendering_spin_new ()">visu_rendering_spin_new</a> ();
const <span class="returnvalue">char</span>* <a class="link" href="v-sim-renderingSpin.html#visu-renderingSpin-getShapeNameI18n" title="visu_renderingSpin_getShapeNameI18n ()">visu_renderingSpin_getShapeNameI18n</a> (<em class="parameter"><code><a class="link" href="v-sim-renderingSpin.html#VisuSpinShapeId" title="enum VisuSpinShapeId"><span class="type">VisuSpinShapeId</span></a> n</code></em>);
<a class="link" href="v-sim-renderingSpin.html#SpinDrawingPolicy" title="enum SpinDrawingPolicy"><span class="returnvalue">SpinDrawingPolicy</span></a> <a class="link" href="v-sim-renderingSpin.html#visu-renderingSpin-getHidingPolicyFromName" title="visu_renderingSpin_getHidingPolicyFromName ()">visu_renderingSpin_getHidingPolicyFromName</a>
(<em class="parameter"><code>const <span class="type">char</span> *name</code></em>);
const <span class="returnvalue">char</span>* <a class="link" href="v-sim-renderingSpin.html#visu-renderingSpin-getHidingPolicyName" title="visu_renderingSpin_getHidingPolicyName ()">visu_renderingSpin_getHidingPolicyName</a>
(<em class="parameter"><code><a class="link" href="v-sim-renderingSpin.html#SpinDrawingPolicy" title="enum SpinDrawingPolicy"><span class="type">SpinDrawingPolicy</span></a> n</code></em>);
const <span class="returnvalue">char</span>* <a class="link" href="v-sim-renderingSpin.html#visu-renderingSpin-getHidingPolicyNameI18n" title="visu_renderingSpin_getHidingPolicyNameI18n ()">visu_renderingSpin_getHidingPolicyNameI18n</a>
(<em class="parameter"><code><a class="link" href="v-sim-renderingSpin.html#SpinDrawingPolicy" title="enum SpinDrawingPolicy"><span class="type">SpinDrawingPolicy</span></a> n</code></em>);
enum <a class="link" href="v-sim-renderingSpin.html#SpinElementResources" title="enum SpinElementResources">SpinElementResources</a>;
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a> <a class="link" href="v-sim-renderingSpin.html#rspin-getElementResource" title="rspin_getElementResource ()">rspin_getElementResource</a> (<em class="parameter"><code><a class="link" href="v-sim-visu-elements.html#VisuElement"><span class="type">VisuElement</span></a> *ele</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-renderingSpin.html#SpinElementResources" title="enum SpinElementResources"><span class="type">SpinElementResources</span></a> property</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> *type</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-renderingSpin.html#rspin-setElementResource-boolean" title="rspin_setElementResource_boolean ()">rspin_setElementResource_boolean</a> (<em class="parameter"><code><a class="link" href="v-sim-visu-elements.html#VisuElement"><span class="type">VisuElement</span></a> *ele</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-renderingSpin.html#SpinElementResources" title="enum SpinElementResources"><span class="type">SpinElementResources</span></a> property</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> value</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-renderingSpin.html#rspin-setElementResource-uint" title="rspin_setElementResource_uint ()">rspin_setElementResource_uint</a> (<em class="parameter"><code><a class="link" href="v-sim-visu-elements.html#VisuElement"><span class="type">VisuElement</span></a> *ele</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-renderingSpin.html#SpinElementResources" title="enum SpinElementResources"><span class="type">SpinElementResources</span></a> property</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> value</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-renderingSpin.html#rspin-setElementResource-float" title="rspin_setElementResource_float ()">rspin_setElementResource_float</a> (<em class="parameter"><code><a class="link" href="v-sim-visu-elements.html#VisuElement"><span class="type">VisuElement</span></a> *ele</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-renderingSpin.html#SpinElementResources" title="enum SpinElementResources"><span class="type">SpinElementResources</span></a> property</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> value</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-renderingSpin.html#rspin-getElementResource-boolean" title="rspin_getElementResource_boolean ()">rspin_getElementResource_boolean</a> (<em class="parameter"><code><a class="link" href="v-sim-visu-elements.html#VisuElement"><span class="type">VisuElement</span></a> *ele</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-renderingSpin.html#SpinElementResources" title="enum SpinElementResources"><span class="type">SpinElementResources</span></a> property</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> <a class="link" href="v-sim-renderingSpin.html#rspin-getElementResource-uint" title="rspin_getElementResource_uint ()">rspin_getElementResource_uint</a> (<em class="parameter"><code><a class="link" href="v-sim-visu-elements.html#VisuElement"><span class="type">VisuElement</span></a> *ele</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-renderingSpin.html#SpinElementResources" title="enum SpinElementResources"><span class="type">SpinElementResources</span></a> property</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="returnvalue">gfloat</span></a> <a class="link" href="v-sim-renderingSpin.html#rspin-getElementResource-float" title="rspin_getElementResource_float ()">rspin_getElementResource_float</a> (<em class="parameter"><code><a class="link" href="v-sim-visu-elements.html#VisuElement"><span class="type">VisuElement</span></a> *ele</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-renderingSpin.html#SpinElementResources" title="enum SpinElementResources"><span class="type">SpinElementResources</span></a> property</code></em>);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="v-sim-renderingSpin.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>
+----<a class="link" href="VisuRendering.html" title="VisuRendering">VisuRendering</a>
+----VisuRenderingSpin
</pre>
</div>
<div class="refsect1" title="Properties">
<a name="v-sim-renderingSpin.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="v-sim-renderingSpin.html#VisuRenderingSpin--cone-omega" title='The "cone-omega" property'>cone-omega</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> : Read / Write
"<a class="link" href="v-sim-renderingSpin.html#VisuRenderingSpin--cone-phi" title='The "cone-phi" property'>cone-phi</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> : Read / Write
"<a class="link" href="v-sim-renderingSpin.html#VisuRenderingSpin--cone-theta" title='The "cone-theta" property'>cone-theta</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> : Read / Write
"<a class="link" href="v-sim-renderingSpin.html#VisuRenderingSpin--hiding-mode" title='The "hiding-mode" property'>hiding-mode</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write
"<a class="link" href="v-sim-renderingSpin.html#VisuRenderingSpin--modulus-scaling" title='The "modulus-scaling" property'>modulus-scaling</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write
"<a class="link" href="v-sim-renderingSpin.html#VisuRenderingSpin--use-atomic" title='The "use-atomic" property'>use-atomic</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
</pre>
</div>
<div class="refsect1" title="Signals">
<a name="v-sim-renderingSpin.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="v-sim-renderingSpin.html#VisuRenderingSpin-colorisationChange" title='The "colorisationChange" signal'>colorisationChange</a>" : Run Last / No Recursion / No Hooks
</pre>
</div>
<div class="refsect1" title="Description">
<a name="v-sim-renderingSpin.description"></a><h2>Description</h2>
<p>
</p>
<p>This method draws arrows to represent atoms. Each arrow has a
given orientation which is set acording to parameters. This is one
way to represent the spin of an atom. These arrows direction are
determined by the spin of each atom. It is designed to read two
separate files : one containing the position of the atoms, the
other containing the spin of each atom. Of course these two files
need to have the exact same number of atoms and also need to sort
atoms in the same order.</p>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="v-sim-renderingSpin.details"></a><h2>Details</h2>
<div class="refsect2" title="enum SpinDrawingPolicy">
<a name="SpinDrawingPolicy"></a><h3>enum SpinDrawingPolicy</h3>
<pre class="programlisting">typedef enum
{
policyAlwaysSpin,
policyHideNullSpin,
policyAtomicNullSpin,
policyNbModes
} SpinDrawingPolicy;
</pre>
<p>
Different policy to render the spin when the modulus is null. This
policy is applied for all <a class="link" href="v-sim-visu-elements.html#VisuElement"><span class="type">VisuElement</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="policyAlwaysSpin"></a><span class="term"><code class="literal">policyAlwaysSpin</code></span></p></td>
<td>Arrows are drawn whatever the modulus value.
</td>
</tr>
<tr>
<td><p><a name="policyHideNullSpin"></a><span class="term"><code class="literal">policyHideNullSpin</code></span></p></td>
<td>Spin with a null modulus are hidden.
</td>
</tr>
<tr>
<td><p><a name="policyAtomicNullSpin"></a><span class="term"><code class="literal">policyAtomicNullSpin</code></span></p></td>
<td>Follow atomic rendering for null modulus.
</td>
</tr>
<tr>
<td><p><a name="policyNbModes"></a><span class="term"><code class="literal">policyNbModes</code></span></p></td>
<td>a flag to count the number of modes.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="enum SpinModulusPolicy">
<a name="SpinModulusPolicy"></a><h3>enum SpinModulusPolicy</h3>
<pre class="programlisting">typedef enum
{
policyNoneModulus,
policyPerTypeModulus,
policyGlobalModulus,
policyNbModulusModes
} SpinModulusPolicy;
</pre>
<p>
Different policy to render the spin depending on the modulus.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="policyNoneModulus"></a><span class="term"><code class="literal">policyNoneModulus</code></span></p></td>
<td>arrows have all the same size, whatever the
modulus value.
</td>
</tr>
<tr>
<td><p><a name="policyPerTypeModulus"></a><span class="term"><code class="literal">policyPerTypeModulus</code></span></p></td>
<td>arrows are scaled per node type.
</td>
</tr>
<tr>
<td><p><a name="policyGlobalModulus"></a><span class="term"><code class="literal">policyGlobalModulus</code></span></p></td>
<td>arrows are scaled globaly.
</td>
</tr>
<tr>
<td><p><a name="policyNbModulusModes"></a><span class="term"><code class="literal">policyNbModulusModes</code></span></p></td>
<td>a flag to count the number of modes.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="enum VisuSpinShapeId">
<a name="VisuSpinShapeId"></a><h3>enum VisuSpinShapeId</h3>
<pre class="programlisting">typedef enum
{
VISU_RENDERING_SPIN_ARROW_SMOOTH,
VISU_RENDERING_SPIN_ARROW_SHARP,
VISU_RENDERING_SPIN_ELLIPSOID,
VISU_RENDERING_SPIN_TORUS,
/*< private >*/
nbSpinShapes
} VisuSpinShapeId;
</pre>
<p>
An identifier for the different shapes to draw elements.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="VISU-RENDERING-SPIN-ARROW-SMOOTH:CAPS"></a><span class="term"><code class="literal">VISU_RENDERING_SPIN_ARROW_SMOOTH</code></span></p></td>
<td>the shape is smooth and rounded ;
</td>
</tr>
<tr>
<td><p><a name="VISU-RENDERING-SPIN-ARROW-SHARP:CAPS"></a><span class="term"><code class="literal">VISU_RENDERING_SPIN_ARROW_SHARP</code></span></p></td>
<td>the shape is built on squares ;
</td>
</tr>
<tr>
<td><p><a name="VISU-RENDERING-SPIN-ELLIPSOID:CAPS"></a><span class="term"><code class="literal">VISU_RENDERING_SPIN_ELLIPSOID</code></span></p></td>
<td>the shape is an ellipsoid ;
</td>
</tr>
<tr>
<td><p><a name="VISU-RENDERING-SPIN-TORUS:CAPS"></a><span class="term"><code class="literal">VISU_RENDERING_SPIN_TORUS</code></span></p></td>
<td>the shape is a torus (direction of the arrow is
normal to the torus plane).
</td>
</tr>
<tr>
<td><p><a name="nbSpinShapes"></a><span class="term"><code class="literal">nbSpinShapes</code></span></p></td>
<td>private.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="enum SpinFileType">
<a name="SpinFileType"></a><h3>enum SpinFileType</h3>
<pre class="programlisting">typedef enum
{
FILE_KIND_POSITION,
FILE_KIND_SPIN
} SpinFileType;
</pre>
<p>
These are keys for the storing of spin files in a VisuData object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="FILE-KIND-POSITION:CAPS"></a><span class="term"><code class="literal">FILE_KIND_POSITION</code></span></p></td>
<td>define a position file ;
</td>
</tr>
<tr>
<td><p><a name="FILE-KIND-SPIN:CAPS"></a><span class="term"><code class="literal">FILE_KIND_SPIN</code></span></p></td>
<td>define a spin description file.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="SPINVALUES_ID">
<a name="SPINVALUES-ID:CAPS"></a><h3>SPINVALUES_ID</h3>
<pre class="programlisting">#define SPINVALUES_ID "spinRendering_values"
</pre>
<p>
This flag should be used when creating a new spin rendering method
as the flag for the spin values as node properties (see
<a class="link" href="v-sim-visu-nodes.html#visu-node-property-newPointer" title="visu_node_property_newPointer ()"><code class="function">visu_node_property_newPointer()</code></a>).
</p>
</div>
<hr>
<div class="refsect2" title="SPINMAXMODULUS_ID">
<a name="SPINMAXMODULUS-ID:CAPS"></a><h3>SPINMAXMODULUS_ID</h3>
<pre class="programlisting">#define SPINMAXMODULUS_ID "spinRendering_maxModulus"
</pre>
<p>
This flag should be used when creating a new spin rendering method
as the flag for the max modulus values as a <a class="link" href="v-sim-visu-nodes.html#VisuNode" title="VisuNode"><span class="type">VisuNode</span></a> property (see
<a class="link" href="v-sim-visu-nodes.html#visu-node-property-newPointer" title="visu_node_property_newPointer ()"><code class="function">visu_node_property_newPointer()</code></a>).
</p>
</div>
<hr>
<div class="refsect2" title="VISU_RENDERING_SPIN_NAME">
<a name="VISU-RENDERING-SPIN-NAME:CAPS"></a><h3>VISU_RENDERING_SPIN_NAME</h3>
<pre class="programlisting">#define VISU_RENDERING_SPIN_NAME "Spin visualisation"
</pre>
<p>
Public name of the spin rendering mode.
</p>
</div>
<hr>
<div class="refsect2" title="VISU_RENDERING_SPIN_TYPE">
<a name="VISU-RENDERING-SPIN-TYPE:CAPS"></a><h3>VISU_RENDERING_SPIN_TYPE</h3>
<pre class="programlisting">#define VISU_RENDERING_SPIN_TYPE (visu_rendering_spin_get_type ())
</pre>
<p>
return the type of <a class="link" href="v-sim-renderingSpin.html#VisuRenderingSpin"><span class="type">VisuRenderingSpin</span></a>.
</p>
</div>
<hr>
<div class="refsect2" title="VISU_RENDERING_SPIN()">
<a name="VISU-RENDERING-SPIN:CAPS"></a><h3>VISU_RENDERING_SPIN()</h3>
<pre class="programlisting">#define VISU_RENDERING_SPIN(obj) (G_TYPE_CHECK_INSTANCE_CAST(obj, VISU_RENDERING_SPIN_TYPE, VisuRenderingSpin))
</pre>
<p>
Cast the given <em class="parameter"><code>obj</code></em> into <a class="link" href="v-sim-renderingSpin.html#VisuRenderingSpin"><span class="type">VisuRenderingSpin</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_RENDERING_SPIN_CLASS()">
<a name="VISU-RENDERING-SPIN-CLASS:CAPS"></a><h3>VISU_RENDERING_SPIN_CLASS()</h3>
<pre class="programlisting">#define VISU_RENDERING_SPIN_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST(klass, VISU_RENDERING_SPIN_TYPE, VisuRenderingSpinClass))
</pre>
<p>
Cast the given <em class="parameter"><code>klass</code></em> into <a class="link" href="v-sim-renderingSpin.html#VisuRenderingSpinClass" title="VisuRenderingSpinClass"><span class="type">VisuRenderingSpinClass</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_RENDERING_SPIN_TYPE()">
<a name="IS-VISU-RENDERING-SPIN-TYPE:CAPS"></a><h3>IS_VISU_RENDERING_SPIN_TYPE()</h3>
<pre class="programlisting">#define IS_VISU_RENDERING_SPIN_TYPE(obj) (G_TYPE_CHECK_INSTANCE_TYPE(obj, VISU_RENDERING_SPIN_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-renderingSpin.html#VisuRenderingSpin"><span class="type">VisuRenderingSpin</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_RENDERING_SPIN_CLASS()">
<a name="IS-VISU-RENDERING-SPIN-CLASS:CAPS"></a><h3>IS_VISU_RENDERING_SPIN_CLASS()</h3>
<pre class="programlisting">#define IS_VISU_RENDERING_SPIN_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE(klass, VISU_RENDERING_SPIN_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-renderingSpin.html#VisuRenderingSpinClass" title="VisuRenderingSpinClass"><span class="type">VisuRenderingSpinClass</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_RENDERING_SPIN_GET_CLASS()">
<a name="VISU-RENDERING-SPIN-GET-CLASS:CAPS"></a><h3>VISU_RENDERING_SPIN_GET_CLASS()</h3>
<pre class="programlisting">#define VISU_RENDERING_SPIN_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS(obj, VISU_RENDERING_SPIN_TYPE, VisuRenderingSpinClass))
</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="visu_rendering_spin_get_type ()">
<a name="visu-rendering-spin-get-type"></a><h3>visu_rendering_spin_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> visu_rendering_spin_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-renderingSpin.html#VisuRenderingSpin"><span class="type">VisuRenderingSpin</span></a>, use
VISU_RENDERING_SPIN_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-renderingSpin.html#VisuRenderingSpin"><span class="type">VisuRenderingSpin</span></a>.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="VisuRenderingSpinPriv">
<a name="VisuRenderingSpinPriv"></a><h3>VisuRenderingSpinPriv</h3>
<pre class="programlisting">typedef struct _VisuRenderingSpinPriv VisuRenderingSpinPriv;</pre>
<p>
An opaque structure.
</p>
</div>
<hr>
<div class="refsect2" title="VisuRenderingSpinClass">
<a name="VisuRenderingSpinClass"></a><h3>VisuRenderingSpinClass</h3>
<pre class="programlisting">typedef struct _VisuRenderingSpinClass VisuRenderingSpinClass;</pre>
<p>
An opaque structure.
</p>
</div>
<hr>
<div class="refsect2" title="VisuRenderingSpin">
<a name="VisuRenderingSpin-struct"></a><h3>VisuRenderingSpin</h3>
<pre class="programlisting">typedef struct _VisuRenderingSpin VisuRenderingSpin;</pre>
<p>
An opaque structure.
</p>
</div>
<hr>
<div class="refsect2" title="visu_rendering_spin_new ()">
<a name="visu-rendering-spin-new"></a><h3>visu_rendering_spin_new ()</h3>
<pre class="programlisting"><a class="link" href="v-sim-renderingSpin.html#VisuRenderingSpin"><span class="returnvalue">VisuRenderingSpin</span></a>* visu_rendering_spin_new ();</pre>
<p>
Create the structure and initialise its values.
</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 allocate <a class="link" href="v-sim-renderingSpin.html#VisuRenderingSpin"><span class="type">VisuRenderingSpin</span></a> object.
</td>
</tr></tbody>
</table></div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2" title="visu_renderingSpin_getShapeNameI18n ()">
<a name="visu-renderingSpin-getShapeNameI18n"></a><h3>visu_renderingSpin_getShapeNameI18n ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span>* visu_renderingSpin_getShapeNameI18n (<em class="parameter"><code><a class="link" href="v-sim-renderingSpin.html#VisuSpinShapeId" title="enum VisuSpinShapeId"><span class="type">VisuSpinShapeId</span></a> n</code></em>);</pre>
<p>
This routine returnes the translated name in UTF-8 corresponding to
the given shape id.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>n</code></em> :</span></p></td>
<td>an id for spin shape.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a string owned by V_Sim.. type utf8</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="visu_renderingSpin_getHidingPolicyFromName ()">
<a name="visu-renderingSpin-getHidingPolicyFromName"></a><h3>visu_renderingSpin_getHidingPolicyFromName ()</h3>
<pre class="programlisting"><a class="link" href="v-sim-renderingSpin.html#SpinDrawingPolicy" title="enum SpinDrawingPolicy"><span class="returnvalue">SpinDrawingPolicy</span></a> visu_renderingSpin_getHidingPolicyFromName
(<em class="parameter"><code>const <span class="type">char</span> *name</code></em>);</pre>
<p>
In the config file, the hiding policy resource is stored with its name (untranslated).
This method is used to retrieve the id from the name.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td> a string.. type filename</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the maximum value if the name is invalid.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="visu_renderingSpin_getHidingPolicyName ()">
<a name="visu-renderingSpin-getHidingPolicyName"></a><h3>visu_renderingSpin_getHidingPolicyName ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span>* visu_renderingSpin_getHidingPolicyName
(<em class="parameter"><code><a class="link" href="v-sim-renderingSpin.html#SpinDrawingPolicy" title="enum SpinDrawingPolicy"><span class="type">SpinDrawingPolicy</span></a> n</code></em>);</pre>
<p>
Transform ids to untranslated names.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>n</code></em> :</span></p></td>
<td>an id for hiding policy.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the name associated to the id.. type filename</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="visu_renderingSpin_getHidingPolicyNameI18n ()">
<a name="visu-renderingSpin-getHidingPolicyNameI18n"></a><h3>visu_renderingSpin_getHidingPolicyNameI18n ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span>* visu_renderingSpin_getHidingPolicyNameI18n
(<em class="parameter"><code><a class="link" href="v-sim-renderingSpin.html#SpinDrawingPolicy" title="enum SpinDrawingPolicy"><span class="type">SpinDrawingPolicy</span></a> n</code></em>);</pre>
<p>
Transform ids to translated names.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>n</code></em> :</span></p></td>
<td>an id for hiding policy.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the name associated to the id in UTF-8.. type utf8</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="enum SpinElementResources">
<a name="SpinElementResources"></a><h3>enum SpinElementResources</h3>
<pre class="programlisting">typedef enum
{
spin_elementHatLength,
spin_elementTailLength,
spin_elementHatRadius,
spin_elementTailRadius,
spin_elementHatColor,
spin_elementTailColor,
spin_elementAAxis,
spin_elementBAxis,
spin_elementElipsoidColor,
spin_elementShape,
spin_nbElementResources
} SpinElementResources;
</pre>
<p>
These are resources defined for each element. They can be accessed with
<a class="link" href="v-sim-renderingSpin.html#rspin-getElementResource" title="rspin_getElementResource ()"><code class="function">rspin_getElementResource()</code></a> or <a class="link" href="v-sim-renderingSpin.html#rspin-getElementResource-boolean" title="rspin_getElementResource_boolean ()"><code class="function">rspin_getElementResource_boolean()</code></a> and other
methods of the same kind.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="spin-elementHatLength"></a><span class="term"><code class="literal">spin_elementHatLength</code></span></p></td>
<td>the length of the pointing element ;
</td>
</tr>
<tr>
<td><p><a name="spin-elementTailLength"></a><span class="term"><code class="literal">spin_elementTailLength</code></span></p></td>
<td>the length of the tail ;
</td>
</tr>
<tr>
<td><p><a name="spin-elementHatRadius"></a><span class="term"><code class="literal">spin_elementHatRadius</code></span></p></td>
<td>the raidus of the pointing element ;
</td>
</tr>
<tr>
<td><p><a name="spin-elementTailRadius"></a><span class="term"><code class="literal">spin_elementTailRadius</code></span></p></td>
<td>the radius of the tail ;
</td>
</tr>
<tr>
<td><p><a name="spin-elementHatColor"></a><span class="term"><code class="literal">spin_elementHatColor</code></span></p></td>
<td>if TRUE, the pointing part use the color of the element ;
</td>
</tr>
<tr>
<td><p><a name="spin-elementTailColor"></a><span class="term"><code class="literal">spin_elementTailColor</code></span></p></td>
<td>if TRUE, the tail uses the color of the element ;
</td>
</tr>
<tr>
<td><p><a name="spin-elementAAxis"></a><span class="term"><code class="literal">spin_elementAAxis</code></span></p></td>
<td>the size of the A axis (elipsoid shape) ;
</td>
</tr>
<tr>
<td><p><a name="spin-elementBAxis"></a><span class="term"><code class="literal">spin_elementBAxis</code></span></p></td>
<td>the size of the B axis (elipsoid shape) ;
</td>
</tr>
<tr>
<td><p><a name="spin-elementElipsoidColor"></a><span class="term"><code class="literal">spin_elementElipsoidColor</code></span></p></td>
<td>if TRUE, the elipsoid uses the color of the element ;
</td>
</tr>
<tr>
<td><p><a name="spin-elementShape"></a><span class="term"><code class="literal">spin_elementShape</code></span></p></td>
<td>an id to defined the shape (rounded arrow, elipsoid...) ;
</td>
</tr>
<tr>
<td><p><a name="spin-nbElementResources"></a><span class="term"><code class="literal">spin_nbElementResources</code></span></p></td>
<td>number of resources per element.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="rspin_getElementResource ()">
<a name="rspin-getElementResource"></a><h3>rspin_getElementResource ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a> rspin_getElementResource (<em class="parameter"><code><a class="link" href="v-sim-visu-elements.html#VisuElement"><span class="type">VisuElement</span></a> *ele</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-renderingSpin.html#SpinElementResources" title="enum SpinElementResources"><span class="type">SpinElementResources</span></a> property</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> *type</code></em>);</pre>
<p>
This is a generic method to access resources per element. Use <a class="link" href="v-sim-renderingSpin.html#rspin-setElementResource-boolean" title="rspin_setElementResource_boolean ()"><code class="function">rspin_setElementResource_boolean()</code></a>
is favored if the type of the value is known (boolean in this exemple).
If the returned value is not NULL the argument <em class="parameter"><code>type</code></em> contains the type of the returned value.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ele</code></em> :</span></p></td>
<td>a pointer to a <a class="link" href="v-sim-visu-elements.html#VisuElement"><span class="type">VisuElement</span></a> object ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>property</code></em> :</span></p></td>
<td>the id of the resource (see <a class="link" href="v-sim-renderingSpin.html#SpinElementResources" title="enum SpinElementResources"><span class="type">SpinElementResources</span></a>) ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td>a location to store the type.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a pointer to the location where the value for the given global
resource is stored.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="rspin_setElementResource_boolean ()">
<a name="rspin-setElementResource-boolean"></a><h3>rspin_setElementResource_boolean ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> rspin_setElementResource_boolean (<em class="parameter"><code><a class="link" href="v-sim-visu-elements.html#VisuElement"><span class="type">VisuElement</span></a> *ele</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-renderingSpin.html#SpinElementResources" title="enum SpinElementResources"><span class="type">SpinElementResources</span></a> property</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> value</code></em>);</pre>
<p>
This method is used to change element resources that are boolean.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ele</code></em> :</span></p></td>
<td>a pointer to a <a class="link" href="v-sim-visu-elements.html#VisuElement"><span class="type">VisuElement</span></a> object ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>property</code></em> :</span></p></td>
<td>the id of the property to set ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>its value.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if the value was changed.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="rspin_setElementResource_uint ()">
<a name="rspin-setElementResource-uint"></a><h3>rspin_setElementResource_uint ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> rspin_setElementResource_uint (<em class="parameter"><code><a class="link" href="v-sim-visu-elements.html#VisuElement"><span class="type">VisuElement</span></a> *ele</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-renderingSpin.html#SpinElementResources" title="enum SpinElementResources"><span class="type">SpinElementResources</span></a> property</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> value</code></em>);</pre>
<p>
This method is used to change element resources that are unsigned int.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ele</code></em> :</span></p></td>
<td>a pointer to a <a class="link" href="v-sim-visu-elements.html#VisuElement"><span class="type">VisuElement</span></a> object ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>property</code></em> :</span></p></td>
<td>the id of the property to set ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>its value.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if the value was changed.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="rspin_setElementResource_float ()">
<a name="rspin-setElementResource-float"></a><h3>rspin_setElementResource_float ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> rspin_setElementResource_float (<em class="parameter"><code><a class="link" href="v-sim-visu-elements.html#VisuElement"><span class="type">VisuElement</span></a> *ele</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-renderingSpin.html#SpinElementResources" title="enum SpinElementResources"><span class="type">SpinElementResources</span></a> property</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> value</code></em>);</pre>
<p>
This method is used to change element resources that are floating point.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ele</code></em> :</span></p></td>
<td>a pointer to a <a class="link" href="v-sim-visu-elements.html#VisuElement"><span class="type">VisuElement</span></a> object ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>property</code></em> :</span></p></td>
<td>the id of the property to set ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>its value.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if the value was changed.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="rspin_getElementResource_boolean ()">
<a name="rspin-getElementResource-boolean"></a><h3>rspin_getElementResource_boolean ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> rspin_getElementResource_boolean (<em class="parameter"><code><a class="link" href="v-sim-visu-elements.html#VisuElement"><span class="type">VisuElement</span></a> *ele</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-renderingSpin.html#SpinElementResources" title="enum SpinElementResources"><span class="type">SpinElementResources</span></a> property</code></em>);</pre>
<p>
This is the specific method to retrieve value of boolean element resources.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ele</code></em> :</span></p></td>
<td>a pointer to a <a class="link" href="v-sim-visu-elements.html#VisuElement"><span class="type">VisuElement</span></a> object ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>property</code></em> :</span></p></td>
<td>the id of the property to get.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the boolean value.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="rspin_getElementResource_uint ()">
<a name="rspin-getElementResource-uint"></a><h3>rspin_getElementResource_uint ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> rspin_getElementResource_uint (<em class="parameter"><code><a class="link" href="v-sim-visu-elements.html#VisuElement"><span class="type">VisuElement</span></a> *ele</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-renderingSpin.html#SpinElementResources" title="enum SpinElementResources"><span class="type">SpinElementResources</span></a> property</code></em>);</pre>
<p>
This is the specific method to retrieve value of unsigned int element resources.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ele</code></em> :</span></p></td>
<td>a pointer to a <a class="link" href="v-sim-visu-elements.html#VisuElement"><span class="type">VisuElement</span></a> object ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>property</code></em> :</span></p></td>
<td>the id of the property to get.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the unsigned int value.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="rspin_getElementResource_float ()">
<a name="rspin-getElementResource-float"></a><h3>rspin_getElementResource_float ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="returnvalue">gfloat</span></a> rspin_getElementResource_float (<em class="parameter"><code><a class="link" href="v-sim-visu-elements.html#VisuElement"><span class="type">VisuElement</span></a> *ele</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-renderingSpin.html#SpinElementResources" title="enum SpinElementResources"><span class="type">SpinElementResources</span></a> property</code></em>);</pre>
<p>
This is the specific method to retrieve value of floating point element resources.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ele</code></em> :</span></p></td>
<td>a pointer to a <a class="link" href="v-sim-visu-elements.html#VisuElement"><span class="type">VisuElement</span></a> object ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>property</code></em> :</span></p></td>
<td>the id of the property to get.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the floating point value.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" title="Property Details">
<a name="v-sim-renderingSpin.property-details"></a><h2>Property Details</h2>
<div class="refsect2" title='The "cone-omega" property'>
<a name="VisuRenderingSpin--cone-omega"></a><h3>The <code class="literal">"cone-omega"</code> property</h3>
<pre class="programlisting"> "cone-omega" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> : Read / Write</pre>
<p>The omega angle to orientate the colourisation cone.</p>
<p>Allowed values: [0,360]</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2" title='The "cone-phi" property'>
<a name="VisuRenderingSpin--cone-phi"></a><h3>The <code class="literal">"cone-phi"</code> property</h3>
<pre class="programlisting"> "cone-phi" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> : Read / Write</pre>
<p>The phi angle to orientate the colourisation cone.</p>
<p>Allowed values: [0,360]</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2" title='The "cone-theta" property'>
<a name="VisuRenderingSpin--cone-theta"></a><h3>The <code class="literal">"cone-theta"</code> property</h3>
<pre class="programlisting"> "cone-theta" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> : Read / Write</pre>
<p>The theta angle to orientate the colourisation cone.</p>
<p>Allowed values: [0,180]</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2" title='The "hiding-mode" property'>
<a name="VisuRenderingSpin--hiding-mode"></a><h3>The <code class="literal">"hiding-mode"</code> property</h3>
<pre class="programlisting"> "hiding-mode" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write</pre>
<p>The hiding policy for spin with a null modulus.</p>
<p>Allowed values: <= 3</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2" title='The "modulus-scaling" property'>
<a name="VisuRenderingSpin--modulus-scaling"></a><h3>The <code class="literal">"modulus-scaling"</code> property</h3>
<pre class="programlisting"> "modulus-scaling" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write</pre>
<p>The scaling policy based on modulus value.</p>
<p>Allowed values: <= 3</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2" title='The "use-atomic" property'>
<a name="VisuRenderingSpin--use-atomic"></a><h3>The <code class="literal">"use-atomic"</code> property</h3>
<pre class="programlisting"> "use-atomic" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre>
<p>If atomic rendering is used in addition to spin rendering.</p>
<p>Default value: FALSE</p>
</div>
</div>
<div class="refsect1" title="Signal Details">
<a name="v-sim-renderingSpin.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2" title='The "colorisationChange" signal'>
<a name="VisuRenderingSpin-colorisationChange"></a><h3>The <code class="literal">"colorisationChange"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="v-sim-renderingSpin.html#VisuRenderingSpin"><span class="type">VisuRenderingSpin</span></a> *render,
<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 whenever a change occur in the
colourisation scheme of the spins.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>render</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>
|
