Render_opengl.hpp 17 KB
Newer Older
Mathieu Faverge's avatar
Mathieu Faverge committed
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
/*
** This file is part of the ViTE project.
**
** This software is governed by the CeCILL-A license under French law
** and abiding by the rules of distribution of free software. You can
** use, modify and/or redistribute the software under the terms of the
** CeCILL-A license as circulated by CEA, CNRS and INRIA at the following
** URL: "http://www.cecill.info".
** 
** As a counterpart to the access to the source code and rights to copy,
** modify and redistribute granted by the license, users are provided
** only with a limited warranty and the software's author, the holder of
** the economic rights, and the successive licensors have only limited
** liability.
** 
** In this respect, the user's attention is drawn to the risks associated
** with loading, using, modifying and/or developing or reproducing the
** software by the user in light of its specific status of free software,
** that may mean that it is complicated to manipulate, and that also
** therefore means that it is reserved for developers and experienced
** professionals having in-depth computer knowledge. Users are therefore
** encouraged to load and test the software's suitability as regards
** their requirements in conditions enabling the security of their
** systems and/or data to be ensured and, more generally, to use and
** operate it in the same conditions as regards security.
** 
** The fact that you are presently reading this means that you have had
** knowledge of the CeCILL-A license and that you accept its terms.
**
**
31
** ViTE developers are (for version 0.* to 1.0):
Mathieu Faverge's avatar
Mathieu Faverge committed
32 33 34 35 36 37 38 39 40 41 42
**
**        - COULOMB Kevin
**        - FAVERGE Mathieu
**        - JAZEIX Johnny
**        - LAGRASSE Olivier
**        - MARCOUEILLE Jule
**        - NOISETTE Pascal
**        - REDONDY Arthur
**        - VUCHENER Clément 
**
*/
43 44 45 46 47 48 49
/*!
 *\file Render_opengl.hpp
 */

#ifndef RENDER_OPENGL_HPP
#define RENDER_OPENGL_HPP

50
#include <QGLWidget>
51 52 53

#include "core/Core.hpp"
#include "render/Hook_event.hpp"
54
#include "render/Render_template.hpp"
55

56 57
class Render_opengl;
class Interface_console;
58 59 60 61 62 63 64 65 66 67 68
struct Container_text_;


/*!
 * \brief Structure used to store arrow information.
 */
struct Arrow_{
    /*!
     * \brief Coordinates.
     */
    Element_pos start_time, end_time, start_height, end_height;
69 70 71
    /*!
     * \brief Colors.
     */
Olivier Lagrasse's avatar
Olivier Lagrasse committed
72
    Element_col red, green, blue;
73 74 75
};

/*!
76
 * \brief Structure used to store event information.
77
 */
78
struct Event_{
79 80 81
    /*!
     * \brief Coordinates and radius.
     */
82
    Element_pos time, height, container_height;
83 84 85 86
    /*!
     * \brief Colors.
     */
    Element_col red, green, blue;
87 88
};

89 90 91 92

/*!
 * \brief This class redefined the OpenGL widget - QGLWidget - to display the trace.
 */
