Developer Documentation
FileSTL.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 
44 
45 #ifndef FILESTLPLUGIN_HH
46 #define FILESTLPLUGIN_HH
47 
48 #include <QObject>
49 class QCheckBox;
50 class QLabel;
51 class QSpinBox;
52 
62 
64 
67 {
68  Q_OBJECT
69  Q_INTERFACES(FileInterface)
70  Q_INTERFACES(LoadSaveInterface)
71  Q_INTERFACES(LoggingInterface)
72  Q_INTERFACES(BaseInterface)
73  Q_INTERFACES(ScriptInterface)
74  Q_INTERFACES(PythonInterface)
75 
76  Q_PLUGIN_METADATA(IID "org.OpenFlipper.Plugins.Plugin-FileSTL")
77 
78  signals:
79  void openedFile( int _id );
80  void addEmptyObject( DataType _type, int& _id);
81  void load(QString _filename, DataType _type, int& _id);
82  void save(int _id , QString _filename );
83  void log(Logtype _type, QString _message);
84  void log(QString _message);
85  void updateView();
86  void updatedObject(int _identifier, const UpdateType& _type);
87 
88  void deleteObject( int _id );
89 
90  void setSlotDescription(QString _slotName, QString _slotDescription,
91  QStringList _parameters, QStringList _descriptions);
92 
93  private slots:
94 
95  void fileOpened( int /*_id*/ ){};
96 
97  void noguiSupported( ) {} ;
98 
99  void initializePlugin();
100 
102  void slotLoadDefault();
103 
105  void slotSaveDefault();
106 
107  public :
108 
109  FileSTLPlugin();
110 
111  ~FileSTLPlugin() {};
112 
113  QString name() { return (QString("FileSTL")); };
114  QString description( ) { return (QString(tr("Load/Save STL-Files"))); };
115 
117 
118  QString getSaveFilters();
119  QString getLoadFilters();
120 
121  QWidget* saveOptionsWidget(QString /*_currentFilter*/);
122  QWidget* loadOptionsWidget(QString /*_currentFilter*/);
123 
124  public slots:
125 
127  int loadObject(QString _filename);
128 
129  bool saveObject(int _id, QString _filename);
130 
131 
140  bool saveObject(int _id, QString _filename, const bool _binary , const std::streamsize _precision = 6 );
141 
142  QString version() { return QString("1.0"); };
143 
144  private :
145 
146  //Option Widgets
147  QWidget* saveOptions_;
148  QWidget* loadOptions_;
149 
150  QCheckBox* saveBinary_;
151  QLabel* savePrecisionLabel_;
152  QSpinBox* savePrecision_;
153 
154  QCheckBox* loadFaceNormal_;
155 
156  QPushButton* saveDefaultButton_;
157  QPushButton* loadDefaultButton_;
158 };
159 
160 #endif //FILESTLPLUGIN_HH
QString description()
Return a description of what the plugin is doing.
Definition: FileSTL.hh:114
void noguiSupported()
Definition: FileSTL.hh:97
void initializePlugin()
Initialize Plugin.
Definition: FileSTL.cc:66
Interface class for exporting functions to python.
DataType supportedType()
Return your supported object type( e.g. DATA_TRIANGLE_MESH )
Definition: FileSTL.cc:91
QWidget * loadOptionsWidget(QString)
Definition: FileSTL.cc:281
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.
FileSTLPlugin()
Constructor.
Definition: FileSTL.cc:50
QString getLoadFilters()
Definition: FileSTL.cc:79
int loadObject(QString _filename)
Loads Object as triangle mesh.
Definition: FileSTL.cc:98
void slotLoadDefault()
Slot called when user wants to save the given Load options as default.
Definition: FileSTL.cc:307
Update type class.
Definition: UpdateType.hh:59
QString name()
Return a name for the plugin.
Definition: FileSTL.hh:113
QWidget * saveOptionsWidget(QString)
Definition: FileSTL.cc:244
Interface for all Plugins which provide scriptable Functions.
void slotSaveDefault()
Slot called when user wants to save the given Save options as default.
Definition: FileSTL.cc:314
QString getSaveFilters()
Definition: FileSTL.cc:85
Interface class from which all plugins have to be created.
Interface class for file handling.
Interface for all plugins which want to Load or Save files and create Objects.