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 Shadow</h2><div class="description">
19
		<p>
20
			La classe <a href="Shadow.html">Shadow</a> permet de manipuler des ombres sur des rectangles.
21
		</p>
22
	</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">
23
<li>
24
<span class="access">const</span> <span class="type">int</span> <a href="Shadow.html#constant.LEFT_TOP">LEFT_TOP</a> := <span class="default">1</span>
25
</li>
26
<li>
27
<span class="access">const</span> <span class="type">int</span> <a href="Shadow.html#constant.LEFT_BOTTOM">LEFT_BOTTOM</a> := <span class="default">2</span>
28
</li>
29
<li>
30
<span class="access">const</span> <span class="type">int</span> <a href="Shadow.html#constant.RIGHT_TOP">RIGHT_TOP</a> := <span class="default">3</span>
31
</li>
32
<li>
33
<span class="access">const</span> <span class="type">int</span> <a href="Shadow.html#constant.RIGHT_BOTTOM">RIGHT_BOTTOM</a> := <span class="default">4</span>
34
</li>
35
<li>
36
<span class="access">const</span> <span class="type">int</span> <a href="Shadow.html#constant.IN">IN</a> := <span class="default">1</span>
37
</li>
38
<li>
39
<span class="access">const</span> <span class="type">int</span> <a href="Shadow.html#constant.OUT">OUT</a> := <span class="default">2</span>
40
</li>
41
</ul><ul class="properties">
42
<li>
43
<span class="access">protected</span> <span class="type">int</span> <a href="Shadow.html#property.size"><span class="argument">$size</span></a> := <span class="default">0</span>
44
</li>
45
<li>
46
<span class="access">protected</span> <a href="Color.html"><span class="type">Color</span></a> <a href="Shadow.html#property.color"><span class="argument">$color</span></a> := <span class="default">new Color(100, 100, 100)</span>
47
</li>
48
<li>
49
<span class="access">protected</span> <span class="type">int</span> <a href="Shadow.html#property.position"><span class="argument">$position</span></a>
50
</li>
51
<li>
52
<span class="access">protected</span> <span class="type">bool</span> <a href="Shadow.html#property.hide"><span class="argument">$hide</span></a>
53
</li>
54
<li>
55
<span class="access">protected</span> <span class="type">bool</span> <a href="Shadow.html#property.smooth"><span class="argument">$smooth</span></a>
56
</li>
57
</ul><ul class="methods">
58
<li>
59
<span class="access">public</span> <a href="Shadow.html#method.__construct">__construct</a>(<span class="type">int</span> <span class="argument">$position</span>)
60
	</li>
61
<li>
62
<span class="access">public</span> <a href="Shadow.html#method.hide">hide</a>(<span class="type">bool</span> <span class="argument">$hide</span>)
63
	</li>
64
<li>
65
<span class="access">public</span> <a href="Shadow.html#method.show">show</a>(<span class="type">bool</span> <span class="argument">$show</span>)
66
	</li>
67
<li>
68
<span class="access">public</span> <a href="Shadow.html#method.setSize">setSize</a>(<span class="type">int</span> <span class="argument">$size</span>)
69
	</li>
70
<li>
71
<span class="access">public</span> <a href="Shadow.html#method.setColor">setColor</a>(<a href="Color.html"><span class="type">Color</span></a> <span class="argument">$color</span>)
72
	</li>
73
<li>
74
<span class="access">public</span> <a href="Shadow.html#method.setPosition">setPosition</a>(<span class="type">int</span> <span class="argument">$position</span>)
75
	</li>
76
<li>
77
<span class="access">public</span> <a href="Shadow.html#method.smooth">smooth</a>(<span class="type">bool</span> <span class="argument">$smooth</span>)
78
	</li>
79
<li>
80
<span class="access">public</span> <a href="Side.html"><span class="type">Side</span></a> <a href="Shadow.html#method.getSpace">getSpace</a>()
81
	</li>
82
<li>
83
<span class="access">public</span> <a href="Shadow.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">$p1</span>, <a href="Point.html"><span class="type">Point</span></a> <span class="argument">$p2</span>, <span class="type">int</span> <span class="argument">$mode</span>)
84
	</li>
85
</ul><h2>Documentation</h2><ul class="doc">
86
<li class="constant">
87
<a id="constant.LEFT_TOP"></a><span class="access">const</span> <span class="type">int</span> <a href="Shadow.html#constant.LEFT_TOP">LEFT_TOP</a> := <span class="default">1</span><div class="description">
88
				Dessine l'ombre sur les côtés haut et gauche.
89
			</div>
90
<div class="description-bottom"><a href="Shadow.html#top">Remonter</a></div>
91
</li>
92
<li class="constant">
93
<a id="constant.LEFT_BOTTOM"></a><span class="access">const</span> <span class="type">int</span> <a href="Shadow.html#constant.LEFT_BOTTOM">LEFT_BOTTOM</a> := <span class="default">2</span><div class="description">
94
				Dessine l'ombre sur les côtés bas et gauche.
95
			</div>
