Developer Documentation

VolumeMeshConvert.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 #pragma once
44
45 #include <OpenFlipper/BasePlugin/BaseInterface.hh>
46 #include <OpenFlipper/BasePlugin/LoggingInterface.hh>
47 #include <OpenFlipper/BasePlugin/ToolbarInterface.hh>
48 #include <OpenFlipper/BasePlugin/LoadSaveInterface.hh>
49 #include <OpenFlipper/BasePlugin/ScriptInterface.hh>
50
51 class VolumeMeshConvertPlugin: public QObject,
52 BaseInterface,
53 LoggingInterface,
54 LoadSaveInterface,
55 ScriptInterface,
56 ToolbarInterface
57 {
58 Q_OBJECT
59 Q_INTERFACES(BaseInterface)
60 Q_INTERFACES(LoggingInterface)
61 Q_INTERFACES(ToolbarInterface)
62 Q_INTERFACES(LoadSaveInterface)
63 Q_INTERFACES(ScriptInterface)
64
65 Q_PLUGIN_METADATA(IID "org.OpenFlipper.Plugins.Plugin-VolumeMeshConvert")
66
67 signals:
68
69 // LoggingInterface
70 void log(Logtype _type, QString _message) override;
71 void log(QString _message) override;
72
73 //ToolbarInterface
74 void addToolbar(QToolBar* _toolbar) override;
75 void getToolBar(QString _name, QToolBar*& _toolbar) override;
76
77 // LoadSaveInterface
78 void addEmptyObject( DataType _type, int& _id) override;
79
80 // BaseInterface
81 void updatedObject(int, const UpdateType& _type) override;
82
83 // ScriptInterface
84 void setSlotDescription(QString _slotName, QString _slotDescription,
85 QStringList _parameters, QStringList _descriptions) override;
86
87 public:
88 VolumeMeshConvertPlugin() = default;
89
90 // BaseInterface
91 QString name() override { return (QString("VolumeMeshConvert")); }
92 QString description() override { return (QString("Convert PolyhedralMesh to TetrahedralMesh and HexahedralMesh and vice versa")); }
93
94 private slots:
95
97 void initializePlugin() override;
98 void pluginsInitialized()override;
99
101 void noguiSupported() override {}
102
103 private:
104
105 QToolBar* toolbar_ = nullptr;
106 QActionGroup* grp_ = nullptr;
107 QAction* actionToHex_ = nullptr;
108 QAction* actionToTet_ = nullptr;
109 QAction* actionToPoly_ = nullptr;
110
111
112
113 private slots:
117 void handleQAction(QAction*);
118
119 public slots:
120 int convertToHexMesh(int _id);
121 int convertToTetMesh(int _id);
122 int convertToPolyhedralMesh(int _id);
123
124 QString version() override { return QString("1.0"); }
125
126 };
ScriptInterface.hh
VolumeMeshConvertPlugin::description
QString description() override
Return a description of what the plugin is doing.
Definition: VolumeMeshConvert.hh:92
VolumeMeshConvertPlugin::handleQAction
void handleQAction(QAction *)
convert Converts polyhedralmesh to hex/tet mesh and vice versa depending on the Action that was calle...
Definition: VolumeMeshConvert.cc:113
LoadSaveInterface.hh
ToolbarInterface
Add a toolbox to OpenFlipper.
Definition: ToolbarInterface.hh:62
Logtype
Logtype
Log types for Message Window.
Definition: LoggingInterface.hh:92
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
VolumeMeshConvertPlugin::name
QString name() override
Return a name for the plugin.
Definition: VolumeMeshConvert.hh:91
ToolbarInterface.hh
VolumeMeshConvertPlugin::initializePlugin
void initializePlugin() override
BaseInterface.
Definition: VolumeMeshConvert.cc:53
VolumeMeshConvertPlugin::noguiSupported
void noguiSupported() override
Tell system that this plugin runs without ui.
Definition: VolumeMeshConvert.hh:101
UpdateType
Update type class.
Definition: UpdateType.hh:60
VolumeMeshConvertPlugin
Definition: VolumeMeshConvert.hh:51
ScriptInterface
Interface for all Plugins which provide scriptable Functions.
Definition: ScriptInterface.hh:58
BaseInterface
Interface class from which all plugins have to be created.
Definition: BaseInterface.hh:65
BaseInterface.hh
LoadSaveInterface
Interface for all plugins which want to Load or Save files and create Objects.
Definition: LoadSaveInterface.hh:59