Developer Documentation
TypePolyhedralMesh.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 #include <QDoubleSpinBox>
46 #include <QCheckBox>
47 
57 
59 Q_OBJECT
60 Q_INTERFACES(BaseInterface)
61 Q_INTERFACES(LoadSaveInterface)
62 Q_INTERFACES(TypeInterface)
63 Q_INTERFACES(KeyInterface)
64 Q_INTERFACES(LoggingInterface)
65 Q_INTERFACES(ContextMenuInterface)
66 Q_INTERFACES(OptionsInterface)
67 
68  Q_PLUGIN_METADATA(IID "org.OpenFlipper.Plugins.Plugin-TypePolyhedralMesh")
69 
70 signals:
71  // Logging interface
72  void log(Logtype _type, QString _message);
73  void log(QString _message);
74 
75  // LoadSave Interface
76  void emptyObjectAdded(int _id);
77 
78  // ContextMenuInterface
79  void addContextMenuItem(QAction* /*_action*/, DataType /*_objectType*/, ContextMenuType /*_type*/);
80 
81 private slots:
82 
83  void noguiSupported() {}
84 
85  void pluginsInitialized();
86 
87  void slot_change_shrinkage();
88 
89  void slotKeyEvent(QKeyEvent* _event);
90 
91  void slotObjectUpdated(int _identifier, const UpdateType & _type);
92 
93  void objectDeleted(int _identifier);
94 
95  void slot_update_planes_in_scenegraph_node(int _deletedObject = -1);
96 
97  void switchRendering();
98 
99  void setTranslucencyFactor();
100 
101  // OptionsInterface
102  void applyOptions();
103 
104 public:
105 
106  // OptionsInterface
107  bool initializeOptionsWidget(QWidget*& _widget);
108 
110  }
111 
113 
114  QString name() {
115  return (QString("TypePolyhedralMesh"));
116  }
117 
118  QString description() {
119  return (QString(tr("Register Polyhedral Mesh Type")));
120  }
121 
122  bool registerType();
123 
124 public slots:
125 
126  QString version() {
127  return QString("1.0");
128  }
129 
130  // Type Interface
131  int addEmpty();
132 
133  DataType supportedType() {
134  return DATA_POLYHEDRAL_MESH;
135  }
136 
137 
138 private:
139 
140  QAction* render_switch_;
141 
142  QAction* translucency_factor_action_;
143 
144 private: // Options
145 
146  QWidget* optionsWidget_;
147  QDoubleSpinBox* scalingFactorSpinBox_;
148  QDoubleSpinBox* translucencyFactorSpinBox_;
149  QCheckBox* renderBoundaryCheckBox_;
150  const QString scalingFactorSettingName_;
151  const QString translucencyFactorSettingName_;
152  const QString renderBoundarySettingName_;
153 };
154 
Interface class for creating custom context menus.
Update type class.
Definition: UpdateType.hh:60
QString description()
Return a description of what the plugin is doing.
Logtype
Log types for Message Window.
Interface for all plugins which want to Load or Save files and create Objects.
QString name()
Return a name for the plugin.
Interface class for type definitions.
Interface for all Plugins which do logging to the logging window of the framework.
bool initializeOptionsWidget(QWidget *&_widget)
Initialize the Options Widget.
Interface class from which all plugins have to be created.
Keyboard Event Interface.
Definition: KeyInterface.hh:59
Predefined datatypes.
Definition: DataTypes.hh:83
Options Dialog interface.
#define DATA_POLYHEDRAL_MESH