Developer Documentation
FileSkeleton.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 * $Revision: 10274 $ *
45 * $LastChangedBy: wilden $ *
46 * $Date: 2010-11-24 17:49:09 +0100 (Wed, 24 Nov 2010) $ *
47 * *
48 \*===========================================================================*/
49 
50 #ifndef FILESKLPLUGIN_HH
51 #define FILESKLPLUGIN_HH
52 
53 #include <QObject>
54 #include <QMenuBar>
55 
62 #include <OpenFlipper/BasePlugin/INIInterface.hh>
64 
66 {
67  Q_OBJECT
68  Q_INTERFACES(FileInterface)
69  Q_INTERFACES(LoadSaveInterface)
70  Q_INTERFACES(LoggingInterface)
71  Q_INTERFACES(BaseInterface)
72  Q_INTERFACES(ScriptInterface)
73  Q_INTERFACES(INIInterface)
74 #if QT_VERSION >= 0x050000
75  Q_PLUGIN_METADATA(IID "org.OpenFlipper.Plugins.Plugin-FileSkeleton")
76 #endif
77  signals:
78  void openedFile( int _id );
79  void addEmptyObject( DataType _type, int& _id);
80  void load(QString _filename, DataType _type, int& _id);
81  void save(int _id , QString _filename );
82  void log(Logtype _type, QString _message);
83  void log(QString _message);
84  void updatedObject(int _identifier, const UpdateType& _type);
85 
86  private slots:
87 
88  void fileOpened( int /*_id*/ ){};
89 
90  void loadIniFile( INIFile& _ini ,int _id );
91  void saveIniFile( INIFile& _ini ,int _id);
92 
93  void noguiSupported( ) {} ;
94 
95  void initializePlugin();
96 
97  public :
98 
99  ~FileSKLPlugin() {};
100 
101  QString name() { return (QString("FileSKL")); };
102  QString description( ) { return (QString("Load/Save Skeletons")); };
103 
105 
106  QString getSaveFilters();
107  QString getLoadFilters();
108 
109  QWidget* saveOptionsWidget(QString /*_currentFilter*/) { return 0; };
110  QWidget* loadOptionsWidget(QString /*_currentFilter*/) { return 0; };
111 
112  public slots:
113 
114  int loadObject(QString _filename);
115 
116  bool saveObject(int _id, QString _filename);
117 
118  private :
119  template<typename Skeleton> bool LoadSkeleton(Skeleton *_pSkeleton, QString _filename);
120  template<typename Skeleton> bool SaveSkeleton(Skeleton *_pSkeleton, QString _filename);
121 
122 };
123 
124 #endif //FILESKLPLUGIN_HH
Predefined datatypes.
Definition: DataTypes.hh:96
Logtype
Log types for Message Window.
QWidget * saveOptionsWidget(QString)
void loadIniFile(INIFile &_ini, int _id)
Load per object settings.
QWidget * loadOptionsWidget(QString)
Interface for all Plugins which provide scriptable Functions.
Interface class for Plugins which have to store information in ini files.
Definition: INIInterface.hh:81
Interface class from which all plugins have to be created.
Update type class.
Definition: UpdateType.hh:70
Interface for all Plugins which do logging to the logging window of the framework.
QString description()
Return a description of what the plugin is doing.
void initializePlugin()
Initialize Plugin.
Definition: FileSkeleton.cc:62
Class for the handling of simple configuration files.
Definition: INIFile.hh:105
void saveIniFile(INIFile &_ini, int _id)
Save per object settings.
Interface class for file handling.
Interface for all plugins which want to Load or Save files and create Objects.
void noguiSupported()
Definition: FileSkeleton.hh:93
DataType supportedType()
Return your supported object type( e.g. DATA_TRIANGLE_MESH )
Definition: FileSkeleton.cc:73
QString name()
Return a name for the plugin.
QString getSaveFilters()
Definition: FileSkeleton.cc:69
QString getLoadFilters()
Definition: FileSkeleton.cc:65