FileOFF.hh 10.1 KB
Newer Older
1 2 3
/*===========================================================================*\
*                                                                            *
*                              OpenFlipper                                   *
Martin Schultz's avatar
Martin Schultz committed
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38
 *           Copyright (c) 2001-2015, RWTH-Aachen University                 *
 *           Department of Computer Graphics and Multimedia                  *
 *                          All rights reserved.                             *
 *                            www.openflipper.org                            *
 *                                                                           *
 *---------------------------------------------------------------------------*
 * This file is part of OpenFlipper.                                         *
 *---------------------------------------------------------------------------*
 *                                                                           *
 * Redistribution and use in source and binary forms, with or without        *
 * modification, are permitted provided that the following conditions        *
 * are met:                                                                  *
 *                                                                           *
 * 1. Redistributions of source code must retain the above copyright notice, *
 *    this list of conditions and the following disclaimer.                  *
 *                                                                           *
 * 2. Redistributions in binary form must reproduce the above copyright      *
 *    notice, this list of conditions and the following disclaimer in the    *
 *    documentation and/or other materials provided with the distribution.   *
 *                                                                           *
 * 3. Neither the name of the copyright holder nor the names of its          *
 *    contributors may be used to endorse or promote products derived from   *
 *    this software without specific prior written permission.               *
 *                                                                           *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS       *
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A           *
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,  *
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,       *
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR        *
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF    *
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING      *
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS        *
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.              *
39 40 41
*                                                                            *
\*===========================================================================*/

Jan Möbius's avatar
Jan Möbius committed
42

43 44 45 46 47

#ifndef FILEOFFPLUGIN_HH
#define FILEOFFPLUGIN_HH

#include <QObject>
48 49 50 51 52 53
#include <QCheckBox>
#include <QLabel>
#include <QSpinBox>
#include <QPushButton>
#include <QComboBox>

54 55 56 57 58 59 60 61 62

#include <OpenFlipper/common/Types.hh>
#include <OpenFlipper/BasePlugin/BaseInterface.hh>
#include <OpenFlipper/BasePlugin/FileInterface.hh>
#include <OpenFlipper/BasePlugin/LoadSaveInterface.hh>
#include <OpenFlipper/BasePlugin/LoggingInterface.hh>
#include <OpenFlipper/BasePlugin/ScriptInterface.hh>
#include <OpenFlipper/BasePlugin/TypeInterface.hh>
#include <OpenFlipper/BasePlugin/StatusbarInterface.hh>
63
#include <OpenFlipper/BasePlugin/PythonInterface.hh>
64 65 66 67 68 69 70 71 72 73 74

#include <ObjectTypes/PolyMesh/PolyMesh.hh>
#include <ObjectTypes/TriangleMesh/TriangleMesh.hh>

// Binary file support
#include <OpenMesh/Core/IO/SR_store.hh>
#include <limits>

#include "OFFImporter.hh"

class FileOFFPlugin : public QObject, BaseInterface, FileInterface, LoadSaveInterface,
75
    LoggingInterface, ScriptInterface, StatusbarInterface, PythonInterface
