Subversion Repositories Applications.gtt

Rev

Rev 61 | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
60 jpm 1 
<html>
2 
	<head>
3 
		<title>Documentation</title>
4 
		<meta http-equiv='Content-Type' content='text/html; charset=utf-8' />
5 
		<link rel='stylesheet' href='style.css' />
6 
	</head>
7 
 
8 
	<body>
9 
		<div align='center'>
10 
		<table cellpadding='0' cellspacing='0' id='contenu' class='round' style='width: 80%; margin-bottom: 20px'>
11 
			<tr>
12 
				<td class='borderhg'>&nbsp;</td>
13 
				<td class='borderh'>&nbsp;</td>
14 
				<td class='cornerhd'></td>
15 
			</tr>
16 
			<tr>
17 
				<td class='borderg'>&nbsp;</td>
18 
				<td><a id="top"></a><h2> Class Mark</h2><div class="description">
19 
		<p>
20 
			La classe <a href="Mark.html">Mark</a> permet de créer des marques, qui peuvent être affichées n'importe où sur une image.
21 
			Typiquement, les marques sont affichées sur les courbes pour mettre en valeur chaque point.
22 
		</p>
23 
		<div class="image">
24 
			<img src="doc/image/marks.png">
25 
		</div>
26 
	</div><ul class="links"><li><a href="index.html">Retourner voir la liste de toutes les classes</a></li></ul><h2>Méthodes et propriétés</h2><ul class="constants">
27 
<li>
28 
<span class="access">const</span> <span class="type">int</span> <a href="Mark.html#constant.CIRCLE">CIRCLE</a> := <span class="default">1</span>
29 
</li>
30 
<li>
31 
<span class="access">const</span> <span class="type">int</span> <a href="Mark.html#constant.SQUARE">SQUARE</a> := <span class="default">2</span>
32 
</li>
33 
<li>
34 
<span class="access">const</span> <span class="type">int</span> <a href="Mark.html#constant.TRIANGLE">TRIANGLE</a> := <span class="default">3</span>
35 
</li>
36 
<li>
37 
<span class="access">const</span> <span class="type">int</span> <a href="Mark.html#constant.INVERTED_TRIANGLE">INVERTED_TRIANGLE</a> := <span class="default">4</span>
38 
</li>
39 
<li>
40 
<span class="access">const</span> <span class="type">int</span> <a href="Mark.html#constant.RHOMBUS">RHOMBUS</a> := <span class="default">5</span>
41 
</li>
42 
<li>
43 
<span class="access">const</span> <span class="type">int</span> <a href="Mark.html#constant.CROSS">CROSS</a> := <span class="default">6</span>
44 
</li>
45 
<li>
46 
<span class="access">const</span> <span class="type">int</span> <a href="Mark.html#constant.PLUS">PLUS</a> := <span class="default">7</span>
47 
</li>
48 
<li>
49 
<span class="access">const</span> <span class="type">int</span> <a href="Mark.html#constant.IMAGE">IMAGE</a> := <span class="default">8</span>
50 
</li>
51 
<li>
52 
<span class="access">const</span> <span class="type">int</span> <a href="Mark.html#constant.STAR">STAR</a> := <span class="default">9</span>
53 
</li>
54 
<li>
55 
<span class="access">const</span> <span class="type">int</span> <a href="Mark.html#constant.PAPERCLIP">PAPERCLIP</a> := <span class="default">10</span>
56 
</li>
57 
<li>
58 
<span class="access">const</span> <span class="type">int</span> <a href="Mark.html#constant.BOOK">BOOK</a> := <span class="default">11</span>
59 
</li>
60 
</ul><ul class="properties">
61 
<li>
62 
<span class="access">protected</span> <a href="Point.html"><span class="type">Point</span></a> <a href="Mark.html#property.move"><span class="argument">$move</span></a>
63 
</li>
64 
<li>
65 
<span class="access">public</span> <a href="Border.html"><span class="type">Border</span></a> <a href="Mark.html#property.border"><span class="argument">$border</span></a>
66 
</li>
67 
</ul><ul class="methods">
68 
<li>
69 
<span class="access">public</span> <a href="Mark.html#method.__construct">__construct</a>()
70 
	</li>
71 
<li>
72 
<span class="access">public</span> <a href="Mark.html#method.move">move</a>(<span class="type">int</span> <span class="argument">$x</span>, <span class="type">int</span> <span class="argument">$y</span>)
73 
	</li>
74 
<li>
75 
<span class="access">public</span> <a href="Mark.html#method.hide">hide</a>(<span class="type">bool</span> <span class="argument">$hide</span> := <span class="default">TRUE</span>)
76 
	</li>
