Developer Documentation

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- File List
- File Members

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
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 * $Revision$ *
45 * $LastChangedBy$ *
46 * $Date$ *
47 * *
48 \*===========================================================================*/
49
50 #ifndef RULERPLUGIN_HH
51 #define RULERPLUGIN_HH
52
53 #include <QObject>
54 #include <QString>
55
56 #include <ACG/Utils/SmartPointer.hh>
57
58 #include <OpenFlipper/BasePlugin/BaseInterface.hh>
59 #include <OpenFlipper/BasePlugin/MouseInterface.hh>
60 #include <OpenFlipper/BasePlugin/PickingInterface.hh>
61 #include <OpenFlipper/BasePlugin/ToolbarInterface.hh>
62 #include <OpenFlipper/BasePlugin/LoadSaveInterface.hh>
63 #include <OpenFlipper/BasePlugin/OptionsInterface.hh>
64
65 #include "Ruler.hh"
66 #include "RulerOptions.hh"
67
68 class RulerPlugin : public QObject, BaseInterface, MouseInterface, PickingInterface, ToolbarInterface, LoadSaveInterface, OptionsInterface
69 {
70 Q_OBJECT
71 Q_INTERFACES(BaseInterface)
72 Q_INTERFACES(MouseInterface)
73 Q_INTERFACES(PickingInterface)
74 Q_INTERFACES(ToolbarInterface)
75 Q_INTERFACES(LoadSaveInterface)
76 Q_INTERFACES(OptionsInterface)
77
78 #if QT_VERSION >= 0x050000
79 Q_PLUGIN_METADATA(IID "org.OpenFlipper.Plugins.Plugin-Ruler")
80 #endif
81
82 signals:
83 void addToolbar(QToolBar *_toolbar);
84
85 void addPickMode(const std::string &_mode);
86
87 void updateView();
88
89 void setPickModeMouseTracking ( const std::string &_mode, bool _mouseTracking);
90
91 public slots:
92
93 void slotPickModeChanged(const std::string& _mode);
94
95 void slotMouseEvent(QMouseEvent* _event);
96
97 void slotViewChanged();
98 public:
99
100 // OptionsInterface
101 bool initializeOptionsWidget(QWidget*& _widget);
102
103 RulerPlugin();
104 ~RulerPlugin();
105
106 QString name(){return QString("RulerPlugin");}
107 QString description(){return QString("Measure the distance between two points.");}
108
109 private:
110
111 void reset();
112
113 void enableDragMode(const int _point);
114
115 void disableDragMode();
116
117 bool dragModeActive(){return lineDrag_ >= 0;}
118
119 QAction *buttonAction_;
120
121 const std::string pickModeName_;
122
123 //saves the index of the dragged point, if no point was dragged, it is -1
124 int lineDrag_;
125
126 //checks if a double click was provided for resetting
127 bool dblClickCheck_;
128
129 ptr::shared_ptr<Ruler> currentRuler_;
130
131 RulerOptions* optionsWidget_;
132
133 const QString textSizeSettingName_;
134 private slots:
135
136 void initializePlugin();
137
138 void pluginsInitialized();
139
140 void slotChangePickMode();
141
142 void slotAllCleared();
143
144 void objectDeleted(int _id);
145
146 // OptionsInterface
147 void applyOptions();
148
149 public slots:
150 QString version(){ return QString("1.0"); }
151 };
152
153
154 #endif //RULERPLUGIN_HH
RulerOptions
Definition: RulerOptions.hh:59
BaseInterface
Interface class from which all plugins have to be created.
Definition: BaseInterface.hh:76
RulerPlugin::description
QString description()
Return a description of what the plugin is doing.
Definition: RulerPlugin.hh:107
OptionsInterface.hh
ToolbarInterface.hh
MouseInterface.hh
OptionsInterface
Options Dialog interface.
Definition: OptionsInterface.hh:74
LoadSaveInterface.hh
ToolbarInterface
Add a toolbox to OpenFlipper.
Definition: ToolbarInterface.hh:79
LoadSaveInterface
Interface for all plugins which want to Load or Save files and create Objects.
Definition: LoadSaveInterface.hh:68
RulerPlugin::name
QString name()
Return a name for the plugin.
Definition: RulerPlugin.hh:106
RulerPlugin
Definition: RulerPlugin.hh:68
RulerPlugin::initializeOptionsWidget
bool initializeOptionsWidget(QWidget *&_widget)
Initialize the Options Widget.
Definition: RulerPlugin.cc:267
PickingInterface
Allow access to picking functions.
Definition: PickingInterface.hh:81
PickingInterface.hh
BaseInterface.hh
MouseInterface
Interface class for receiving mouse events.
Definition: MouseInterface.hh:75