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
51
52#include "MergeToolbox.hh"
53
55{
56Q_OBJECT
57Q_INTERFACES(BaseInterface)
58Q_INTERFACES(ToolboxInterface)
59Q_INTERFACES(LoggingInterface)
60Q_INTERFACES(LoadSaveInterface)
61Q_INTERFACES(ScriptInterface)
62 Q_PLUGIN_METADATA(IID "org.OpenFlipper.Plugins.Plugin-Merge")
63
64
65
66signals:
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
89public :
90
93
94 QString name() { return (QString("Merge")); };
95 QString description( ) { return (QString("Merge target objects")); };
96
97private :
98 MergeToolBox* tool_;
99 QIcon* toolIcon_;
100 std::vector<int> convertedIds;
101 std::vector< BaseObjectData* > objects;
102 int polyMergeID, triMergeID;
103
104 DataType checkType(const std::vector< BaseObjectData* > &);
105
106private slots :
107 // Tell system that this plugin runs without ui
108 void noguiSupported( ) {} ;
109
110public slots:
111 // BaseInterface
112 void initializePlugin();
113 void pluginsInitialized();
114
115 void mergeObjects();
116
124 int mergeObjects(const std::vector< BaseObjectData* > & _objects, QString _name = "merged object", bool _deleteSeparateObjects = true, DataType type_ = typeId("TriangleMesh"));
125
134 int mergeObjects(IdList _objects, QString _name = "merged object", bool _deleteSeparateObjects = true, DataType type_ = typeId("TriangleMesh"));
135
141 void slotCleanup(DataType _type, bool _deleteSeparateObjects);
142
143//template functions
144private:
145
146 template< class MeshT >
147 void mergeMeshes( const std::vector< MeshT* >& _meshes );
148
149 template< class MeshT >
150 void mergeMeshes( const std::vector< MeshT* >& _meshes, typename MeshT::VertexHandle& _vhB);
151
152 public slots:
153 QString version() { return QString("1.1"); };
154
155};
156
DLLEXPORT DataType typeId(QString _name)
Given a dataType Identifier string this function will return the id of the datatype.
Definition: Types.cc:139
std::vector< int > IdList
Standard Type for id Lists used for scripting.
Definition: DataTypes.hh:181
Logtype
Log types for Message Window.
Interface class from which all plugins have to be created.
Predefined datatypes.
Definition: DataTypes.hh:83
Interface for all plugins which want to Load or Save files and create Objects.
Interface for all Plugins which do logging to the logging window of the framework.
void mergeMeshes(const std::vector< MeshT * > &_meshes)
merges Meshes into the first mesh
QString name()
Return a name for the plugin.
Definition: MergePlugin.hh:94
void slotCleanup(DataType _type, bool _deleteSeparateObjects)
slotCleanup is called when the cleanup event is processed at the end of mergeObjects.
Definition: MergePlugin.cc:94
QString description()
Return a description of what the plugin is doing.
Definition: MergePlugin.hh:95
void initializePlugin()
init the Toolbox
Definition: MergePlugin.cc:172
void mergeObjects()
merge two objects with target flag
Definition: MergePlugin.cc:279
Interface for all Plugins which provide scriptable Functions.
Plugins can add its own toolbox to the main widget's toolbox area by using this interface.
Update type class.
Definition: UpdateType.hh:59