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 
53 #ifndef SMOOTHERPLUGIN_HH
54 #define SMOOTHERPLUGIN_HH
55 
62 
64 {
65  Q_OBJECT
66  Q_INTERFACES(BaseInterface)
67  Q_INTERFACES(ToolboxInterface)
68  Q_INTERFACES(LoggingInterface)
69  Q_INTERFACES(ScriptInterface)
70  Q_INTERFACES(BackupInterface)
71 
72 #if QT_VERSION >= 0x050000
73  Q_PLUGIN_METADATA(IID "org.OpenFlipper.Plugins.Plugin-SimpleSmoother")
74 #endif
75 
76  signals:
77  //BaseInterface
78  void updateView();
79  void updatedObject(int _id, const UpdateType& _type);
80  void setSlotDescription(QString _slotName, QString _slotDescription,
81  QStringList _parameters, QStringList _descriptions);
82 
83  //LoggingInterface
84  void log(Logtype _type, QString _message);
85  void log(QString _message);
86 
87  // ToolboxInterface
88  void addToolbox( QString _name , QWidget* _widget, QIcon* _icon);
89 
90  // ScriptInterface
91  void scriptInfo(QString _functionName);
92 
93  // BackupInterface
94  void createBackup( int _id , QString _name, UpdateType _type = UPDATE_ALL );
95 
96  public:
97 
99  ~SmootherPlugin();
100 
101  // BaseInterface
102  QString name() { return (QString("Simple Smoother")); };
103  QString description( ) { return (QString("Smooths the active Mesh")); };
104 
105  private:
106 
108  QSpinBox* iterationsSpinbox_;
109 
110  private slots:
111  void simpleLaplace();
112 
113  void initializePlugin(); // BaseInterface
114 
115  void pluginsInitialized(); // BaseInterface
116 
117  // Scriptable functions
118  public slots:
119 
120  void simpleLaplace(int _iterations);
121 
122  QString version() { return QString("1.0"); };
123 };
124 
125 #endif //SMOOTHERPLUGIN_HH
Interface class from which all plugins have to be created.
Logtype
Log types for Message Window.
QString description()
Return a description of what the plugin is doing.
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()
Return a name for the plugin.
void simpleLaplace()
simpleLaplace
Interface for all Plugins which provide scriptable Functions.
QSpinBox * iterationsSpinbox_
SpinBox for Number of iterations.
Interface class for backup handling.
Plugins can add its own toolbox to the main widget's toolbox area by using this interface.
void pluginsInitialized()
Set the scripting slot descriptions.