Developer Documentation

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- File List
- File Members

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