FileVTK.hh

/*===========================================================================*\
*                                                                            *
*                              OpenFlipper                                   *
 *           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.              *
*                                                                            *
\*===========================================================================*/

/*===========================================================================*\
*                                                                            *
*   $Revision$                                                       *
*   $LastChangedBy$                                            *
*   $Date$                     *
*                                                                            *
\*===========================================================================*/

#ifndef FILEVTKPLUGIN_HH
#define FILEVTKPLUGIN_HH

#include <QObject>

#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/INIInterface.hh>
#include <OpenFlipper/BasePlugin/TypeInterface.hh>
#include <OpenFlipper/BasePlugin/RPCInterface.hh>
#include <OpenFlipper/BasePlugin/StatusbarInterface.hh>
#include <OpenFlipper/BasePlugin/TextureInterface.hh>

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

#ifdef ENABLE_OPENVOLUMEMESH_HEXAHEDRAL_SUPPORT
#include <ObjectTypes/HexahedralMesh/HexahedralMesh.hh>
#endif
#ifdef ENABLE_OPENVOLUMEMESH_POLYHEDRAL_SUPPORT
#include <ObjectTypes/PolyhedralMesh/PolyhedralMesh.hh>
#endif
#ifdef ENABLE_OPENVOLUMEMESH_TETRAHEDRAL_SUPPORT
#include <ObjectTypes/TetrahedralMesh/TetrahedralMesh.hh>
#endif

enum Dataset {
  STRUCTURED_POINTS,
  STRUCTURED_GRID,
  RECTILINEAR_GRID,
  POLYDATA,
  UNSTRUCTURED_GRID
};

