DrawingWindow.cpp

   1 /*
   2  * Copyright (c) 2007-2010, Arnaud Giersch <arnaud.giersch@iut-bm.univ-fcomte.fr>
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   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
  15  *    written permission.
  16  *
  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.
  28  */
  29
  30 #include "DrawingWindow.h"
  31 #include <QApplication>
  32 #include <QPaintEvent>
  33 #include <QThread>
  34 #include <QTimerEvent>
  35
  36 /*! \class DrawingWindow
  37  *  \brief Fenêtre de dessin.
  38  *
  39  * \author Arnaud Giersch <arnaud.giersch@iut-bm.univ-fcomte.fr>
  40  * \date 2007-2010
  41  *
  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
  46  * DrawingWindow.
  47  *
  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.
  52  *
  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.
  56  *
  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.
  61  *
  62  * Un appui sur la touche &lt;Esc&gt; 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.
  65  *
  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
  69  * sera fermée.
  70  */
  71
  72 /*! \example hello.cpp
  73  *
  74  * Voir le code source à la fin de la page.  Pour compiler et exécuter
  75  * ce programme, il faut :
  76  *
  77  * <b>1. Créer le fichier \c hello.pro</b>
  78  *
  79  * Pour simplifier, ce fichier contient la liste des fichiers sources
  80  * composant le programme.
  81  *
  82  * \include hello.pro
  83  *
  84  * <b>2. Créer le fichier \c Makefile avec la commande :</b>
  85  *
  86  * \verbatim qmake-qt4 hello.pro \endverbatim
  87  * ou tout simplement :
  88  * \verbatim qmake-qt4 \endverbatim
  89  *
  90  * <b>3. Compiler le programme avec la commande :</b>
  91  *
  92  * \verbatim make hello \endverbatim
  93  * ou tout simplement :
  94  * \verbatim make \endverbatim
  95  *
  96  * <b>4. Exécuter le programme avec la commande :</b>
  97  *
  98  * \verbatim ./hello \endverbatim
  99  *
 100  * <b>Code source de l'exemple</b>
 101  */
 102
 103 /*! \example exemple.cpp
 104  *
 105  * Un exemple un peu plus sophistiqué.
 106  */
 107
 108 //! Classe de thread.
 109 class DrawingThread: public QThread {
 110 public:
 111     DrawingThread(DrawingWindow &w, DrawingWindow::ThreadFunction f);
 112     void start_once(Priority priority = InheritPriority);
 113
 114 protected:
 115     void run();
 116
 117 private:
 118     DrawingWindow &drawingWindow;
 119     DrawingWindow::ThreadFunction threadFunction;
 120     bool started_once;
 121
 122     friend class DrawingWindow;
 123 };
 124
 125 enum UserEvents {
 126     SyncRequest = QEvent::User, //!< Demande de synchronisation.
 127     CloseRequest,               //!< Demande de fermeture de la fenêtre.
 128     DrawTextRequest,            //!< Demande d'écriture de texte.
 129 };
 130
 131 //! Demande de synchronisation.
 132 class SyncRequestEvent: public QEvent {
 133 public:
 134     SyncRequestEvent(): QEvent(static_cast<QEvent::Type>(SyncRequest))
 135     { }
 136 };
 137
 138 //! Demande de fermeture de fenêtre.
 139 class CloseRequestEvent: public QEvent {
 140 public:
 141     CloseRequestEvent(): QEvent(static_cast<QEvent::Type>(CloseRequest))
 142     { }
 143 };
 144
 145 //! Demande de tracé de texte.
 146 class DrawTextEvent: public QEvent {
 147 public:
 148     const int x;
 149     const int y;
 150     const char *text;
 151     const int flags;
 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_)
 155     { }
 156 };
 157
 158 //--- DrawingWindow ----------------------------------------------------
 159
 160 /*! \file DrawingWindow.h
 161  *  \brief Classe DrawingWindow.
 162  */
 163
 164 /*! \typedef DrawingWindow::ThreadFunction
 165  *  \brief Type de la fonction de dessin, passée en paramètre de construction.
 166  */
 167 /*! \var DrawingWindow::DEFAULT_WIDTH
 168  *  \brief Largeur par défaut de la fenêtre.
 169  */
 170 /*! \var DrawingWindow::DEFAULT_HEIGHT
 171  *  \brief Hauteur par défaut de la fenêtre.
 172  */
 173 /*! \var DrawingWindow::width
 174  *  \brief Largeur de la fenêtre.
 175  */
 176 /*! \var DrawingWindow::height
 177  *  \brief Hauteur de la fenêtre.
 178  */
 179 /*! \var DrawingWindow::paintInterval
 180  *  \brief Intervalle de temps entre deux rendus (ms).
 181  */
 182
 183 //! Constructeur.
 184 /*!
 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
 187  * nouveau thread.
 188  *
 189  * \param fun           fonction de dessin
 190  * \param width_        largeur de la fenêtre
 191  * \param height_       hauteur de la fenêtre
 192  *
 193  * \see QWidget
 194  */
 195 DrawingWindow::DrawingWindow(ThreadFunction fun, int width_, int height_)
 196     : QWidget()
 197     , width(width_)
 198     , height(height_)
 199 {
 200     initialize(fun);
 201 }
 202
 203 //! Constructeur.
 204 /*!
 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
 207  * thread.
 208  *
 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
 213  *
 214  * \see QWidget
 215  */
 216 DrawingWindow::DrawingWindow(QWidget *parent,
 217                              ThreadFunction fun, int width_, int height_)
 218     : QWidget(parent)
 219     , width(width_)
 220     , height(height_)
 221 {
 222     initialize(fun);
 223 }
 224
 225 //! Constructeur.
 226 /*!
 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
 229  * thread.
 230  *
 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
 236  *
 237  * \see QWidget
 238  */
 239 DrawingWindow::DrawingWindow(QWidget *parent, Qt::WindowFlags flags,
 240                              ThreadFunction fun, int width_, int height_)
 241     : QWidget(parent, flags)
 242     , width(width_)
 243     , height(height_)
 244 {
 245     initialize(fun);
 246 }
 247
 248 //! Destructeur.
 249 DrawingWindow::~DrawingWindow()
 250 {
 251     delete thread;
 252     delete painter;
 253     delete image;
 254 }
 255
 256 //! Change la couleur de dessin.
 257 /*!
 258  * La couleur est un entier, tel que retourné par getPointColor.
 259  * Normalement de la forme #00RRGGBB.
 260  *
 261  * \param color         couleur
 262  *
 263  * \see setColor(const char *), setColor(float, float, float),
 264  *      setBgColor(unsigned int),
 265  *      getPointColor
 266  */
 267 void DrawingWindow::setColor(unsigned int color)
 268 {
 269     setColor(QColor::fromRgb(color));
 270 }
 271
 272 //! Change la couleur de dessin.
 273 /*!
 274  * Le nom de couleur est de la forme "black", "white", "red", "blue", ...
 275  *
 276  * \param name          nom de couleur
 277  *
 278  * \see setColor(unsigned int), setColor(float, float, float),
 279  *      setBgColor(const char *)
 280  * \see http://www.w3.org/TR/SVG/types.html#ColorKeywords
 281  */
 282 void DrawingWindow::setColor(const char *name)
 283 {
 284     setColor(QColor(name));
 285 }
 286
 287 //! Change la couleur de dessin.
 288 /*!
 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.
 292  *
 293  * \param red           composante de rouge
 294  * \param green         composante de vert
 295  * \param blue          composante de bleu
 296  *
 297  * \see setColor(unsigned int), setColor(const char *),
 298  *      setBgColor(float, float, float)
 299  */
 300 void DrawingWindow::setColor(float red, float green, float blue)
 301 {
 302     setColor(QColor::fromRgbF(red, green, blue));
 303 }
 304
 305 //! Change la couleur de fond.
 306 /*!
 307  * \param color         couleur
 308  *
 309  * \see setBgColor(const char *), setBgColor(float, float, float),
 310  *      setColor(unsigned int),
 311  *      getPointColor,
 312  *      clearGraph
 313  */
 314 void DrawingWindow::setBgColor(unsigned int color)
 315 {
 316     setBgColor(QColor::fromRgb(color));
 317 }
 318
 319 //! Change la couleur de fond.
 320 /*!
 321  * \param name          nom de couleur
 322  *
 323  * \see setBgColor(unsigned int), setBgColor(float, float, float),
 324  *      setColor(const char *),
 325  *      clearGraph
 326  * \see http://www.w3.org/TR/SVG/types.html#ColorKeywords
 327  */
 328 void DrawingWindow::setBgColor(const char *name)
 329 {
 330     setBgColor(QColor(name));
 331 }
 332
 333 //! Change la couleur de fond.
 334 /*!
 335  * \param red           composante de rouge
 336  * \param green         composante de vert
 337  * \param blue          composante de bleu
 338  *
 339  * \see setBgColor(unsigned int), setBgColor(const char *),
 340  *      setColor(float, float, float),
 341  *      clearGraph
 342  */
 343 void DrawingWindow::setBgColor(float red, float green, float blue)
 344 {
 345     setBgColor(QColor::fromRgbF(red, green, blue));
 346 }
 347
 348 //! Change l'épaisseur du pinceau
 349 /*!
 350  * Le pinceau à une épaisseur de 1 par défaut.
 351  *
 352  * \param width         épaisseur du pinceau
 353  */
 354 void DrawingWindow::setPenWidth(int width)
 355 {
 356     QPen pen(painter->pen());
 357     pen.setWidth(width);
 358     painter->setPen(pen);
 359 }
 360
 361 //! Retourne la fonte courante utilisée pour dessiner du texte.
 362 /*!
 363  * \see QFont, setFont
 364  */
 365 const QFont &DrawingWindow::getFont() const
 366 {
 367     return painter->font();
 368 }
 369
 370 //! Applique une nouvelle font pour dessiner du texte.
 371 /*!
 372  * \see QFont, getFont
 373  */
 374 void DrawingWindow::setFont(const QFont &font)
 375 {
 376     painter->setFont(font);
 377 }
 378
 379 //! Active ou non l'antialiasing.
 380 /*!
 381  * Permet de lisser le dessin.
 382  * Fonctionnalité désactivée par défaut.
 383  *
 384  * \param state         état de l'antialiasing
 385  *
 386  * \bug                 expérimental
 387  */
 388 void DrawingWindow::setAntialiasing(bool state)
 389 {
 390     painter->setRenderHint(QPainter::Antialiasing, state);
 391 }
 392
 393 //! Efface la fenêtre.
 394 /*!
 395  * La fenêtre est effacée avec la couleur de fond courante.
 396  *
 397  * \see setBgColor
 398  */
 399 void DrawingWindow::clearGraph()
 400 {
 401     safeLock(imageMutex);
 402     painter->fillRect(image->rect(), getBgColor());
 403     dirty();
 404     safeUnlock(imageMutex);
 405 }
 406
 407 //! Dessine un point.
 408 /*!
 409  * Dessine un point (pixel) aux coordonnées (x, y), avec la couleur de
 410  * dessin courante.
 411  *
 412  * \param x, y          coordonnées du point
 413  *
 414  * \see setColor
 415  */
 416 void DrawingWindow::drawPoint(int x, int y)
 417 {
 418     safeLock(imageMutex);
 419     painter->drawPoint(x, y);
 420     dirty(x, y);
 421     safeUnlock(imageMutex);
 422 }
 423
 424 //! Dessine un segment.
 425 /*!
 426  * Dessine un segement de droite entre les coordonnées (x1, y1) et
 427  * (x2, y2), avec la couleur de dessin courante.
 428  *
 429  * \param x1, y1        coordonnées d'une extrémité du segment
 430  * \param x2, y2        coordonnées de l'autre extrémité du segment
 431  *
 432  * \see setColor
 433  */
 434 void DrawingWindow::drawLine(int x1, int y1, int x2, int y2)
 435 {
 436     safeLock(imageMutex);
 437     painter->drawLine(x1, y1, x2, y2);
 438     dirty(x1, y1, x2, y2);
 439     safeUnlock(imageMutex);
 440 }
 441
 442 //! Dessine un rectangle.
 443 /*!
 444  * Dessine le rectangle parallèle aux axes et défini par les
 445  * coordonnées de deux sommets opposés (x1, y1) et (x2, y2).  Utilise
 446  * la couleur de dessin courante.
 447  *
 448  * \param x1, y1        coordonnées d'un sommet du rectangle
 449  * \param x2, y2        coordonnées du sommet opposé du rectangle
 450  *
 451  * \see fillRect, setColor
 452  */
 453 void DrawingWindow::drawRect(int x1, int y1, int x2, int y2)
 454 {
 455     QRect r;
 456     r.setCoords(x1, y1, x2 - 1, y2 - 1);
 457     r = r.normalized();
 458     safeLock(imageMutex);
 459     painter->drawRect(r);
 460     r.adjust(0, 0, 1, 1);
 461     dirty(r);
 462     safeUnlock(imageMutex);
 463 }
 464
 465 //! Dessine un rectangle plein.
 466 /*!
 467  * Dessine le rectangle plein parallèle aux axes et défini par les
 468  * coordonnées de deux sommets opposés (x1, y1) et (x2, y2).  Utilise
 469  * la couleur de dessin courante.
 470  *
 471  * \param x1, y1        coordonnées d'un sommet du rectangle
 472  * \param x2, y2        coordonnées du sommet opposé du rectangle
 473  *
 474  * \see drawRect, setColor
 475  */
 476 void DrawingWindow::fillRect(int x1, int y1, int x2, int y2)
 477 {
 478     painter->setBrush(getColor());
 479     drawRect(x1, y1, x2, y2);
 480     painter->setBrush(Qt::NoBrush);
 481 }
 482
 483 //! Dessine un cercle.
 484 /*!
 485  * Dessine un cercle de centre (x, y) et de rayon r.  Utilise la
 486  * couleur de dessin courante.
 487  *
 488  * \param x, y          coordonnées du centre du cercle
 489  * \param r             rayon du cercle
 490  *
 491  * \see fillCircle, setColor
 492  */
 493 void DrawingWindow::drawCircle(int x, int y, int r)
 494 {
 495     QRect rect;
 496     rect.setCoords(x - r, y - r, x + r - 1, y + r - 1);
 497     safeLock(imageMutex);
 498     painter->drawEllipse(rect);
 499     rect.adjust(0, 0, 1, 1);
 500     dirty(rect);
 501     safeUnlock(imageMutex);
 502 }
 503
 504 //! Dessine un disque.
 505 /*!
 506  * Dessine un disque (cercle plein) de centre (x, y) et de rayon r.
 507  * Utilise la couleur de dessin courante.
 508  *
 509  * \param x, y          coordonnées du centre du disque
 510  * \param r             rayon du disque
 511  *
 512  * \see drawCircle, setColor
 513  */
 514 void DrawingWindow::fillCircle(int x, int y, int r)
 515 {
 516     painter->setBrush(getColor());
 517     drawCircle(x, y, r);
 518     painter->setBrush(Qt::NoBrush);
 519 }
 520
 521 //! Dessine un triangle.
 522 /*!
 523  * Dessine un triangle défini par les coordonnées de ses sommets:
 524  * (x1, y1), (x2, y2) et (x3, y3).  Utilise la couleur de dessin
 525  * courante.
 526  *
 527  * \param x1, y1        coordonnées du premier sommet du triangle
 528  * \param x2, y2        coordonnées du deuxième sommet du triangle
 529  * \param x3, y3        coordonnées du troisième sommet du triangle
 530  *
 531  * \see fillTriangle, setColor
 532  */
 533 void DrawingWindow::drawTriangle(int x1, int y1, int x2, int y2, int x3, int y3)
 534 {
 535     QPolygon poly(3);
 536     poly.putPoints(0, 3, x1, y1, x2, y2, x3, y3);
 537     safeLock(imageMutex);
 538     painter->drawConvexPolygon(poly);
 539     dirty(poly.boundingRect());
 540     safeUnlock(imageMutex);
 541 }
 542
 543 //! Dessine un triangle plein.
 544 /*!
 545  * Dessine un triangle plein défini par les coordonnées de ses
 546  * sommets: (x1, y1), (x2, y2) et (x3, y3).  Utilise la couleur de
 547  * dessin courante.
 548  *
 549  * \param x1, y1        coordonnées du premier sommet du triangle
 550  * \param x2, y2        coordonnées du deuxième sommet du triangle
 551  * \param x3, y3        coordonnées du troisième sommet du triangle
 552  *
 553  * \see drawTriangle, setColor
 554  */
 555 void DrawingWindow::fillTriangle(int x1, int y1, int x2, int y2, int x3, int y3)
 556 {
 557     painter->setBrush(getColor());
 558     drawTriangle(x1, y1, x2, y2, x3, y3);
 559     painter->setBrush(Qt::NoBrush);
 560 }
 561
 562 //! Écrit du texte.
 563 /*!
 564  * Écrit le texte text, aux coordonnées (x, y) et avec les paramètres
 565  * d'alignement flags.  Le texte est écrit avec la couleur de dessin
 566  * courante.  Les flags sont une combinaison (ou binaire) de
 567  * Qt::AlignLeft, Qt::AligneRight, Qt::AlignHCenter, Qt::AlignTop,
 568  * Qt::AlignBottom, Qt::AlignVCenter, Qt::AlignCenter.  Par défaut, le
 569  * texte est aligné en haut à gauche.
 570  *
 571  * \param x, y          coordonnées du texte
 572  * \param text          texte à écrire
 573  * \param flags         paramètres d'alignement
 574  *
 575  * \see drawText(int, int, const std::string &, int)
 576  * \see drawTextBg, setColor
 577  * \see QPainter::drawText
 578  */
 579 void DrawingWindow::drawText(int x, int y, const char *text, int flags)
 580 {
 581     safeLock(syncMutex);
 582     if (!terminateThread) {
 583         qApp->postEvent(this, new DrawTextEvent(x, y, text, flags));
 584         syncCondition.wait(&syncMutex);
 585     }
 586     safeUnlock(syncMutex);
 587 }
 588
 589 //! Écrit du texte.
 590 /*!
 591  * \see drawText(int, int, const char *, int)
 592  */
 593 void DrawingWindow::drawText(int x, int y, const std::string &text, int flags)
 594 {
 595     drawText(x, y, text.c_str(), flags);
 596 }
 597
 598 //! Écrit du texte sur fond coloré.
 599 /*!
 600  * Écrit du texte comme drawText, mais l'arrière-plan est coloré avec
 601  * la couleur de fond courante.
 602  *
 603  * \param x, y          coordonnées du texte
 604  * \param text          texte à écrire
 605  * \param flags         paramètres d'alignement
 606  *
 607  * \see drawTextBg(int, int, const std::string &, int)
 608  * \see drawText, setColor, setColorBg
 609  */
 610 void DrawingWindow::drawTextBg(int x, int y, const char *text, int flags)
 611 {
 612     painter->setBackgroundMode(Qt::OpaqueMode);
 613     drawText(x, y, text, flags);
 614     painter->setBackgroundMode(Qt::TransparentMode);
 615 }
 616
 617 //! Écrit du texte sur fond coloré.
 618 /*!
 619  * \see drawTextBg(int, int, const char *, int)
 620  */
 621 void DrawingWindow::drawTextBg(int x, int y, const std::string &text, int flags)
 622 {
 623     drawTextBg(x, y, text.c_str(), flags);
 624 }
 625
 626 //! Retourne la couleur d'un pixel.
 627 /*!
 628  * Retourne la couleur du pixel de coordonnées (x, y).  La valeur
 629  * retournée peut servir de paramètres à setColor(unsigned int) ou
 630  * setBgColor(unsigned int).
 631  *
 632  * \param x, y          coordonnées du pixel
 633  * \return              couleur du pixel
 634  *
 635  * \see setColor(unsigned int), setBgColor(unsigned int)
 636  */
 637 unsigned int DrawingWindow::getPointColor(int x, int y) const
 638 {
 639     return image->pixel(x, y);
 640 }
 641
 642 //! Attend l'appui sur un des boutons de la souris.
 643 /*!
 644  * Attend l'appui sur un des boutons de la souris.  Retourne le bouton
 645  * qui a été pressé et les coordonnées du pointeur de souris à ce
 646  * moment-là.
 647  *
 648  * \param x, y          coordonnées du pointeur de souris
 649  * \param button        numéro du bouton qui a été pressé
 650  *                      (1: gauche, 2: droit, 3: milieu, 0 sinon)
 651  * \param time          durée maximale de l'attente
 652  * \return              true si un bouton a été pressé
 653  *
 654  * \bug                 expérimental
 655  */
 656 bool DrawingWindow::waitMousePress(int &x, int &y, int &button,
 657                                    unsigned long time)
 658 {
 659     bool pressed;
 660     safeLock(mouseMutex);
 661     if (terminateThread) {
 662         pressed = false;
 663     } else {
 664         pressed = mouseCondition.wait(&mouseMutex, time);
 665         if (pressed) {
 666             x = mousePos.x();
 667             y = mousePos.y();
 668             if (mouseButton & Qt::LeftButton)
 669                 button = 1;
 670             else if (mouseButton & Qt::RightButton)
 671                 button = 2;
 672             else if (mouseButton & Qt::MidButton)
 673                 button = 3;
 674             else
 675                 button = 0;
 676         }
 677     }
 678     safeUnlock(mouseMutex);
 679     return pressed;
 680 }
 681
 682 //! Synchronise le contenu de la fenêtre.
 683 /*!
 684  * Pour des raisons d'efficacités, le résultat des fonctions de dessin
 685  * n'est pas affiché immédiatement.  L'appel à sync permet de
 686  * synchroniser le contenu de la fenêtre.  Autrement dit, cela bloque
 687  * l'exécution du programme jusqu'à ce que le contenu de la fenêtre
 688  * soit à jour.
 689  *
 690  * \param time          durée maximale de l'attente
 691  * \return              true si la fenêtre a pu être synchronisée
 692  */
 693 bool DrawingWindow::sync(unsigned long time)
 694 {
 695     bool synced;
 696     safeLock(syncMutex);
 697     if (terminateThread) {
 698         synced = false;
 699     } else {
 700         qApp->postEvent(this, new SyncRequestEvent());
 701         synced = syncCondition.wait(&syncMutex, time);
 702     }
 703     safeUnlock(syncMutex);
 704     return synced;
 705 }
 706
 707 //! Ferme la fenêtre graphique.
 708 void DrawingWindow::closeGraph()
 709 {
 710     qApp->postEvent(this, new CloseRequestEvent());
 711 }
 712
 713 //! Suspend l'exécution pendant un certain temps.
 714 /*!
 715  * \param secs          temps d'attente en seconde
 716  */
 717 void DrawingWindow::sleep(unsigned long secs)
 718 {
 719     DrawingThread::sleep(secs);
 720 }
 721
 722 //! Suspend l'exécution pendant un certain temps.
 723 /*!
 724  * \param msecs          temps d'attente en millisecondes
 725  */
 726 void DrawingWindow::msleep(unsigned long msecs)
 727 {
 728     DrawingThread::msleep(msecs);
 729 }
 730
 731 //! Suspend l'exécution pendant un certain temps.
 732 /*!
 733  * \param usecs          temps d'attente en microsecondes
 734  */
 735 void DrawingWindow::usleep(unsigned long usecs)
 736 {
 737     DrawingThread::usleep(usecs);
 738 }
 739
 740 /*!
 741  * \see QWidget
 742  */
 743 void DrawingWindow::closeEvent(QCloseEvent *ev)
 744 {
 745     timer.stop();
 746     thread->terminate();
 747     syncMutex.lock();
 748     mouseMutex.lock();
 749     terminateThread = true;     // this flag is needed for the case
 750                                 // where the following wakeAll() call
 751                                 // occurs between the
 752                                 // setTerminationEnable(false) and the
 753                                 // mutex lock in safeLock() called
 754                                 // from sync()
 755     syncCondition.wakeAll();
 756     mouseCondition.wakeAll();
 757     mouseMutex.unlock();
 758     syncMutex.unlock();
 759     QWidget::closeEvent(ev);
 760     thread->wait();
 761 }
 762
 763 /*!
 764  * \see QWidget
 765  */
 766 void DrawingWindow::customEvent(QEvent *ev)
 767 {
 768     switch ((int )ev->type()) {
 769     case SyncRequest:
 770         realSync();
 771         break;
 772     case CloseRequest:
 773         close();
 774         break;
 775     case DrawTextRequest:
 776         DrawTextEvent *tev = dynamic_cast<DrawTextEvent *>(ev);
 777         realDrawText(tev->x, tev->y, tev->text, tev->flags);
 778         break;
 779     }
 780 }
 781
 782 /*!
 783  * \see QWidget
 784  *
 785  * \bug                 expérimental
 786  */
 787 void DrawingWindow::mousePressEvent(QMouseEvent *ev)
 788 {
 789     mouseMutex.lock();
 790     mousePos = ev->pos();
 791     mouseButton = ev->button();
 792     ev->accept();
 793     mouseCondition.wakeAll();
 794     mouseMutex.unlock();
 795 }
 796
 797 /*!
 798  * \see QWidget
 799  */
 800 void DrawingWindow::keyPressEvent(QKeyEvent *ev)
 801 {
 802     bool accept = true;
 803     switch (ev->key()) {
 804     case Qt::Key_Escape:
 805         close();
 806         break;
 807     default:
 808         accept = false;
 809         break;
 810     }
 811     if (accept)
 812         ev->accept();
 813 }
 814
 815 /*!
 816  * \see QWidget
 817  */
 818 void DrawingWindow::paintEvent(QPaintEvent *ev)
 819 {
 820     QPainter widgetPainter(this);
 821     imageMutex.lock();
 822     QImage imageCopy(*image);
 823     imageMutex.unlock();
 824     QRect rect = ev->rect();
 825     widgetPainter.drawImage(rect, imageCopy, rect);
 826 }
 827
 828 /*!
 829  * \see QWidget
 830  */
 831 void DrawingWindow::showEvent(QShowEvent *ev)
 832 {
 833     QWidget::showEvent(ev);
 834     qApp->flush();
 835     qApp->syncX();
 836     timer.start(paintInterval, this);
 837     thread->start_once(QThread::IdlePriority);
 838 }
 839
 840 /*!
 841  * \see QWidget
 842  */
 843 void DrawingWindow::timerEvent(QTimerEvent *ev)
 844 {
 845     if (ev->timerId() == timer.timerId()) {
 846         mayUpdate();
 847         timer.start(paintInterval, this);
 848     } else {
 849         QWidget::timerEvent(ev);
 850     }
 851 }
 852
 853 //--- DrawingWindow (private methods) ----------------------------------
 854
 855 //! Fonction d'initialisation.
 856 /*!
 857  * Fonction appelée par les différents constructeurs.
 858  *
 859  * \param fun           fonction de dessin
 860  */
 861 void DrawingWindow::initialize(DrawingWindow::ThreadFunction fun)
 862 {
 863     terminateThread = false;
 864     lockCount = 0;
 865     image = new QImage(width, height, QImage::Format_RGB32);
 866     painter = new QPainter(image);
 867     thread = new DrawingThread(*this, fun);
 868
 869     setFocusPolicy(Qt::StrongFocus);
 870     setFixedSize(image->size());
 871     setAttribute(Qt::WA_OpaquePaintEvent);
 872     setFocus();
 873
 874     setColor("black");
 875     setBgColor("white");
 876     clearGraph();
 877
 878     dirtyFlag = false;
 879 }
 880
 881 //! Change la couleur de dessin.
 882 /*!
 883  * \param color                 couleur
 884  */
 885 inline
 886 void DrawingWindow::setColor(const QColor &color)
 887 {
 888     QPen pen(painter->pen());
 889     pen.setColor(color);
 890     painter->setPen(pen);
 891 }
 892
 893 //! Change la couleur de fond.
 894 /*!
 895  * \param color                 couleur
 896  */
 897 inline
 898 void DrawingWindow::setBgColor(const QColor &color)
 899 {
 900     painter->setBackground(color);
 901 }
 902
 903 //! Retourne la couleur de dessin courante.
 904 /*!
 905  * \return              couleur de dessin courante
 906  */
 907 inline
 908 QColor DrawingWindow::getColor()
 909 {
 910     return painter->pen().color();
 911 }
 912
 913 //! Retourne la couleur de fond courante.
 914 /*!
 915  * \return              couleur de fond courante
 916  */
 917 inline
 918 QColor DrawingWindow::getBgColor()
 919 {
 920     return painter->background().color();
 921 }
 922
 923 //! Verrouille un mutex.
 924 /*!
 925  * S'assure que le thread courant ne peut pas être terminé s'il
 926  * détient un mutex.  Pendant de safeUnlock.
 927  *
 928  * \param mutex         le mutex à verrouiller
 929  *
 930  * \see safeUnlock
 931  */
 932 inline
 933 void DrawingWindow::safeLock(QMutex &mutex)
 934 {
 935     if (lockCount++ == 0)
 936         thread->setTerminationEnabled(false);
 937     mutex.lock();
 938 }
 939
 940 //! Déverrouille un mutex.
 941 /*!
 942  * S'assure que le thread courant ne peut pas être terminé s'il
 943  * détient un mutex.  Pendant de safeLock.
 944  *
 945  * \param mutex         le mutex à déverrouiller
 946  *
 947  * \see safeLock
 948  */
 949 inline
 950 void DrawingWindow::safeUnlock(QMutex &mutex)
 951 {
 952     mutex.unlock();
 953     if (--lockCount == 0)
 954         thread->setTerminationEnabled(true);
 955 }
 956
 957 //! Marque l'image entière comme non à jour.
 958 inline
 959 void DrawingWindow::dirty()
 960 {
 961     dirtyFlag = true;
 962     dirtyRect = image->rect();
 963 }
 964
 965 //! Marque un point de l'image comme non à jour.
 966 /*!
 967  * \param x, y          coordonnées du point
 968  */
 969 inline
 970 void DrawingWindow::dirty(int x, int y)
 971 {
 972     dirty(QRect(x, y, 1, 1));
 973 }
 974
 975 //! Marque une zone de l'image comme non à jour.
 976 /*!
 977  * La zone est définie par un rectangle dont les coordonnées de deux
 978  * sommets oppposés sont données.
 979  *
 980  * \param x1, y1        coordonnées d'un sommet du rectangle
 981  * \param x2, y2        coordonnées du sommet opposé du rectangle
 982  */
 983 inline
 984 void DrawingWindow::dirty(int x1, int y1, int x2, int y2)
 985 {
 986     QRect r;
 987     r.setCoords(x1, y1, x2, y2);
 988     dirty(r.normalized());
 989 }
 990
 991 //! Marque une zone de l'image comme non à jour.
 992 /*!
 993  * \param rect          rectangle délimitant la zone
 994  */
 995 void DrawingWindow::dirty(const QRect &rect)
 996 {
 997     if (dirtyFlag) {
 998         dirtyRect |= rect;
 999     } else {
1000         dirtyFlag = true;
1001         dirtyRect = rect;
1002     }
1003 }
1004
1005 //! Génère un update si besoin.
1006 /*!
1007  * Génère une demande de mise à jour de la fenêtre (appel à update)
1008  * s'il y en a besoin.
1009  */
1010 void DrawingWindow::mayUpdate()
1011 {
1012     imageMutex.lock();
1013     bool dirty = dirtyFlag;
1014     QRect rect = dirtyRect;
1015     dirtyFlag = false;
1016     imageMutex.unlock();
1017     if (dirty)
1018         update(rect);
1019 }
1020
1021 //! Fonction bas-niveau pour sync.
1022 /*!
1023  * Fonction de synchronisation dans le thread principal.
1024  *
1025  * \see sync, customEvent
1026  */
1027 void DrawingWindow::realSync()
1028 {
1029     mayUpdate();
1030     qApp->sendPostedEvents(this, QEvent::UpdateLater);
1031     qApp->sendPostedEvents(this, QEvent::UpdateRequest);
1032     qApp->sendPostedEvents(this, QEvent::Paint);
1033     qApp->processEvents(QEventLoop::ExcludeUserInputEvents |
1034                         QEventLoop::ExcludeSocketNotifiers |
1035                         QEventLoop::DeferredDeletion |
1036                         QEventLoop::X11ExcludeTimers);
1037     qApp->flush();
1038     qApp->syncX();
1039     syncMutex.lock();
1040     syncCondition.wakeAll();
1041     syncMutex.unlock();
1042 }
1043
1044 //! Fonction bas-niveau pour drawText.
1045 /*!
1046  * Le rendu de texte doit être fait dans le thread principal.  D'où
1047  * les manipulations tordues et la synchronisation qui s'en suit.
1048  *
1049  * \param x, y, text, flags     cf. drawText
1050  *
1051  * \see drawText, customEvent
1052  */
1053 void DrawingWindow::realDrawText(int x, int y, const char *text, int flags)
1054 {
1055     QRect r(image->rect());
1056     switch (flags & Qt::AlignHorizontal_Mask) {
1057     case Qt::AlignRight:
1058         r.setRight(x);
1059         break;
1060     case Qt::AlignHCenter:
1061         if (x < width / 2)
1062             r.setLeft(2 * x - width + 1);
1063         else
1064             r.setRight(2 * x);
1065         break;
1066     default:
1067         r.setLeft(x);
1068     }
1069     switch (flags & Qt::AlignVertical_Mask) {
1070     case Qt::AlignBottom:
1071         r.setBottom(y);
1072         break;
1073     case Qt::AlignVCenter:
1074         if (y < height / 2)
1075             r.setTop(2 * y - height + 1);
1076         else
1077             r.setBottom(2 * y);
1078         break;
1079     default:
1080         r.setTop(y);
1081     }
1082     syncMutex.lock();
1083     painter->drawText(r, flags, QString::fromUtf8(text), &r);
1084     dirty(r);
1085     syncCondition.wakeAll();
1086     syncMutex.unlock();
1087 }
1088
1089 //--- DrawingThread ----------------------------------------------------
1090
1091 //! Constructeur.
1092 DrawingThread::DrawingThread(DrawingWindow &w, DrawingWindow::ThreadFunction f)
1093     : drawingWindow(w)
1094     , threadFunction(f)
1095     , started_once(false)
1096 {
1097 }
1098
1099 //! Démarre le thread si ce n'a pas encore été fait.
1100 void DrawingThread::start_once(Priority priority)
1101 {
1102     if (!started_once) {
1103         started_once = true;
1104         start(priority);
1105     }
1106 }
1107
1108 //! La vraie fonction pour le thread.
1109 void DrawingThread::run()
1110 {
1111     threadFunction(drawingWindow);
1112 }