77 
<li>
78 
<span class="access">public</span> <a href="Mark.html#method.show">show</a>(<span class="type">bool</span> <span class="argument">$show</span> := <span class="default">TRUE</span>)
79 
	</li>
80 
<li>
81 
<span class="access">public</span> <a href="Mark.html#method.setSize">setSize</a>(<span class="type">int</span> <span class="argument">$size</span>)
82 
	</li>
83 
<li>
84 
<span class="access">public</span> <a href="Mark.html#method.setType">setType</a>(<span class="type">int</span> <span class="argument">$type</span>, <span class="type">int</span> <span class="argument">$size</span> := <span class="default">NULL</span>)
85 
	</li>
86 
<li>
87 
<span class="access">public</span> <a href="Mark.html#method.setFill">setFill</a>(<span class="type">mixed</span> <span class="argument">$fill</span>)
88 
	</li>
89 
<li>
90 
<span class="access">public</span> <a href="Mark.html#method.setImage">setImage</a>(<a href="Image.html"><span class="type">Image</span></a> <span class="argument">$image</span>)
91 
	</li>
92 
<li>
93 
<span class="access">public</span> <a href="Mark.html#method.draw">draw</a>(<a href="Driver.html"><span class="type">Driver</span></a> <span class="argument">$driver</span>, <a href="Point.html"><span class="type">Point</span></a> <span class="argument">$point</span>)
94 
	</li>
95 
</ul><h2>Documentation</h2><ul class="doc">
96 
<li class="constant">
97 
<a id="constant.CIRCLE"></a><span class="access">const</span> <span class="type">int</span> <a href="Mark.html#constant.CIRCLE">CIRCLE</a> := <span class="default">1</span><div class="description">
98 
				Pour les marques de la forme d'un cercle.
99 
			</div>
100 
<div class="description-bottom"><a href="Mark.html#top">Remonter</a></div>
101 
</li>
102 
<li class="constant">
103 
<a id="constant.SQUARE"></a><span class="access">const</span> <span class="type">int</span> <a href="Mark.html#constant.SQUARE">SQUARE</a> := <span class="default">2</span><div class="description">
104 
				Pour les marques de la forme d'un carré.
105 
			</div>
106 
<div class="description-bottom"><a href="Mark.html#top">Remonter</a></div>
107 
</li>
108 
<li class="constant">
109 
<a id="constant.TRIANGLE"></a><span class="access">const</span> <span class="type">int</span> <a href="Mark.html#constant.TRIANGLE">TRIANGLE</a> := <span class="default">3</span><div class="description">
110 
				Pour les marques de la forme d'un trianble.
111 
			</div>
112 
<div class="description-bottom"><a href="Mark.html#top">Remonter</a></div>
113 
</li>
114 
<li class="constant">
115 
<a id="constant.INVERTED_TRIANGLE"></a><span class="access">const</span> <span class="type">int</span> <a href="Mark.html#constant.INVERTED_TRIANGLE">INVERTED_TRIANGLE</a> := <span class="default">4</span><div class="description">
116 
				Pour les marques de la forme d'un triangle inversé (sommet vers le bas).
117 
			</div>
118 
<div class="description-bottom"><a href="Mark.html#top">Remonter</a></div>
119 
</li>
120 
<li class="constant">
121 
<a id="constant.RHOMBUS"></a><span class="access">const</span> <span class="type">int</span> <a href="Mark.html#constant.RHOMBUS">RHOMBUS</a> := <span class="default">5</span><div class="description">
122 
				Représente une marque de type rhombus (carré à 45°).
123 
			</div>
124 
<div class="description-bottom"><a href="Mark.html#top">Remonter</a></div>
125 
</li>
126 
<li class="constant">
127 
<a id="constant.CROSS"></a><span class="access">const</span> <span class="type">int</span> <a href="Mark.html#constant.CROSS">CROSS</a> := <span class="default">6</span><div class="description">
128 
				Représente une marque de la forme d'une croix (X).
129 
			</div>
130 
<div class="description-bottom"><a href="Mark.html#top">Remonter</a></div>
131 
</li>
132 
<li class="constant">
133 
<a id="constant.PLUS"></a><span class="access">const</span> <span class="type">int</span> <a href="Mark.html#constant.PLUS">PLUS</a> := <span class="default">7</span><div class="description">
134 
				Représente une marque de la forme d'un plus (+).
135 
			</div>
