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 
55 
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 
108  }
109 
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 
Interface class for type definitions.
QString description()
Return a description of what the plugin is doing.
#define DATA_HEXAHEDRAL_MESH
Logtype
Log types for Message Window.
Predefined datatypes.
Definition: DataTypes.hh:83
Interface for all Plugins which do logging to the logging window of the framework.
Update type class.
Definition: UpdateType.hh:60
QString name()
Return a name for the plugin.
Keyboard Event Interface.
Definition: KeyInterface.hh:59
Interface class for creating custom context menus.
Interface class from which all plugins have to be created.
Interface for all plugins which want to Load or Save files and create Objects.