Tulip  4.4.0
Better Visualization Through Research
 All Classes Namespaces 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 
25 class QGraphicsProxyWidget;
26 class QAction;
27 class QRectF;
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 
63  Q_OBJECT
64 
65  tlp::GlMainWidget* _glMainWidget;
66  tlp::GlOverviewGraphicsItem* _overviewItem;
67  bool isOverviewVisible;
68  QGraphicsProxyWidget* _quickAccessBarItem;
69 
70  QAction *_centerViewAction;
71  QAction *_forceRedrawAction;
72 
73 protected :
74 
75  tlp::QuickAccessBar* _quickAccessBar;
76  tlp::SceneConfigWidget* _sceneConfigurationWidget;
77  tlp::SceneLayersConfigWidget* _sceneLayersConfigurationWidget;
78 
79 public:
80 
81  enum OverviewPosition {OVERVIEW_TOP_LEFT, OVERVIEW_TOP_RIGHT, OVERVIEW_BOTTOM_LEFT, OVERVIEW_BOTTOM_RIGHT};
82 
83  GlMainView();
84  virtual ~GlMainView();
85  tlp::GlMainWidget* getGlMainWidget() const;
86  virtual QList<QWidget*> configurationWidgets() const;
87  bool overviewVisible() const;
88  QPixmap snapshot(const QSize &outputSize=QSize()) const;
89  void setOverviewPosition(const OverviewPosition &position);
90 
91 public slots:
92  /**
93  * @brief Calls GlMainWidget::draw();
94  */
95  virtual void draw();
96 
97  /**
98  * @brief Calls GlMainWidget::redraw();
99  */
100  void redraw();
101 
102  /**
103  * @brief Calls GlMainWidget::redraw();
104  */
105  virtual void refresh();
106 
107  /**
108  * @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.
109  */
110  virtual void drawOverview(bool generatePixmap=true);
111 
112  /**
113  * @brief Centers the scene's camera
114  */
115  virtual void centerView(bool graphChanged = false);
116 
117  /**
118  * @brief Toggles the overview on or off
119  */
120  void setOverviewVisible(bool);
121 
122  /**
123  * @brief Toggles the orthogonal projection on or off, then draws
124  */
125  void setViewOrtho(bool);
126 
127  /**
128  * @brief Force the settings set in the configuration widgets to be re-applied.
129  */
130  void applySettings();
131 
132  /**
133  * @brief Display a dialog that takes a snapshot of the current scene.
134  */
135  void openSnapshotDialog();
136 
137  void undoCallback();
138 
139 protected slots:
140  virtual void glMainViewDrawn(bool graphChanged);
141  virtual void sceneRectChanged(const QRectF&);
142  void setQuickAccessBarVisible(bool);
143  void fillContextMenu(QMenu *menu,const QPointF &);
144 
145 protected:
146  virtual void setupWidget();
147  bool quickAccessBarVisible() const;
148  void assignNewGlMainWidget(GlMainWidget *glMainWidget,bool deleteOldGlMainWidget=true);
149  bool eventFilter(QObject* obj, QEvent* event);
150 
151  tlp::GlOverviewGraphicsItem* overviewItem() const;
152 
153  OverviewPosition _overviewPosition;
154 };
155 }
156 
157 #endif /* GLMAINVIEW_H_ */