Developer Documentation

MergePlugin.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 #include <QObject>
45
46 #include <OpenFlipper/BasePlugin/BaseInterface.hh>
47 #include <OpenFlipper/BasePlugin/ToolboxInterface.hh>
48 #include <OpenFlipper/BasePlugin/LoadSaveInterface.hh>
49 #include <OpenFlipper/BasePlugin/LoggingInterface.hh>
50 #include <OpenFlipper/BasePlugin/ScriptInterface.hh>
51
52 #include "MergeToolbox.hh"
53
54 class MergePlugin : public QObject, BaseInterface, ToolboxInterface, LoggingInterface, LoadSaveInterface, ScriptInterface
55 {
56 Q_OBJECT
57 Q_INTERFACES(BaseInterface)
58 Q_INTERFACES(ToolboxInterface)
59 Q_INTERFACES(LoggingInterface)
60 Q_INTERFACES(LoadSaveInterface)
61 Q_INTERFACES(ScriptInterface)
62 Q_PLUGIN_METADATA(IID "org.OpenFlipper.Plugins.Plugin-Merge")
63
64
65
66 signals:
67 //BaseInterface
68 void updateView();
69 void updatedObject(int _identifier, const UpdateType& _type);
70
71 //LoggingInterface:
72 void log( Logtype _type, QString _message );
73 void log( QString _message );
74
75 // LoadSaveInterface
76 void addEmptyObject( DataType _type, int &_objectId );
77 void deleteObject( int _id );
78
79 // ToolboxInterface
80 void addToolbox( QString _name , QWidget* _widget );
81 void addToolbox( QString _name , QWidget* _widget , QIcon* _icon );
82
83 // ScriptInterface
84 void setSlotDescription(QString _slotName, QString _slotDescription,
85 QStringList _parameters, QStringList _descriptions);
86
87 void cleanup( DataType _type, bool _deleteSeparateObjects);
88
89 public :
90
91 MergePlugin();
92 ~MergePlugin() {};
93
94 QString name() { return (QString("Merge")); };
95 QString description( ) { return (QString("Merge target objects")); };
96
97 private :
98 MergeToolBox* tool_;
99 std::vector<int> convertedIds;
100 std::vector< BaseObjectData* > objects;
101 int polyMergeID, triMergeID;
102
103 DataType checkType(const std::vector< BaseObjectData* > &);
104
105 private slots :
106 // Tell system that this plugin runs without ui
107 void noguiSupported( ) {} ;
108
109 public slots:
110 // BaseInterface
111 void initializePlugin();
112 void pluginsInitialized();
113
114 void mergeObjects();
115
123 int mergeObjects(const std::vector< BaseObjectData* > & _objects, QString _name = "merged object", bool _deleteSeparateObjects = true, DataType type_ = typeId("TriangleMesh"));
124
133 int mergeObjects(IdList _objects, QString _name = "merged object", bool _deleteSeparateObjects = true, DataType type_ = typeId("TriangleMesh"));
134
140 void slotCleanup(DataType _type, bool _deleteSeparateObjects);
141
142 //template functions
143 private:
144
145 template< class MeshT >
146 void mergeMeshes( const std::vector< MeshT* >& _meshes );
147
148 template< class MeshT >
149 void mergeMeshes( const std::vector< MeshT* >& _meshes, typename MeshT::VertexHandle& _vhB);
150
151 public slots:
152 QString version() { return QString("1.1"); };
153
154 };
155
ScriptInterface.hh
ToolboxInterface.hh
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
MergePlugin::description
QString description()
Return a description of what the plugin is doing.
Definition: MergePlugin.hh:95
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
IdList
std::vector< int > IdList
Standard Type for id Lists used for scripting.
Definition: DataTypes.hh:179
MergePlugin
Definition: MergePlugin.hh:54
UpdateType
Update type class.
Definition: UpdateType.hh:60
MergePlugin::mergeMeshes
void mergeMeshes(const std::vector< MeshT * > &_meshes)
merges Meshes into the first mesh
Definition: MergePlugintemplate.cc:51
MergePlugin::name
QString name()
Return a name for the plugin.
Definition: MergePlugin.hh:94
MergePlugin::initializePlugin
void initializePlugin()
init the Toolbox
Definition: MergePlugin.cc:169
MergeToolBox
Definition: MergeToolbox.hh:46
ScriptInterface
Interface for all Plugins which provide scriptable Functions.
Definition: ScriptInterface.hh:58
MergePlugin::mergeObjects
void mergeObjects()
merge two objects with target flag
Definition: MergePlugin.cc:276
BaseInterface
Interface class from which all plugins have to be created.
Definition: BaseInterface.hh:65
BaseInterface.hh
MergePlugin::slotCleanup
void slotCleanup(DataType _type, bool _deleteSeparateObjects)
slotCleanup is called when the cleanup event is processed at the end of mergeObjects.
Definition: MergePlugin.cc:96
typeId
DLLEXPORT DataType typeId(QString _name)
Given a dataType Identifier string this function will return the id of the datatype.
Definition: Types.cc:139
LoadSaveInterface
Interface for all plugins which want to Load or Save files and create Objects.
Definition: LoadSaveInterface.hh:59