Tulip  4.0.0
Better Visualization Through Research
 All Classes Files Functions Variables Enumerations Enumerator Properties Groups Pages
GlMainView.h
1 /*
2  *
3  * This file is part of Tulip (www.tulip-software.org)
4  *
5  * Authors: David Auber and the Tulip development Team
6  * from LaBRI, University of Bordeaux 1 and Inria Bordeaux - Sud Ouest
7  *
8  * Tulip is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU Lesser General Public License
10  * as published by the Free Software Foundation, either version 3
11  * of the License, or (at your option) any later version.
12  *
13  * Tulip is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
16  * See the GNU General Public License for more details.
17  *
18  */
19 
20 #ifndef Tulip_GLMAINVIEW_H
21 #define Tulip_GLMAINVIEW_H
22 
23 #include <tulip/ViewWidget.h>
24 #include <QtGui/QAction>
25 #include <QtGui/QMenu>
26 
27 class QGraphicsProxyWidget;
28 
29 namespace tlp {
30 class GlOverviewGraphicsItem;
31 class SceneConfigWidget;
32 class SceneLayersConfigWidget;
33 class GlMainWidget;
34 class QuickAccessBar;
35 
36 /**
37  * @ingroup Plugins
38  *
39  * @brief An abstract view that displays a GlMainWidget as its central widget.
40  *
41  * The GlMainView subclasses ViewWidget and always uses a GlMainWidget as the central widget of the panel. It also adds the following features:
42  * @list
43  * @li An overview of the scene that can be toggled on or off.
44  * @li Some configuration widgets that modify the rendering parameters.
45  * @li A quick access bar widget that allows the user to quickly modify some of the most used rendering parameters and graph properties (nodes color, edges display, etc)
46  * @li The possibility to make snapshots of the current scene
47  * @endlist
48  *
49  * Subclassing GlMainView means you will only want to display graphs in a single GlMainWidget. Switching the central widget can only be achieved from the ViewWidget class.
50  *
51  * @warning It is strongly unadvised to re-implement methods already implemented into tlp::View or tlp::ViewWidget. If you have to add custom behavior to those method, make sure to call the upper-class methods first:
52  @code
53  void MyView::setupWidget() { // Where MyView is a subclass of tlp::GlMainView
54  GlMainView::setupWidget(); // call this first
55  // insert custom behavior here
56  }
57  @endcode
58 
59  * @see tlp::ViewWidget
60  */
61 class TLP_QT_SCOPE GlMainView: public tlp::ViewWidget {
62  Q_OBJECT
63 
64  tlp::GlMainWidget* _glMainWidget;
65  tlp::GlOverviewGraphicsItem* _overviewItem;
66  tlp::SceneConfigWidget* _sceneConfigurationWidget;
67  tlp::SceneLayersConfigWidget* _sceneLayersConfigurationWidget;
68  tlp::QuickAccessBar* _quickAccessBar;
69  QGraphicsProxyWidget* _quickAccessBarItem;
70 
71  QAction *_centerViewAction;
72  QAction *_forceRedrawAction;
73 
74 public:
75  GlMainView();
76  virtual ~GlMainView();
77  tlp::GlMainWidget* getGlMainWidget() const;
78  virtual QList<QWidget*> configurationWidgets() const;
79  bool overviewVisible() const;
80  QPixmap snapshot(const QSize &outputSize=QSize());
81 
82 public slots:
83  /**
84  * @brief Calls GlMainWidget::draw();
85  */
86  virtual void draw(tlp::PluginProgress* pluginProgress);
87 
88  /**
89  * @brief Calls GlMainWidget::redraw();
90  */
91  void redraw();
92 
93  /**
94  * @brief Calls GlMainWidget::redraw();
95  */
96  virtual void refresh(PluginProgress *pluginProgress);
97 
98  /**
99  * @brief Force the overview to be redrawn. Since GlMainView already detects graph's modifications, this method should not be called manually to avoid extra rendering.
100  */
101  virtual void drawOverview(bool generatePixmap=true);
102 
103  /**
104  * @brief Centers the scene's camera
105  */
106  virtual void centerView();
107 
108  /**
109  * @brief Toggles the overview on or off
110  */
111  void setOverviewVisible(bool);
112 
113  /**
114  * @brief Force the settings set in the configuration widgets to be re-applied.
115  */
116  void applySettings();
117 
118  /**
119  * @brief Display a dialog that takes a snapshot of the current scene.
120  */
121  void openSnapshotDialog();
122 
123 protected slots:
124  virtual void glMainViewDrawn(bool graphChanged);
125  virtual void sceneRectChanged(const QRectF&);
126  void setQuickAccessBarVisible(bool);
127  void fillContextMenu(QMenu *menu,const QPointF &);
128 
129 protected:
130  virtual void setupWidget();
131  bool quickAccessBarVisible() const;
132  void assignNewGlMainWidget(GlMainWidget *glMainWidget,bool deleteOldGlMainWidget=true);
133 
134  tlp::GlOverviewGraphicsItem* overviewItem() const;
135 };
136 }
137 
138 #endif /* GLMAINVIEW_H_ */