class FileVTKPlugin : public QObject, BaseInterface, FileInterface, LoadSaveInterface,
    LoggingInterface, ScriptInterface, INIInterface, StatusbarInterface, RPCInterface, TextureInterface
{
    class CellType {

    public:

      CellType() :
              type(0),
              index(-1)
      {
      }

      // The type of the cell
      unsigned int type;

      // The index of the primitiv in the mesh that was created from this cell
      unsigned int index;

      // list of indices in the cell
      std::vector<quint32> indices;
    };

   Q_OBJECT
   Q_INTERFACES(FileInterface)
   Q_INTERFACES(LoadSaveInterface)
   Q_INTERFACES(LoggingInterface)
   Q_INTERFACES(BaseInterface)
   Q_INTERFACES(ScriptInterface)
   Q_INTERFACES(INIInterface)
   Q_INTERFACES(StatusbarInterface)
   Q_INTERFACES(RPCInterface)
   Q_INTERFACES(TextureInterface)

#if QT_VERSION >= 0x050000
  Q_PLUGIN_METADATA(IID "org.OpenFlipper.Plugins.Plugin-VTK")
#endif

  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();
    void updatedObject(int _identifier, const UpdateType& _type);

    void emptyObjectAdded( int _id );
    void deleteObject( int _id );

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

    //RPCInterface
    void pluginExists( QString _pluginName , bool& _exists  );
    void functionExists( QString _pluginName , QString _functionName , bool& _exists  );

    //TextureInterface
    void setTextureMode(QString _textureName, QString _mode, int _id );
    void switchTexture( QString _textureName, int _id );
    void addMultiTexture( QString _textureGroup, QString _name, QString _filename, int _id, int& _textureId);
    void textureFilename( int /*_id*/, QString /*_textureName*/, QString& /*_textureFilename*/ );
    void textureIndex(QString _name,int _id, int& _index);
    void getCurrentTexture(int /*_id*/, QString& /*_name*/);
    void textureName (int, int, QString &);
    void getSubTextures (int, QString, QStringList &);
    void textureIndexPropertyName(int, QString&);

  private slots:

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

    void noguiSupported( ) {} ;

    void initializePlugin();

    void slotSaveDefault();


  public :
      enum ObjectOptionsVtk
      {
        NONE                   = 0,
        BINARY                 = 1,
        FACENORMALS            = 1 << 1,
        VERTEXNORMALS          = 1 << 2,
        VERTEXTEXCOORDS        = 1 << 3,
      };

      FileVTKPlugin();

     ~FileVTKPlugin() {};

     QString name() { return (QString("FileVTK")); };
     QString description( ) { return (QString(tr("Load/Save ASCII VTK-Files"))); };

     DataType supportedType();

     QString getSaveFilters();
     QString getLoadFilters();

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

  public slots:

    int loadObject(QString _filename);

    int loadObject(QString _filename, DataType _type);

    bool saveObject(int _id, QString _filename);

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

  private:

    bool forceTriangleMesh_;
    bool forcePolyMesh_;

    QWidget* saveOptions_;

    QCheckBox*   saveBinary_;
    QCheckBox*   saveFaceNormals_;
    QCheckBox*   saveVertexNormals_;
    QCheckBox*   saveVertexTexCoords_;
    QLabel*      savePrecisionLabel_;
    QSpinBox*    savePrecision_;
    QPushButton* saveDefaultButton_;

    bool binary_;
    unsigned int userWriteOptions_;

    void updateUserOptions();


    template <typename MeshT>
    void addCellNormal(MeshT*& _mesh,const CellType& _cell, OpenMesh::Vec3d _normal);

    template <typename MeshT>
    int addTetraCellToOpenMesh(MeshT _mesh, std::vector<quint32> _indices);

    template <typename MeshT>
    int addHexaCellToOpenMesh(MeshT _mesh, std::vector<quint32> _indices);

    template <typename MeshT>
    int addWedgeCellToOpenMesh(MeshT _mesh, std::vector<quint32> _indices);

    template <typename MeshT>
    int addPyramidCellToOpenMesh(MeshT _mesh, std::vector<quint32> _indices);

    template <typename MeshT>
    int addFaceToOpenMesh(MeshT*& _mesh, std::vector<quint32> _indices);

    template <typename MeshT>
    int addFaceToOpenMesh(MeshT*& _mesh, quint32 _index1, quint32 _index2, quint32 _index3);

    template <typename MeshT>
    void updateFaceNormalsOfOpenMesh(MeshT*& _mesh);

    template <typename MeshT>
    void updateVertexNormalsOfOpenMesh(MeshT*& _mesh);

    template <typename MeshT>
    void removeTemporaryPropertiesOfOpenMesh(MeshT*& _mesh);

    template <typename MeshT>
    void addVertexNormalToOpenMesh(MeshT _mesh, quint32 _index, OpenMesh::Vec3d _normal);

    template <typename MeshT>
    void addFaceNormalToOpenMesh(MeshT _mesh, quint32 _index, OpenMesh::Vec3d _normal);

    template <typename MeshT>
    void setNormalsOfDuplicatedVerticesOfOpenMesh(MeshT*& _mesh);

    template< class MeshT >
    bool writeASCIIDataOfOpenMesh(std::ostream& _out, MeshT& _mesh );

    int addTetraCell(TriMesh*& _mesh, std::vector<quint32> _indices);

    int addTetraCell(PolyMesh*& _mesh, std::vector<quint32> _indices);

    int addHexaCell(TriMesh*& _mesh, std::vector<quint32> _indices);

    int addHexaCell(PolyMesh*& _mesh, std::vector<quint32> _indices);

    int addWedgeCell(TriMesh*& _mesh, std::vector<quint32> _indices);

    int addWedgeCell(PolyMesh*& _mesh, std::vector<quint32> _indices);

    int addPyramidCell(TriMesh*& _mesh, std::vector<quint32> _indices);

    int addPyramidCell(PolyMesh*& _mesh, std::vector<quint32> _indices);

    int addFace(TriMesh*& _mesh, std::vector<quint32> _indices);

    int addFace(PolyMesh*& _mesh, std::vector<quint32> _indices);

    int addFace(TriMesh*& _mesh, quint32 _index1, quint32 _index2, quint32 _index3);

    int addFace(PolyMesh*& _mesh, quint32 _index1, quint32 _index2, quint32 _index3);

    void updateFaceNormals(TriMesh*& _mesh);

    void updateFaceNormals(PolyMesh*& _mesh);

    void updateVertexNormals(TriMesh*& _mesh);

    void updateVertexNormals(PolyMesh*& _mesh);

    void removeTemporaryProperties(TriMesh*& _mesh);

    void removeTemporaryProperties(PolyMesh*& _mesh);

    void addVertexNormal(TriMesh*& _mesh, quint32 _index, OpenMesh::Vec3d _normal);

    void addVertexNormal(PolyMesh*& _mesh, quint32 _index, OpenMesh::Vec3d _normal);

    void addFaceNormal(TriMesh*& _mesh, quint32 _index, OpenMesh::Vec3d _normal);

    void addFaceNormal(PolyMesh*& _mesh, quint32 _index, OpenMesh::Vec3d _normal);

    void setNormalsOfDuplicatedVertices(TriMesh*& _mesh);

    void setNormalsOfDuplicatedVertices(PolyMesh*& _mesh);

    bool writeASCIIData(std::ostream& _out, TriMesh& _mesh);

    bool writeASCIIData(std::ostream& _out, PolyMesh& _mesh);

#ifdef ENABLE_OPENVOLUMEMESH_SUPPORT

    template <typename MeshT>
    int addTetraCellToOpenVolumeMesh(MeshT _mesh, std::vector<quint32> _indices);

    template <typename MeshT>
    int addHexaCellToOpenVolumeMesh(MeshT _mesh, std::vector<quint32> _indices);

    template <typename MeshT>
    int addWedgeCellToOpenVolumeMesh(MeshT _mesh, std::vector<quint32> _indices);

    template <typename MeshT>
    int addPyramidCellToOpenVolumeMesh(MeshT _mesh, std::vector<quint32> _indices);

    template <typename MeshT>
    int addFaceToOpenVolumeMesh(MeshT*& _mesh, std::vector<quint32> indices);

    template <typename MeshT>
    int addFaceToOpenVolumeMesh(MeshT*& _mesh, quint32 _index1, quint32 _index2, quint32 _index3);

    template <typename MeshT>
    void addVertexNormalToOpenVolumeMesh(MeshT _mesh, quint32 _index, OpenMesh::Vec3d _normal);

    template <typename MeshT>
    void addFaceNormalToOpenVolumeMesh(MeshT _mesh, quint32 _index, OpenMesh::Vec3d _normal);

    template< class MeshT >
    bool writeASCIIDataOfOpenVolumeMesh(std::ostream& _out, MeshT& _mesh );
#endif //ENABLE_OPENVOLUMEMESH_SUPPORT

#ifdef ENABLE_OPENVOLUMEMESH_HEXAHEDRAL_SUPPORT

    int addTetraCell(HexahedralMesh*& _mesh, std::vector<quint32> indices);

    int addHexaCell(HexahedralMesh*& _mesh, std::vector<quint32> indices);

    int addWedgeCell(HexahedralMesh*& _mesh, std::vector<quint32> indices);

    int addPyramidCell(HexahedralMesh*& _mesh, std::vector<quint32> indices);

    int addFace(HexahedralMesh*& _mesh, std::vector<quint32> indices);

    int addFace(HexahedralMesh*& _mesh, quint32 _index1, quint32 _index2, quint32 _index3);

    void updateFaceNormals(HexahedralMesh*& _mesh){/* don't need to be updated */};

    void updateVertexNormals(HexahedralMesh*& _mesh){/* don't need to be updated */};

    void removeTemporaryProperties(HexahedralMesh*& _mesh){/* don't need to be removed */};

    void addVertexNormal(HexahedralMesh*& _mesh, quint32 _index, OpenMesh::Vec3d _normal);

    void addFaceNormal(HexahedralMesh*& _mesh, quint32 _index, OpenMesh::Vec3d _normal);

    void setNormalsOfDuplicatedVertices(HexahedralMesh*& _mesh){/* we didn't duplicate any vertices */};

    bool writeASCIIData(std::ostream& _out, HexahedralMesh& _mesh);
#endif //ENABLE_OPENVOLUMEMESH_HEXAHEDRAL_SUPPORT

#ifdef ENABLE_OPENVOLUMEMESH_POLYHEDRAL_SUPPORT

    int addTetraCell(PolyhedralMesh*& _mesh, std::vector<quint32> indices);

    int addHexaCell(PolyhedralMesh*& _mesh, std::vector<quint32> indices);

    int addWedgeCell(PolyhedralMesh*& _mesh, std::vector<quint32> indices);

    int addPyramidCell(PolyhedralMesh*& _mesh, std::vector<quint32> indices);

    int addFace(PolyhedralMesh*& _mesh, std::vector<quint32> indices);

    int addFace(PolyhedralMesh*& _mesh, quint32 _index1, quint32 _index2, quint32 _index3);

    void updateFaceNormals(PolyhedralMesh*& _mesh){/* don't need to be updated */};

    void updateVertexNormals(PolyhedralMesh*& _mesh){/* don't need to be updated */};

    void removeTemporaryProperties(PolyhedralMesh*& _mesh){/* don't need to be removed */};

    void addVertexNormal(PolyhedralMesh*& _mesh, quint32 _index, OpenMesh::Vec3d _normal);

    void addFaceNormal(PolyhedralMesh*& _mesh, quint32 _index, OpenMesh::Vec3d _normal);

    void setNormalsOfDuplicatedVertices(PolyhedralMesh*& _mesh){/* we didn't duplicate any vertices */};

    bool writeASCIIData(std::ostream& _out, PolyhedralMesh& _mesh);
#endif //ENABLE_OPENVOLUMEMESH_POLYHEDRAL_SUPPORT

#ifdef ENABLE_OPENVOLUMEMESH_TETRAHEDRAL_SUPPORT

    int addTetraCell(TetrahedralMesh*& _mesh, std::vector<quint32> indices);

    int addHexaCell(TetrahedralMesh*& _mesh, std::vector<quint32> indices);

    int addWedgeCell(TetrahedralMesh*& _mesh, std::vector<quint32> indices);

    int addPyramidCell(TetrahedralMesh*& _mesh, std::vector<quint32> indices);

    int addFace(TetrahedralMesh*& _mesh, std::vector<quint32> indices);

    int addFace(TetrahedralMesh*& _mesh, quint32 _index1, quint32 _index2, quint32 _index3);

    void updateFaceNormals(TetrahedralMesh*& _mesh){/* don't need to be updated */};

    void updateVertexNormals(TetrahedralMesh*& _mesh){/* don't need to be updated */};

    void removeTemporaryProperties(TetrahedralMesh*& _mesh){/* don't need to be removed */};

    void addVertexNormal(TetrahedralMesh*& _mesh, quint32 _index, OpenMesh::Vec3d _normal);

    void addFaceNormal(TetrahedralMesh*& _mesh, quint32 _index, OpenMesh::Vec3d _normal);

    void setNormalsOfDuplicatedVertices(TetrahedralMesh*& _mesh){/* we didn't duplicate any vertices */};

    bool writeASCIIData(std::ostream& _out, TetrahedralMesh& _mesh);
#endif //ENABLE_OPENVOLUMEMESH_POLYHEDRAL_SUPPORT


    enum BestMeshType {
        BMT_None            = 0,
        BMT_TriMesh         = 1,
        BMT_PolyMesh        = 1 << 1,
        BMT_HexahedralMesh  = 1 << 2,
        BMT_PolyhedralMesh  = 1 << 3,
        BMT_TetrahedralMesh = 1 << 4
    };

    BestMeshType findBestObjectType(QString _filename);

    template <typename MeshT>
    bool loadMesh(QTextStream& _stream,MeshT*& _mesh, Dataset _type);

    template <typename MeshT>
    bool loadMeshPoints(QString _spec,QTextStream& _in,MeshT*& _mesh);

    template <typename MeshT>
    bool loadMeshLines(QString _spec,QTextStream& _in,MeshT*& _mesh);

    template <typename MeshT>
    bool loadMeshPolygons(QString _spec,QTextStream& _in,MeshT*& _mesh, std::vector<CellType>& _cells);

    template <typename MeshT>
    int add_non_manifold_face(MeshT*& _mesh, std::vector< OpenMesh::VertexHandle >& _vhandles);

    template <typename MeshT>
    bool loadMeshTriangleStrips(QString _spec,QTextStream& _in,MeshT*& _mesh, std::vector<CellType>& _cells);

    template <typename MeshT>
    bool loadMeshCells(QString _spec,QTextStream& _in,MeshT*& _mesh, std::vector<CellType>& _cells);

    template <typename MeshT>
    bool loadMeshNormals(QString _spec,QTextStream& _in,MeshT*& _mesh, std::vector<CellType>& _cells, bool _pointNormal, quint32 _count);

    template< class MeshT >
    bool writeMesh(std::ostream& _out, MeshT& _mesh );

};


#endif //FILEVTKPLUGIN_HH