You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1133 lines
23 KiB
1133 lines
23 KiB
<chapter id="scripting">
|
|
<title
|
|
>Skriptid</title>
|
|
|
|
<para
|
|
>&chalk; võimaldab kirjutada Ruby või Pythoni skripte (interpretaatorite kättesaadavus sõltub sellest, mida sinu distributsioon või sinu masina administraator on paigaldanud). Alljärgnevalt kirjeldame skriptimise API-t. </para
|
|
><para
|
|
>Mõned näited on &chalk;ga kaasa pandud, need leiab kataloogist <filename
|
|
>/usr/share/apps/chalk/scripts</filename
|
|
> (või <filename
|
|
>/opt/kde/share/apps/chalk/scripts</filename
|
|
>). </para>
|
|
|
|
<sect1 id="scripting-variables">
|
|
<title
|
|
>Mooduli <classname
|
|
>Krosschalkcore</classname
|
|
> muutujad</title>
|
|
|
|
<itemizedlist>
|
|
<listitem
|
|
><para
|
|
><varname
|
|
>ChalkDocument</varname
|
|
> tagastab <classname
|
|
>Document</classname
|
|
>-objekti</para
|
|
></listitem>
|
|
<listitem
|
|
><para
|
|
><varname
|
|
>ChalkScript</varname
|
|
> tagastab <classname
|
|
>ScriptProgress</classname
|
|
>-objekti</para
|
|
></listitem>
|
|
</itemizedlist>
|
|
|
|
<para
|
|
>Objekti saab hankida mooduli <classname
|
|
>Krosschalkcore</classname
|
|
> funktsiooni <function
|
|
>get</function
|
|
> kasutades, milleks Ruby korral tuleb kirjutada midagi sellist: <programlisting
|
|
>doc = Krosschalkcore::get("ChalkDocument")
|
|
script = Krosschalkcore::get("ChalkScript")
|
|
</programlisting>
|
|
</para>
|
|
|
|
</sect1>
|
|
|
|
<sect1 id="scripting-functions">
|
|
<title
|
|
>Mooduli <classname
|
|
>Krosschalkcore</classname
|
|
> funktsioonid</title>
|
|
|
|
<itemizedlist>
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>getBrush</function
|
|
></para
|
|
><para
|
|
>See funktsioon tagastab klassi <classname
|
|
>Brush</classname
|
|
>, mis võetakse &chalk; ressursside loendist. Kasutada saab üht argumenti: pintsli nimi. Näide (Ruby): <programlisting
|
|
>Krosschalkcore::getBrush("Circle (05)")
|
|
</programlisting
|
|
></para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>getFilter</function
|
|
></para
|
|
><para
|
|
>See funktsioon tagastab klassi <classname
|
|
>Filter</classname
|
|
>, mis võetakse &chalk; ressursside loendist. Kasutada saab üht argumenti: filtri nimi. Näide (Ruby): <programlisting
|
|
>Krosschalkcore::getFilter("invert")
|
|
</programlisting
|
|
></para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>getPattern</function
|
|
></para
|
|
><para
|
|
>See funktsioon tagastab klassi <classname
|
|
>Pattern</classname
|
|
>, mis võetakse &chalk; ressursside loendist. Kasutada saab üht argumenti: mustri nimi. Näide (Ruby): <programlisting
|
|
>Krosschalkcore::getPattern("Bricks")
|
|
</programlisting
|
|
></para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>loadBrush</function
|
|
></para
|
|
><para
|
|
>See funktsioon laadib klassi <classname
|
|
>Brush</classname
|
|
> ja tagastab siis selle. Kasutada saab üht argumenti: pintsli failinimi.</para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>loadPattern</function
|
|
></para
|
|
><para
|
|
>See funktsioon laadib klassi <classname
|
|
>Pattern</classname
|
|
> ja tagastab siis selle. Kasutada saab üht argumenti: mustri failinimi.</para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>newCircleBrush</function
|
|
></para
|
|
><para
|
|
>See funktsioon tagastab klassi <classname
|
|
>Brush</classname
|
|
> ringikujulisena. Kasutada tuleb vähemalt kaht argumenti: laius ja kõrgus. Kasutada saab veel kaht argumenti: varju laius ja varju kõrgus. Kui varju pole määratud, seda ei kasutata. Näide (Ruby): <programlisting
|
|
>Krosschalkcore::newCircleBrush(10,20) # loob puhta ringi
|
|
Krosschalkcore::newCircleBrush(10,20,5,10) # loob ülemineku
|
|
</programlisting
|
|
></para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>newHSVColor</function
|
|
></para
|
|
><para
|
|
>See funktsioon tagastab uue klassi <classname
|
|
>Color</classname
|
|
> määratud HSV-tripletiga. Kasutada saab kolme argumenti: toon (0 kuni 255), küllastus (0 kuni 255), väärtus (0 kuni 255). Näide (Ruby): <programlisting
|
|
>Krosschalkcore::newHSVColor(255,125,0)
|
|
</programlisting
|
|
></para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>newImage</function
|
|
></para
|
|
><para
|
|
>See funktsioon tagastab uue klassi <classname
|
|
>Image</classname
|
|
>. Kasutada saab nelja argumenti: laius, kõrgus, värviruumi ID, pildi nimi. Tagastatakse <classname
|
|
>Image</classname
|
|
>-objekt. Näide (Ruby): <programlisting
|
|
>Krosschalkcore::newImage(10,20, "RGBA", "kikoo")
|
|
</programlisting
|
|
></para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>newRectBrush</function
|
|
></para
|
|
><para
|
|
>See funktsioon tagastab klassi <classname
|
|
>Brush</classname
|
|
> ristkülikukujulisena. Kasutada tuleb vähemalt kaht argumenti: laius ja kõrgus. Kasutada saab veel kaht argumenti: varju laius ja varju kõrgus. Kui varju pole määratud, seda ei kasutata. Näide (Ruby): <programlisting
|
|
>Krosschalkcore::newRectBrush(10,20) # loob puhta ristküliku
|
|
Krosschalkcore::newRectBrush(10,20,5,10) # loob ülemineku
|
|
</programlisting
|
|
></para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>newRGBColor</function
|
|
></para
|
|
><para
|
|
>See funktsioon tagastab uue klassi <classname
|
|
>Color</classname
|
|
> määratud RGB-tripletiga. Kasutada saab kolme argumenti: punane (0 kuni 255), sinine (0 kuni 255), roheline (0 kuni 255). Näide (Ruby): <programlisting
|
|
>Krosschalkcore::newRGBColor(255,0,0) # loob punase värvi
|
|
Krosschalkcore::newRGBColor(255,255,255) # loob valge värvi
|
|
</programlisting
|
|
></para
|
|
></listitem>
|
|
</itemizedlist>
|
|
</sect1>
|
|
|
|
<sect1 id="scripting-objects">
|
|
<title
|
|
><classname
|
|
>Krosschalkcore</classname
|
|
> objektide kirjeldused ja funktsioonide loendid</title>
|
|
|
|
<itemizedlist>
|
|
<listitem
|
|
><para
|
|
>Objekt: PaintLayer</para>
|
|
|
|
<itemizedlist>
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>beginPainting</function
|
|
></para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>convertToColorspace</function
|
|
></para
|
|
><para
|
|
>Teisendab pildi värviruumi. See funktsioon kasutab üht argumenti: sihtvärviruumi nimi. Näide (Ruby): <programlisting
|
|
>image.convertToColorspace("CMYK")
|
|
</programlisting
|
|
></para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>createHistogram</function
|
|
></para
|
|
><para
|
|
>See funktsioon loob antud kihi histogrammi. Kasutada saab kaht argumenti: histogrammi tüüp ("RGB8HISTO") ja 0, kui histogramm on lineaarne, või 1, kui histogramm on logaritmiline.</para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>createHLineIterator</function
|
|
></para
|
|
><para
|
|
>Loob iteraatori üle kihi, itereerib reas. Funktsioon kasutab kolme argumenti: <varname
|
|
>x</varname
|
|
> (algus reas), <varname
|
|
>y</varname
|
|
> (rea vertikaalne positsioon), rea laius.</para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>createPainter</function
|
|
></para
|
|
><para
|
|
>See funktsioon loob klassi <classname
|
|
>Painter</classname
|
|
>, mis võimaldab kihil joonistada. </para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>createRectIterator</function
|
|
></para
|
|
><para
|
|
>Loob iteraatori üle kihi, itereerib ristkülikulises piirkonnas. Funktsioon kasutab nelja argumenti: <varname
|
|
>x</varname
|
|
>, <varname
|
|
>y</varname
|
|
>, ristküliku laius, ristküliku kõrgus.</para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>createVLineIterator</function
|
|
></para
|
|
><para
|
|
>Loob iteraatori üle kihi, itereerib veerus. Funktsioon kasutab kolme argumenti: <varname
|
|
>x</varname
|
|
> (veeru horisontaalne positsioon), <varname
|
|
>y</varname
|
|
> (algus veerus), veeru kõrgus.</para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>endPainting</function
|
|
></para
|
|
><para
|
|
>Selle funktsiooniga saab sulgeda aktiivse tagasivõtmise kirje ja lisada selle ajalukku.</para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>fastWaveletTransformation</function
|
|
></para
|
|
><para
|
|
>Tagastab kihist teisendatud kiirlainiku.</para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>fastWaveletUntransformation</function
|
|
></para
|
|
><para
|
|
>Teisendab kiirlainiku tagasi kihti. Kasutada saab üht argumenti: lainikuobjekt. Näide (Ruby): <programlisting
|
|
>wavelet = layer.fastWaveletTransformation()
|
|
layer.fastWaveletUntransformation(wavelet)
|
|
</programlisting
|
|
></para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>getHeight</function
|
|
></para
|
|
><para
|
|
>Tagastab kihi kõrguse.</para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>getWidth</function
|
|
></para
|
|
><para
|
|
>Tagastab kihi laiuse.</para
|
|
></listitem>
|
|
</itemizedlist>
|
|
</listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Objekt: <classname
|
|
>Filter</classname
|
|
></para>
|
|
<itemizedlist>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>getFilterConfiguration</function
|
|
></para
|
|
><para
|
|
>Tagastab antud filtriga seotud klassi <classname
|
|
>FilterConfiguration</classname
|
|
>.</para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>process</function
|
|
></para
|
|
><para
|
|
>See funktsioon rakendab filtri. Kasutada tuleb vähemalt üht argumenti: lähtekiht. Kasutada saab veel nelja argumenti: <varname
|
|
>x</varname
|
|
>, <varname
|
|
>y</varname
|
|
>, <varname
|
|
>width</varname
|
|
>, <varname
|
|
>height</varname
|
|
>. (<varname
|
|
>x</varname
|
|
>,<varname
|
|
>y</varname
|
|
>,<varname
|
|
>width</varname
|
|
>,<varname
|
|
>height</varname
|
|
>) määravad ristkülikulise ala, millele filter rakendatakse. Kui ristkülik pole määratud, rakendatakse filter tervele lähtekihile. Näide (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
|
|
>Objekt: <classname
|
|
>FilterConfiguration</classname
|
|
></para>
|
|
<itemizedlist>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>getProperty</function
|
|
></para
|
|
><para
|
|
>See funktsioon tagastab seonduva klassi <classname
|
|
>Filter</classname
|
|
> parameetri väärtuse. Kasutada saab üht argumenti: parameetri nimi.</para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>setProperty</function
|
|
></para
|
|
><para
|
|
>See funktsioon defineerib seonduva klassi <classname
|
|
>Filter</classname
|
|
> parameetri. Kasutada saab kaht argumenti: parameetri nimi ja väärtus, mille tüüp sõltub klassist <classname
|
|
>Filter</classname
|
|
>.</para
|
|
></listitem>
|
|
</itemizedlist>
|
|
</listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Objekt: <classname
|
|
>Histogram</classname
|
|
></para>
|
|
|
|
<para
|
|
>See klass võimaldab ligipääsu klassi <classname
|
|
>PaintLayer</classname
|
|
> histogrammile. Näide (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
|
|
>Funktsioon: <function
|
|
>getChannel</function
|
|
></para
|
|
><para
|
|
>Tagastab valitud kanali.</para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>getCount</function
|
|
></para
|
|
><para
|
|
>See funktsioon kasutab histogrammi kasutatud pikslite arvu.</para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>getHighest</function
|
|
></para
|
|
><para
|
|
>See funktsioon tagastab histogrammi suurima väärtuse.</para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>getLowest</function
|
|
></para
|
|
><para
|
|
>See funktsioon tagastab histogrammi väikseima väärtuse.</para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>getMax</function
|
|
></para
|
|
><para
|
|
>See funktsioon tagastab histogrammi maksimaalse raja (väärtused maksimumist suuremas positsioonis on null). Väärtus on vahemikus 0,0 – 1,0.</para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>getMean</function
|
|
></para
|
|
><para
|
|
>See funktsioon tagastab histogrammi keskmise.</para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>getMin</function
|
|
></para
|
|
><para
|
|
>See funktsioon tagastab histogrammi minimaalse raja (väärtused miinimumist väiksemas positsioonis on null). Väärtus on vahemikus 0,0 – 1,0.</para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>getNumberOfBins</function
|
|
></para
|
|
><para
|
|
>Tagastab kastide arvu histogrammis. </para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>getTotal</function
|
|
></para
|
|
><para
|
|
>See funktsioon tagastab histogrammi kõigi väärtuste summa.</para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>getValue</function
|
|
></para
|
|
><para
|
|
>Tagastab histogrammi kasti väärtuse. See funktsioon kasutab üht argumenti: indeks vahemikus 0 kuni 255.</para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>setChannel</function
|
|
></para
|
|
><para
|
|
>Valib kihi kanali, mille kohta hankida histogrammi tulemus. See funktsioon kasutab üht argumenti: kanali number.</para
|
|
></listitem>
|
|
</itemizedlist>
|
|
</listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Objekt: <classname
|
|
>ScriptProgress</classname
|
|
></para>
|
|
<para
|
|
><classname
|
|
>ScriptProgress</classname
|
|
>'i kasutatakse &chalk; olekuriba edenemisriba haldamiseks. Näide (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
|
|
>Funktsioon: <function
|
|
>incProgress</function
|
|
></para
|
|
><para
|
|
>See funktsioon kasvatab edenemist ühe sammu võrra.</para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>setProgress</function
|
|
></para
|
|
><para
|
|
>See funktsioon määrab edenemise väärtuse. See kasutab üht argumenti: edenemise väärtus.</para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>setProgressStage</function
|
|
></para
|
|
><para
|
|
>See funktsioon määrab edenemise väärtuse ja näitab teksti.</para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>setProgressTotalSteps</function
|
|
></para
|
|
><para
|
|
>See funktsioon määrab sammude arvu, mida skript nõuab. See kasutab üht argumenti: edenemise maksimumväärtus.</para
|
|
></listitem>
|
|
</itemizedlist>
|
|
</listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Objekt: <classname
|
|
>Wavelet</classname
|
|
></para
|
|
><para
|
|
>See objekt sisaldab klassi <classname
|
|
>PaintLayer</classname
|
|
> lainikteisenduse koefitsiente.</para>
|
|
<itemizedlist>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>getDepth</function
|
|
></para
|
|
><para
|
|
>Tagastab kihi sügavuse.</para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>getNCoeff</function
|
|
></para
|
|
><para
|
|
>Tagastab N-nda koefitsiendi väärtuse. Funktsioon kasutab üht argumenti: koefitsiendi indeks,</para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>getNumCoeffs</function
|
|
></para
|
|
><para
|
|
>Tagastab koefitsientide arvu antud lainikus (= suurus * suurus * sügavus).</para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>getSize</function
|
|
></para
|
|
><para
|
|
>Tagastab lainiku suuruse (suurus = laius = kõrgus).</para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>getXYCoeff</function
|
|
></para
|
|
><para
|
|
>Tagastab koefitsiendi väärtuse. Funktsioon kasutab kaht argumenti: <varname
|
|
>x</varname
|
|
> ja <varname
|
|
>y</varname
|
|
>.</para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>setNCoeff</function
|
|
></para
|
|
><para
|
|
>Määrab N-nda koefitsiendi väärtuse. Funktsioon kasutab kaht argumenti: koefitsiendi indeks ja koefitsiendi uus väärtus.</para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>setXYCoeff</function
|
|
></para
|
|
><para
|
|
>Määrab koefitsiendi väärtuse. Funktsioon kasutab kolme argumenti: <varname
|
|
>x</varname
|
|
>, <varname
|
|
>y</varname
|
|
> ja koefitsiendi uus väärtus.</para
|
|
></listitem>
|
|
</itemizedlist>
|
|
</listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Objekt: <classname
|
|
>Painter</classname
|
|
></para>
|
|
<itemizedlist>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>convolve</function
|
|
></para
|
|
><para
|
|
>See funktsioon rakendab pildile konvolutsioonituuma. Kasutada tuleb vähemalt kolme argumenti: loend tuuma loenditega (kõik loendid peavad olema ühesuguse suurusega), tegur ja nihe. </para
|
|
><para
|
|
>Piksli väärtus määratakse järgmise funktsiooniga: K * P / tegur + nihe, kus K on tuum ja P naabruskond. </para
|
|
><para
|
|
>Kasutada võib järgmisi lisaargumente: <varname
|
|
>borderOp</varname
|
|
> (määrab, kuidas konvolveerida piksleid pildi piiril: 0 = kasutatakse vaikevärvi, 1 = kasutatakse pildi vastaskülje pikslit, 2 = kasutatakse piiri pikslit, 3 = välditakse piiri piksleid), <varname
|
|
>channel</varname
|
|
> (1 tähendab värvi, 2 alfat, 3 mõlemat), <varname
|
|
>x</varname
|
|
>, <varname
|
|
>y</varname
|
|
>, <varname
|
|
>width</varname
|
|
>, <varname
|
|
>height</varname
|
|
>.</para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>setFillThreshold</function
|
|
></para
|
|
><para
|
|
>Määrab täitmise läve. Kasutada saab üht argument: lävi.</para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>fillColor</function
|
|
></para
|
|
><para
|
|
>Alustab täitmist värviga. Kasutada saab kaht argumenti: <varname
|
|
>x</varname
|
|
> ja <varname
|
|
>y</varname
|
|
>.</para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>fillPattern</function
|
|
></para
|
|
><para
|
|
>Alustab täitmist mustriga. Kasutada saab kaht argumenti: <varname
|
|
>x</varname
|
|
> ja <varname
|
|
>y</varname
|
|
>.</para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>paintPolyline</function
|
|
></para
|
|
><para
|
|
>See funktsioon joonistab kompleksjoone. Kasutada saab kaht argumenti: X-positsioonide loend ja Y-positsioonide loend.</para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>paintLine</function
|
|
></para
|
|
><para
|
|
>See funktsioon joonistab sirge. Kasutada saab viit argumenti: <varname
|
|
>x1</varname
|
|
>, <varname
|
|
>y1</varname
|
|
>, <varname
|
|
>x2</varname
|
|
>, <varname
|
|
>y2</varname
|
|
> ja <varname
|
|
>pressure</varname
|
|
> (surve). </para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>paintBezierCurve</function
|
|
></para
|
|
><para
|
|
>See funktsioon joonistab Bezier' kõvera. Kasutada saab kümmet argumenti: <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
|
|
>, kus (<varname
|
|
>x1</varname
|
|
>,<varname
|
|
>y1</varname
|
|
>) on alguspositsioon, <varname
|
|
>p1</varname
|
|
> surve alguses, (<varname
|
|
>x2</varname
|
|
>,<varname
|
|
>y2</varname
|
|
>) lõpp-positsioon, <varname
|
|
>p2</varname
|
|
> surve lõpus. (<varname
|
|
>cx1</varname
|
|
>,<varname
|
|
>cy1</varname
|
|
>) ja (<varname
|
|
>cx2</varname
|
|
>,<varname
|
|
>cy2</varname
|
|
>) on kontrollpunktide positsioonid.</para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>paintEllipse</function
|
|
></para
|
|
><para
|
|
>See funktsioon joonistab ellipsi. Kasutada saab viit argumenti: <varname
|
|
>x1</varname
|
|
>, <varname
|
|
>y1</varname
|
|
>, <varname
|
|
>x2</varname
|
|
>, <varname
|
|
>y2</varname
|
|
>, <varname
|
|
>pressure</varname
|
|
>, kus (<varname
|
|
>x1</varname
|
|
>,<varname
|
|
>y1</varname
|
|
>) ja (<varname
|
|
>x2</varname
|
|
>,<varname
|
|
>y2</varname
|
|
>) on fookuste positsioonid.</para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>paintPolygon</function
|
|
></para
|
|
><para
|
|
>See funktsioon joonistab hulknurga. Kasutada saab kaht argumenti: X-positsioonide loend ja Y-positsioonide loend.</para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>paintRect</function
|
|
></para
|
|
><para
|
|
>See funktsioon joonistab ristküliku. Kasutada saab viit argumenti: <varname
|
|
>x</varname
|
|
>, <varname
|
|
>y</varname
|
|
>, <varname
|
|
>width</varname
|
|
> (laius), <varname
|
|
>height</varname
|
|
> (kõrgus), <varname
|
|
>pressure</varname
|
|
> (surve).</para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>paintAt</function
|
|
></para
|
|
><para
|
|
>See funktsioon joonistab määratud positsioonis. Kasutada saab kolme argumenti: <varname
|
|
>x</varname
|
|
>, <varname
|
|
>y</varname
|
|
>, <varname
|
|
>pressure</varname
|
|
> (surve).</para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>setPaintColor</function
|
|
></para
|
|
><para
|
|
>See funktsioon määrab joonistamise värvi (nimetatakse ka esiplaani värviks). Kasutada saab üht argumenti: <classname
|
|
>Color</classname
|
|
> (värv).</para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>setBackgroundColor</function
|
|
></para
|
|
><para
|
|
>See funktsioon määrab taustavärvi. Kasutada saab üht argumenti: <classname
|
|
>Color</classname
|
|
> (värv).</para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>setPattern</function
|
|
></para
|
|
><para
|
|
>See funktsioon määrab täitmisel kasutatava mustri. Kasutada saab üht argumenti: <classname
|
|
>Pattern</classname
|
|
>-objekt.</para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>setBrush</function
|
|
></para
|
|
><para
|
|
>See funktsioon määrab joonistamisel kasutatava pintsli. Kasutada saab üht argumenti: <classname
|
|
>Brush</classname
|
|
>-objekt.</para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>setPaintOp</function
|
|
></para
|
|
><para
|
|
>See funktsioon määratleb joonistamisoperatsiooni. Kasutada saab üht argumenti: joonistamisoperatsiooni nimi.</para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>setDuplicateOffset</function
|
|
></para
|
|
><para
|
|
>See funktsioon määrab klooni nihke. Kasutada saab kaht argumenti: horisontaalne nihe ja vertikaalne nihe.</para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>setOpacity</function
|
|
></para
|
|
><para
|
|
>See funktsioon määrab joonistamise läbipaistmatuse. Kasutada saab üht argumenti: läbipaistmatus vahemikus 0 kuni 255.</para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>setStrokeStyle</function
|
|
></para
|
|
><para
|
|
>see funktsioon määrab joone stiili. Kasutada saab üht argumenti: 0 tähendab puudumist ja 1 pintslit.</para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>setFillStyle</function
|
|
></para
|
|
><para
|
|
>See funktsioon määrab klassi <classname
|
|
>Painter</classname
|
|
> täitmise stiili. Kasutada saab üht argumenti: 0 tähendab puudumist, 1 täitmist esiplaani värviga, 2 täitmist taustavärviga, 3 täitmist mustriga.</para
|
|
></listitem>
|
|
</itemizedlist>
|
|
</listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Objekt: <classname
|
|
>Iterator</classname
|
|
></para
|
|
><para
|
|
>See objekt võimaldab muuta piksliväärtusi ükshaaval. Osade funktsioonide nimi sõltub värviruumist: kui näiteks kihi värviruumiks on RGB, siis on funktsioonideks <function
|
|
>setR</function
|
|
>, <function
|
|
>setG</function
|
|
> ja <function
|
|
>setB</function
|
|
>, kui aga CMYK, siis <function
|
|
>setC</function
|
|
>, <function
|
|
>setM</function
|
|
>, <function
|
|
>setY</function
|
|
> ja <function
|
|
>setK</function
|
|
>. Alljärgnevas dokumentatsioonis eeldame, et värviruumi nimi on ABC, millel on kolm kanalit: A, B ja C.</para>
|
|
|
|
<itemizedlist>
|
|
<listitem
|
|
><para
|
|
>Funktsioonid: <function
|
|
>setA</function
|
|
>, <function
|
|
>setB</function
|
|
>, <function
|
|
>setC</function
|
|
></para
|
|
><para
|
|
>Need funktsioonid kasutavad üht argumenti: antud piksli ühe kanali uus väärtus.</para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>setABC</function
|
|
></para
|
|
><para
|
|
>Määrab kõigi kanalite väärtuse. Funktsioon kasutab üht argumenti: massiiv kõigi kanalite uute väärtustega.</para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioonid: <function
|
|
>getA</function
|
|
>, <function
|
|
>getB</function
|
|
>, <function
|
|
>getC</function
|
|
></para
|
|
><para
|
|
>Tagastab piksli ühe kanali väärtuse.</para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>getABC</function
|
|
></para
|
|
><para
|
|
>Tagastab massiivi kõigi kanalite väärtustega.</para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>darken</function
|
|
></para
|
|
><para
|
|
>Tumendab pikslit. See funktsioon kasutab vähemalt üht argumenti: <varname
|
|
>shade</varname
|
|
> (kogus, mille võrra kõiki värvikanaleid tumendatakse). Funktsioon võib kasutada veel üht lisaargumenti: <varname
|
|
>compensation</varname
|
|
> (piirab tumendamist).</para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>invertColor</function
|
|
></para
|
|
><para
|
|
>Inverteerib piksli värvi.</para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>next</function
|
|
></para
|
|
><para
|
|
>Kasvatab positsiooni, liigub järgmisele pikslile.</para
|
|
></listitem>
|
|
|
|
<listitem
|
|
><para
|
|
>Funktsioon: <function
|
|
>isDone</function
|
|
></para
|
|
><para
|
|
>Tagastab 'tõene', kui iteraator asub lõpus (rohkem piksleid enam pole).</para
|
|
></listitem>
|
|
</itemizedlist>
|
|
</listitem>
|
|
</itemizedlist>
|
|
|
|
</sect1>
|
|
|
|
<sect1 id="scripting-resources">
|
|
<title
|
|
>Ressursid</title>
|
|
|
|
<para
|
|
>Toome siin mõningad vihjed ja &chalk; ressursside osalise loendi: </para
|
|
><para
|
|
>Klassid <classname
|
|
>Brush</classname
|
|
> ja <classname
|
|
>Pattern</classname
|
|
>: nime ja seonduva pintsli või mustri leiab &chalk; tööriistariba valijast. </para
|
|
><para
|
|
>&chalk; 1.5 värviruumide ID-de loend: LABA, RGBA, RGBA16, RGBAF32, RGBAF16HALF, LMSAF32, GRAYA, GRAYA16, CMYK, CMYKA16. </para>
|
|
</sect1>
|
|
|
|
</chapter>
|
|
|