136 
<div class="description-bottom"><a href="Mark.html#top">Remonter</a></div>
137 
</li>
138 
<li class="constant">
139 
<a id="constant.IMAGE"></a><span class="access">const</span> <span class="type">int</span> <a href="Mark.html#constant.IMAGE">IMAGE</a> := <span class="default">8</span><div class="description">
140 
				Pour les marques de type image.
141 
			</div>
142 
<div class="description-bottom"><a href="Mark.html#top">Remonter</a></div>
143 
</li>
144 
<li class="constant">
145 
<a id="constant.STAR"></a><span class="access">const</span> <span class="type">int</span> <a href="Mark.html#constant.STAR">STAR</a> := <span class="default">9</span><div class="description">
146 
				Représente une marque de type étoile.
147 
			</div>
148 
<div class="description-bottom"><a href="Mark.html#top">Remonter</a></div>
149 
</li>
150 
<li class="constant">
151 
<a id="constant.PAPERCLIP"></a><span class="access">const</span> <span class="type">int</span> <a href="Mark.html#constant.PAPERCLIP">PAPERCLIP</a> := <span class="default">10</span><div class="description">
152 
				Représente une marque de type trombonne.
153 
			</div>
154 
<div class="description-bottom"><a href="Mark.html#top">Remonter</a></div>
155 
</li>
156 
<li class="constant">
157 
<a id="constant.BOOK"></a><span class="access">const</span> <span class="type">int</span> <a href="Mark.html#constant.BOOK">BOOK</a> := <span class="default">11</span><div class="description">
158 
				Représente une marque de type livre.
159 
			</div>
160 
<div class="description-bottom"><a href="Mark.html#top">Remonter</a></div>
161 
</li>
162 
<li class="property">
163 
<a id="property.move"></a><span class="access">protected</span> <a href="Point.html"><span class="type">Point</span></a> <a href="Mark.html#property.move"><span class="argument">$move</span></a><div class="description">
164 
				Le déplacement de la marque défini par l'utilisateur.
165 
			<div class="see">
166 
					Voir aussi :
167 
					<ul><li><a href="Mark.html#method.move">Mark::move()</a></li></ul>
168 
</div>
169 
</div>
170 
<div class="description-bottom"><a href="Mark.html#top">Remonter</a></div>
171 
</li>
172 
<li class="property">
173 
<a id="property.border"></a><span class="access">public</span> <a href="Border.html"><span class="type">Border</span></a> <a href="Mark.html#property.border"><span class="argument">$border</span></a><div class="description">
174 
				La bordure qui entoure la marque.
175 
			</div>
176 
<div class="description-bottom"><a href="Mark.html#top">Remonter</a></div>
177 
</li>
178 
<li class="method">
179 
<a id="method.__construct"></a><span class="access">public</span> <a href="Mark.html#method.__construct">__construct</a>()
180 
	<div class="description">
181 
				Construit un nouvel objet qui permettra l'affichage de marques sur une image.
182 
			</div>
183 
<div class="description-bottom"><a href="Mark.html#top">Remonter</a></div>
184 
</li>
185 
<li class="method">
186 
<a id="method.move"></a><span class="access">public</span> <a href="Mark.html#method.move">move</a>(<span class="type">int</span> <span class="argument">$x</span>, <span class="type">int</span> <span class="argument">$y</span>)
187 
	<div class="description">
188 
				Déplace l'affichage des marques de $x pixels sur l'axe des abscisses et de $y pixels sur l'axe des ordonnées.
189 
				Les appels à <a href="Mark.html#method.move">move()</a> sont cumulés, c'est-à-dire qu'un appel avec de nouvelles valeurs additionnera ces valeurs avec les anciennes.
190 
				Par défaut, $x et $y sont à 0 pixel.
191 
			</div>
192 
<div class="description-bottom"><a href="Mark.html#top">Remonter</a></div>
193 
</li>
194 
<li class="method">
195 
<a id="method.hide"></a><span class="access">public</span> <a href="Mark.html#method.hide">hide</a>(<span class="type">bool</span> <span class="argument">$hide</span> := <span class="default">TRUE</span>)
196 
	<div class="description">
197 
				Permet de cacher (par défaut) ou d'afficher les marques.
198 
			</div>
199 
<div class="description-bottom"><a href="Mark.html#top">Remonter</a></div>
200 
</li>
201 
<li class="method">
202 
<a id="method.show"></a><span class="access">public</span> <a href="Mark.html#method.show">show</a>(<span class="type">bool</span> <span class="argument">$show</span> := <span class="default">TRUE</span>)
203 
	<div class="description">
