2 * Copyright (c) 2007, Arnaud Giersch <arnaud.giersch@iut-bm.univ-fcomte.fr>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. The name of the author may not be used to endorse or promote
14 * products derived from this software without specific prior
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
18 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
21 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
23 * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
25 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 #include "DrawingWindow.h"
31 #include <QApplication>
32 #include <QPaintEvent>
34 #include <QTimerEvent>
36 /*! \class DrawingWindow
37 * \brief Fenêtre de dessin.
39 * \author Arnaud Giersch <arnaud.giersch@iut-bm.univ-fcomte.fr>
42 * Cette classe décrit un widget Qt permettant d'écrire des
43 * applications graphiques simples. Pour cela, il faut définir une
44 * fonction de dessin. Cette fonction ne retourne rien et prend comme
45 * unique paramètre une référence vers un objet de class
48 * La fonction devra ensuite être passée en paramètre pour les
49 * constructeurs de la classe, ainsi que les dimension requises pour
50 * la fenêtre graphique. Le programme est ensuite compilé comme
51 * n'importe quel programme Qt.
53 * Concrètement, la fonction sera exécutée dans un nouveau thread,
54 * tandis que le thread principal s'occupera de la gestion des
55 * évènements et du rendu dans la fenêtre.
57 * <b>NB.</b> Pour toutes les méthodes de dessin, le coin en haut à gauche
58 * de la fenêtre a les coordonnées (0, 0). Le coin en bas à droite de
59 * la fenêtre a les coordonnées (largeur - 1, hauteur - 1), si la
60 * fenêtre est de dimension largeur × hauteur.
62 * Un appui sur la touche <Esc> provoque la fermeture de la fenêtre.
63 * Comme pour la plupart des applications, il est également possible
64 * de fermer la fenêtre via le gestionnaire de fenêtres.
66 * Il est possible, dans une application, d'ouvrir plusieurs fenêtres,
67 * avec des fonctions de dessin éventuellement différentes.
68 * L'application se terminera normalement lorsque la dernière fenêtre
72 /*! \example hello.cpp
74 * Voir le code source à la fin de la page. Pour compiler et exécuter
75 * ce programme, il faut :
77 * <b>1. Créer le fichier \c hello.pro</b>
79 * Pour simplifier, ce fichier contient la liste des fichiers sources
80 * composant le programme.
84 * <b>2. Créer le fichier \c Makefile avec la commande :</b>
86 * \verbatim qmake-qt4 hello.pro \endverbatim
87 * ou tout simplement :
88 * \verbatim qmake-qt4 \endverbatim
90 * <b>3. Compiler le programme avec la commande :</b>
92 * \verbatim make hello \endverbatim
93 * ou tout simplement :
94 * \verbatim make \endverbatim
96 * <b>4. Exécuter le programme avec la commande :</b>
98 * \verbatim ./exemple \endverbatim
100 * <b>Code source de l'exemple</b>
103 /*! \example exemple.cpp
105 * Un exemple un peu plus sophistiqué.
108 //! Classe de thread.
109 class DrawingThread: public QThread {
111 DrawingThread(DrawingWindow &w, DrawingWindow::ThreadFunction f);
112 void start_once(Priority priority = InheritPriority);
118 DrawingWindow &drawingWindow;
119 DrawingWindow::ThreadFunction threadFunction;
122 friend class DrawingWindow;
126 SyncRequest = QEvent::User, //!< Demande de synchronisation.
127 CloseRequest, //!< Demande de fermeture de la fenêtre.
128 DrawTextRequest, //!< Demande d'écriture de texte.
131 //! Demande de synchronisation.
132 class SyncRequestEvent: public QEvent {
134 SyncRequestEvent(): QEvent(static_cast<QEvent::Type>(SyncRequest))
138 //! Demande de fermeture de fenêtre.
139 class CloseRequestEvent: public QEvent {
141 CloseRequestEvent(): QEvent(static_cast<QEvent::Type>(CloseRequest))
145 //! Demande de tracé de texte.
146 class DrawTextEvent: public QEvent {
152 DrawTextEvent(int x_, int y_, const char* text_, int flags_)
153 : QEvent(static_cast<QEvent::Type>(DrawTextRequest))
154 , x(x_), y(y_), text(text_), flags(flags_)
158 //--- DrawingWindow ----------------------------------------------------
160 /*! \file DrawingWindow.h
161 * \brief Classe DrawingWindow.
164 /*! \typedef DrawingWindow::ThreadFunction
165 * \brief Type de la fonction de dessin, passée en paramètre de construction.
167 /*! \var DrawingWindow::DEFAULT_WIDTH
168 * \brief Largeur par défaut de la fenêtre.
170 /*! \var DrawingWindow::DEFAULT_HEIGHT
171 * \brief Hauteur par défaut de la fenêtre.
173 /*! \var DrawingWindow::width
174 * \brief Largeur de la fenêtre.
176 /*! \var DrawingWindow::height
177 * \brief Hauteur de la fenêtre.
179 /*! \var DrawingWindow::paintInterval
180 * \brief Intervalle de temps entre deux rendus (ms).
185 * Construit une nouvelle fenêtre de dessin avec les dimensions
186 * passées en paramètres. La fonction fun sera exécutée dans un
189 * \param fun fonction de dessin
190 * \param width_ largeur de la fenêtre
191 * \param height_ hauteur de la fenêtre
195 DrawingWindow::DrawingWindow(ThreadFunction fun, int width_, int height_)
205 * Construit un nouveau widget de dessin avec les dimensions passées
206 * en paramètres. La fonction fun sera exécutée dans un nouveau
209 * \param parent widget parent
210 * \param fun fonction de dessin
211 * \param width_ largeur de la fenêtre
212 * \param height_ hauteur de la fenêtre
216 DrawingWindow::DrawingWindow(QWidget *parent,
217 ThreadFunction fun, int width_, int height_)
227 * Construit un nouveau widget de dessin avec les dimensions passées
228 * en paramètres. La fonction fun sera exécutée dans un nouveau
231 * \param parent widget parent
232 * \param flags flags passés au constructeur de QWidget
233 * \param fun fonction de dessin
234 * \param width_ largeur de la fenêtre
235 * \param height_ hauteur de la fenêtre
239 DrawingWindow::DrawingWindow(QWidget *parent, Qt::WindowFlags flags,
240 ThreadFunction fun, int width_, int height_)
241 : QWidget(parent, flags)
249 DrawingWindow::~DrawingWindow()
256 //! Change la couleur de dessin.
258 * La couleur est un entier, tel que retourné par getPointColor.
259 * Normalement de la forme #00RRGGBB.
261 * \param color couleur
263 * \see setColor(const char *), setColor(float, float, float),
264 * setBgColor(unsigned int),
267 void DrawingWindow::setColor(unsigned int color)
269 setColor(QColor::fromRgb(color));
272 //! Change la couleur de dessin.
274 * Le nom de couleur est de la forme "black", "white", "red", "blue", ...
276 * \param name nom de couleur
278 * \see setColor(unsigned int), setColor(float, float, float),
279 * setBgColor(const char *)
280 * \see http://www.w3.org/TR/SVG/types.html#ColorKeywords
282 void DrawingWindow::setColor(const char *name)
284 setColor(QColor(name));
287 //! Change la couleur de dessin.
289 * Les composantes de rouge, vert et bleu de la couleur doivent être
290 * compris entre 0 et 1. Si le trois composantes sont à 0, on obtient
291 * du noir; si les trois composantes sont à 1, on obtient du blanc.
293 * \param red composante de rouge
294 * \param green composante de vert
295 * \param blue composante de bleu
297 * \see setColor(unsigned int), setColor(const char *),
298 * setBgColor(float, float, float)
300 void DrawingWindow::setColor(float red, float green, float blue)
302 setColor(QColor::fromRgbF(red, green, blue));
305 //! Change la couleur de fond.
307 * \param color couleur
309 * \see setBgColor(const char *), setBgColor(float, float, float),
310 * setColor(unsigned int),
314 void DrawingWindow::setBgColor(unsigned int color)
316 setBgColor(QColor::fromRgb(color));
319 //! Change la couleur de fond.
321 * \param name nom de couleur
323 * \see setBgColor(unsigned int), setBgColor(float, float, float),
324 * setColor(const char *),
326 * \see http://www.w3.org/TR/SVG/types.html#ColorKeywords
328 void DrawingWindow::setBgColor(const char *name)
330 setBgColor(QColor(name));
333 //! Change la couleur de fond.
335 * \param red composante de rouge
336 * \param green composante de vert
337 * \param blue composante de bleu
339 * \see setBgColor(unsigned int), setBgColor(const char *),
340 * setColor(float, float, float),
343 void DrawingWindow::setBgColor(float red, float green, float blue)
345 setBgColor(QColor::fromRgbF(red, green, blue));
348 //! Efface la fenêtre.
350 * La fenêtre est effacée avec la couleur de fond courante.
354 void DrawingWindow::clearGraph()
356 safeLock(imageMutex);
357 painter->fillRect(image->rect(), getBgColor());
359 safeUnlock(imageMutex);
362 //! Dessine un point.
364 * Dessine un point (pixel) aux coordonnées (x, y), avec la couleur de
367 * \param x, y coordonnées du point
371 void DrawingWindow::drawPoint(int x, int y)
373 safeLock(imageMutex);
374 painter->drawPoint(x, y);
376 safeUnlock(imageMutex);
379 //! Dessine un segment.
381 * Dessine un segement de droite entre les coordonnées (x1, y1) et
382 * (x2, y2), avec la couleur de dessin courante.
384 * \param x1, y1 coordonnées d'une extrémité du segment
385 * \param x2, y2 coordonnées de l'autre extrémité du segment
389 void DrawingWindow::drawLine(int x1, int y1, int x2, int y2)
391 safeLock(imageMutex);
392 painter->drawLine(x1, y1, x2, y2);
393 dirty(x1, y1, x2, y2);
394 safeUnlock(imageMutex);
397 //! Dessine un rectangle.
399 * Dessine le rectangle parallèle aux axes et défini par les
400 * coordonnées de deux sommets opposés (x1, y1) et (x2, y2). Utilise
401 * la couleur de dessin courante.
403 * \param x1, y1 coordonnées d'un sommet du rectangle
404 * \param x2, y2 coordonnées du sommet opposé du rectangle
406 * \see fillRect, setColor
408 void DrawingWindow::drawRect(int x1, int y1, int x2, int y2)
411 r.setCoords(x1, y1, x2 - 1, y2 - 1);
413 safeLock(imageMutex);
414 painter->drawRect(r);
415 r.adjust(0, 0, 1, 1);
417 safeUnlock(imageMutex);
420 //! Dessine un rectangle plein.
422 * Dessine le rectangle plein parallèle aux axes et défini par les
423 * coordonnées de deux sommets opposés (x1, y1) et (x2, y2). Utilise
424 * la couleur de dessin courante.
426 * \param x1, y1 coordonnées d'un sommet du rectangle
427 * \param x2, y2 coordonnées du sommet opposé du rectangle
429 * \see drawRect, setColor
431 void DrawingWindow::fillRect(int x1, int y1, int x2, int y2)
433 painter->setBrush(getColor());
434 drawRect(x1, y1, x2, y2);
435 painter->setBrush(Qt::NoBrush);
438 //! Dessine un cercle.
440 * Dessine un cercle de centre (x, y) et de rayon r. Utilise la
441 * couleur de dessin courante.
443 * \param x, y coordonnées du centre du cercle
444 * \param r rayon du cercle
446 * \see fillCircle, setColor
448 void DrawingWindow::drawCircle(int x, int y, int r)
451 rect.setCoords(x - r, y - r, x + r - 1, y + r - 1);
452 safeLock(imageMutex);
453 painter->drawEllipse(rect);
454 rect.adjust(0, 0, 1, 1);
456 safeUnlock(imageMutex);
459 //! Dessine un disque.
461 * Dessine un disque (cercle plein) de centre (x, y) et de rayon r.
462 * Utilise la couleur de dessin courante.
464 * \param x, y coordonnées du centre du disque
465 * \param r rayon du disque
467 * \see drawCircle, setColor
469 void DrawingWindow::fillCircle(int x, int y, int r)
471 painter->setBrush(getColor());
473 painter->setBrush(Qt::NoBrush);
478 * Écrit le texte text, aux coordonnées (x, y) et avec les paramètres
479 * d'alignement flags. Le texte est écrit avec la couleur de dessin
480 * courante. Les flags sont une combinaison (ou binaire) de
481 * Qt::AlignLeft, Qt::AligneRight, Qt::AlignHCenter, Qt::AlignTop,
482 * Qt::AlignBottom, Qt::AlignVCenter, Qt::AlignCenter. Par défaut, le
483 * texte est aligné en haut à gauche.
485 * \param x, y coordonnées du texte
486 * \param text texte à écrire
487 * \param flags paramètres d'alignement
489 * \see drawTextBg, setColor
490 * \see QPainter::drawText
492 void DrawingWindow::drawText(int x, int y, const char *text, int flags)
495 if (!terminateThread) {
496 qApp->postEvent(this, new DrawTextEvent(x, y, text, flags));
497 syncCondition.wait(&syncMutex);
499 safeUnlock(syncMutex);
502 //! Écrit du texte sur fond coloré.
504 * Écrit du texte comme drawText, mais l'arrière-plan est coloré avec
505 * la couleur de fond courante.
507 * \param x, y coordonnées du texte
508 * \param text texte à écrire
509 * \param flags paramètres d'alignement
511 * \see drawText, setColor, setColorBg
513 void DrawingWindow::drawTextBg(int x, int y, const char *text, int flags)
515 painter->setBackgroundMode(Qt::OpaqueMode);
516 drawText(x, y, text, flags);
517 painter->setBackgroundMode(Qt::TransparentMode);
521 //! Retourne la couleur d'un pixel.
523 * Retourne la couleur du pixel de coordonnées (x, y). La valeur
524 * retournée peut servir de paramètres à setColor(unsigned int) ou
525 * setBgColor(unsigned int).
527 * \param x, y coordonnées du pixel
528 * \return couleur du pixel
530 * \see setColor(unsigned int), setBgColor(unsigned int)
532 unsigned int DrawingWindow::getPointColor(int x, int y)
534 return image->pixel(x, y);
537 //! Synchronise le contenu de la fenêtre.
539 * Pour des raisons d'efficacités, le résultat des fonctions de dessin
540 * n'est pas affiché immédiatement. L'appel à sync permet de
541 * synchroniser le contenu de la fenêtre. Autrement dit, cela bloque
542 * l'exécution du programme jusqu'à ce que le contenu de la fenêtre
545 * \param time durée maximale de l'attente
546 * \return true si la fenêtre a pu être synchronisée
548 bool DrawingWindow::sync(unsigned long time)
552 if (terminateThread) {
555 qApp->postEvent(this, new SyncRequestEvent());
556 synced = syncCondition.wait(&syncMutex, time);
558 safeUnlock(syncMutex);
562 //! Ferme la fenêtre graphique.
563 void DrawingWindow::closeGraph()
565 qApp->postEvent(this, new CloseRequestEvent());
568 //! Suspend l'exécution pendant un certain temps.
570 * \param secs temps d'attente en seconde
572 void DrawingWindow::sleep(unsigned long secs)
574 DrawingThread::sleep(secs);
577 //! Suspend l'exécution pendant un certain temps.
579 * \param msecs temps d'attente en millisecondes
581 void DrawingWindow::msleep(unsigned long msecs)
583 DrawingThread::msleep(msecs);
586 //! Suspend l'exécution pendant un certain temps.
588 * \param usecs temps d'attente en microsecondes
590 void DrawingWindow::usleep(unsigned long usecs)
592 DrawingThread::usleep(usecs);
598 void DrawingWindow::closeEvent(QCloseEvent *ev)
603 terminateThread = true; // this flag is needed for the case
604 // where the following wakeAll() call
605 // occurs between the
606 // setTerminationEnable(false) and the
607 // mutex lock in safeLock() called
609 syncCondition.wakeAll();
611 QWidget::closeEvent(ev);
618 void DrawingWindow::customEvent(QEvent *ev)
620 switch ((int )ev->type()) {
627 case DrawTextRequest:
628 DrawTextEvent* tev = dynamic_cast<DrawTextEvent *>(ev);
629 realDrawText(tev->x, tev->y, tev->text, tev->flags);
637 void DrawingWindow::keyPressEvent(QKeyEvent *ev)
655 void DrawingWindow::paintEvent(QPaintEvent *ev)
657 QPainter widgetPainter(this);
659 QImage imageCopy(*image);
661 QRect rect = ev->rect();
662 widgetPainter.drawImage(rect, imageCopy, rect);
668 void DrawingWindow::showEvent(QShowEvent *ev)
670 QWidget::showEvent(ev);
673 timer.start(paintInterval, this);
674 thread->start_once(QThread::IdlePriority);
680 void DrawingWindow::timerEvent(QTimerEvent *ev)
682 if (ev->timerId() == timer.timerId()) {
684 timer.start(paintInterval, this);
686 QWidget::timerEvent(ev);
690 //--- DrawingWindow (private methods) ----------------------------------
692 //! Fonction d'initialisation.
694 * Fonction appelée par les différents constructeurs.
696 * \param fun fonction de dessin
698 void DrawingWindow::initialize(DrawingWindow::ThreadFunction fun)
700 terminateThread = false;
702 image = new QImage(width, height, QImage::Format_RGB32);
703 painter = new QPainter(image);
704 thread = new DrawingThread(*this, fun);
706 setFocusPolicy(Qt::StrongFocus);
707 setFixedSize(image->size());
708 setAttribute(Qt::WA_OpaquePaintEvent);
718 //! Change la couleur de dessin.
720 * \param color couleur
723 void DrawingWindow::setColor(const QColor& color)
725 QPen pen(painter->pen());
727 painter->setPen(pen);
730 //! Change la couleur de fond.
732 * \param color couleur
735 void DrawingWindow::setBgColor(const QColor& color)
737 painter->setBackground(color);
740 //! Retourne la couleur de dessin courante.
742 * \return couleur de dessin courante
745 QColor DrawingWindow::getColor()
747 return painter->pen().color();
750 //! Retourne la couleur de fond courante.
752 * \return couleur de fond courante
755 QColor DrawingWindow::getBgColor()
757 return painter->background().color();
760 //! Verrouille un mutex.
762 * S'assure que le thread courant ne peut pas être terminé s'il
763 * détient un mutex. Pendant de safeUnlock.
765 * \param mutex le mutex à verrouiller
770 void DrawingWindow::safeLock(QMutex &mutex)
772 if (lockCount++ == 0)
773 thread->setTerminationEnabled(false);
777 //! Déverrouille un mutex.
779 * S'assure que le thread courant ne peut pas être terminé s'il
780 * détient un mutex. Pendant de safeLock.
782 * \param mutex le mutex à déverrouiller
787 void DrawingWindow::safeUnlock(QMutex &mutex)
790 if (--lockCount == 0)
791 thread->setTerminationEnabled(true);
794 //! Marque l'image entière comme non à jour.
796 void DrawingWindow::dirty()
799 dirtyRect = image->rect();
802 //! Marque un point de l'image comme non à jour.
804 * \param x, y coordonnées du point
807 void DrawingWindow::dirty(int x, int y)
809 dirty(QRect(x, y, 1, 1));
812 //! Marque une zone de l'image comme non à jour.
814 * La zone est définie par un rectangle dont les coordonnées de deux
815 * sommets oppposés sont données.
817 * \param x1, y1 coordonnées d'un sommet du rectangle
818 * \param x2, y2 coordonnées du sommet opposé du rectangle
821 void DrawingWindow::dirty(int x1, int y1, int x2, int y2)
824 r.setCoords(x1, y1, x2, y2);
825 dirty(r.normalized());
828 //! Marque une zone de l'image comme non à jour.
830 * \param rect rectangle délimitant la zone
832 void DrawingWindow::dirty(const QRect &rect)
842 //! Génère un update si besoin.
844 * Génère une demande de mise à jour de la fenêtre (appel à update)
845 * s'il y en a besoin.
847 void DrawingWindow::mayUpdate()
850 bool dirty = dirtyFlag;
851 QRect rect = dirtyRect;
858 //! Fonction bas-niveau pour sync.
860 * Fonction de synchronisation dans le thread principal.
862 * \see sync, customEvent
864 void DrawingWindow::realSync()
867 qApp->sendPostedEvents(this, QEvent::UpdateLater);
868 qApp->sendPostedEvents(this, QEvent::UpdateRequest);
869 qApp->sendPostedEvents(this, QEvent::Paint);
870 qApp->processEvents(QEventLoop::ExcludeUserInputEvents |
871 QEventLoop::ExcludeSocketNotifiers |
872 QEventLoop::DeferredDeletion |
873 QEventLoop::X11ExcludeTimers);
877 syncCondition.wakeAll();
881 //! Fonction bas-niveau pour drawText.
883 * Le rendu de texte doit être fait dans le thread principal. D'où
884 * les manipulations tordues et la synchronisation qui s'en suit.
886 * \param x, y, text, flags cf. drawText
888 * \see drawText, customEvent
890 void DrawingWindow::realDrawText(int x, int y, const char *text, int flags)
892 QRect r(image->rect());
893 switch (flags & Qt::AlignHorizontal_Mask) {
897 case Qt::AlignHCenter:
899 r.setLeft(2 * x - width + 1);
906 switch (flags & Qt::AlignVertical_Mask) {
907 case Qt::AlignBottom:
910 case Qt::AlignVCenter:
912 r.setTop(2 * y - height + 1);
920 painter->drawText(r, flags, text, &r);
922 syncCondition.wakeAll();
926 //--- DrawingThread ----------------------------------------------------
929 DrawingThread::DrawingThread(DrawingWindow &w, DrawingWindow::ThreadFunction f)
932 , started_once(false)
936 //! Démarre le thread si ce n'a pas encore été fait.
937 void DrawingThread::start_once(Priority priority)
945 //! La vraie fonction pour le thread.
946 void DrawingThread::run()
948 threadFunction(drawingWindow);