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
45 #ifndef SUBDIVIDERPLUGIN_HH
46 #define SUBDIVIDERPLUGIN_HH
47
48 #include <QObject>
49 #include <QMenuBar>
50
51 #include <OpenFlipper/BasePlugin/BaseInterface.hh>
52 #include <OpenFlipper/BasePlugin/LoggingInterface.hh>
53 #include <OpenFlipper/BasePlugin/ToolboxInterface.hh>
54 #include <OpenFlipper/BasePlugin/BackupInterface.hh>
55 #include <OpenFlipper/BasePlugin/ScriptInterface.hh>
56 #include <OpenFlipper/BasePlugin/LoadSaveInterface.hh>
57 #include <OpenFlipper/BasePlugin/BackupInterface.hh>
58 #include <OpenFlipper/common/Types.hh>
59 #include <ObjectTypes/TriangleMesh/TriangleMesh.hh>
60 #include <ObjectTypes/PolyMesh/PolyMesh.hh>
61
62 #include "subdividerToolbar.hh"
63
64 class SubdividerPlugin : public QObject, BaseInterface , ToolboxInterface, LoggingInterface, LoadSaveInterface, ScriptInterface, BackupInterface
65 {
66 Q_OBJECT
67 Q_INTERFACES(BaseInterface)
68 Q_INTERFACES(ToolboxInterface)
69 Q_INTERFACES(LoggingInterface)
70 Q_INTERFACES(LoadSaveInterface)
71 Q_INTERFACES(ScriptInterface)
72 Q_INTERFACES(BackupInterface)
73
74 Q_PLUGIN_METADATA(IID "org.OpenFlipper.Plugins.Plugin-Subdivider")
75
76 signals:
77 void updateView();
78 void updatedObject(int _id, const UpdateType& _type);
79
80 void addPickMode( const std::string& _mode );
81
82 void log(Logtype _type, QString _message);
83 void log(QString _message);
84
85 void addEmptyObject( DataType _type, int& _id );
86
87 void defineViewMode(QString _mode, QStringList _usedWidgets);
88
89 // ToolboxInterface
90 void addToolbox( QString _name , QWidget* _widget, QIcon* _icon );
91
92 // BackupInterface
93 void createBackup( int _id , QString _name, UpdateType _type = UPDATE_ALL );
94
95 // ScriptInterface
96 void setSlotDescription(QString _slotName, QString _slotDescription,
97 QStringList _parameters, QStringList _descriptions);
98
99 private slots:
100
101 void initializePlugin();
102
103 void pluginsInitialized();
104
106 void noguiSupported( ) {} ;
107
108 void slotSubdivideUniformButton();
109
110 void slotSimpleSubdivideButton();
111
112 public slots:
113
132 void subdivide(int _objectId, QString _algorithm , int _steps, bool _update_points = true);
133
147 void simpleSubdivide(int _objectId, QString _algorithm , int _steps, double _parameter, bool _update_points = true);
148
149
150 public :
151 SubdividerPlugin();
152 ~SubdividerPlugin() {};
153
154 QString name() { return (QString("Subdivider")); };
155 QString description( ) { return (QString("Subdivide a mesh")); };
156
157 private :
159 subdividerToolbarWidget* tool_;
160 QIcon* toolIcon_;
161
162 private:
163
164 bool test_trimesh_object(int _identifier, BaseObjectData*& _object);
165
166
167 public slots:
168 QString version() { return QString("1.0"); };
169 };
170
171 #endif //SUBDIVIDERPLUGIN_HH
ScriptInterface.hh
ToolboxInterface.hh
UPDATE_ALL
const UpdateType UPDATE_ALL(UpdateTypeSet(1))
Identifier for all updates.
LoadSaveInterface.hh
ToolboxInterface
Plugins can add its own toolbox to the main widget&#39;s toolbox area by using this interface.
Definition: ToolboxInterface.hh:68
Logtype
Logtype
Log types for Message Window.
Definition: LoggingInterface.hh:92
subdividerToolbarWidget
Definition: subdividerToolbar.hh:46
SubdividerPlugin::name
QString name()
Return a name for the plugin.
Definition: SubdividerPlugin.hh:154
SubdividerPlugin::description
QString description()
Return a description of what the plugin is doing.
Definition: SubdividerPlugin.hh:155
DataType
Predefined datatypes.
Definition: DataTypes.hh:83
LoggingInterface
Interface for all Plugins which do logging to the logging window of the framework.
Definition: LoggingInterface.hh:112
LoggingInterface.hh
SubdividerPlugin::noguiSupported
void noguiSupported()
Make plugin available in no-GUI mode.
Definition: SubdividerPlugin.hh:106
TriangleMesh.hh
SubdividerPlugin
Definition: SubdividerPlugin.hh:64
SubdividerPlugin::simpleSubdivide
void simpleSubdivide(int _objectId, QString _algorithm, int _steps, double _parameter, bool _update_points=true)
Scripting slot for the simple subdivision algorithms.
Definition: SubdividerPlugin.cc:164
SubdividerPlugin::tool_
subdividerToolbarWidget * tool_
Widget for Toolbox.
Definition: SubdividerPlugin.hh:155
BaseObjectData
Definition: BaseObjectData.hh:102
UpdateType
Update type class.
Definition: UpdateType.hh:60
PolyMesh.hh
ScriptInterface
Interface for all Plugins which provide scriptable Functions.
Definition: ScriptInterface.hh:58
Types.hh
BaseInterface
Interface class from which all plugins have to be created.
Definition: BaseInterface.hh:65
BaseInterface.hh
BackupInterface
Interface class for backup handling.
Definition: BackupInterface.hh:59
BackupInterface.hh
SubdividerPlugin::subdivide
void subdivide(int _objectId, QString _algorithm, int _steps, bool _update_points=true)
Scripting slot for subdivision.
Definition: SubdividerPlugin.cc:197
LoadSaveInterface
Interface for all plugins which want to Load or Save files and create Objects.
Definition: LoadSaveInterface.hh:59