| 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'> </td>
|
|
|
13 |
<td class='borderh'> </td>
|
|
|
14 |
<td class='cornerhd'></td>
|
|
|
15 |
</tr>
|
|
|
16 |
<tr>
|
|
|
17 |
<td class='borderg'> </td>
|
|
|
18 |
<td><a id="top"></a><h2> Class Tick</h2><div class="description">
|
|
|
19 |
<p>
|
|
|
20 |
La classe <a href="Tick.html">Tick</a> permet de représenter des ticks, petits traits réguliers associés à un axe.
|
|
|
21 |
</p>
|
|
|
22 |
<div class="image">
|
|
|
23 |
<img src="doc/image/ticks-out.png" style="margin-right: 42px" alt="Ticks à l'extérieur">
|
|
|
24 |
<img src="doc/image/ticks-in.png" alt="Ticks à l'intérieur">
|
|
|
25 |
</div>
|
|
|
26 |
<p>
|
|
|
27 |
De nombreuses méthodes de la classe <a href="Tick.html">Tick</a> ne sont pas documentées,
|
|
|
28 |
car elles ne sont utilisées qu'en interne par Artichow.
|
|
|
29 |
Néanmoins, si vous développez Artichow, vous aurez besoin de ces méthodes.
|
|
|
30 |
N'hésitez donc pas à parcourir le code source de cette classe.
|
|
|
31 |
</p>
|
|
|
32 |
</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">
|
|
|
33 |
<li>
|
|
|
34 |
<span class="access">const</span> <span class="type">string</span> <a href="Tick.html#constant.OUT">OUT</a> := <span class="default">0</span>
|
|
|
35 |
</li>
|
|
|
36 |
<li>
|
|
|
37 |
<span class="access">const</span> <span class="type">string</span> <a href="Tick.html#constant.IN">IN</a> := <span class="default">1</span>
|
|
|
38 |
</li>
|
|
|
39 |
<li>
|
|
|
40 |
<span class="access">const</span> <span class="type">string</span> <a href="Tick.html#constant.IN_OUT">IN_OUT</a> := <span class="default">2</span>
|
|
|
41 |
</li>
|
|
|
42 |
</ul><ul class="methods">
|
|
|
43 |
<li>
|
|
|
44 |
<span class="access">public</span> <a href="Tick.html#method.__construct">__construct</a>(<span class="type">int</span> <span class="argument">$number</span>, <span class="type">int</span> <span class="argument">$size</span>)
|
|
|
45 |
</li>
|
|
|
46 |
<li>
|
|
|
47 |
<span class="access">public</span> <a href="Tick.html#method.setStyle">setStyle</a>(<span class="type">int</span> <span class="argument">$style</span>)
|
|
|
48 |
</li>
|
|
|
49 |
<li>
|
|
|
50 |
<span class="access">public</span> <a href="Tick.html#method.setColor">setColor</a>(<a href="Color.html"><span class="type">Color</span></a> <span class="argument">$color</span>)
|
|
|
51 |
</li>
|
|
|
52 |
<li>
|
|
|
53 |
<span class="access">public</span> <a href="Tick.html#method.setSize">setSize</a>(<span class="type">int</span> <span class="argument">$size</span>)
|
|
|
54 |
</li>
|
|
|
55 |
<li>
|
|
|
56 |
<span class="access">public</span> <a href="Tick.html#method.setInterval">setInterval</a>(<span class="type">int</span> <span class="argument">$interval</span>)
|
|
|
57 |
</li>
|
|
|
58 |
<li>
|
|
|
59 |
<span class="access">public</span> <a href="Tick.html#method.setNumber">setNumber</a>(<span class="type">int</span> <span class="argument">$number</span>)
|
|
|
60 |
</li>
|
|
|
61 |
<li>
|
|
|
62 |
<span class="access">public</span> <a href="Tick.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="Tick.html#method.hideFirst">hideFirst</a>(<span class="type">bool</span> <span class="argument">$hideFirst</span>)
|
|
|
66 |
</li>
|
|
|
67 |
<li>
|
|
|
68 |
<span class="access">public</span> <a href="Tick.html#method.hideLast">hideLast</a>(<span class="type">bool</span> <span class="argument">$hideLast</span>)
|
|
|
69 |
</li>
|
|
|
70 |
<li>
|
|
|
71 |
<span class="access">public</span> <a href="Tick.html#method.draw">draw</a>(<a href="Driver.html"><span class="type">Driver</span></a> <span class="argument">$driver</span>, <a href="Vector.html"><span class="type">Vector</span></a> <span class="argument">$vector</span>)
|
|
|
72 |
</li>
|
|
|
73 |
</ul><h2>Documentation</h2><ul class="doc">
|
|
|
74 |
<li class="constant">
|
|
|
75 |
<a id="constant.OUT"></a><span class="access">const</span> <span class="type">string</span> <a href="Tick.html#constant.OUT">OUT</a> := <span class="default">0</span><div class="description">
|
|
|
76 |
Indique que les ticks doivent être tournés vers l'extérieur.
|
|
|
77 |
</div>
|
|
|
78 |
<div class="description-bottom"><a href="Tick.html#top">Remonter</a></div>
|
|
|
79 |
</li>
|
|
|
80 |
<li class="constant">
|
|
|
81 |
<a id="constant.IN"></a><span class="access">const</span> <span class="type">string</span> <a href="Tick.html#constant.IN">IN</a> := <span class="default">1</span><div class="description">
|
|
|
82 |
Indique que les types doivent être tournés vers l'intérieur.
|
|
|
83 |
</div>
|
|
|
84 |
<div class="description-bottom"><a href="Tick.html#top">Remonter</a></div>
|
|
|
85 |
</li>
|
|
|
86 |
<li class="constant">
|
|
|
87 |
<a id="constant.IN_OUT"></a><span class="access">const</span> <span class="type">string</span> <a href="Tick.html#constant.IN_OUT">IN_OUT</a> := <span class="default">2</span><div class="description">
|
|
|
88 |
Indique que les ticks sont et tournés vers l'extérieur, et tournés vers l'intérieur.
|
|
|
89 |
</div>
|
|
|
90 |
<div class="description-bottom"><a href="Tick.html#top">Remonter</a></div>
|
|
|
91 |
</li>
|
|
|
92 |
<li class="method">
|
|
|
93 |
<a id="method.__construct"></a><span class="access">public</span> <a href="Tick.html#method.__construct">__construct</a>(<span class="type">int</span> <span class="argument">$number</span>, <span class="type">int</span> <span class="argument">$size</span>)
|
|
|
94 |
<div class="description">
|
|
|
95 |
Construit un nouvel objet <a href="Tick.html">Tick</a>.
|
|
|
96 |
$number représente un nombre de ticks et $size leur taille en pixels.
|
|
|
97 |
</div>
|
|
|
98 |
<div class="description-bottom"><a href="Tick.html#top">Remonter</a></div>
|
|
|
99 |
</li>
|
|
|
100 |
<li class="method">
|
|
|
101 |
<a id="method.setStyle"></a><span class="access">public</span> <a href="Tick.html#method.setStyle">setStyle</a>(<span class="type">int</span> <span class="argument">$style</span>)
|
|
|
102 |
<div class="description">
|
|
|
103 |
Change le style des ticks. Peut être <a href="Tick.html#constant.IN">Tick::IN</a>, <a href="Tick.html#constant.OUT">Tick::OUT</a> ou <a href="Tick.html#constant.IN_OUT">Tick::IN_OUT</a>.
|
|
|
104 |
Dans le premier cas, les ticks seront tournés vers l'intérieur. Dans le second vers l'extérieur et dans le troisième et vers l'extérieur et vers l'intérieur.
|
|
|
105 |
</div>
|
|
|
106 |
<div class="description-bottom"><a href="Tick.html#top">Remonter</a></div>
|
|
|
107 |
</li>
|
|
|
108 |
<li class="method">
|
|
|
109 |
<a id="method.setColor"></a><span class="access">public</span> <a href="Tick.html#method.setColor">setColor</a>(<a href="Color.html"><span class="type">Color</span></a> <span class="argument">$color</span>)
|
|
|
110 |
<div class="description">
|
|
|
111 |
Change la couleur des ticks pour $color.
|
|
|
112 |
Par défaut, les ticks sont dessinés en noir.
|
|
|
113 |
</div>
|
|
|
114 |
<div class="description-bottom"><a href="Tick.html#top">Remonter</a></div>
|
|
|
115 |
</li>
|
|
|
116 |
<li class="method">
|
|
|
117 |
<a id="method.setSize"></a><span class="access">public</span> <a href="Tick.html#method.setSize">setSize</a>(<span class="type">int</span> <span class="argument">$size</span>)
|
|
|
118 |
<div class="description">
|
|
|
119 |
Change la taille des ticks pour $size.
|
|
|
120 |
$size doit être donné en pixels.
|
|
|
121 |
</div>
|
|
|
122 |
<div class="description-bottom"><a href="Tick.html#top">Remonter</a></div>
|
|
|
123 |
</li>
|
|
|
124 |
<li class="method">
|
|
|
125 |
<a id="method.setInterval"></a><span class="access">public</span> <a href="Tick.html#method.setInterval">setInterval</a>(<span class="type">int</span> <span class="argument">$interval</span>)
|
|
|
126 |
<div class="description">
|
|
|
127 |
Change l'intervalle d'affichage des ticks par rapport à leur nombre.
|
|
|
128 |
Si $interval vaut 1, alors tous les ticks seront affichés.
|
|
|
129 |
Si $interval vaut 0.5, alors un tick sur deux sera affiché.
|
|
|
130 |
<div class="see">
|
|
|
131 |
Voir aussi :
|
|
|
132 |
<ul><li><a href="Tick.html#method.setNumber">Tick::setNumber()</a></li></ul>
|
|
|
133 |
</div>
|
|
|
134 |
</div>
|
|
|
135 |
<div class="description-bottom"><a href="Tick.html#top">Remonter</a></div>
|
|
|
136 |
</li>
|
|
|
137 |
<li class="method">
|
|
|
138 |
<a id="method.setNumber"></a><span class="access">public</span> <a href="Tick.html#method.setNumber">setNumber</a>(<span class="type">int</span> <span class="argument">$number</span>)
|
|
|
139 |
<div class="description">
|
|
|
140 |
Change le nombre de ticks à afficher pour $number.
|
|
|
141 |
<div class="see">
|
|
|
142 |
Voir aussi :
|
|
|
143 |
<ul><li><a href="Tick.html#method.setInterval">Tick::setInterval()</a></li></ul>
|
|
|
144 |
</div>
|
|
|
145 |
</div>
|
|
|
146 |
<div class="description-bottom"><a href="Tick.html#top">Remonter</a></div>
|
|
|
147 |
</li>
|
|
|
148 |
<li class="method">
|
|
|
149 |
<a id="method.hide"></a><span class="access">public</span> <a href="Tick.html#method.hide">hide</a>(<span class="type">bool</span> <span class="argument">$hide</span>)
|
|
|
150 |
<div class="description">
|
|
|
151 |
Permet de cache ou d'afficher les ticks.
|
|
|
152 |
</div>
|
|
|
153 |
<div class="description-bottom"><a href="Tick.html#top">Remonter</a></div>
|
|
|
154 |
</li>
|
|
|
155 |
<li class="method">
|
|
|
156 |
<a id="method.hideFirst"></a><span class="access">public</span> <a href="Tick.html#method.hideFirst">hideFirst</a>(<span class="type">bool</span> <span class="argument">$hideFirst</span>)
|
|
|
157 |
<div class="description">
|
|
|
158 |
Permet de cache ou d'afficher le premier tick.
|
|
|
159 |
</div>
|
|
|
160 |
<div class="description-bottom"><a href="Tick.html#top">Remonter</a></div>
|
|
|
161 |
</li>
|
|
|
162 |
<li class="method">
|
|
|
163 |
<a id="method.hideLast"></a><span class="access">public</span> <a href="Tick.html#method.hideLast">hideLast</a>(<span class="type">bool</span> <span class="argument">$hideLast</span>)
|
|
|
164 |
<div class="description">
|
|
|
165 |
Permet de cache ou d'afficher le dernier tick.
|
|
|
166 |
</div>
|
|
|
167 |
<div class="description-bottom"><a href="Tick.html#top">Remonter</a></div>
|
|
|
168 |
</li>
|
|
|
169 |
<li class="method">
|
|
|
170 |
<a id="method.draw"></a><span class="access">public</span> <a href="Tick.html#method.draw">draw</a>(<a href="Driver.html"><span class="type">Driver</span></a> <span class="argument">$driver</span>, <a href="Vector.html"><span class="type">Vector</span></a> <span class="argument">$vector</span>)
|
|
|
171 |
<div class="description">
|
|
|
172 |
Dessine les ticks sur le vecteur $vector.
|
|
|
173 |
</div>
|
|
|
174 |
<div class="description-bottom"><a href="Tick.html#top">Remonter</a></div>
|
|
|
175 |
</li>
|
|
|
176 |
</ul>
|
|
|
177 |
</td>
|
|
|
178 |
<td class='borderd'> </td>
|
|
|
179 |
</tr>
|
|
|
180 |
<tr>
|
|
|
181 |
<td class='cornerbg'></td>
|
|
|
182 |
<td class='borderb'> </td>
|
|
|
183 |
<td class='cornerbd'></td>
|
|
|
184 |
</tr>
|
|
|
185 |
</table>
|
|
|
186 |
</div>
|
|
|
187 |
</body>
|
|
|
188 |
</html>
|