Developer Documentation

PluginAlignMeshes.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/LoggingInterface.hh>
48 #include <OpenFlipper/BasePlugin/ToolboxInterface.hh>
49 #include <OpenFlipper/common/Types.hh>
50
51 #include "Widgets/AlignMeshesToolbox.hh"
52
53 class PluginAlignMeshes : public QObject, BaseInterface, LoggingInterface, ToolboxInterface {
54
55 Q_OBJECT
56 Q_INTERFACES(BaseInterface)
57 Q_INTERFACES(ToolboxInterface)
58 Q_INTERFACES(LoggingInterface)
59
60 Q_PLUGIN_METADATA(IID "org.OpenFlipper.Plugins.Plugin-AlignMeshes")
61
62 public:
63
64 PluginAlignMeshes();
65
66 ~PluginAlignMeshes();
67
68 // BaseInterface
69 QString name() { return QString("PluginAlignMeshes"); }
70 QString description() { return tr("Aligns meshes"); }
71
72 signals:
73 // BaseInterface
74 void updatedObject(int _id, const UpdateType& _type);
75
76 // LoggingInterface
77 void log(Logtype _type, QString _message);
78 void log(QString _message);
79
80 // ToolboxInterface
81 void addToolbox(QString _name, QWidget* _widget, QIcon* _icon);
82
83 public slots:
84
85 // BaseInterface
86 QString version() { return QString("1.0"); }
87
88 void alignMeshes();
89
90 private slots:
91
92 // BaseInterface
93 void initializePlugin();
94
95 private:
96 AlignMeshesToolbox* toolBox_;
97 QIcon* toolIcon_;
98 };
99
100
101
PluginAlignMeshes::description
QString description()
Return a description of what the plugin is doing.
Definition: PluginAlignMeshes.hh:70
UpdateType
Update type class.
Definition: UpdateType.hh:60
Logtype
Logtype
Log types for Message Window.
Definition: LoggingInterface.hh:92
LoggingInterface.hh
PluginAlignMeshes
Definition: PluginAlignMeshes.hh:53
LoggingInterface
Interface for all Plugins which do logging to the logging window of the framework.
Definition: LoggingInterface.hh:112
BaseInterface.hh
ToolboxInterface
Plugins can add its own toolbox to the main widget&#39;s toolbox area by using this interface.
Definition: ToolboxInterface.hh:68
BaseInterface
Interface class from which all plugins have to be created.
Definition: BaseInterface.hh:65
ToolboxInterface.hh
AlignMeshesToolbox
Definition: AlignMeshesToolbox.hh:5
Types.hh
PluginAlignMeshes::name
QString name()
Return a name for the plugin.
Definition: PluginAlignMeshes.hh:69