Developer Documentation
RulerPlugin.hh
1 /*===========================================================================*\
2 * *
3 * OpenFlipper *
4  * Copyright (c) 2001-2015, RWTH-Aachen University *
5  * Department of Computer Graphics and Multimedia *
6  * All rights reserved. *
7  * www.openflipper.org *
8  * *
9  *---------------------------------------------------------------------------*
10  * This file is part of OpenFlipper. *
11  *---------------------------------------------------------------------------*
12  * *
13  * Redistribution and use in source and binary forms, with or without *
14  * modification, are permitted provided that the following conditions *
15  * are met: *
16  * *
17  * 1. Redistributions of source code must retain the above copyright notice, *
18  * this list of conditions and the following disclaimer. *
19  * *
20  * 2. Redistributions in binary form must reproduce the above copyright *
21  * notice, this list of conditions and the following disclaimer in the *
22  * documentation and/or other materials provided with the distribution. *
23  * *
24  * 3. Neither the name of the copyright holder nor the names of its *
25  * contributors may be used to endorse or promote products derived from *
26  * this software without specific prior written permission. *
27  * *
28  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS *
29  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
30  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A *
31  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
32  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, *
33  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, *
34  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR *
35  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF *
36  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING *
37  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS *
38  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
39 * *
40 \*===========================================================================*/
41 
42 
43 
44 #ifndef RULERPLUGIN_HH
45 #define RULERPLUGIN_HH
46 
47 #include <QObject>
48 #include <QString>
49 
50 #include <ACG/Utils/SmartPointer.hh>
51 
58 
59 #include "Ruler.hh"
60 #include "RulerOptions.hh"
61 
63 {
64  Q_OBJECT
65  Q_INTERFACES(BaseInterface)
66  Q_INTERFACES(MouseInterface)
67  Q_INTERFACES(PickingInterface)
68  Q_INTERFACES(ToolbarInterface)
69  Q_INTERFACES(LoadSaveInterface)
70  Q_INTERFACES(OptionsInterface)
71 
72  Q_PLUGIN_METADATA(IID "org.OpenFlipper.Plugins.Plugin-Ruler")
73 
74 signals:
75  void addToolbar(QToolBar *_toolbar);
76 
77  void addPickMode(const std::string &_mode);
78 
79  void updateView();
80 
81  void setPickModeMouseTracking ( const std::string &_mode, bool _mouseTracking);
82 
83 public slots:
84 
85  void slotPickModeChanged(const std::string& _mode);
86 
87  void slotMouseEvent(QMouseEvent* _event);
88 
89  void slotViewChanged();
90 public:
91 
92  // OptionsInterface
93  bool initializeOptionsWidget(QWidget*& _widget);
94 
95  RulerPlugin();
96  ~RulerPlugin();
97 
98  QString name(){return QString("RulerPlugin");}
99  QString description(){return QString("Measure the distance between two points.");}
100 
101 private:
102 
103  void reset();
104 
105  void enableDragMode(const int _point);
106 
107  void disableDragMode();
108 
109  bool dragModeActive(){return lineDrag_ >= 0;}
110 
111  QAction *buttonAction_;
112 
113  const std::string pickModeName_;
114 
115  //saves the index of the dragged point, if no point was dragged, it is -1
116  int lineDrag_;
117 
118  //checks if a double click was provided for resetting
119  bool dblClickCheck_;
120 
121  ptr::shared_ptr<Ruler> currentRuler_;
122 
123  RulerOptions* optionsWidget_;
124 
125  const QString textSizeSettingName_;
126 private slots:
127 
128  void initializePlugin();
129 
130  void pluginsInitialized();
131 
132  void slotChangePickMode();
133 
134  void slotAllCleared();
135 
136  void objectDeleted(int _id);
137 
138  // OptionsInterface
139  void applyOptions();
140 
141 public slots:
142  QString version(){ return QString("1.0"); }
143 };
144 
145 
146 #endif //RULERPLUGIN_HH
Options Dialog interface.
Add a toolbox to OpenFlipper.
Interface class for receiving mouse events.
QString description()
Return a description of what the plugin is doing.
Definition: RulerPlugin.hh:99
QString name()
Return a name for the plugin.
Definition: RulerPlugin.hh:98
Interface class from which all plugins have to be created.
Allow access to picking functions.
Interface for all plugins which want to Load or Save files and create Objects.
bool initializeOptionsWidget(QWidget *&_widget)
Initialize the Options Widget.
Definition: RulerPlugin.cc:259