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