Developer Documentation
FilePla.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 #ifndef FILEPLAPLUGIN_HH
45 #define FILEPLAPLUGIN_HH
46 
47 #include <QObject>
48 
56 
58 {
59  Q_OBJECT
60  Q_INTERFACES(FileInterface)
61  Q_INTERFACES(LoadSaveInterface)
62  Q_INTERFACES(LoggingInterface)
63  Q_INTERFACES(BaseInterface)
64  Q_INTERFACES(ScriptInterface)
65 
66  Q_PLUGIN_METADATA(IID "org.OpenFlipper.Plugins.Plugin-FilePla")
67 
68  signals:
69  void openedFile( int _id );
70  void addEmptyObject( DataType _type, int& _id);
71  void load(QString _filename, DataType _type, int& _id);
72  void save(int _id , QString _filename );
73  void log(Logtype _type, QString _message);
74  void log(QString _message);
75  void updatedObject(int _identifier, const UpdateType& _type);
76 
77  private slots:
78 
79  void fileOpened( int /*_id*/ ){};
80 
81  void noguiSupported( ) {} ;
82 
83  void initializePlugin();
84 
85  public :
86 
87  ~FilePlaPlugin() {};
88 
89  QString name() { return (QString("FilePlane")); };
90  QString description( ) { return (QString(tr("Load/Save Planes"))); };
91 
93 
94  QString getSaveFilters();
95  QString getLoadFilters();
96 
97  QWidget* saveOptionsWidget(QString /*_currentFilter*/) { return 0; };
98  QWidget* loadOptionsWidget(QString /*_currentFilter*/) { return 0; };
99 
100  public slots:
101 
102  int loadObject(QString _filename);
103 
104  bool saveObject(int _id, QString _filename);
105 
106  QString version() { return QString("1.0"); };
107 
108 };
109 
110 #endif //FILEPLAPLUGIN_HH
Update type class.
Definition: UpdateType.hh:60
Logtype
Log types for Message Window.
void noguiSupported()
Definition: FilePla.hh:81
Interface for all plugins which want to Load or Save files and create Objects.
Interface for all Plugins which provide scriptable Functions.
Interface for all Plugins which do logging to the logging window of the framework.
QString getLoadFilters()
Definition: FilePla.cc:55
QWidget * loadOptionsWidget(QString)
Definition: FilePla.hh:98
Interface class from which all plugins have to be created.
Predefined datatypes.
Definition: DataTypes.hh:83
Interface class for file handling.
QString getSaveFilters()
Definition: FilePla.cc:59
QString name()
Return a name for the plugin.
Definition: FilePla.hh:89
QString description()
Return a description of what the plugin is doing.
Definition: FilePla.hh:90
QWidget * saveOptionsWidget(QString)
Definition: FilePla.hh:97
void initializePlugin()
Initialize Plugin.
Definition: FilePla.cc:52
DataType supportedType()
Return your supported object type( e.g. DATA_TRIANGLE_MESH )
Definition: FilePla.cc:63