Developer Documentation

TypeHexahedralMesh.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 <QObject>
46
47 #include <ObjectTypes/HexahedralMesh/HexahedralMesh.hh>
48 #include <OpenFlipper/common/Types.hh>
49 #include <OpenFlipper/BasePlugin/BaseInterface.hh>
50 #include <OpenFlipper/BasePlugin/LoadSaveInterface.hh>
51 #include <OpenFlipper/BasePlugin/TypeInterface.hh>
52 #include <OpenFlipper/BasePlugin/KeyInterface.hh>
53 #include <OpenFlipper/BasePlugin/LoggingInterface.hh>
54 #include <OpenFlipper/BasePlugin/ContextMenuInterface.hh>
55
56 class TypeHexahedralMeshPlugin : public QObject, BaseInterface, LoadSaveInterface, TypeInterface, KeyInterface, LoggingInterface, ContextMenuInterface {
57 Q_OBJECT
58 Q_INTERFACES(BaseInterface)
59 Q_INTERFACES(LoadSaveInterface)
60 Q_INTERFACES(TypeInterface)
61 Q_INTERFACES(KeyInterface)
62 Q_INTERFACES(LoggingInterface)
63 Q_INTERFACES(ContextMenuInterface)
64
65 Q_PLUGIN_METADATA(IID "org.OpenFlipper.Plugins.Plugin-TypeHexahedralMesh")
66
67 signals:
68 // Logging interface
69 void log(Logtype _type, QString _message);
70 void log(QString _message);
71
72 // LoadSave Interface
73 void emptyObjectAdded(int _id);
74
75 // ContextMenuInterface
76 void addContextMenuItem(QAction* /*_action*/, DataType /*_objectType*/, ContextMenuType /*_type*/);
77
78 // BaseInterface
79 void updatedObject(int _objId, const UpdateType& _type);
80
81 private slots:
82
83 // BaseInterface
84 void slotObjectUpdated(int _identifier, const UpdateType& _type);
85 void objectDeleted(int _identifier);
86 void noguiSupported() {}
87 void pluginsInitialized();
88
89 // KeyInterface
90 void slotKeyEvent(QKeyEvent* _event);
91
92 // ContextMenuInterface
93 void slotUpdateContextMenu(int _objectId);
94
95 // Switches
96
97 void slot_change_shrinkage();
98
99 void slot_update_planes_in_scenegraph_node(int _deletedObject = -1);
100
101 void switchRendering();
102
103 void setTranslucencyFactor();
104
105 public:
106
107 ~TypeHexahedralMeshPlugin() {
108 }
109
110 TypeHexahedralMeshPlugin();
111
112 QString name() {
113 return (QString("TypeHexahedralMesh"));
114 }
115
116 QString description() {
117 return (QString(tr("Register HexahedralMesh type ")));
118 }
119
120 bool registerType();
121
122 public slots:
123
124 QString version() {
125 return QString("1.0");
126 }
127
128 // Type Interface
129 int addEmpty();
130
131 DataType supportedType() {
132 return DATA_HEXAHEDRAL_MESH;
133 }
134
135
136 private:
137
138 QAction* render_switch_;
139
140 QAction* translucency_factor_action_;
141
142 };
143
ContextMenuInterface
Interface class for creating custom context menus.
Definition: ContextMenuInterface.hh:85
UpdateType
Update type class.
Definition: UpdateType.hh:60
Logtype
Logtype
Log types for Message Window.
Definition: LoggingInterface.hh:92
LoadSaveInterface
Interface for all plugins which want to Load or Save files and create Objects.
Definition: LoadSaveInterface.hh:59
HexahedralMesh.hh
LoggingInterface.hh
TypeInterface
Interface class for type definitions.
Definition: TypeInterface.hh:63
LoggingInterface
Interface for all Plugins which do logging to the logging window of the framework.
Definition: LoggingInterface.hh:112
TypeHexahedralMeshPlugin::name
QString name()
Return a name for the plugin.
Definition: TypeHexahedralMesh.hh:112
BaseInterface.hh
KeyInterface.hh
ContextMenuInterface.hh
TypeHexahedralMeshPlugin::description
QString description()
Return a description of what the plugin is doing.
Definition: TypeHexahedralMesh.hh:116
LoadSaveInterface.hh
DATA_HEXAHEDRAL_MESH
#define DATA_HEXAHEDRAL_MESH
Definition: HexahedralMesh.hh:56
BaseInterface
Interface class from which all plugins have to be created.
Definition: BaseInterface.hh:65
TypeInterface.hh
Types.hh
KeyInterface
Keyboard Event Interface.
Definition: KeyInterface.hh:59
DataType
Predefined datatypes.
Definition: DataTypes.hh:83
TypeHexahedralMeshPlugin
Definition: TypeHexahedralMesh.hh:56
ContextMenuType
ContextMenuType
Definition: ContextMenuInterface.hh:56