Developer Documentation

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