Developer Documentation
HoleFillerPlugin.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 #ifndef HOLEFILLINGPLUGIN_HH
51 #define HOLEFILLINGPLUGIN_HH
52 
53 #include <QObject>
54 #include <QMenuBar>
55 
66 
67 #include "holefillerToolbar.hh"
68 
69 #include <vector>
70 #include <utility>
71 
73 {
74  Q_OBJECT
75  Q_INTERFACES(BaseInterface)
76  Q_INTERFACES(MouseInterface)
77  Q_INTERFACES(PickingInterface)
78  Q_INTERFACES(ToolboxInterface)
79  Q_INTERFACES(LoggingInterface)
80  Q_INTERFACES(ScriptInterface)
81  Q_INTERFACES(BackupInterface)
82 #if QT_VERSION >= 0x050000
83  Q_PLUGIN_METADATA(IID "org.OpenFlipper.Plugins.Plugin-HoleFilling")
84 #endif
85 
86  signals:
87  // BaseInterface
88  void updateView();
89  void updatedObject(int _id, const UpdateType& _type);
90 
91  void addPickMode( const std::string& _mode );
92 
93  void log(Logtype _type, QString _message);
94  void log(QString _message);
95 
96  void createBackup( int _objectid, QString _name, UpdateType _type = UPDATE_ALL);
97 
98  void scriptInfo( QString _functionName );
99 
100  void setSlotDescription(QString _slotName , QString _slotDescription,
101  QStringList _parameters , QStringList _descriptions);
102 
103  // ToolboxInterface
104  void addToolbox( QString _name , QWidget* _widget, QIcon* _icon );
105 
106 
107  private slots:
108  void slotObjectUpdated( int _identifier, const UpdateType& _type );
109 
110  void slotMouseWheelEvent(QWheelEvent * /*_event*/, const std::string & /*_mode*/){};
111 
112  void slotMouseEvent( QMouseEvent* /*_event*/ ){};
113 
114  // BaseInterface
115  void initializePlugin();
116  void pluginsInitialized() ;
117 
118  void detectButton( );
119 
120  public :
121 
122  ~HoleFillerPlugin() {};
123 
125 
126  QString name() { return (QString("Hole Filler")); };
127  QString description( ) { return (QString("Fill Holes or connect meshes")); };
128 
129  private slots:
131 
132  void slotCellDoubleClicked(int _row , int _col);
133  void slotFillSelection();
134  private :
135 
136  void update_menu();
137 
139  void getSelectedHoles(std::vector<int>& _holeIds, std::vector<int>& _objIds);
140 
143 
145  std::vector< std::pair< int , int> > holeMapping_;
146 
147  //Scripting slots
148  public slots:
149 
150  void fillAllHoles(int _objectID);
151 
152  void fillHole(int _objectID, int _edgeHandle);
153 
154  public slots:
155 
156  QString version() { return QString("1.3"); };
157 };
158 
159 #endif //HOLEFILLINGPLUGIN_HH
std::vector< std::pair< int, int > > holeMapping_
map from the index in the table to (object-id, hole-id)
void slotItemSelectionChanged()
slot for displaying selected holes
Interface class for receiving mouse events.
void fillHole(int _objectID, int _edgeHandle)
fill a hole in given object where _edgeHandle is on the boundary
Logtype
Log types for Message Window.
QString description()
Return a description of what the plugin is doing.
void pluginsInitialized()
add PickModes after initialization
void detectButton()
detect holes on all objects
void slotFillSelection()
Fill all selected holes.
void slotCellDoubleClicked(int _row, int _col)
Slot for filling holes from double-clicked rows.
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.
QString name()
Return a name for the plugin.
HoleFillerToolbarWidget * tool_
Widget for Toolbox.
void slotObjectUpdated(int _identifier, const UpdateType &_type)
check for holes if an object has changed
void initializePlugin()
Initialize the toolbox widget.
void fillAllHoles(int _objectID)
fill all holes from a given object
void getSelectedHoles(std::vector< int > &_holeIds, std::vector< int > &_objIds)
get a map from objectID to (selected) holeIDs
const UpdateType UPDATE_ALL(UpdateTypeSet(1))
Identifier for all updates.
HoleFillerPlugin()
Constructor.
void slotMouseEvent(QMouseEvent *)
Mouse Event from main application ( Picking Mode )
void update_menu()
update the entries in the tableWidget
Interface class for backup handling.
Allow access to picking functions.