Developer Documentation
FilePolyLine.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 FILEPOLYLINEPLUGIN_HH
45 #define FILEPOLYLINEPLUGIN_HH
46 
47 #include <QObject>
48 #include <QMenuBar>
49 
56 #include <OpenFlipper/BasePlugin/INIInterface.hh>
58 
60 {
61  Q_OBJECT
62  Q_INTERFACES(FileInterface)
63  Q_INTERFACES(LoadSaveInterface)
64  Q_INTERFACES(LoggingInterface)
65  Q_INTERFACES(BaseInterface)
66  Q_INTERFACES(ScriptInterface)
67  Q_INTERFACES(INIInterface)
68 
69  Q_PLUGIN_METADATA(IID "org.OpenFlipper.Plugins.Plugin-FilePolyLine")
70 
71  signals:
72  void openedFile( int _id );
73  void addEmptyObject( DataType _type, int& _id);
74  void load(QString _filename, DataType _type, int& _id);
75  void save(int _id , QString _filename );
76  void log(Logtype _type, QString _message);
77  void log(QString _message);
78 
79  void emptyObjectAdded( int _id );
80 
81  //RPC Interface
82  void pluginExists(QString _pluginName, bool &_exists);
83  void functionExists(QString _pluginName, QString _functionName, bool &_exists);
84 
85  private slots:
86 
87  void fileOpened( int /*_id*/ ){};
88 
89  void loadIniFileLast( INIFile& _ini ,int _id );
90  void saveIniFile( INIFile& _ini ,int _id);
91 
92  void noguiSupported( ) {} ;
93 
94  void initializePlugin();
95  public :
96 
97  ~FilePolyLinePlugin() {};
98 
99  QString name() { return (QString("FilePolyLine")); };
100  QString description( ) { return (QString(tr("Load/Save Poly Lines"))); };
101 
103 
104  QString getSaveFilters();
105  QString getLoadFilters();
106 
107  QWidget* saveOptionsWidget(QString /*_currentFilter*/) { return 0; };
108  QWidget* loadOptionsWidget(QString /*_currentFilter*/) { return 0; };
109 
110  public slots:
111 
112  int loadObject(QString _filename);
113 
114  bool saveObject(int _id, QString _filename);
115 
116  QString version() { return QString("1.01"); };
117 
118 };
119 
120 #endif //FILEPOLYLINEPLUGIN_HH
Interface class for Plugins which have to store information in ini files.
Definition: INIInterface.hh:60
QWidget * saveOptionsWidget(QString)
Logtype
Log types for Message Window.
Interface for all plugins which want to Load or Save files and create Objects.
Interface for all Plugins which provide scriptable Functions.
QString getSaveFilters()
Definition: FilePolyLine.cc:64
Interface for all Plugins which do logging to the logging window of the framework.
QWidget * loadOptionsWidget(QString)
QString getLoadFilters()
Definition: FilePolyLine.cc:60
Interface class from which all plugins have to be created.
void initializePlugin()
Initialize Plugin.
Definition: FilePolyLine.cc:56
QString description()
Return a description of what the plugin is doing.
Predefined datatypes.
Definition: DataTypes.hh:83
Interface class for file handling.
DataType supportedType()
Return your supported object type( e.g. DATA_TRIANGLE_MESH )
Definition: FilePolyLine.cc:68
void saveIniFile(INIFile &_ini, int _id)
Save per object settings.
QString name()
Return a name for the plugin.
Definition: FilePolyLine.hh:99
Class for the handling of simple configuration files.
Definition: INIFile.hh:99