76 77 78 79 80 81 82 83
{
   Q_OBJECT
   Q_INTERFACES(FileInterface)
   Q_INTERFACES(LoadSaveInterface)
   Q_INTERFACES(LoggingInterface)
   Q_INTERFACES(BaseInterface)
   Q_INTERFACES(ScriptInterface)
   Q_INTERFACES(StatusbarInterface)
84 85 86 87
   Q_INTERFACES(PythonInterface)

   Q_PLUGIN_METADATA(IID "org.OpenFlipper.Plugins.Plugin-FileOFF")

88 89 90 91 92 93 94 95
  signals:
    void openedFile( int _id );
    void addEmptyObject( DataType _type, int& _id);
    void load(QString _filename, DataType _type, int& _id);
    void save(int _id , QString _filename );
    void log(Logtype _type, QString _message);
    void log(QString _message);
    void updateView();
96
    void updatedObject(int _identifier, const UpdateType& _type);
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111

    void deleteObject( int _id );

    // StatusbarInterface
    void showStatusMessage(QString _message, int _timeout = 0);
    void setStatus( ApplicationStatus::applicationStatus _status);

  private slots:

    void fileOpened( int /*_id*/ ){};

    void noguiSupported( ) {} ;

    void initializePlugin();

112 113
    /// Displays a dialog to ask how to load the mesh (triangle, polymesh , autodetect)
    void handleTrimeshDialog();
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229

    /// Slot called when user wants to save the given Load options as default
    void slotLoadDefault();

    /// Slot called when user wants to save the given Save options as default
    void slotSaveDefault();

  public :

     FileOFFPlugin();

     ~FileOFFPlugin() {};

     QString name() { return (QString("FileOFF")); };
     QString description( ) { return (QString(tr("Load/Save OFF-Files"))); };

     DataType supportedType();

     QString getSaveFilters();
     QString getLoadFilters();

     QWidget* saveOptionsWidget(QString /*_currentFilter*/);
     QWidget* loadOptionsWidget(QString /*_currentFilter*/);

  public slots:

    /// Loads Object and converts it to a triangle mesh if possible
    int loadObject(QString _filename);

    /// Loads Object with given datatype
    int loadObject(QString _filename, DataType _type);

    bool saveObject(int _id, QString _filename);

    QString version() { return QString("1.1"); };

  private:

    /// Before Parsing the actual file, read all features supported
    bool readFileOptions(QString _filename, OFFImporter& _importer);

    /// Read OFF file and parse it
    bool readOFFFile(QString _filename, OFFImporter& _importer);

    /// Parse ascii OFF file
    bool parseASCII(std::istream& _in, OFFImporter& _importer, DataType _type, QString& _objectName);

    /// Parse binary OFF file
    bool parseBinary(std::istream& _in, OFFImporter& _importer, DataType _type, QString& _objectName);

    /// Get color type
    int getColorType(std::string& _line, bool _texCoordsAvailable);

    /// Update user options depending on which options have been selected
    /// on the load dialog
    void updateUserOptions();

    /// Test if there are face color components (_nV is the initial face valence)
    bool extendedFaceColorTest(std::istream& _in, uint _nV, uint _nF, int _nB) const;

    // Binary reader and writer helpers
    void readValue(std::istream& _in, float& _value) const {
        float tmp;

        OpenMesh::IO::restore( _in , tmp, false ); //assuming LSB byte order
        _value = tmp;
    }

    void readValue(std::istream& _in, int& _value) const {
        OpenMesh::IO::int32_t tmp;

        OpenMesh::IO::restore( _in , tmp, false ); //assuming LSB byte order
        _value = tmp;
    }

    void readValue(std::istream& _in, unsigned int& _value) const {
        OpenMesh::IO::uint32_t tmp;

        OpenMesh::IO::restore( _in , tmp, false ); //assuming LSB byte order
        _value = tmp;
    }

    void writeValue(std::ostream& _out, int value) const {

        OpenMesh::IO::uint32_t tmp = value;
        OpenMesh::IO::store(_out, tmp, false);
    }

    void writeValue(std::ostream& _out, unsigned int value) const {

        OpenMesh::IO::uint32_t tmp = value;
        OpenMesh::IO::store(_out, tmp, false);
    }

    void writeValue(std::ostream& _out, float value) const {

        float tmp = value;
        OpenMesh::IO::store(_out, tmp, false);
    }

    void trimString( std::string& _string);

    /** \brief Function to retrieve next line
     *
     * @param ifs             The input stream we operate on
     * @param _string         This will be the output string
     * @param _skipEmptyLines Skip empty/comment lines? If not, empty strings will be returned if comment or (remaining) line is empty
     * @return
     */
    bool getCleanLine( std::istream& ifs , std::string& _string, bool _skipEmptyLines = true);

    /// Check for degenerate faces before adding them
    bool checkDegenerateFace(const std::vector<VertexHandle>& _v);

    /// Writer function
    template< class MeshT >
230
    bool writeMesh(std::ostream& _out, MeshT& _mesh, BaseObject &_baseObj);
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273

    /// Write binary mesh data to file
    template< class MeshT >
    bool writeBinaryData(std::ostream& _out, MeshT& _mesh );

    /// Write ASCII mesh data to file
    template< class MeshT >
    bool writeASCIIData(std::ostream& _out, MeshT& _mesh );

    /// backup per vertex/face texture coordinates
    template <class MeshT>
    void backupTextureCoordinates(MeshT& _mesh);

    //Option Widgets
    QWidget* loadOptions_;
    QWidget* saveOptions_;

    QCheckBox*   saveBinary_;
    QCheckBox*   saveVertexColor_;
    QCheckBox*   saveFaceColor_;
    QCheckBox*   saveAlpha_;
    QCheckBox*   saveNormals_;
    QCheckBox*   saveTexCoords_;
    QLabel*      savePrecisionLabel_;
    QSpinBox*    savePrecision_;
    QPushButton* saveDefaultButton_;


    QComboBox*   triMeshHandling_;
    QCheckBox*   loadVertexColor_;
    QCheckBox*   loadFaceColor_;
    QCheckBox*   loadAlpha_;
    QCheckBox*   loadNormals_;
    QCheckBox*   loadTexCoords_;
    QCheckBox*   loadCheckManifold_;
    QPushButton* loadDefaultButton_;

    unsigned int userReadOptions_;
    unsigned int userWriteOptions_;

    bool forceTriangleMesh_;
    bool forcePolyMesh_;
    bool readColorComp_;
Jan Möbius's avatar
Jan Möbius committed
274
    OFFImporter::ObjectOptionsE trimeshOptions_;
275 276 277 278
};

#if defined(INCLUDE_TEMPLATES) && !defined(FILEOFFPLUGIN_C)
#define FILEOFFPLUGIN_TEMPLATES
279
#include "FileOFFT_impl.hh"
280 281 282
#endif

#endif //FILEOFFPLUGIN_HH