93
class Render_opengl :  /*public QGLWidget,*/ public Hook_event, public Render_template
94 95 96 97 98 99 100 101
{
    Q_OBJECT
    
protected:
    
    /*!
     * \brief Contains the parent instance.
     */
102
    Core* _core;
103

Olivier Lagrasse's avatar
Olivier Lagrasse committed
104 105 106 107 108
    /*!
     * \brief The waiting screen display list.
     */
     GLuint _wait_list;

109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129

    /*!
     * \brief The container GLu list.
     */
    GLuint _list_containers;
    
    /*!
     * \brief The state GLu list.
     */
    GLuint _list_states;
    
     /*!
      * \brief The counter GLu list.
      */
    GLuint _list_counters;

    
    /*!
     * \brief The wait GLu list.
     */
    //  GLuint _wait_list;
130 131

    float _red, _green, _blue;
132
    
133 134
    std::vector<Container_text_> _texts;
    std::vector<Arrow_> _arrows;
135
    std::vector<Event_> _circles;
136 137


Olivier Lagrasse's avatar
Olivier Lagrasse committed
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
    /***********************************
     *
     * The wait screen drawing.
     *
     **********************************/

    /***********************************
     * The wait list Attributes.
     **********************************/


    /*!
     * \brief Rotation angle for the wait.
     */
    float _wait_angle;

    /*!
     * \brief Y rotation angle for the wait.
     */
    float _wait_angle_y;

    /*!
     * \brief Time in ms between two frames for the waiting screen.
     */
    static const int DRAWING_TIMER_DEFAULT;

    /*!
     * \brief Wait animation seconds per frame.
     */
    int _wait_spf;

    /*!
     * \brief Timer to animate the wait.
     */
    QTimer* _wait_timer;

174 175 176 177 178 179 180 181 182 183 184
public:

    /***********************************
     *
     * Constructor and destructor.
     *
     **********************************/

    /*!
     * \brief The default constructor
     */
185
    Render_opengl(Core* core, QWidget *parent);
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

    /*!
     * \brief The destructor
     */
    virtual ~Render_opengl();

    /*!
     * \brief Set Statistics and Informations about input trace
     */
    void set_total_width(Element_pos){}

    /*!
     * \brief Set Statistics and Informations about input trace
     */
    void set_total_time(Times){}

    /*!
     * \brief display the scale 
     */
    void display_time_scale(){}


    /***********************************
     *
     * Default QGLWidget functions.
     *
     **********************************/
     
    /*!
     * \brief Call by the system to initialize the OpenGL render area.
     */
      void initializeGL();
     
    /*!
     * \brief Call by the system when the render area was resized (occurs during a window resizement).
     * \param width : the new width of the render area.
     * \param height : the new height of the render area. 
     */
    void resizeGL(int width, int height);
     
    /*!
     * \brief Call by the system each time the render area need to be updated.
     */
229 230 231
    void paintGL();
    
    //void paintEvent(QPaintEvent *event);
232

233 234 235 236
    /* void initializeOverlayGL();
    void resizeOverlayGL(int width, int height);
    void paintOverlayGL();*/
    
237 238 239 240 241 242 243 244 245 246

    /***********************************
     *
     * Building functions.
     *
     **********************************/

    /*!
     * \brief This function constructs the trace.
     */
247
    //  bool display_build() ;
248 249 250 251

    /*!
     * \brief This function releases the trace.
     */
252
    //   bool display_unbuild() ;
253 254 255 256

    /*!
     * \brief Proceeds with the initialization of the OpenGL draw functions.
     */
257
    void start_draw();
258 259 260 261

    /*!
     * \brief Creates and opens the display list for container draws.
     */
262
    void start_draw_containers();
263 264 265 266 267 268 269 270

    /*!
     * \brief Draw a container according to the parameters
     * \param x the x position of the container
     * \param y the y position of the container
     * \param w the width of the container
     * \param h the height of the container
     */
271
    void draw_container(const Element_pos x, const Element_pos y, const Element_pos w, const Element_pos h);
272 273 274 275 276 277 278 279 280

    /*!
     * \brief Draw the text of a container.
     * \param x the x position of the text.
     * \param y the y position of the text.
     * \param value the string value of the text.
     *
     * This function stores text in a list. This list will be display each time the render area need to be updated.
     */
281
    void draw_container_text(const Element_pos x, const Element_pos y, const std::string value);
282 283 284 285

    /*!
     * \brief Closes the container display list.
     */
286
    void end_draw_containers();
287 288 289 290
     
    /*!
     * \brief Creates and opens the display list for stater draws.
     */
291
    void start_draw_states();
292 293 294 295 296 297 298 299 300 301 302

    /*!
     * \brief Draw a state of the trace.
     * \param start the beginning time of the state.
     * \param end the ending time of the state.
     * \param base vertical position of the state.
     * \param height the state height.
     * \param r the red color rate of the state.
     * \param g the green color rate of the state.
     * \param b the blue color rate of the state.
     */
303
    void draw_state(const Element_pos start , const Element_pos end, const Element_pos base, const Element_pos height, const Element_col r, const Element_col g, const Element_col b);
304 305 306 307

    /*!
     * \brief Closes the state display list.
     */
308
    void end_draw_states();
309 310 311 312

    /*!
     * \brief Open the arrow display list.
     */
313
    void start_draw_arrows();
314 315 316 317 318 319 320 321 322 323

    /*!
     * \brief Draw an arrow.
     * \param start_time the beginning time of the arrow.
     * \param end_time the ending time of the arrow.
     * \param start_height vertical position of the begining time of the arrow.
     * \param end_height vertical position of the ending time of the arrow.
     *
     * This function stores all the information of the arrow to display it each time the render area need to be updated.
     */
Olivier Lagrasse's avatar
Olivier Lagrasse committed
324
    void draw_arrow(const Element_pos start_time, const Element_pos end_time, const Element_pos start_height, const Element_pos end_height,const Element_col red, const Element_col green, const Element_col blue);
325 326 327 328

    /*!
     * \brief Closes the arrow display list.
     */
329
    void end_draw_arrows();
330 331 332 333 334

    /*!
     * \brief Draw arrows contained in the Arrow_ vector
     * \param arrows An arrow vector.
     */
335
    // void draw_stored_arrows(std::vector<Arrow_> &arrows);
336

337 338
    void start_draw_events();

339 340 341 342 343 344
    /*!
     * \brief Draw an event.
     * \param time time when the event occurs.
     * \param height vertical position of the event.
     * \param container_height information to draw event. It corresponds to the container height when they are drawn horizontally.
     *
345 346 347
     *
     * \brief Creates and opens the display list for container draws.
     *
348 349
     * This function stores all the information of the event to display it each time the render area need to be updated.
     */
350
    void draw_event(const Element_pos time, const Element_pos height,  const Element_pos container_height);
351

352 353 354
    void end_draw_events();


355 356 357 358
    /*!
     * \brief Draw events contained in the Event_ vector
     * \param events An event vector.
     */
359
    //  void draw_stored_events(std::vector<Event_> &events);
360 361 362 363

    /*!
     * \brief Creates and opens the display list for counter draws.
     */
364
    void start_draw_counter();
365 366 367 368 369 370 371 372
     
    /*!
     * \brief Draw a point of the counter.
     * \param x x position of the point.
     * \param y y position of the point.
     *
     * Each time counter is increased, this function is called with the coordinates of the new point.
     */
373
    void draw_counter(const Element_pos x, const Element_pos y);
374 375 376 377
     
    /*!
     * \brief Closes the counter display list.
     */
378
    void end_draw_counter();
379

Olivier Lagrasse's avatar
Olivier Lagrasse committed
380 381 382 383 384 385 386 387 388 389 390
    /*!
     * \brief Called before ruler drawing.
     */
    void start_ruler();
     
    /*!
     * \brief Called after ruler drawing.
     */
    void end_ruler();
     

391 392 393
    /*!
     * \brief Do nothing (it is present for compatibility of the Render class).
     */
394
    void end_draw();
395 396 397

    

398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
    /***********************************
     *
     * Render OpenGL drawing functions.
     *
     **********************************/

    /*!
     * \brief Display a wait on the screen if there is no file opened.
     * \return Asset value of the wait.
     */
    GLuint draw_wait();

    /*!
     * \brief Draw the ruler display list.
     */
    void call_ruler();



    /***********************************
     *
     * Building functions.
     *
     **********************************/

    /*!
     * \brief This function draws the trace.
     */
    bool build();

    /*!
     * \brief This function releases the trace.
     */
    bool unbuild();

433 434 435 436 437 438
    /***********************************
     *
     * Displaying functions.
     *
     **********************************/

439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497
 //    /*!
//      * \brief Display on screen containers between container_begin and container_end.
//      * \param container_begin integer value : id of the first container.
//      * \param container_end integer value : id of the last container.
//      */
//       void display_container(Element_count container_begin, Element_count container_end) =0;

//     /*!
//      * \brief Display on screen states between timer_begin and time_end, 
//      * container_begin and container_end and with timer width between depth_begin and depth_end.
//      * \param time_begin floating point value : time of the first state.
//      * \param time_end floating point value : time of the last state.
//      * \param container_begin integer value : id of the first container.
//      * \param container_end integer value : id of the last container.
//      * \param depth_begin floating point value : width of the narrowest state.
//      * \param depth_end floating point value : width of the widest state.
//      */
//        void display_state(Element_pos time_begin, Element_pos time_end, 
//                        Element_count container_begin, Element_count container_end, 
//                        Element_pos depth_begin, Element_pos depth_end) =0;

//     /*!
//      * \brief Display on screen arrows between timer_begin and time_end, 
//      * container_begin and container_end and with timer width between depth_begin and depth_end.
//      * \param time_begin floating point value : time of the smallest arrow time value.
//      * \param time_end floating point value : time of the higher arrow time value.
//      * \param container_begin integer value : id of the first container.
//      * \param container_end integer value : id of the last container.
//      * \param depth_begin floating point value : the narrowest difference between 
//      * the beginning time and the ending time of the arrow.
//      * \param depth_end floating point value : width of the widest difference between
//      * the beginning time and the ending time of the arrow.
//      */
//     virtual void display_arrow(Element_pos time_begin, Element_pos time_end, 
//                        Element_count container_begin, Element_count container_end, 
//                        Element_pos depth_begin, Element_pos depth_end) =0;

//     /*!
//      * \brief Display on screen events between timer_begin and time_end, 
//      * container_begin and container_end.
//      * \param time_begin floating point value : time of the first event.
//      * \param time_end floating point value : time of the last event.
//      * \param container_begin integer value : id of the first container.
//      * \param container_end integer value : id of the last container.
//      */
//     virtual void display_event(Element_pos time_begin, Element_pos time_end, 
//                        Element_count container_begin, Element_count container_end) =0;  

//     /*!
//      * \brief Display on screen counters between timer_begin and time_end, 
//      * container_begin and container_end.
//      * \param time_begin floating point value : time of the smallest counter time value.
//      * \param time_end floating point value : time of the higher counter time value.
//      * \param container_begin integer value : id of the first container.
//      * \param container_end integer value : id of the last container.
//      */
//     virtual void display_counter(Element_pos time_begin, Element_pos time_end, 
//                          Element_count container_begin, Element_count container_end) =0;   
    
498
    /*!
499 500 501 502
     * \brief Set the color for the further drawings.
     * \param r the red value. Within [0 ; 1].
     * \param g the green value. Within [0 ; 1].
     * \param b the blue value. Within [0 ; 1].   
503
     */
504
    void set_color(float r, float g, float b);
505 506

    /*!
507 508 509 510 511
     * \brief Draw a text.
     * \param x the horizontal position of the left bottom corner of the text.
     * \param y the vertical position of the left bottom corner of the text.
     * \param z the deep position of the text.
     * \param s the text.
512
     */
513
    virtual void draw_text(const Element_pos x, const Element_pos y, const Element_pos z, const std::string s);
514 515

    /*!
516 517 518 519 520 521
     * \brief Draw a quad.
     * \param x the horizontal position of the left bottom corner of the quad.
     * \param y the vertical position of the left bottom corner of the quad.
     * \param z the deep position of the quad.
     * \param w the width of the quad.
     * \param h the height of the quad.
522
     */
523
    void draw_quad(Element_pos x, Element_pos y, Element_pos z, Element_pos w, Element_pos h);
524 525

    /*!
526 527 528 529 530
     * \brief Draw a triangle.
     * \param x the horizontal position of the triangle center.
     * \param y the vertical position of the triangle center.
     * \param size the edge size.
     * \param r the rotation of triangle. (clockwise and in degree)
531
     */
532 533 534 535 536 537 538 539 540 541 542 543
    void draw_triangle(Element_pos x, Element_pos y,
                       Element_pos size, Element_pos r);
    
    /*!
     * \brief Draw a line.
     * \param x1 the horizontal position of the first point.
     * \param y1 the vertical position of the firt point.
     * \param x2 the horizontal position of the second point.
     * \param y2 the vertical position of the second point.
     * \param z the deep position of the triangle.
     */
    void draw_line(Element_pos x1, Element_pos y1, Element_pos x2, Element_pos y2, Element_pos z);
544 545

    /*!
546 547 548 549 550
     * \brief Draw a circle.
     * \param x the horizontal position of the circle center.
     * \param y the vertical position of the circle center.
     * \param z the deep position of the circle.
     * \param r the circle radius.
551
     */
552 553 554 555 556 557 558
    void draw_circle(Element_pos x, Element_pos y, Element_pos z, Element_pos r);

    /* Temporary methods. Use to draw stored arrows and circles. It is to prevent scaling */
    void draw_stored_arrows();
    void draw_stored_circles();

    void draw_stored_texts();
559 560 561 562 563
};



#endif