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
|
Ce manuel utilisateur a pour objectif de faciliter l'utilisation de MTools.
La première patie décrit en détail les fonctionnalités générales c'est à dire
celles communes à tous les objets MTools.
La deuxième partie décrit l'utilisation spécifique de chaque objet.
PARTIE 1 : Les fonctionnalités communes
---------------------------------------
1.1 MTools.pm
-------------
Cette partie de la documentation est principalement extraite de MTools.pm
MTools exporte des fonctions destinées principalement à :
- activer des fonctions propres à la librairie mtools
- assurer la compatibilité entre la manipulation des objets mtools et des
objets zincs
Ainsi, d'une manière générale, toutes fonctions exportées s'appliquent aussi
bien à des objets zinc qu'à des objets mtools. L'unique restriction est dans la
méthode d'appel :
- obligatoirement : fct ($obj, @parametres) pour un objet zinc
- indiferemment $obj -> fct (@parametres).
L'avantage de la première méthode est qu'elle s'applique aussi bien à un objet
zinc qu'à un objet MTools. L'inconvénient est que l'on perd la possibilité de
profiter de l'héritage et de la redéfinition éventuelle de la fonction.
La fonction particuliere "new" :
La fonction "new" permet de générer une nouvelle frame encapsulant un
canvas zinc.
Une frame MTools est unique pour une application.
Elle initialise par ailleurs les données génériques pour le
fonctionnement de MTools.
Les callbacks dans MTools :
\&fct : exécution de fct ()
[\&fct, @params] : exécution de fct (@params)
['fct_name', $obj, @params] : exécution de $obj -> fct_name (@params)
[$obj, 'fct_name', @params] : exécution de $obj -> fct_name (@params)
[$obj, \&fct_name, @params] : exécution de fct_name ($obj, @params)
Fonctions :
- propertyExists : teste si une propriété MTools a été enregistrée (par
recordProperty) pour l'objet en question. S'il s'agit d'un objet zinc la
valeur retournée est forcément 0.
- mconfigure : permet de configurer indifférement des propriétes zinc ou
MTools d'un objet. Les paramètres sont passés sous forme d'une table de
hash. Par habitude, les propriétes zinc ou definies pour assurer une
compatibilité avec zinc (comme '-visible') ont été précédées d'un '-'.
- mget : $obj -> mget ('propriete') permet de récupérer la valeur d'une
propriété
- plisten : $obj -> plisten ('property_name', callback) plisten permet
d'écouter les modifications des propriétés mtools d'un objet => associe
l'appel d'une fonction à la modification d'un objet MTools
- unplisten : $obj -> unplisten ('property_name', callback) supprime
l'écoute
- plink : plink ([$obj1, 'property_1'], [$obj2, 'property_2'], ...);
Synchronise n propriétés. Si property_1 est modifiée, property_2 prendra
la valeur de property_1 et réciproquement. À l'initialisation, toutes
les propriétés prennent la valeur de property_1.
- executer : executer (callback); permet d'exécuter une callback du type
predefini ci-dessus dans la section "Les callbacks dans MTools"
- binding : $obj -> binding ('evenement', callback) permet d'écouter un
évènement MTOOLS ou Tk survenant sur un objet. binding peut aussi être
redéfini pour écouter de nouvelles sources d'évènements (par exemple
MIvy ou WacomAdapter)
- unbinding : $obj -> unbinding ('evenement', callback) arrête l'écoute
d'un évènement
- minstanciate : minstanciate ('definition', $parent) permet de
retourner un objet MTools à partir de la spec 'definition'
. si 'definition' est un path svg, minstanciate instancie le svg et
retourne un objet MTools encapsulant le contenu
. si 'definition' est un objet zinc, minstanciate retourne un objet
MTools encapsulant l'objet zinc
. si 'definition' est déjà un objet MTools, minstanciate retourne
l'objet lui-meme.
minstanciate change également le groupe parent qui deviendra
obligatoirement $parent
- minstance : minstance ($objet, $parent) est le cousin de minstanciate
mais lui retourne obligatoirement un objet zinc
- mrun : lance l'exécution de la main loop.
- mfind : $objet -> mfind ('tag') permet de chercher un fils de l'objet
ayant le tag correspondant
- mplaying : permet de lire un fichier son
Les fonctions suivantes encapsulent l'exécution des fonctions zinc
associées. Voir la documentation zinc :
http://www.tkzinc.org/Documentation/refman-3.3.4/index.html
- raise
- scale
- translate
- rotate
- coords
- bbox
- type
- tset
- treset
- tget
- clone
- chggroup
1.2 MObjet.pm
-------------
Cette partie de la documentation est principalement extraite de MObjet.pm
Le composant MObjet est l'objet racine des composants MTools.
Il definit les fonctions applicables uniquement aux objets MTools.
IMPORTANT : Une autre partie des fonctions applicables aux objets MTools est
définie dans la classe MTools. La différence entre ces deux classes de fonctions
est que les fonctions définies dans MTools sont également applicables à des
objets zinc tandis que les fonctions définies ici ne peuvent être appliquées
qu'à des objets héritant de MTools::MObjet.
Concepts :
- Objet MTools : objet héritant de MObjet
- Les PROPERTY : les propriétés sont des attributs particuliers et
modifiables par un appel à "mconfigure". Elles peuvent être écoutées et
synchronisées avec d'autres propriétés MTools ou meme zinc ! (cf
MTools::plink et MTools::plisten). En conséquence elles sont là pour
engendrer un comportement consécutif à leur modification et doivent être
distinguées des attibuts qui peuvent se contenter d'être des clef de
hash de l'objet.
- Les EVENT : les évènements peuvent être émis par n'importe quel objet
MTools et captés par un binding.
Les fonctions publiques :
- recordEvent : permet de permettre à un objet MObjet d'émettre un
évènement.
- recordProperty : permet de déclarer et initialiser une propriété.
NOTA : il pourrait manquer une déclaration collective des
propriétés. Initialement, celle-ci n'a pas été effectuée pour essayer de
limiter l'usage des propriétés et ne pas les utiliser comme des
attributs.
- notify : permet à un objet MTools de notifier un évènement
préalablement enregistré par recordEvent
- propagate : permet à un objet de propager un évènement émis par un
autre objet (correspond à un recordEvent puis un binding sur un
évènement d'un objet effectuant le notify du meme évènement depuis
l'objet declarant la propagation)
PARTIE 2 : Les objets de MTools
-------------------------------
2.1 Les éléments graphiques
---------------------------
Les objets graphiques élémentaires sont de type MObjet. Ils se trouvent dans
MTools::GUI.
_______
MCircle : l'objet cercle. La création nécessite les arguments suivants :
- parent : père de l'objet.
- x, y : coordonnées du centre du cercle
- r : rayon du cercle
- %options : table de hash passée en paramètre de la création de l'objet
zinc arc
Exemple d'utilisation :
use MTools;
use MTools::GUI::MCircle;
new MTools (800, 600, "Exemple de cercle");
my $cercle = new MTools::GUI::MCircle (1, 400, 300, 200);
my $disque = new MTools::GUI::MCircle (1, 400, 300, 200,
-filled => 1, -fillcolor => red);
mrun;
________
MRect.pm : l'objet rectangle. La création nécessite les arguments suivants :
- parent : père de l'objet.
- x, y : coordonnées de l'angle en haut à gauche du rectangle
- w, h : largeur et hauteur du rectangle
- %options : table de hash passée en paramètre de la création de l'objet
zinc rectangle
Exemple d'utilisation :
use MTools;
use MTools::GUI::MRect;
new MTools (800, 600, "Exemple de rectangle");
my $contour = new MTools::GUI::MRect (1, 400, 300, 200, 10);
my $surface = new MTools::GUI::MRect (1, 400, 400, 200, 20, -filled => 1, -fillcolor => red);
mrun;
________
MClip.pm : l'objet permettant de faire du clipping. Le clipping est une
technique qui consiste à réaliser une fenêtre de visualisation. En pratique,
le clip est un objet qui définit une surface. Les portions du groupe clippé qui
se trouvent à l'intérieur de cette surface sont visibles, tout ce qui est en
dehors n'est pas affiché.
La création nécessite les arguments suivants :
- clipped : groupe zinc clippé
- path : description de l'objet clippant
- soit une descrition sous forme [_type, _coords] créant un
objet zinc de type _type et de coordonnées _coords
- soit un objet existant qui prendra pour père le groupe $clipped.
Exemple d'utilisation :
use MTools;
use MTools::MGroup;
use MTools::GUI::MCircle;
use MTools::GUI::MRect;
use MTools::GUI::MClip;
new MTools (800, 600, "Exemple de clip");
my $fenetre = new MTools::MGroup (1);
my $disque = new MTools::GUI::MCircle ($fenetre, 400, 300, 100, -filled => 1);
my $trou = new MTools::GUI::MRect ($fenetre, 250, 300, 100, 60);
new MTools::GUI::MClip ($fenetre, $trou);
mrun;
_________
MCurve.pm :
_________________________
MAntiRecouvrementGroup.pm :
_________
MImage.pm :
________
MText.pm :
___________
MTexture.pm :
2.2 Le SVG
2.3 Les widgets
2.4 Les transformations
2.5 Les animations
2.6 Les comportements
2.7 Les inclassables
MGroup, ptkdb, MObjet, MTimer, MState, MSwitch, MIvy, WacomAdapter
2.8 L'utilisation de TkZinc
|
