summaryrefslogtreecommitdiffstats
path: root/koffice-i18n-ca/docs/koffice/chalk/developers-scripting.docbook
blob: b21bad3a13054220daadd1d2338349196acf080e (plain)
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
<sect1 id="developers-scripting">
<title
>Programació amb scripts</title>

<para
>En el &chalk;, podeu escriure scripts en Ruby o Python (la disponibilitat dels intèrprets pot dependre d'on els ha instal·lat el vostre administrador o la vostra distribució a la màquina). Aquí trobareu una descripció de l'scripting API. </para
><para
>Alguns exemples es distribueixen amb el &chalk;, i els haurieu de trobar a <filename
>/usr/share/apps/chalk/scripts</filename
> (o <filename
>/opt/kde/share/apps/chalk/scripts</filename
>). </para>

<sect2 id="developers-scripting-variables">
<title
>Variables en el mòdul <classname
>Krosschalkcore</classname
></title>

<itemizedlist>
<listitem
><para
><varname
>ChalkDocument</varname
> retorna un objecte <classname
>Document</classname
></para
></listitem>
<listitem
><para
><varname
>ChalkScript</varname
> retorna un objecte <classname
>ScriptProgress</classname
></para
></listitem>
</itemizedlist>

<para
>Podeu obtenir un objecte usant la funció <function
>get</function
> del mòdul <classname
>Krosschalkcore</classname
>. En Ruby haureu d'escriure alguna cosa com aquesta: <programlisting
>doc = Krosschalkcore::get("ChalkDocument")
script = Krosschalkcore::get("ChalkScript")
</programlisting>
</para>

</sect2>

<sect2 id="developers-scripting-functions">
<title
>Funcions en el mòdul <classname
>Krosschalkcore</classname
></title>

<itemizedlist>
<listitem
><para
>Funció: <function
>getBrush</function
></para
><para
>Aquesta funció retorna un <classname
>Brush</classname
> agafat de la llista de recursos del &chalk;. Agafa un argument: el nom del pinzell. Per exemple (en Ruby): <programlisting
>Krosschalkcore::getBrush("Circle (05)")
</programlisting
></para
></listitem>

<listitem
><para
>Funció: <function
>getFilter</function
></para
><para
>Aquesta funció retorna un <classname
>Filter</classname
> agafat de la llista de recursos del &chalk;. Agafa un argument: el nom del filtre. Per exemple (en Ruby): <programlisting
>Krosschalkcore::getFilter("invert")
</programlisting
></para
></listitem>

<listitem
><para
>Funció: <function
>getPattern</function
></para
><para
>Aquesta funció retorna un <classname
>Pattern</classname
> agafat de la llista de recursos del &chalk;. Agafa un argument: el nom del patró. Per exemple (en Ruby): <programlisting
>Krosschalkcore::getPattern("Bricks")
</programlisting
></para
></listitem>

<listitem
><para
>Funció: <function
>loadBrush</function
></para
><para
>Aquesta funció carrega un <classname
>Brush</classname
> agafat de la llista de recursos del &chalk;. Agafa un argument: el nom del pinzell.</para
></listitem>

<listitem
><para
>Funció: <function
>loadPattern</function
></para
><para
>Aquesta funció carrega un <classname
>Pattern</classname
> i llavors el retorna. Agafa un argument: el nom de fitxer del patró.</para
></listitem>

<listitem
><para
>Funció: <function
>newCircleBrush</function
></para
><para
>Aquesta funció retorna un <classname
>Brush</classname
> amb forma circular. Agafa almenys dos arguments: ample i alçada. Pot agafar-ne dos més: amplada i alçada de l'ombra. Si no està especificada l'ombra, no s'usarà cap ombra. Per exemple (en Ruby): <programlisting
>Krosschalkcore::newCircleBrush(10,20) # create a plain circle
Krosschalkcore::newCircleBrush(10,20,5,10) # create a gradient
</programlisting
></para
></listitem>

<listitem
><para
>Function: <function
>newHSVColor</function
></para
><para
>Aquesta funció retorna un nou <classname
>Color</classname
> amb la tripleta HSV donada. Agafa tres arguments: component de matís (0 a 255), component de saturació (0 a 255), component de valor (0 a 255). Per exemple (en Ruby): <programlisting
>Krosschalkcore::newHSVColor(255,125,0)
</programlisting
></para
></listitem>

<listitem
><para
>Funció: <function
>newImage</function
></para
><para
>Aquesta funció retorna una nova <classname
>Image</classname
>. Agafa quatre arguments: amplada, alçada, identificació de l'espai de color, nom de la imatge. I de retorn obteniu un objecte <classname
>Image</classname
>. Per exemple (en Ruby): <programlisting
>Krosschalkcore::newImage(10,20, "RGBA", "kikoo")
</programlisting
></para
></listitem>

<listitem
><para
>Funció: <function
>newRectBrush</function
></para
><para
>Aquesta funció retorna un <classname
>Brush</classname
> amb forma rectangular. Agafa almenys dos arguments: ample i alçada. Pot agafar-ne dos més: amplada i alçada de l'ombra. Si no està especificada l'ombra, no s'usarà cap ombra. Per exemple (en Ruby): <programlisting
>Krosschalkcore::newRectBrush(10,20) # create a plain rectangle
 Krosschalkcore::newRectBrush(10,20,5,10) # create a gradient
</programlisting
></para
></listitem>

<listitem
><para
>Funció: <function
>newRGBColor</function
></para
><para
>Aquesta funció retorna un nou <classname
>Color</classname
> amb la tripleta RGB donada. Agafa tres arguments: component de vermell (0 a 255), component de blau (0 a 255), component de verd (0 a 255). Per exemple (en Ruby): <programlisting
>Krosschalkcore::newRGBColor(255,0,0) # create a red color
Krosschalkcore::newRGBColor(255,255,255) # create a white color
</programlisting
></para
></listitem>
</itemizedlist>
</sect2>

<sect2 id="developers-scripting-objects">
<title
>Descripcions i llistes de funció per a diversos objectes en <classname
>Krosschalkcore</classname
></title>

<itemizedlist>
<listitem
><para
>Objecte: PaintLayer</para>

<itemizedlist>
<listitem
><para
>Funció: <function
>beginPainting</function
></para
></listitem>

<listitem
><para
>Funció: <function
>convertToColorspace</function
></para
><para
>Converteix la imatge a un espai de color. Aquesta funció agafa un argument: el nom de l'espai de color de destí. Per exemple (en Ruby): <programlisting
>image.convertToColorspace("CMYK")
</programlisting
></para
></listitem>

<listitem
><para
>Funció: <function
>createHistogram</function
></para
><para
>Aquesta funció crea un Histograma per a aquesta capa. Agafa dos arguments: el tipus d'histograma ("RGB8HISTO"), i 0 si l'histograma és liniar, o 1 si és logarítmic.</para
></listitem>

<listitem
><para
>Funció: <function
>createHLineIterator</function
></para
><para
>Crea un iterator sobre una capa, interactuarà en una fila. Aquesta funció agafa tres arguments: <varname
>x</varname
> (comença a la fila), <varname
>y</varname
> (posició vertical de la fila), amplada de la fila.</para
></listitem>

<listitem
><para
>Funció: <function
>createPainter</function
></para
><para
>Aquesta funció crea un <classname
>Painter</classname
> que us permetrà de dibuixar a la capa. </para
></listitem>

<listitem
><para
>Funció: <function
>createRectIterator</function
></para
><para
>Crea un iterator sobre una capa, iteractuarà sobre un àrea rectangular. Aquesta funció agafa quatre arguments: <varname
>x</varname
>, <varname
>y</varname
>, amplada del rectangle, alçada del rectangle.</para
></listitem>

<listitem
><para
>Funció: <function
>createVLineIterator</function
></para
><para
>Crea in iterator sobre una capa, interactuarà sobre una columna. Aquesta funció agafa tres arguments: <varname
>x</varname
> (posició horitzontal de la  columna), <varname
>y</varname
> (inici de la columna), alçada de la columna.</para
></listitem>

<listitem
><para
>Funció: <function
>endPainting</function
></para
><para
>Aquesta funció tanca l'entrada actual de desfés i l'afegeix a l'historial.</para
></listitem>

<listitem
><para
>Funció: <function
>fastWaveletTransformation</function
></para
><para
>Retorna la transformació ràpida d'ona de la capa.</para
></listitem>

<listitem
><para
>Funció: <function
>fastWaveletUntransformation</function
></para
><para
>Destransforma una ona ràpida a la seva capa. Agafa un argument: un objecte d'ona. Per exemple (en Ruby): <programlisting
>wavelet = layer.fastWaveletTransformation()
layer.fastWaveletUntransformation(wavelet)
</programlisting
></para
></listitem>

<listitem
><para
>Funció: <function
>getHeight</function
></para
><para
>Retorna l'alçada de la capa.</para
></listitem>

<listitem
><para
>Funció: <function
>getWidth</function
></para
><para
>Retorna l'amplada de la capa.</para
></listitem>
</itemizedlist>
</listitem>

<listitem
><para
>Objecte: <classname
>Filter</classname
></para>
<itemizedlist>

<listitem
><para
>Funció: <function
>getFilterConfiguration</function
></para
><para
>Aquesta funció retorna el <classname
>FilterConfiguration</classname
> associat amb aquest filtre.</para
></listitem>

<listitem
><para
>Funció: <function
>process</function
></para
><para
>Aquesta funció aplicarà el filtre. Agafa almenys un argument: la capa font. També podeu usar aquests quatre aguments: <varname
>x</varname
>, <varname
>y</varname
>, <varname
>amplada</varname
>, <varname
>alçada</varname
>. (<varname
>x</varname
>,<varname
>y</varname
>,<varname
>amplada</varname
>,<varname
>alçada</varname
>) defineix l'àrea rectangular sobre la qual es computarà el filtre. Si el rectangle no està definit, llavors el filtre s'aplicarà sobre tota la capa font. Per exemple (en Ruby): <programlisting
>doc = Krosschalkcore::get("ChalkDocument")
image = doc.getImage()
layer = image.getActivePaintLayer()
width = layer.getWidth()
height = layer.getHeight()
filter = Krosschalkcore::getFilter("invert")
filter.process(layer, layer)
filter.process(layer, layer, 10, 10, 20, 20 )
</programlisting
></para
></listitem>
</itemizedlist
></listitem>

<listitem
><para
>Objecte: <classname
>FilterConfiguration</classname
></para>
<itemizedlist>

<listitem
><para
>Funció: <function
>getProperty</function
></para
><para
>Aquesta funció retorna el valor d'un paràmetre del <classname
>Filter</classname
> associat. Agafa un argument: el nom del paràmetre.</para
></listitem>

<listitem
><para
>Funció: <function
>setProperty</function
></para
><para
>Aquesta funció defineix un paràmetre del <classname
>Filter</classname
> associat. Agafa dos arguments: el nom del paràmetre i el valor, el tipus del qual depén del <classname
>Filter</classname
>.</para
></listitem>
</itemizedlist>
</listitem>

<listitem
><para
>Objecte: <classname
>Histogram</classname
></para>

<para
>Aquesta classe us permet d'accedir l'histogram d'un <classname
>PaintLayer</classname
>. Exemple (en Ruby): <programlisting
>doc = krosschalkcore::get("ChalkDocument")
 image = doc.getImage()
 layer = image.getActiveLayer()
 histo = layer.createHistogram("RGB8HISTO",0)
 min = layer.getMin() * 255
 max = layer.getMax() * 255
 for i in min..max
   print layer.getValue(i)
   print "\n"
 end
</programlisting>
</para>

<itemizedlist>
<listitem
><para
>Funció: <function
>getChannel</function
></para
><para
>Retorna el canal seleccionat.</para
></listitem>

<listitem
><para
>Funció: <function
>getCount</function
></para
><para
>Aquesta funció retorna el número de píxels usats per l'histograma.</para
></listitem>

<listitem
><para
>Funció: <function
>getHighest</function
></para
><para
>Aquesta funció retorna el valor més alt de l'histograma.</para
></listitem>

<listitem
><para
>Funció: <function
>getLowest</function
></para
><para
>Aquesta funció retorna el valor més baix de l'histograma.</para
></listitem>

<listitem
><para
>Funció: <function
>getMax</function
></para
><para
>Aquesta funció retorna el límit màxim de l'histograma (els valors de posició més gran que el màxim són nuls). El valor és en el rang entre 0.0 i 1.0.</para
></listitem>

<listitem
><para
>Funció: <function
>getMean</function
></para
><para
>Aquesta funció retorna la mitjana de l'histograma.</para
></listitem>

<listitem
><para
>Funció: <function
>getMin</function
></para
><para
>Aquesta funció retorna el límit mínim de l'histograma (els valors de posició més petits que el mínim són nuls). El valor és en el rang entre 0.0 i 1.0.</para
></listitem>

<listitem
><para
>Funció: <function
>getNumberOfBins</function
></para
><para
>Retorna el número de bins de l'histograma. </para
></listitem>

<listitem
><para
>Funció: <function
>getTotal</function
></para
><para
>Aquesta funció retorna la suma de tots els valors de l'histograma.</para
></listitem>

<listitem
><para
>Funció: <function
>getValue</function
></para
><para
>Retorna el valor d'un bin de l'histograma. Aquesta funció agafa un argumnet: l'índex, en el rang [0..255].</para
></listitem>

<listitem
><para
>Funció: <function
>setChannel</function
></para
><para
>Selecciona el canal de la cap on posar el resultat de l'histograma. Aquesta funció agafa un argument: el número de canal.</para
></listitem>
</itemizedlist>
</listitem>

<listitem
><para
>Objecte: <classname
>ScriptProgress</classname
></para>
<para
><classname
>ScriptProgress</classname
> s'usa per a gestionar la barra de progrés de la barra d'estatus en el &chalk;. Per exemple (en Ruby): <programlisting
>script = Krosschalkcore::get("ChalkScript")
script.setProgressTotalSteps(1000)
script.setProgressStage("progressive", 0)
for i in 1..900
  script.incProgress()
end
script.setProgressStage("brutal", 1000)
</programlisting
></para>

<itemizedlist>
<listitem
><para
>Funció: <function
>incProgress</function
></para
><para
>Aquesta funció incrementa el progrés en un pas.</para
></listitem>

<listitem
><para
>Funció: <function
>setProgress</function
></para
><para
>Aquesta funció arranja el valor del progrés. Agafa un argument: el valor del progrés.</para
></listitem>

<listitem
><para
>Funció: <function
>setProgressStage</function
></para
><para
>Aquesta funció arranja el valor del progrés i mostra el text.</para
></listitem>

<listitem
><para
>Funció: <function
>setProgressTotalSteps</function
></para
><para
>Aquesta funció arranja el número de passes que requerirà l'script. Agafa un argument: el valor màxim del progrés.</para
></listitem>
</itemizedlist>
</listitem>

<listitem
><para
>Objecte: <classname
>Wavelet</classname
></para
><para
>Aquest objecte conté els coeficients d'una transformació d'ona d'una <classname
>PaintLayer</classname
>.</para>
<itemizedlist>

<listitem
><para
>Funció: <function
>getDepth</function
></para
><para
>Retorna la profunditat de la capa.</para
></listitem>

<listitem
><para
>Funció: <function
>getNCoeff</function
></para
><para
>Retorna el valor de l'enèssim coeficient. Aquesta funció agafa un argument: l'índex del coeficient.</para
></listitem>

<listitem
><para
>Funció: <function
>getNumCoeffs</function
></para
><para
>Retorna el número de coeficients en aquesta ona (= size * size * depth).</para
></listitem>

<listitem
><para
>Funció: <function
>getSize</function
></para
><para
>Retorna la mida de l'ona (size = width = height).</para
></listitem>

<listitem
><para
>Funció: <function
>getXYCoeff</function
></para
><para
>Retorna el valor d'un coeficient. Aquesta funció agafa dos arguments: <varname
>x</varname
> i <varname
>y</varname
>.</para
></listitem>

<listitem
><para
>Funció: <function
>setNCoeff</function
></para
><para
>Arranja el valor de l'enèssim coeficient. Aquesta finció agafa dos arguments: l'índex del coeficient i el nou valor del coeficient.</para
></listitem>

<listitem
><para
>Funció: <function
>setXYCoeff</function
></para
><para
>Arranja el valor d'un coeficient. La funció agafa tres arguments: <varname
>x</varname
>, <varname
>y</varname
>, i  el nou valor del coeficient.</para
></listitem>
</itemizedlist>
</listitem>

<listitem
><para
>Objecte: <classname
>Painter</classname
></para>
<itemizedlist>

<listitem
><para
>Funció: <function
>convolve</function
></para
><para
>Aquesta funció aplica un nucli de convulsió a una imatge. Agafa almenys tres arguments: una llista de nuclis (totes les llistes han de tenir la mateixa mida), el factor i la compensació. </para
><para
>El valor dun píxel vindrà donat per la següent funció: K * P / factor + compensació, on K és el nucli i P és el veïnat. </para
><para
>Pot agafar els següents arguments opcionals: <varname
>borderOp</varname
> (control·la com convolucionar els píxels a la vora d'una imatge: 0 = usa el color per omissió, 1 = usa el píxel de la part oposada de la imatge, 2 = usa el píxel de la vora, 3 = evita els píxels de la vora), <varname
>channel</varname
> (1 per al color, 2 per alfa, 3 per ambdós), <varname
>x</varname
>, <varname
>y</varname
>, <varname
>ample</varname
>, <varname
>alçada</varname
>.</para
></listitem>

<listitem
><para
>Funció: <function
>setFillThreshold</function
></para
><para
>Arranja el llindar ple. Agafa un argument: el llindar.</para
></listitem>

<listitem
><para
>Funció: <function
>fillColor</function
></para
><para
>Comença a omplir amb un color. Agafa dos arguments: <varname
>x</varname
> i <varname
>y</varname
>.</para
></listitem>

<listitem
><para
>Funció: <function
>fillPattern</function
></para
><para
>Comença a omplir un patró. Agafa dos arguments: <varname
>x</varname
> i <varname
>y</varname
>.</para
></listitem>

<listitem
><para
>Funció: <function
>paintPolyline</function
></para
><para
>Aquesta funció dibuixarà una polilínia. Agafa dos arguments: una llista de posicions x i una llista de posicions y.</para
></listitem>

<listitem
><para
>Funció: <function
>paintLine</function
></para
><para
>Aquesta funció dibuixarà una línia. Agafa cinc arguments: <varname
>x1</varname
>, <varname
>y1</varname
>, <varname
>x2</varname
>, <varname
>y2</varname
>, i <varname
>pressure</varname
>. </para
></listitem>

<listitem
><para
>Funció: <function
>paintBezierCurve</function
></para
><para
>Aquesta funció dibuixarà una corba de Bezier. Agafa deu arguments: <varname
>x1</varname
>, <varname
>y1</varname
>, <varname
>p1</varname
>, <varname
>cx1</varname
>, <varname
>cy1</varname
>, <varname
>cx2</varname
>, <varname
>cx2</varname
>, <varname
>x2</varname
>, <varname
>y2</varname
>, <varname
>p2</varname
>, on (<varname
>x1</varname
>,<varname
>y1</varname
>) és la posició d'inici, <varname
>p1</varname
> és la pressió a l'inici, (<varname
>x2</varname
>,<varname
>y2</varname
>) és la posició final, <varname
>p2</varname
> és la pressió al final. (<varname
>cx1</varname
>,<varname
>cy1</varname
>) i (<varname
>cx2</varname
>,<varname
>cy2</varname
>) són les posicions dels punts de control.</para
></listitem>

<listitem
><para
>Funció: <function
>paintEllipse</function
></para
><para
>Aquesta funció dibuixarà una el·lipsi. Agafa cinc arguments: <varname
>x1</varname
>, <varname
>y1</varname
>, <varname
>x2</varname
>, <varname
>y2</varname
>, <varname
>pressure</varname
>, on (<varname
>x1</varname
>,<varname
>y1</varname
>) i (<varname
>x2</varname
>,<varname
>y2</varname
>) són les posicions dels dos centres.</para
></listitem>

<listitem
><para
>Funció: <function
>paintPolygon</function
></para
><para
>Aquesta funció dibuixarà un polígon. Agafa dos arguments: una llista de posicions x i una llista de posicions y.</para
></listitem>

<listitem
><para
>Funció: <function
>paintRect</function
></para
><para
>Aquesta funció dibuixarà un rectangle. Agafa cinc arguments: <varname
>x</varname
>, <varname
>y</varname
>, <varname
>ample</varname
> <varname
>alçada</varname
> i <varname
>pressió</varname
>.</para
></listitem>

<listitem
><para
>Funció: <function
>paintAt</function
></para
><para
>Aquesta funció dibuixarà en una posició donada. Agafa tres arguments: <varname
>x</varname
>, <varname
>y</varname
>, <varname
>pressió</varname
>.</para
></listitem>

<listitem
><para
>Funció: <function
>setPaintColor</function
></para
><para
>Aquesta funció arrajna el color de dibuix (també anomenat color de primer pla). Agafa un argument: un <classname
>Color</classname
>.</para
></listitem>

<listitem
><para
>Funció: <function
>setBackgroundColor</function
></para
><para
>Aquesta funció arranja el color de fons. Agafa un argument: un <classname
>Color</classname
>.</para
></listitem>

<listitem
><para
>Funció: <function
>setPattern</function
></para
><para
>Aquesta funció arranja el patró usat per a l'ompliment. Agafa un argument: un objecte de <classname
>Pattern</classname
>.</para
></listitem>

<listitem
><para
>Funció: <function
>setBrush</function
></para
><para
>Aquesta funció arranja el pinzell a usar en un dibuix. Agafa un argument: un objecte de <classname
>Brush</classname
>.</para
></listitem>

<listitem
><para
>Funció: <function
>setPaintOp</function
></para
><para
>Aquesta funció defineix l'operació de dibuix. Agafa un argument: el nom de l'operació de dibuix.</para
></listitem>

<listitem
><para
>Funció: <function
>setDuplicateOffset</function
></para
><para
>Aquesta funció defineix la compensació duplicada. Agafa dos arguments: la compensació horitzontal i la compensació vertical.</para
></listitem>

<listitem
><para
>Funció: <function
>setOpacity</function
></para
><para
>Aquesta funció arranja l'opacitat del dibuix. Agafa un argument: l'opacitat, en el rang de 0 a 255.</para
></listitem>

<listitem
><para
>Funció: <function
>setStrokeStyle</function
></para
><para
>Aquesta funció arranja l'estil del traç. Agafa un argument: 0 per a cap, o 1 per a pinzell.</para
></listitem>

<listitem
><para
>Funció: <function
>setFillStyle</function
></para
><para
>Aquesta funció arranja l'estil d'ompliment del <classname
>Painter</classname
>. Agaf un argument: 0 per a cap, 1 per a ompliment amb el color de primer pla, 2 per a ompliment amb el color de fons, 3 per a ompliment amb un patró.</para
></listitem>
</itemizedlist>
</listitem>

<listitem
><para
>Objecte: <classname
>Iterator</classname
></para
><para
>Aquest objecte us permet de canviar valors de píxel un per un. El nom d'algunes funcions depén de l'espai de color, per exemple, si l'espai de color de la capa és RGB, tindreu <function
>setR</function
>, <function
>setG</function
> i <function
>setB</function
>, i per a CMYK: <function
>setC</function
>, <function
>setM</function
>, <function
>setY</function
> i <function
>setK</function
>. A la documentació de sota assumirem que l'espai de color es diu ABC, amb tres canals: A, B i C.</para>

<itemizedlist>
<listitem
><para
>Funcions: <function
>setA</function
>, <function
>setB</function
>, <function
>setC</function
></para
><para
>Aquestes funcions agafen un argument: el nou valor d'un dels canals d'aquest píxel.</para
></listitem>

<listitem
><para
>Funció: <function
>setABC</function
></para
><para
>Arranja el valor de tots els canals. Aquesta funció agafa un argument: una matriu amb els nous valors per a tots els canals.</para
></listitem>

<listitem
><para
>Funcions: <function
>getA</function
>, <function
>getB</function
>, <function
>getC</function
></para
><para
>Retornen el valor d'un dels canals d'aquest píxel.</para
></listitem>

<listitem
><para
>Funció: <function
>getABC</function
></para
><para
>Retorna una matriu amb els valors de tots els canals.</para
></listitem>

<listitem
><para
>Funció: <function
>darken</function
></para
><para
>Obscureix un píxel. Aquesta funció agafa almenys un argument: <varname
>shade</varname
> (quantitat usada per aobscurir tots els canals de color). Aquesta funció pot agafar el següent argument opcional: <varname
>compensation</varname
> (per a limitar l'obscuriment).</para
></listitem>

<listitem
><para
>Funció: <function
>invertColor</function
></para
><para
>Inverteix el color d'un píxel.</para
></listitem>

<listitem
><para
>Funció: <function
>next</function
></para
><para
>Incrementa la posició, va al següent píxel.</para
></listitem>

<listitem
><para
>Funció: <function
>isDone</function
></para
><para
>Retorna vertader si l'iterator està al final (no hi ha més píxels disponibles).</para
></listitem>
</itemizedlist>
</listitem>
</itemizedlist>

</sect2>

<sect2 id="developers-scripting-resources">
<title
>Recursos</title>

<para
>Aquí hi ha pistes o llistes parcials de recursos per al &chalk;. </para
><para
>Per a <classname
>Brush</classname
> i <classname
>Pattern</classname
>: podeu obtenir el nom i el pinzell o patró associat des del selector de la barra d'eines del &chalk;. </para
><para
>Una llista d'identificadors per a espais de color en el &chalk;: LABA, RGBA, RGBA16, RGBAF32, RGBAF16HALF, LMSAF32, GRAYA, GRAYA16, CMYK, CMYKA16. </para>
</sect2>

</sect1>