Developer Documentation
SubdividerPlugin.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 #ifndef SUBDIVIDERPLUGIN_HH
52 #define SUBDIVIDERPLUGIN_HH
53 
54 #include <QObject>
55 #include <QMenuBar>
56 
67 
68 #include "subdividerToolbar.hh"
69 
71 {
72  Q_OBJECT
73  Q_INTERFACES(BaseInterface)
74  Q_INTERFACES(ToolboxInterface)
75  Q_INTERFACES(LoggingInterface)
76  Q_INTERFACES(LoadSaveInterface)
77  Q_INTERFACES(ScriptInterface)
78  Q_INTERFACES(BackupInterface)
79 
80 #if QT_VERSION >= 0x050000
81  Q_PLUGIN_METADATA(IID "org.OpenFlipper.Plugins.Plugin-Subdivider")
82 #endif
83 
84 signals:
85  void updateView();
86  void updatedObject(int _id, const UpdateType& _type);
87 
88  void addPickMode( const std::string& _mode );
89 
90  void log(Logtype _type, QString _message);
91  void log(QString _message);
92 
93  void addEmptyObject( DataType _type, int& _id );
94 
95  void defineViewMode(QString _mode, QStringList _usedWidgets);
96 
97  // ToolboxInterface
98  void addToolbox( QString _name , QWidget* _widget, QIcon* _icon );
99 
100  // BackupInterface
101  void createBackup( int _id , QString _name, UpdateType _type = UPDATE_ALL );
102 
103  // ScriptInterface
104  void setSlotDescription(QString _slotName, QString _slotDescription,
105  QStringList _parameters, QStringList _descriptions);
106 
107 private slots:
108 
109  void initializePlugin();
110 
111  void pluginsInitialized();
112 
114  void noguiSupported( ) {} ;
115 
116  void slotSubdivideUniformButton();
117 
118  void slotSimpleSubdivideButton();
119 
120 public slots:
121 
140  void subdivide(int _objectId, QString _algorithm , int _steps, bool _update_points = true);
141 
155  void simpleSubdivide(int _objectId, QString _algorithm , int _steps, double _parameter, bool _update_points = true);
156 
157 
158 public :
160  ~SubdividerPlugin() {};
161 
162  QString name() { return (QString("Subdivider")); };
163  QString description( ) { return (QString("Subdivide a mesh")); };
164 
165 private :
168  QIcon* toolIcon_;
169 
170 private:
171 
172  bool test_trimesh_object(int _identifier, BaseObjectData*& _object);
173 
174 
175 public slots:
176  QString version() { return QString("1.0"); };
177 };
178 
179 #endif //SUBDIVIDERPLUGIN_HH
subdividerToolbarWidget * tool_
Widget for Toolbox.
QString description()
Return a description of what the plugin is doing.
void noguiSupported()
Make plugin available in no-GUI mode.
void subdivide(int _objectId, QString _algorithm, int _steps, bool _update_points=true)
Scripting slot for subdivision.
Predefined datatypes.
Definition: DataTypes.hh:96
Logtype
Log types for Message Window.
Interface for all Plugins which provide scriptable Functions.
Interface class from which all plugins have to be created.
Update type class.
Definition: UpdateType.hh:70
Plugins can add its own toolbox to the main widget&#39;s toolbox area by using this interface.
Interface for all Plugins which do logging to the logging window of the framework.
Interface for all plugins which want to Load or Save files and create Objects.
const UpdateType UPDATE_ALL(UpdateTypeSet(1))
Identifier for all updates.
void simpleSubdivide(int _objectId, QString _algorithm, int _steps, double _parameter, bool _update_points=true)
Scripting slot for the simple subdivision algorithms.
Interface class for backup handling.
QString name()
Return a name for the plugin.