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
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ClutterPath: Clutter Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="Clutter Reference Manual">
<link rel="up" href="ch10.html" title="General purpose API">
<link rel="prev" href="clutter-General.html" title="General">
<link rel="next" href="ClutterSettings.html" title="ClutterSettings">
<meta name="generator" content="GTK-Doc V1.29 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#ClutterPath.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#ClutterPath.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#ClutterPath.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch10.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="clutter-General.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ClutterSettings.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="ClutterPath"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="ClutterPath.top_of_page"></a>ClutterPath</span></h2>
<p>ClutterPath — An object describing a path with straight lines
and bezier curves.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="ClutterPath.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="ClutterPath.html#ClutterPathCallback" title="ClutterPathCallback ()">*ClutterPathCallback</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="ClutterPath.html" title="ClutterPath"><span class="returnvalue">ClutterPath</span></a> *
</td>
<td class="function_name">
<a class="link" href="ClutterPath.html#clutter-path-new" title="clutter_path_new ()">clutter_path_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="ClutterPath.html" title="ClutterPath"><span class="returnvalue">ClutterPath</span></a> *
</td>
<td class="function_name">
<a class="link" href="ClutterPath.html#clutter-path-new-with-description" title="clutter_path_new_with_description ()">clutter_path_new_with_description</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterPath.html#clutter-path-add-move-to" title="clutter_path_add_move_to ()">clutter_path_add_move_to</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterPath.html#clutter-path-add-rel-move-to" title="clutter_path_add_rel_move_to ()">clutter_path_add_rel_move_to</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterPath.html#clutter-path-add-line-to" title="clutter_path_add_line_to ()">clutter_path_add_line_to</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterPath.html#clutter-path-add-rel-line-to" title="clutter_path_add_rel_line_to ()">clutter_path_add_rel_line_to</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterPath.html#clutter-path-add-curve-to" title="clutter_path_add_curve_to ()">clutter_path_add_curve_to</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterPath.html#clutter-path-add-rel-curve-to" title="clutter_path_add_rel_curve_to ()">clutter_path_add_rel_curve_to</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterPath.html#clutter-path-add-close" title="clutter_path_add_close ()">clutter_path_add_close</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="ClutterPath.html#clutter-path-add-string" title="clutter_path_add_string ()">clutter_path_add_string</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterPath.html#clutter-path-add-node" title="clutter_path_add_node ()">clutter_path_add_node</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterPath.html#clutter-path-add-cairo-path" title="clutter_path_add_cairo_path ()">clutter_path_add_cairo_path</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="ClutterPath.html#clutter-path-get-n-nodes" title="clutter_path_get_n_nodes ()">clutter_path_get_n_nodes</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterPath.html#clutter-path-get-node" title="clutter_path_get_node ()">clutter_path_get_node</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GSList</span> *
</td>
<td class="function_name">
<a class="link" href="ClutterPath.html#clutter-path-get-nodes" title="clutter_path_get_nodes ()">clutter_path_get_nodes</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterPath.html#clutter-path-foreach" title="clutter_path_foreach ()">clutter_path_foreach</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterPath.html#clutter-path-insert-node" title="clutter_path_insert_node ()">clutter_path_insert_node</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterPath.html#clutter-path-remove-node" title="clutter_path_remove_node ()">clutter_path_remove_node</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterPath.html#clutter-path-replace-node" title="clutter_path_replace_node ()">clutter_path_replace_node</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="ClutterPath.html#clutter-path-get-description" title="clutter_path_get_description ()">clutter_path_get_description</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="ClutterPath.html#clutter-path-set-description" title="clutter_path_set_description ()">clutter_path_set_description</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterPath.html#clutter-path-to-cairo-path" title="clutter_path_to_cairo_path ()">clutter_path_to_cairo_path</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterPath.html#clutter-path-clear" title="clutter_path_clear ()">clutter_path_clear</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="ClutterPath.html#clutter-path-get-position" title="clutter_path_get_position ()">clutter_path_get_position</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="ClutterPath.html#clutter-path-get-length" title="clutter_path_get_length ()">clutter_path_get_length</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="ClutterPath.html#ClutterPathNode"><span class="returnvalue">ClutterPathNode</span></a> *
</td>
<td class="function_name">
<a class="link" href="ClutterPath.html#clutter-path-node-copy" title="clutter_path_node_copy ()">clutter_path_node_copy</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterPath.html#clutter-path-node-free" title="clutter_path_node_free ()">clutter_path_node_free</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="ClutterPath.html#clutter-path-node-equal" title="clutter_path_node_equal ()">clutter_path_node_equal</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterPath.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="ClutterPath.html#ClutterPath--description" title="The “description” property">description</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">guint</span></td>
<td class="property_name"><a class="link" href="ClutterPath.html#ClutterPath--length" title="The “length” property">length</a></td>
<td class="property_flags">Read</td>
</tr>
</tbody>
</table></div>
</div>
<a name="ClutterPathNode"></a><div class="refsect1">
<a name="ClutterPath.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="ClutterPath.html#ClutterPath-struct" title="ClutterPath">ClutterPath</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="ClutterPath.html#ClutterPathClass" title="struct ClutterPathClass">ClutterPathClass</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="ClutterPath.html#ClutterPathNodeType" title="enum ClutterPathNodeType">ClutterPathNodeType</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="ClutterPath.html#ClutterPathNode-struct" title="struct ClutterPathNode">ClutterPathNode</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterPath.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-Boxed-Types.html">GBoxed</a>
<span class="lineart">╰──</span> ClutterPathNode
GObject
<span class="lineart">╰──</span> GInitiallyUnowned
<span class="lineart">╰──</span> ClutterPath
</pre>
</div>
<div class="refsect1">
<a name="ClutterPath.description"></a><h2>Description</h2>
<p>A <a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a> contains a description of a path consisting of
straight lines and bezier curves. This can be used in a
<a class="link" href="ClutterBehaviourPath.html" title="ClutterBehaviourPath"><span class="type">ClutterBehaviourPath</span></a> to animate an actor moving along the path.</p>
<p>The path consists of a series of nodes. Each node is one of the
following four types:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p><a class="link" href="ClutterPath.html#CLUTTER-PATH-MOVE-TO:CAPS"><code class="literal">CLUTTER_PATH_MOVE_TO</code></a>, changes the position of the path to the
given pair of coordinates. This is usually used as the first node
of a path to mark the start position. If it is used in the middle
of a path then the path will be disjoint and the actor will appear
to jump to the new position when animated.</p></li>
<li class="listitem"><p><a class="link" href="ClutterPath.html#CLUTTER-PATH-LINE-TO:CAPS"><code class="literal">CLUTTER_PATH_LINE_TO</code></a>, creates a straight line from the previous
point to the given point.</p></li>
<li class="listitem"><p><a class="link" href="ClutterPath.html#CLUTTER-PATH-CURVE-TO:CAPS"><code class="literal">CLUTTER_PATH_CURVE_TO</code></a>, creates a bezier curve. The end of the
last node is used as the first control point and the three
subsequent coordinates given in the node as used as the other three.
-<a class="link" href="ClutterPath.html#CLUTTER-PATH-CLOSE:CAPS"><code class="literal">CLUTTER_PATH_CLOSE</code></a>, creates a straight line from the last node to
the last <a class="link" href="ClutterPath.html#CLUTTER-PATH-MOVE-TO:CAPS"><code class="literal">CLUTTER_PATH_MOVE_TO</code></a> node. This can be used to close a
path so that it will appear as a loop when animated.</p></li>
</ul></div>
<p>The first three types have the corresponding relative versions
<a class="link" href="ClutterPath.html#CLUTTER-PATH-REL-MOVE-TO:CAPS"><code class="literal">CLUTTER_PATH_REL_MOVE_TO</code></a>, <a class="link" href="ClutterPath.html#CLUTTER-PATH-REL-LINE-TO:CAPS"><code class="literal">CLUTTER_PATH_REL_LINE_TO</code></a> and
<a class="link" href="ClutterPath.html#CLUTTER-PATH-REL-CURVE-TO:CAPS"><code class="literal">CLUTTER_PATH_REL_CURVE_TO</code></a>. These are exactly the same except the
coordinates are given relative to the previous node instead of as
direct screen positions.</p>
<p>You can build a path using the node adding functions such as
<a class="link" href="ClutterPath.html#clutter-path-add-line-to" title="clutter_path_add_line_to ()"><code class="function">clutter_path_add_line_to()</code></a>. Alternatively the path can be described
in a string using a subset of the SVG path syntax. See
<a class="link" href="ClutterPath.html#clutter-path-add-string" title="clutter_path_add_string ()"><code class="function">clutter_path_add_string()</code></a> for details.</p>
<p><a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a> is available since Clutter 1.0</p>
</div>
<div class="refsect1">
<a name="ClutterPath.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="ClutterPathCallback"></a><h3>ClutterPathCallback ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*ClutterPathCallback<span class="c_punctuation">)</span> (<em class="parameter"><code>const <a class="link" href="ClutterPath.html#ClutterPathNode"><span class="type">ClutterPathNode</span></a> *node</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
<p>This function is passed to <a class="link" href="ClutterPath.html#clutter-path-foreach" title="clutter_path_foreach ()"><code class="function">clutter_path_foreach()</code></a> and will be
called for each node contained in the path.</p>
<div class="refsect3">
<a name="ClutterPathCallback.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>node</p></td>
<td class="parameter_description"><p>the node</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>optional data passed to the function. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-path-new"></a><h3>clutter_path_new ()</h3>
<pre class="programlisting"><a class="link" href="ClutterPath.html" title="ClutterPath"><span class="returnvalue">ClutterPath</span></a> *
clutter_path_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new <a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a> instance with no nodes.</p>
<p>The object has a floating reference so if you add it to a
<a class="link" href="ClutterBehaviourPath.html" title="ClutterBehaviourPath"><span class="type">ClutterBehaviourPath</span></a> then you do not need to unref it.</p>
<div class="refsect3">
<a name="clutter-path-new.returns"></a><h4>Returns</h4>
<p> the newly created <a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a></p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-path-new-with-description"></a><h3>clutter_path_new_with_description ()</h3>
<pre class="programlisting"><a class="link" href="ClutterPath.html" title="ClutterPath"><span class="returnvalue">ClutterPath</span></a> *
clutter_path_new_with_description (<em class="parameter"><code>const <span class="type">gchar</span> *desc</code></em>);</pre>
<p>Creates a new <a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a> instance with the nodes described in
<em class="parameter"><code>desc</code></em>
. See <a class="link" href="ClutterPath.html#clutter-path-add-string" title="clutter_path_add_string ()"><code class="function">clutter_path_add_string()</code></a> for details of the format of
the string.</p>
<p>The object has a floating reference so if you add it to a
<a class="link" href="ClutterBehaviourPath.html" title="ClutterBehaviourPath"><span class="type">ClutterBehaviourPath</span></a> then you do not need to unref it.</p>
<div class="refsect3">
<a name="clutter-path-new-with-description.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>desc</p></td>
<td class="parameter_description"><p>a string describing the path</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-path-new-with-description.returns"></a><h4>Returns</h4>
<p> the newly created <a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a></p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-path-add-move-to"></a><h3>clutter_path_add_move_to ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_path_add_move_to (<em class="parameter"><code><a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a> *path</code></em>,
<em class="parameter"><code><span class="type">gint</span> x</code></em>,
<em class="parameter"><code><span class="type">gint</span> y</code></em>);</pre>
<p>Adds a <a class="link" href="ClutterPath.html#CLUTTER-PATH-MOVE-TO:CAPS"><code class="literal">CLUTTER_PATH_MOVE_TO</code></a> type node to the path. This is usually
used as the first node in a path. It can also be used in the middle
of the path to cause the actor to jump to the new coordinate.</p>
<div class="refsect3">
<a name="clutter-path-add-move-to.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>path</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>x</p></td>
<td class="parameter_description"><p>the x coordinate</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>y</p></td>
<td class="parameter_description"><p>the y coordinate</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-path-add-rel-move-to"></a><h3>clutter_path_add_rel_move_to ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_path_add_rel_move_to (<em class="parameter"><code><a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a> *path</code></em>,
<em class="parameter"><code><span class="type">gint</span> x</code></em>,
<em class="parameter"><code><span class="type">gint</span> y</code></em>);</pre>
<p>Same as <a class="link" href="ClutterPath.html#clutter-path-add-move-to" title="clutter_path_add_move_to ()"><code class="function">clutter_path_add_move_to()</code></a> except the coordinates are
relative to the previous node.</p>
<div class="refsect3">
<a name="clutter-path-add-rel-move-to.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>path</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>x</p></td>
<td class="parameter_description"><p>the x coordinate</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>y</p></td>
<td class="parameter_description"><p>the y coordinate</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-path-add-line-to"></a><h3>clutter_path_add_line_to ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_path_add_line_to (<em class="parameter"><code><a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a> *path</code></em>,
<em class="parameter"><code><span class="type">gint</span> x</code></em>,
<em class="parameter"><code><span class="type">gint</span> y</code></em>);</pre>
<p>Adds a <a class="link" href="ClutterPath.html#CLUTTER-PATH-LINE-TO:CAPS"><code class="literal">CLUTTER_PATH_LINE_TO</code></a> type node to the path. This causes the
actor to move to the new coordinates in a straight line.</p>
<div class="refsect3">
<a name="clutter-path-add-line-to.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>path</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>x</p></td>
<td class="parameter_description"><p>the x coordinate</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>y</p></td>
<td class="parameter_description"><p>the y coordinate</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-path-add-rel-line-to"></a><h3>clutter_path_add_rel_line_to ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_path_add_rel_line_to (<em class="parameter"><code><a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a> *path</code></em>,
<em class="parameter"><code><span class="type">gint</span> x</code></em>,
<em class="parameter"><code><span class="type">gint</span> y</code></em>);</pre>
<p>Same as <a class="link" href="ClutterPath.html#clutter-path-add-line-to" title="clutter_path_add_line_to ()"><code class="function">clutter_path_add_line_to()</code></a> except the coordinates are
relative to the previous node.</p>
<div class="refsect3">
<a name="clutter-path-add-rel-line-to.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>path</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>x</p></td>
<td class="parameter_description"><p>the x coordinate</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>y</p></td>
<td class="parameter_description"><p>the y coordinate</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-path-add-curve-to"></a><h3>clutter_path_add_curve_to ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_path_add_curve_to (<em class="parameter"><code><a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a> *path</code></em>,
<em class="parameter"><code><span class="type">gint</span> x_1</code></em>,
<em class="parameter"><code><span class="type">gint</span> y_1</code></em>,
<em class="parameter"><code><span class="type">gint</span> x_2</code></em>,
<em class="parameter"><code><span class="type">gint</span> y_2</code></em>,
<em class="parameter"><code><span class="type">gint</span> x_3</code></em>,
<em class="parameter"><code><span class="type">gint</span> y_3</code></em>);</pre>
<p>Adds a <a class="link" href="ClutterPath.html#CLUTTER-PATH-CURVE-TO:CAPS"><code class="literal">CLUTTER_PATH_CURVE_TO</code></a> type node to the path. This causes
the actor to follow a bezier from the last node to (<em class="parameter"><code>x_3</code></em>
, <em class="parameter"><code>y_3</code></em>
) using
(<em class="parameter"><code>x_1</code></em>
, <em class="parameter"><code>y_1</code></em>
) and (<em class="parameter"><code>x_2</code></em>
,<em class="parameter"><code>y_2</code></em>
) as control points.</p>
<div class="refsect3">
<a name="clutter-path-add-curve-to.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>path</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>x_1</p></td>
<td class="parameter_description"><p>the x coordinate of the first control point</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>y_1</p></td>
<td class="parameter_description"><p>the y coordinate of the first control point</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>x_2</p></td>
<td class="parameter_description"><p>the x coordinate of the second control point</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>y_2</p></td>
<td class="parameter_description"><p>the y coordinate of the second control point</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>x_3</p></td>
<td class="parameter_description"><p>the x coordinate of the third control point</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>y_3</p></td>
<td class="parameter_description"><p>the y coordinate of the third control point</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-path-add-rel-curve-to"></a><h3>clutter_path_add_rel_curve_to ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_path_add_rel_curve_to (<em class="parameter"><code><a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a> *path</code></em>,
<em class="parameter"><code><span class="type">gint</span> x_1</code></em>,
<em class="parameter"><code><span class="type">gint</span> y_1</code></em>,
<em class="parameter"><code><span class="type">gint</span> x_2</code></em>,
<em class="parameter"><code><span class="type">gint</span> y_2</code></em>,
<em class="parameter"><code><span class="type">gint</span> x_3</code></em>,
<em class="parameter"><code><span class="type">gint</span> y_3</code></em>);</pre>
<p>Same as <a class="link" href="ClutterPath.html#clutter-path-add-curve-to" title="clutter_path_add_curve_to ()"><code class="function">clutter_path_add_curve_to()</code></a> except the coordinates are
relative to the previous node.</p>
<div class="refsect3">
<a name="clutter-path-add-rel-curve-to.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>path</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>x_1</p></td>
<td class="parameter_description"><p>the x coordinate of the first control point</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>y_1</p></td>
<td class="parameter_description"><p>the y coordinate of the first control point</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>x_2</p></td>
<td class="parameter_description"><p>the x coordinate of the second control point</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>y_2</p></td>
<td class="parameter_description"><p>the y coordinate of the second control point</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>x_3</p></td>
<td class="parameter_description"><p>the x coordinate of the third control point</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>y_3</p></td>
<td class="parameter_description"><p>the y coordinate of the third control point</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-path-add-close"></a><h3>clutter_path_add_close ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_path_add_close (<em class="parameter"><code><a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a> *path</code></em>);</pre>
<p>Adds a <a class="link" href="ClutterPath.html#CLUTTER-PATH-CLOSE:CAPS"><code class="literal">CLUTTER_PATH_CLOSE</code></a> type node to the path. This creates a
straight line from the last node to the last <a class="link" href="ClutterPath.html#CLUTTER-PATH-MOVE-TO:CAPS"><code class="literal">CLUTTER_PATH_MOVE_TO</code></a>
type node.</p>
<div class="refsect3">
<a name="clutter-path-add-close.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>path</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-path-add-string"></a><h3>clutter_path_add_string ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
clutter_path_add_string (<em class="parameter"><code><a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a> *path</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *str</code></em>);</pre>
<p>Adds new nodes to the end of the path as described in <em class="parameter"><code>str</code></em>
. The
format is a subset of the SVG path format. Each node is represented
by a letter and is followed by zero, one or three pairs of
coordinates. The coordinates can be separated by spaces or a
comma. The types are:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p><code class="literal">M</code>: Adds a <a class="link" href="ClutterPath.html#CLUTTER-PATH-MOVE-TO:CAPS"><code class="literal">CLUTTER_PATH_MOVE_TO</code></a> node. Takes one pair of coordinates.</p></li>
<li class="listitem"><p><code class="literal">L</code>: Adds a <a class="link" href="ClutterPath.html#CLUTTER-PATH-LINE-TO:CAPS"><code class="literal">CLUTTER_PATH_LINE_TO</code></a> node. Takes one pair of coordinates.</p></li>
<li class="listitem"><p><code class="literal">C</code>: Adds a <a class="link" href="ClutterPath.html#CLUTTER-PATH-CURVE-TO:CAPS"><code class="literal">CLUTTER_PATH_CURVE_TO</code></a> node. Takes three pairs of coordinates.</p></li>
<li class="listitem"><p><code class="literal">z</code>: Adds a <a class="link" href="ClutterPath.html#CLUTTER-PATH-CLOSE:CAPS"><code class="literal">CLUTTER_PATH_CLOSE</code></a> node. No coordinates are needed.</p></li>
</ul></div>
<p>The M, L and C commands can also be specified in lower case which
means the coordinates are relative to the previous node.</p>
<p>For example, to move an actor in a 100 by 100 pixel square centered
on the point 300,300 you could use the following path:</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="normal">M </span><span class="number">250</span><span class="symbol">,</span><span class="number">350</span><span class="normal"> l </span><span class="number">0</span><span class="normal"> </span><span class="symbol">-</span><span class="number">100</span><span class="normal"> L </span><span class="number">350</span><span class="symbol">,</span><span class="number">250</span><span class="normal"> l </span><span class="number">0</span><span class="normal"> </span><span class="number">100</span><span class="normal"> z</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p></p>
<p>If the path description isn't valid <code class="literal">FALSE</code> will be returned and no
nodes will be added.</p>
<div class="refsect3">
<a name="clutter-path-add-string.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>path</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>str</p></td>
<td class="parameter_description"><p>a string describing the new nodes</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-path-add-string.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> is the path description was valid or <code class="literal">FALSE</code>
otherwise.</p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-path-add-node"></a><h3>clutter_path_add_node ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_path_add_node (<em class="parameter"><code><a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a> *path</code></em>,
<em class="parameter"><code>const <a class="link" href="ClutterPath.html#ClutterPathNode"><span class="type">ClutterPathNode</span></a> *node</code></em>);</pre>
<p>Adds <em class="parameter"><code>node</code></em>
to the end of the path.</p>
<div class="refsect3">
<a name="clutter-path-add-node.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>path</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>node</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterPath.html#ClutterPathNode"><span class="type">ClutterPathNode</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-path-add-cairo-path"></a><h3>clutter_path_add_cairo_path ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_path_add_cairo_path (<em class="parameter"><code><a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a> *path</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/cairo/cairo-Paths.html#cairo-path-t"><span class="type">cairo_path_t</span></a> *cpath</code></em>);</pre>
<p>Add the nodes of the Cairo path to the end of <em class="parameter"><code>path</code></em>
.</p>
<div class="refsect3">
<a name="clutter-path-add-cairo-path.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>path</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cpath</p></td>
<td class="parameter_description"><p>a Cairo path</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-path-get-n-nodes"></a><h3>clutter_path_get_n_nodes ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
clutter_path_get_n_nodes (<em class="parameter"><code><a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a> *path</code></em>);</pre>
<p>Retrieves the number of nodes in the path.</p>
<div class="refsect3">
<a name="clutter-path-get-n-nodes.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>path</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-path-get-n-nodes.returns"></a><h4>Returns</h4>
<p> the number of nodes.</p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-path-get-node"></a><h3>clutter_path_get_node ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_path_get_node (<em class="parameter"><code><a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a> *path</code></em>,
<em class="parameter"><code><span class="type">guint</span> index_</code></em>,
<em class="parameter"><code><a class="link" href="ClutterPath.html#ClutterPathNode"><span class="type">ClutterPathNode</span></a> *node</code></em>);</pre>
<p>Retrieves the node of the path indexed by <em class="parameter"><code>index</code></em>
.</p>
<div class="refsect3">
<a name="clutter-path-get-node.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>path</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>index_</p></td>
<td class="parameter_description"><p>the node number to retrieve</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>node</p></td>
<td class="parameter_description"><p>a location to store a copy of the node. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-path-get-nodes"></a><h3>clutter_path_get_nodes ()</h3>
<pre class="programlisting"><span class="returnvalue">GSList</span> *
clutter_path_get_nodes (<em class="parameter"><code><a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a> *path</code></em>);</pre>
<p>Returns a <span class="type">GSList</span> of <a class="link" href="ClutterPath.html#ClutterPathNode"><span class="type">ClutterPathNode</span></a>s. The list should be
freed with <code class="function">g_slist_free()</code>. The nodes are owned by the path and
should not be freed. Altering the path may cause the nodes in the
list to become invalid so you should copy them if you want to keep
the list.</p>
<div class="refsect3">
<a name="clutter-path-get-nodes.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>path</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-path-get-nodes.returns"></a><h4>Returns</h4>
<p>a
list of nodes in the path. </p>
<p><span class="annotation">[<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> Clutter.PathNode]</span></p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-path-foreach"></a><h3>clutter_path_foreach ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_path_foreach (<em class="parameter"><code><a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a> *path</code></em>,
<em class="parameter"><code><a class="link" href="ClutterPath.html#ClutterPathCallback" title="ClutterPathCallback ()"><span class="type">ClutterPathCallback</span></a> callback</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>Calls a function for each node of the path.</p>
<div class="refsect3">
<a name="clutter-path-foreach.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>path</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>callback</p></td>
<td class="parameter_description"><p>the function to call with each node. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid only during the call to the method."><span class="acronym">scope call</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data to pass to the function</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-path-insert-node"></a><h3>clutter_path_insert_node ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_path_insert_node (<em class="parameter"><code><a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a> *path</code></em>,
<em class="parameter"><code><span class="type">gint</span> index_</code></em>,
<em class="parameter"><code>const <a class="link" href="ClutterPath.html#ClutterPathNode"><span class="type">ClutterPathNode</span></a> *node</code></em>);</pre>
<p>Inserts <em class="parameter"><code>node</code></em>
into the path before the node at the given offset. If
<em class="parameter"><code>index_</code></em>
is negative it will append the node to the end of the path.</p>
<div class="refsect3">
<a name="clutter-path-insert-node.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>path</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>index_</p></td>
<td class="parameter_description"><p>offset of where to insert the node</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>node</p></td>
<td class="parameter_description"><p>the node to insert</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-path-remove-node"></a><h3>clutter_path_remove_node ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_path_remove_node (<em class="parameter"><code><a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a> *path</code></em>,
<em class="parameter"><code><span class="type">guint</span> index_</code></em>);</pre>
<p>Removes the node at the given offset from the path.</p>
<div class="refsect3">
<a name="clutter-path-remove-node.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>path</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>index_</p></td>
<td class="parameter_description"><p>index of the node to remove</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-path-replace-node"></a><h3>clutter_path_replace_node ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_path_replace_node (<em class="parameter"><code><a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a> *path</code></em>,
<em class="parameter"><code><span class="type">guint</span> index_</code></em>,
<em class="parameter"><code>const <a class="link" href="ClutterPath.html#ClutterPathNode"><span class="type">ClutterPathNode</span></a> *node</code></em>);</pre>
<p>Replaces the node at offset <em class="parameter"><code>index_</code></em>
with <em class="parameter"><code>node</code></em>
.</p>
<div class="refsect3">
<a name="clutter-path-replace-node.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>path</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>index_</p></td>
<td class="parameter_description"><p>index to the existing node</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>node</p></td>
<td class="parameter_description"><p>the replacement node</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-path-get-description"></a><h3>clutter_path_get_description ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
clutter_path_get_description (<em class="parameter"><code><a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a> *path</code></em>);</pre>
<p>Returns a newly allocated string describing the path in the same
format as used by <a class="link" href="ClutterPath.html#clutter-path-add-string" title="clutter_path_add_string ()"><code class="function">clutter_path_add_string()</code></a>.</p>
<div class="refsect3">
<a name="clutter-path-get-description.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>path</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-path-get-description.returns"></a><h4>Returns</h4>
<p> a string description of the path. Free with <code class="function">g_free()</code>.</p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-path-set-description"></a><h3>clutter_path_set_description ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
clutter_path_set_description (<em class="parameter"><code><a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a> *path</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *str</code></em>);</pre>
<p>Replaces all of the nodes in the path with nodes described by
<em class="parameter"><code>str</code></em>
. See <a class="link" href="ClutterPath.html#clutter-path-add-string" title="clutter_path_add_string ()"><code class="function">clutter_path_add_string()</code></a> for details of the format.</p>
<p>If the string is invalid then <code class="literal">FALSE</code> is returned and the path is
unaltered.</p>
<div class="refsect3">
<a name="clutter-path-set-description.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>path</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>str</p></td>
<td class="parameter_description"><p>a string describing the path</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-path-set-description.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> is the path was valid, <code class="literal">FALSE</code> otherwise.</p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-path-to-cairo-path"></a><h3>clutter_path_to_cairo_path ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_path_to_cairo_path (<em class="parameter"><code><a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a> *path</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/cairo/cairo-cairo-t.html#cairo-t"><span class="type">cairo_t</span></a> *cr</code></em>);</pre>
<p>Add the nodes of the ClutterPath to the path in the Cairo context.</p>
<div class="refsect3">
<a name="clutter-path-to-cairo-path.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>path</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cr</p></td>
<td class="parameter_description"><p>a Cairo context</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-path-clear"></a><h3>clutter_path_clear ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_path_clear (<em class="parameter"><code><a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a> *path</code></em>);</pre>
<p>Removes all nodes from the path.</p>
<div class="refsect3">
<a name="clutter-path-clear.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>path</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-path-get-position"></a><h3>clutter_path_get_position ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
clutter_path_get_position (<em class="parameter"><code><a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a> *path</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> progress</code></em>,
<em class="parameter"><code><a class="link" href="clutter-Base-geometric-types.html#ClutterKnot"><span class="type">ClutterKnot</span></a> *position</code></em>);</pre>
<p>The value in <em class="parameter"><code>progress</code></em>
represents a position along the path where
0.0 is the beginning and 1.0 is the end of the path. An
interpolated position is then stored in <em class="parameter"><code>position</code></em>
.</p>
<div class="refsect3">
<a name="clutter-path-get-position.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>path</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>progress</p></td>
<td class="parameter_description"><p>a position along the path as a fraction of its length</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>position</p></td>
<td class="parameter_description"><p>location to store the position. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-path-get-position.returns"></a><h4>Returns</h4>
<p> index of the node used to calculate the position.</p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-path-get-length"></a><h3>clutter_path_get_length ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
clutter_path_get_length (<em class="parameter"><code><a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a> *path</code></em>);</pre>
<p>Retrieves an approximation of the total length of the path.</p>
<div class="refsect3">
<a name="clutter-path-get-length.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>path</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-path-get-length.returns"></a><h4>Returns</h4>
<p> the length of the path.</p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-path-node-copy"></a><h3>clutter_path_node_copy ()</h3>
<pre class="programlisting"><a class="link" href="ClutterPath.html#ClutterPathNode"><span class="returnvalue">ClutterPathNode</span></a> *
clutter_path_node_copy (<em class="parameter"><code>const <a class="link" href="ClutterPath.html#ClutterPathNode"><span class="type">ClutterPathNode</span></a> *node</code></em>);</pre>
<p>Makes an allocated copy of a node.</p>
<div class="refsect3">
<a name="clutter-path-node-copy.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>node</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterPath.html#ClutterPathNode"><span class="type">ClutterPathNode</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-path-node-copy.returns"></a><h4>Returns</h4>
<p> the copied node.</p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-path-node-free"></a><h3>clutter_path_node_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_path_node_free (<em class="parameter"><code><a class="link" href="ClutterPath.html#ClutterPathNode"><span class="type">ClutterPathNode</span></a> *node</code></em>);</pre>
<p>Frees the memory of an allocated node.</p>
<div class="refsect3">
<a name="clutter-path-node-free.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>node</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterPath.html#ClutterPathNode"><span class="type">ClutterPathNode</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-path-node-equal"></a><h3>clutter_path_node_equal ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
clutter_path_node_equal (<em class="parameter"><code>const <a class="link" href="ClutterPath.html#ClutterPathNode"><span class="type">ClutterPathNode</span></a> *node_a</code></em>,
<em class="parameter"><code>const <a class="link" href="ClutterPath.html#ClutterPathNode"><span class="type">ClutterPathNode</span></a> *node_b</code></em>);</pre>
<p>Compares two nodes and checks if they are the same type with the
same coordinates.</p>
<div class="refsect3">
<a name="clutter-path-node-equal.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>node_a</p></td>
<td class="parameter_description"><p>First node</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>node_b</p></td>
<td class="parameter_description"><p>Second node</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-path-node-equal.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the nodes are the same.</p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
</div>
<div class="refsect1">
<a name="ClutterPath.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="ClutterPath-struct"></a><h3>ClutterPath</h3>
<pre class="programlisting">typedef struct _ClutterPath ClutterPath;</pre>
<p>The <a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a> struct contains only private data and should
be accessed with the functions below.</p>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterPathClass"></a><h3>struct ClutterPathClass</h3>
<pre class="programlisting">struct ClutterPathClass {
};
</pre>
<p>The <a class="link" href="ClutterPath.html#ClutterPathClass" title="struct ClutterPathClass"><span class="type">ClutterPathClass</span></a> struct contains only private data.</p>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterPathNodeType"></a><h3>enum ClutterPathNodeType</h3>
<p>Types of nodes in a <a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a>.</p>
<div class="refsect3">
<a name="ClutterPathNodeType.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="CLUTTER-PATH-MOVE-TO:CAPS"></a>CLUTTER_PATH_MOVE_TO</p></td>
<td class="enum_member_description">
<p>jump to the given position</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="CLUTTER-PATH-LINE-TO:CAPS"></a>CLUTTER_PATH_LINE_TO</p></td>
<td class="enum_member_description">
<p>create a line from the last node to the
given position</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="CLUTTER-PATH-CURVE-TO:CAPS"></a>CLUTTER_PATH_CURVE_TO</p></td>
<td class="enum_member_description">
<p>bezier curve using the last position and
three control points.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="CLUTTER-PATH-CLOSE:CAPS"></a>CLUTTER_PATH_CLOSE</p></td>
<td class="enum_member_description">
<p>create a line from the last node to the last
<a class="link" href="ClutterPath.html#CLUTTER-PATH-MOVE-TO:CAPS"><code class="literal">CLUTTER_PATH_MOVE_TO</code></a> node.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="CLUTTER-PATH-REL-MOVE-TO:CAPS"></a>CLUTTER_PATH_REL_MOVE_TO</p></td>
<td class="enum_member_description">
<p>same as <a class="link" href="ClutterPath.html#CLUTTER-PATH-MOVE-TO:CAPS"><code class="literal">CLUTTER_PATH_MOVE_TO</code></a> but with
coordinates relative to the last node.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="CLUTTER-PATH-REL-LINE-TO:CAPS"></a>CLUTTER_PATH_REL_LINE_TO</p></td>
<td class="enum_member_description">
<p>same as <a class="link" href="ClutterPath.html#CLUTTER-PATH-LINE-TO:CAPS"><code class="literal">CLUTTER_PATH_LINE_TO</code></a> but with
coordinates relative to the last node.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="CLUTTER-PATH-REL-CURVE-TO:CAPS"></a>CLUTTER_PATH_REL_CURVE_TO</p></td>
<td class="enum_member_description">
<p>same as <a class="link" href="ClutterPath.html#CLUTTER-PATH-CURVE-TO:CAPS"><code class="literal">CLUTTER_PATH_CURVE_TO</code></a> but with
coordinates relative to the last node.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterPathNode-struct"></a><h3>struct ClutterPathNode</h3>
<pre class="programlisting">struct ClutterPathNode {
ClutterPathNodeType type;
ClutterKnot points[3];
};
</pre>
<p>Represents a single node of a <a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a>.</p>
<p>Some of the coordinates in <em class="parameter"><code>points</code></em>
may be unused for some node
types. <a class="link" href="ClutterPath.html#CLUTTER-PATH-MOVE-TO:CAPS"><code class="literal">CLUTTER_PATH_MOVE_TO</code></a> and <a class="link" href="ClutterPath.html#CLUTTER-PATH-LINE-TO:CAPS"><code class="literal">CLUTTER_PATH_LINE_TO</code></a> use only one
pair of coordinates, <a class="link" href="ClutterPath.html#CLUTTER-PATH-CURVE-TO:CAPS"><code class="literal">CLUTTER_PATH_CURVE_TO</code></a> uses all three and
<a class="link" href="ClutterPath.html#CLUTTER-PATH-CLOSE:CAPS"><code class="literal">CLUTTER_PATH_CLOSE</code></a> uses none.</p>
<div class="refsect3">
<a name="ClutterPathNode.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><a class="link" href="ClutterPath.html#ClutterPathNodeType" title="enum ClutterPathNodeType"><span class="type">ClutterPathNodeType</span></a> <em class="structfield"><code><a name="ClutterPathNode-struct.type"></a>type</code></em>;</p></td>
<td class="struct_member_description"><p>the node's type</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a class="link" href="clutter-Base-geometric-types.html#ClutterKnot"><span class="type">ClutterKnot</span></a> <em class="structfield"><code><a name="ClutterPathNode-struct.points"></a>points</code></em>[3];</p></td>
<td class="struct_member_description"><p>the coordinates of the node</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
</div>
<div class="refsect1">
<a name="ClutterPath.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="ClutterPath--description"></a><h3>The <code class="literal">“description”</code> property</h3>
<pre class="programlisting"> “description” <span class="type">gchar</span> *</pre>
<p>SVG-style description of the path.</p>
<p>Flags: Read / Write</p>
<p>Default value: ""</p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterPath--length"></a><h3>The <code class="literal">“length”</code> property</h3>
<pre class="programlisting"> “length” <span class="type">guint</span></pre>
<p>An approximation of the total length of the path.</p>
<p>Flags: Read</p>
<p>Default value: 0</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.29</div>
</body>
</html>
|
