Developer Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
SmootherPlugin.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 //=============================================================================
51 //
52 // SmootherPlugin
53 //
54 //=============================================================================
55 
56 #ifndef SMOOTHERPLUGIN_HH
57 #define SMOOTHERPLUGIN_HH
58 
59 //== INCLUDES =================================================================
60 
61 #include <QObject>
62 #include <QMenuBar>
63 #include <QTimer>
64 
70 
74 
76 
77 #include "SmootherToolbarWidget.hh"
78 
79 
80 //== CLASS DEFINITION =========================================================
81 
82 
86 {
87  Q_OBJECT
88  Q_INTERFACES(BaseInterface)
89  Q_INTERFACES(ToolboxInterface)
90  Q_INTERFACES(BackupInterface)
91  Q_INTERFACES(LoggingInterface)
92  Q_INTERFACES(ScriptInterface)
93 
94 #if QT_VERSION >= 0x050000
95  Q_PLUGIN_METADATA(IID "org.OpenFlipper.Plugins.Plugin-Smoother")
96 #endif
97 
98 signals:
99 
100  // BaseInterface
101  void updateView();
102 
103  void updatedObject(int, const UpdateType&);
104 
105  void setSlotDescription(QString _slotName, QString _slotDescription,
106  QStringList _parameters, QStringList _descriptions);
107 
108  // LoggingInterface
109  void log(Logtype _type, QString _message);
110  void log(QString _message);
111 
112  // ToolboxInterface
113  void addToolbox( QString _name , QWidget* _widget, QIcon* _icon );
114 
115  // BackupInterface
116  void createBackup( int _id , QString _name, UpdateType _type = UPDATE_ALL );
117 
118  // ScriptInterface
119  void scriptInfo(QString _functionName);
120 
121 public :
122 
124  SmootherPlugin();
125 
128 
130  QString name(){ return (QString("Smoother")); };
131 
133  QString description() { return (QString("Mesh Smoothing ...")); };
134 
135 private slots:
136 
137  void initializePlugin(); // BaseInterface
138 
140  void pluginsInitialized();
141 
143  void noguiSupported( ) {} ;
144 
145 private :
146 
149  QIcon* toolIcon_;
150 
151 private slots:
152 
154  void slot_smooth();
155 
156 //===========================================================================
159 //===========================================================================
160 public slots:
161 
172  void smooth(int _objectId , int _iterations , QString _direction , QString _continuity, double _maxDistance = -1.0, bool _respectFeatures = true);
173 
176 public slots:
177  QString version() { return QString("1.0"); };
178 
179 
180 
181 private:
183 };
184 
185 #endif //SMOOTHERPLUGIN_HH
Interface class from which all plugins have to be created.
void noguiSupported()
Tell system that this plugin runs without ui.
Logtype
Log types for Message Window.
QString description()
Description of the Plugin.
Update type class.
Definition: UpdateType.hh:70
const UpdateType UPDATE_ALL(UpdateTypeSet(1))
Identifier for all updates.
Interface for all Plugins which do logging to the logging window of the framework.
QString name()
Name of the Plugin.
Interface for all Plugins which provide scriptable Functions.
~SmootherPlugin()
default destructor
void smooth(int _objectId, int _iterations, QString _direction, QString _continuity, double _maxDistance=-1.0, bool _respectFeatures=true)
smooth an object
Interface class for backup handling.
Plugins can add its own toolbox to the main widget's toolbox area by using this interface.
SmootherToolbarWidget * tool_
Widget for Toolbox.
void pluginsInitialized()
Set the scripting slot descriptions.
void slot_smooth()
Slot connected to the smooth button in the toolbox.