96
<div class="description-bottom"><a href="Shadow.html#top">Remonter</a></div>
97
</li>
98
<li class="constant">
99
<a id="constant.RIGHT_TOP"></a><span class="access">const</span> <span class="type">int</span> <a href="Shadow.html#constant.RIGHT_TOP">RIGHT_TOP</a> := <span class="default">3</span><div class="description">
100
				Dessine l'ombre sur les côtés haut et droit.
101
			</div>
102
<div class="description-bottom"><a href="Shadow.html#top">Remonter</a></div>
103
</li>
104
<li class="constant">
105
<a id="constant.RIGHT_BOTTOM"></a><span class="access">const</span> <span class="type">int</span> <a href="Shadow.html#constant.RIGHT_BOTTOM">RIGHT_BOTTOM</a> := <span class="default">4</span><div class="description">
106
				Dessine l'ombre sur les côtés bas et droit.
107
			</div>
108
<div class="description-bottom"><a href="Shadow.html#top">Remonter</a></div>
109
</li>
110
<li class="constant">
111
<a id="constant.IN"></a><span class="access">const</span> <span class="type">int</span> <a href="Shadow.html#constant.IN">IN</a> := <span class="default">1</span><div class="description">
112
				Spécifie que l'ombre doit être dessinée à l'intérieur.
113
			</div>
114
<div class="description-bottom"><a href="Shadow.html#top">Remonter</a></div>
115
</li>
116
<li class="constant">
117
<a id="constant.OUT"></a><span class="access">const</span> <span class="type">int</span> <a href="Shadow.html#constant.OUT">OUT</a> := <span class="default">2</span><div class="description">
118
				Spécifie que l'ombre doit être dessinée à l'extérieur.
119
			</div>
120
<div class="description-bottom"><a href="Shadow.html#top">Remonter</a></div>
121
</li>
122
<li class="property">
123
<a id="property.size"></a><span class="access">protected</span> <span class="type">int</span> <a href="Shadow.html#property.size"><span class="argument">$size</span></a> := <span class="default">0</span><div class="description">
124
				Taille de l'ombre.
125
				Cette valeur est par défaut à 0, ce qui signifie qu'aucune ombre n'est affichée.
126
			</div>
127
<div class="description-bottom"><a href="Shadow.html#top">Remonter</a></div>
128
</li>
129
<li class="property">
130
<a id="property.color"></a><span class="access">protected</span> <a href="Color.html"><span class="type">Color</span></a> <a href="Shadow.html#property.color"><span class="argument">$color</span></a> := <span class="default">new Color(100, 100, 100)</span><div class="description">
131
				Taille de l'ombre.
132
				Cette valeur est par défaut à 0, ce qui signifie qu'aucune ombre n'est affichée.
133
			</div>
134
<div class="description-bottom"><a href="Shadow.html#top">Remonter</a></div>
135
</li>
136
<li class="property">
137
<a id="property.position"></a><span class="access">protected</span> <span class="type">int</span> <a href="Shadow.html#property.position"><span class="argument">$position</span></a><div class="description">
138
				Détermine la position de l'ombre.
139
				Les valeurs possible sont <a href="Shadow.html#constant.LEFT_TOP">Shadow::LEFT_TOP</a>, <a href="Shadow.html#constant.RIGHT_TOP">Shadow::RIGHT_TOP</a>, <a href="Shadow.html#constant.LEFT_BOTTOM">Shadow::LEFT_BOTTOM</a> ou <a href="Shadow.html#constant.RIGHT_BOTTOM">Shadow::RIGHT_BOTTOM</a>.
140
			</div>
141
<div class="description-bottom"><a href="Shadow.html#top">Remonter</a></div>
142
</li>
143
<li class="property">
144
<a id="property.hide"></a><span class="access">protected</span> <span class="type">bool</span> <a href="Shadow.html#property.hide"><span class="argument">$hide</span></a><div class="description">
145
				Détermine si l'ombre doit être cachée.
146
			</div>
147
<div class="description-bottom"><a href="Shadow.html#top">Remonter</a></div>
148
</li>
149
<li class="property">
150
<a id="property.smooth"></a><span class="access">protected</span> <span class="type">bool</span> <a href="Shadow.html#property.smooth"><span class="argument">$smooth</span></a><div class="description">
151
				Détermine si l'ombre doit être lissée ou non.
152
			</div>
153
<div class="description-bottom"><a href="Shadow.html#top">Remonter</a></div>
154
</li>
155
<li class="method">
156
<a id="method.__construct"></a><span class="access">public</span> <a href="Shadow.html#method.__construct">__construct</a>(<span class="type">int</span> <span class="argument">$position</span>)
157
	<div class="description">
158
				Déclare une ombre à la position $position.
159
				$position peut prendre les valeurs <a href="Shadow.html#constant.LEFT_TOP">Shadow::LEFT_TOP</a>, <a href="Shadow.html#constant.RIGHT_TOP">Shadow::RIGHT_TOP</a>, <a href="Shadow.html#constant.LEFT_BOTTOM">Shadow::LEFT_BOTTOM</a> ou <a href="Shadow.html#constant.RIGHT_BOTTOM">Shadow::RIGHT_BOTTOM</a>.
