Developer Documentation
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 //=============================================================================
45 //
46 // SmootherPlugin
47 //
48 //=============================================================================
49 
50 #ifndef SMOOTHERPLUGIN_HH
51 #define SMOOTHERPLUGIN_HH
52 
53 //== INCLUDES =================================================================
54 
55 #include <QObject>
56 #include <QMenuBar>
57 #include <QTimer>
58 
65 
69 
71 
72 #include "SmootherToolbarWidget.hh"
73 
74 
75 //== CLASS DEFINITION =========================================================
76 
77 
81 {
82  Q_OBJECT
83  Q_INTERFACES(BaseInterface)
84  Q_INTERFACES(ToolboxInterface)
85  Q_INTERFACES(BackupInterface)
86  Q_INTERFACES(LoggingInterface)
87  Q_INTERFACES(ScriptInterface)
88  Q_INTERFACES(PythonInterface)
89 
90  Q_PLUGIN_METADATA(IID "org.OpenFlipper.Plugins.Plugin-Smoother")
91 
92 signals:
93 
94  // BaseInterface
95  void updateView();
96 
97  void updatedObject(int, const UpdateType&);
98 
99  void setSlotDescription(QString _slotName, QString _slotDescription,
100  QStringList _parameters, QStringList _descriptions);
101 
102  // LoggingInterface
103  void log(Logtype _type, QString _message);
104  void log(QString _message);
105 
106  // ToolboxInterface
107  void addToolbox( QString _name , QWidget* _widget, QIcon* _icon );
108 
109  // BackupInterface
110  void createBackup( int _id , QString _name, UpdateType _type = UPDATE_ALL );
111 
112  // ScriptInterface
113  void scriptInfo(QString _functionName);
114 
115 public :
116 
118  SmootherPlugin();
119 
122 
124  QString name(){ return (QString("Smoother")); };
125 
127  QString description() { return (QString("Mesh Smoothing ...")); };
128 
129 private slots:
130 
131  void initializePlugin(); // BaseInterface
132 
134  void pluginsInitialized();
135 
137  void noguiSupported( ) {} ;
138 
139 private :
140 
143  QIcon* toolIcon_;
144 
145 private slots:
146 
148  void slot_smooth();
149 
150 //===========================================================================
153 //===========================================================================
154 public slots:
155 
166  void smooth(int _objectId , int _iterations , QString _direction , QString _continuity, double _maxDistance = -1.0, bool _respectFeatures = true);
167 
170 public slots:
171  QString version() { return QString("1.0"); };
172 
173 
174 
175 private:
177 };
178 
179 #endif //SMOOTHERPLUGIN_HH
~SmootherPlugin()
default destructor
void slot_smooth()
Slot connected to the smooth button in the toolbox.
Update type class.
Definition: UpdateType.hh:60
const UpdateType UPDATE_ALL(UpdateTypeSet(1))
Identifier for all updates.
void noguiSupported()
Tell system that this plugin runs without ui.
Logtype
Log types for Message Window.
QString name()
Name of the Plugin.
Interface for all Plugins which provide scriptable Functions.
void pluginsInitialized()
Set the scripting slot descriptions.
Interface for all Plugins which do logging to the logging window of the framework.
void smooth(int _objectId, int _iterations, QString _direction, QString _continuity, double _maxDistance=-1.0, bool _respectFeatures=true)
smooth an object
Plugins can add its own toolbox to the main widget&#39;s toolbox area by using this interface.
Interface class from which all plugins have to be created.
QString description()
Description of the Plugin.
SmootherToolbarWidget * tool_
Widget for Toolbox.
Interface class for backup handling.
Interface class for exporting functions to python.