204 
				Permet d'afficher (par défaut) ou de cacher les marques.
205 
			</div>
206 
<div class="description-bottom"><a href="Mark.html#top">Remonter</a></div>
207 
</li>
208 
<li class="method">
209 
<a id="method.setSize"></a><span class="access">public</span> <a href="Mark.html#method.setSize">setSize</a>(<span class="type">int</span> <span class="argument">$size</span>)
210 
	<div class="description">
211 
				Change la taille des marques pour $size. Cette méthode n'a aucun effet pour les marques de type <a href="Mark.html#constant.IMAGE"></a>, <a href="Mark.html#constant.STAR"></a>, <a href="Mark.html#constant.PAPERCLIP"></a> ou <a href="Mark.html#constant.BOOK"></a>.
212 
			</div>
213 
<div class="description-bottom"><a href="Mark.html#top">Remonter</a></div>
214 
</li>
215 
<li class="method">
216 
<a id="method.setType"></a><span class="access">public</span> <a href="Mark.html#method.setType">setType</a>(<span class="type">int</span> <span class="argument">$type</span>, <span class="type">int</span> <span class="argument">$size</span> := <span class="default">NULL</span>)
217 
	<div class="description">
218 
				Change le type de marque à utiliser.
219 
				Les valeurs possibles sont <a href="Mark.html#constant.CIRCLE"></a>, <a href="Mark.html#constant.SQUARE"></a>, <a href="Mark.html#constant.TRIANGLE"></a>, <a href="Mark.html#constant.IMAGE"></a>, <a href="Mark.html#constant.STAR"></a>, <a href="Mark.html#constant.PAPERCLIP"></a> ou encore <a href="Mark.html#constant.BOOK"></a>.
220 
				L'argument optionnel $size permet de déterminer la taille de la marque et n'a aucun effet sur <a href="Mark.html#constant.IMAGE"></a>, <a href="Mark.html#constant.PAPERCLIP"></a> et <a href="Mark.html#constant.BOOK"></a>.
221 
			</div>
222 
<div class="description-bottom"><a href="Mark.html#top">Remonter</a></div>
223 
</li>
224 
<li class="method">
225 
<a id="method.setFill"></a><span class="access">public</span> <a href="Mark.html#method.setFill">setFill</a>(<span class="type">mixed</span> <span class="argument">$fill</span>)
226 
	<div class="description">
227 
				Remplit la marque avec la couleur ou le dégradé $fill. Cette méthode n'a aucun effet pour les marques de type <a href="Mark.html#constant.IMAGE">Mark::IMAGE</a>.
228 
			<div class="see">
229 
					Voir aussi :
230 
					<ul><li><a href="Mark.html#method.setType">Mark::setType()</a></li></ul>
231 
</div>
232 
</div>
233 
<div class="description-bottom"><a href="Mark.html#top">Remonter</a></div>
234 
</li>
235 
<li class="method">
236 
<a id="method.setImage"></a><span class="access">public</span> <a href="Mark.html#method.setImage">setImage</a>(<a href="Image.html"><span class="type">Image</span></a> <span class="argument">$image</span>)
237 
	<div class="description">
238 
				Change l'image à afficher sur la marque. Cette méthode n'a de sens que pour les marques de type <a href="Mark.html#constant.IMAGE">Mark::IMAGE</a>.
239 
			<div class="see">
240 
					Voir aussi :
241 
					<ul><li><a href="Mark.html#method.setType">Mark::setType()</a></li></ul>
242 
</div>
243 
</div>
244 
<div class="description-bottom"><a href="Mark.html#top">Remonter</a></div>
245 
</li>
246 
<li class="method">
247 
<a id="method.draw"></a><span class="access">public</span> <a href="Mark.html#method.draw">draw</a>(<a href="Driver.html"><span class="type">Driver</span></a> <span class="argument">$driver</span>, <a href="Point.html"><span class="type">Point</span></a> <span class="argument">$point</span>)
248 
	<div class="description">
249 
				Dessine la marque avec le pilote $driver. Le centre de la marque sera sur le point $point.
250 
			</div>
251 
<div class="description-bottom"><a href="Mark.html#top">Remonter</a></div>
252 
</li>
253 
</ul>
254 
</td>
255 
				<td class='borderd'>&nbsp;</td>
256 
			</tr>
257 
			<tr>
258 
				<td class='cornerbg'></td>
259 
				<td class='borderb'>&nbsp;</td>
260 
				<td class='cornerbd'></td>
261 
			</tr>
262 
		</table>
263 
		</div>
264 
	</body>
265 
</html>