160
			</div>
161
<div class="description-bottom"><a href="Shadow.html#top">Remonter</a></div>
162
</li>
163
<li class="method">
164
<a id="method.hide"></a><span class="access">public</span> <a href="Shadow.html#method.hide">hide</a>(<span class="type">bool</span> <span class="argument">$hide</span>)
165
	<div class="description">
166
				Détermine si l'ombre doit être cachée ou non.
167
			</div>
168
<div class="description-bottom"><a href="Shadow.html#top">Remonter</a></div>
169
</li>
170
<li class="method">
171
<a id="method.show"></a><span class="access">public</span> <a href="Shadow.html#method.show">show</a>(<span class="type">bool</span> <span class="argument">$show</span>)
172
	<div class="description">
173
				Détermine si l'ombre doit être affichée ou non.
174
			</div>
175
<div class="description-bottom"><a href="Shadow.html#top">Remonter</a></div>
176
</li>
177
<li class="method">
178
<a id="method.setSize"></a><span class="access">public</span> <a href="Shadow.html#method.setSize">setSize</a>(<span class="type">int</span> <span class="argument">$size</span>)
179
	<div class="description">
180
				Change la taille de l'ombre pour $size.
181
			</div>
182
<div class="description-bottom"><a href="Shadow.html#top">Remonter</a></div>
183
</li>
184
<li class="method">
185
<a id="method.setColor"></a><span class="access">public</span> <a href="Shadow.html#method.setColor">setColor</a>(<a href="Color.html"><span class="type">Color</span></a> <span class="argument">$color</span>)
186
	<div class="description">
187
				Change la couleur de l'ombre pour $color.
188
			</div>
189
<div class="description-bottom"><a href="Shadow.html#top">Remonter</a></div>
190
</li>
191
<li class="method">
192
<a id="method.setPosition"></a><span class="access">public</span> <a href="Shadow.html#method.setPosition">setPosition</a>(<span class="type">int</span> <span class="argument">$position</span>)
193
	<div class="description">
194
				Change la position de l'ombre.
195
				$position peut prendre les valeurs <a href="Shadow.html#constant.LEFT_TOP">Shadow::LEFT_TOP</a>, <a href="Shadow.html#constant.RIGHT_TOP">Shadow::RIGHT_TOP</a>, <a href="Shadow.html#constant.LEFT_BOTTOM">Shadow::LEFT_BOTTOM</a> ou <a href="Shadow.html#constant.RIGHT_BOTTOM">Shadow::RIGHT_BOTTOM</a>.
196
			</div>
197
<div class="description-bottom"><a href="Shadow.html#top">Remonter</a></div>
198
</li>
199
<li class="method">
200
<a id="method.smooth"></a><span class="access">public</span> <a href="Shadow.html#method.smooth">smooth</a>(<span class="type">bool</span> <span class="argument">$smooth</span>)
201
	<div class="description">
202
				Détermine si l'ombre doit être lissée ou non.
203
			</div>
204
<div class="description-bottom"><a href="Shadow.html#top">Remonter</a></div>
205
</li>
206
<li class="method">
207
<a id="method.getSpace"></a><span class="access">public</span> <a href="Side.html"><span class="type">Side</span></a> <a href="Shadow.html#method.getSpace">getSpace</a>()
208
	<div class="description">
209
				Retourne l'espace pris par l'ombre à gauche, droit, en haut et en bas.
210
				Les espaces sont retournés en pixels.
211
			</div>
212
<div class="description-bottom"><a href="Shadow.html#top">Remonter</a></div>
213
</li>
214
<li class="method">
215
<a id="method.draw"></a><span class="access">public</span> <a href="Shadow.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">$p1</span>, <a href="Point.html"><span class="type">Point</span></a> <span class="argument">$p2</span>, <span class="type">int</span> <span class="argument">$mode</span>)
216
	<div class="description">
217
				Dessine l'ombre avec le pilote $driver dans un rectangle dont la diagonale est le segment qui relie les points $p1 et $p2.
218
				Le paramètre $mode détermine le mode d'affichage de l'ombre. Si <a href="Shadow.html#constant.OUT">Shadow::OUT</a> est spécifié, alors l'ombre sera dessinée en dehors du rectangle. Si <a href="Shadow.html#constant.IN">Shadow::IN</a> est spécifié, alors l'ombre sera dessinée à l'intérieur du rectangle.
219
			</div>
220
<div class="description-bottom"><a href="Shadow.html#top">Remonter</a></div>
221
</li>
222
</ul>
223
</td>
224
				<td class='borderd'>&nbsp;</td>
225
			</tr>
226
			<tr>
227
				<td class='cornerbg'></td>
228
				<td class='borderb'>&nbsp;</td>
229
				<td class='cornerbd'></td>
230
			</tr>
231
		</table>
232
		</div>
233
	</body>
234
</html>