Developer Documentation
FileBundle.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
45//================================================================
46//
47// CLASS FileBundlePlugin
48//
49// This class is the base class for loading and saving
50// (reading/writing) SplatCloud objects from/to bundler files
51// on disc.
52//
53//================================================================
54
55
56#ifndef FILEBUNDLEPLUGIN_HH
57#define FILEBUNDLEPLUGIN_HH
58
59#ifdef _MSC_VER
60 #if (_MSC_VER <= 1916)
61 #define QT_NO_FLOAT16_OPERATORS
62 #endif
63#endif
64
65
66//== INCLUDES ====================================================
67
68
69#include <QObject>
70
76
78
80
81//== CLASS DEFINITION ============================================
82
83
85{
86 Q_OBJECT
87 Q_INTERFACES( FileInterface )
88 Q_INTERFACES( LoadSaveInterface )
89 Q_INTERFACES( LoggingInterface )
90 Q_INTERFACES( BaseInterface )
91 Q_INTERFACES( ScriptInterface )
92 Q_PLUGIN_METADATA(IID "org.OpenFlipper.Plugins.Plugin-FileBundle")
93signals:
94
95 // -- File Interface --
96 void openedFile( int _objectId );
97
98 // -- LoadSave Interface --
99 void addEmptyObject( DataType _type, int &_objectId );
100 void deleteObject ( int _objectId );
101 void updatedObject( int _objectId, const UpdateType &_type );
102
103 //-- Logging Interface --
104 void log( QString _message );
105 void log( Logtype _type, QString _message );
106
107public slots:
108
109 // -- Base Interface --
110 QString version() { return QString( "1.0" ); }
111
112 // -- File Interface --
113 int loadObject( QString _filename );
114 bool saveObject( int _objectId, QString _filename );
115
116private slots:
117
118 // -- Base Interface --
119 void noguiSupported() { }
120
121public:
122
123 //-- Base Interface --
124 QString name() { return QString( "FileBundle" ); }
125 QString description( ) { return QString( tr( "Load/Save SplatCloud Bundler format files" ) ); }
126
127 // -- File Interface --
129
130 // -- File Interface --
131 QString getSaveFilters() { return QString( tr( "Bundler SplatCloud files ( *.out )" ) ); }
132 QString getLoadFilters() { return QString( tr( "Bundler SplatCloud files ( *.out )" ) ); }
133 QWidget *saveOptionsWidget( QString /*_currentFilter*/ );
134 QWidget *loadOptionsWidget( QString /*_currentFilter*/ );
135
136private:
137
138 // add/remove multiple objects
139 bool addEmptyObjects( unsigned int _num, const DataType &_dataType, std::vector<int> &_objectIDs );
140 void deleteObjects( std::vector<int> &_objectIDs );
141
142 // read image list file from disc
143 bool readImagelistFile( const char *_filename, std::vector<std::string> &_imagePaths ) /*const*/;
144
145 // read bundle file from disc to scenegraph node
146 void readCameras( FILE *_file, const std::vector<int> &_cameraObjectIDs, SplatCloud_Cameras &_cameras ) /*const*/;
147 void readPoints ( FILE *_file, const std::vector<int> &_cameraObjectIDs, SplatCloud &_splatCloud ) /*const*/;
148 bool readBundleFile( const char *_filename, SplatCloud &_splatCloud ) /*const*/;
149
150 // write bundle file from scenegraph node to disc
151 bool writeBundleFile( const char *_filename, const SplatCloud &_splatCloud ) /*const*/;
152};
153
154
155//================================================================
156
157
158#endif // FILEBUNDLEPLUGIN_HH
Logtype
Log types for Message Window.
#define DATA_SPLATCLOUD
Definition: SplatCloud.hh:59
Interface class from which all plugins have to be created.
Predefined datatypes.
Definition: DataTypes.hh:83
QWidget * saveOptionsWidget(QString)
Definition: FileBundle.cc:529
QString name()
Return a name for the plugin.
Definition: FileBundle.hh:124
QString description()
Return a description of what the plugin is doing.
Definition: FileBundle.hh:125
DataType supportedType()
Return your supported object type( e.g. DATA_TRIANGLE_MESH )
Definition: FileBundle.hh:128
QString getLoadFilters()
Definition: FileBundle.hh:132
QString getSaveFilters()
Definition: FileBundle.hh:131
QWidget * loadOptionsWidget(QString)
Definition: FileBundle.cc:538
Interface class for file handling.
Interface for all plugins which want to Load or Save files and create Objects.
Interface for all Plugins which do logging to the logging window of the framework.
Interface for all Plugins which provide scriptable Functions.
Update type class.
Definition: UpdateType.hh:59