OpenMesh
OpenMesh/Core/IO/importer/BaseImporter.hh
00001 /*===========================================================================*\
00002  *                                                                           *
00003  *                               OpenMesh                                    *
00004  *      Copyright (C) 2001-2011 by Computer Graphics Group, RWTH Aachen      *
00005  *                           www.openmesh.org                                *
00006  *                                                                           *
00007  *---------------------------------------------------------------------------* 
00008  *  This file is part of OpenMesh.                                           *
00009  *                                                                           *
00010  *  OpenMesh is free software: you can redistribute it and/or modify         * 
00011  *  it under the terms of the GNU Lesser General Public License as           *
00012  *  published by the Free Software Foundation, either version 3 of           *
00013  *  the License, or (at your option) any later version with the              *
00014  *  following exceptions:                                                    *
00015  *                                                                           *
00016  *  If other files instantiate templates or use macros                       *
00017  *  or inline functions from this file, or you compile this file and         *
00018  *  link it with other files to produce an executable, this file does        *
00019  *  not by itself cause the resulting executable to be covered by the        *
00020  *  GNU Lesser General Public License. This exception does not however       *
00021  *  invalidate any other reasons why the executable file might be            *
00022  *  covered by the GNU Lesser General Public License.                        *
00023  *                                                                           *
00024  *  OpenMesh is distributed in the hope that it will be useful,              *
00025  *  but WITHOUT ANY WARRANTY; without even the implied warranty of           *
00026  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the            *
00027  *  GNU Lesser General Public License for more details.                      *
00028  *                                                                           *
00029  *  You should have received a copy of the GNU LesserGeneral Public          *
00030  *  License along with OpenMesh.  If not,                                    *
00031  *  see <http://www.gnu.org/licenses/>.                                      *
00032  *                                                                           *
00033 \*===========================================================================*/ 
00034 
00035 /*===========================================================================*\
00036  *                                                                           *             
00037  *   $Revision: 362 $                                                         *
00038  *   $Date: 2011-01-26 10:21:12 +0100 (Mi, 26 Jan 2011) $                   *
00039  *                                                                           *
00040 \*===========================================================================*/
00041 
00042 
00043 //=============================================================================
00044 //
00045 //  Implements the baseclass for IOManager importer modules
00046 //
00047 //=============================================================================
00048 
00049 
00050 #ifndef __BASEIMPORTER_HH__
00051 #define __BASEIMPORTER_HH__
00052 
00053 
00054 //=== INCLUDES ================================================================
00055 
00056 
00057 // STL
00058 #include <vector>
00059 
00060 // OpenMesh
00061 #include <OpenMesh/Core/System/config.h>
00062 #include <OpenMesh/Core/Geometry/VectorT.hh>
00063 #include <OpenMesh/Core/Mesh/BaseKernel.hh>
00064 
00065 
00066 //== NAMESPACES ===============================================================
00067 
00068 
00069 namespace OpenMesh {
00070 namespace IO {
00071 
00072 
00073 //=== IMPLEMENTATION ==========================================================
00074 
00075 
00081 class BaseImporter
00082 {
00083 public:
00084 
00085   // base class needs virtual destructor
00086   virtual ~BaseImporter() {}
00087 
00088 
00089   // add a vertex with coordinate \c _point
00090   virtual VertexHandle add_vertex(const Vec3f& _point) = 0;
00091 
00092   // add a face with indices _indices refering to vertices
00093   typedef std::vector<VertexHandle> VHandles;
00094   virtual FaceHandle add_face(const VHandles& _indices) = 0;
00095 
00096   // add texture coordinates per face, _vh references the first texcoord
00097   virtual void add_face_texcoords( FaceHandle _fh, VertexHandle _vh, const std::vector<Vec2f>& _face_texcoords) = 0;
00098 
00099   // Set the texture index for a face
00100   virtual void set_face_texindex( FaceHandle _fh, int _texId ) = 0;
00101 
00102   // set vertex normal
00103   virtual void set_normal(VertexHandle _vh, const Vec3f& _normal) = 0;
00104 
00105   // set vertex color
00106   virtual void set_color(VertexHandle _vh, const Vec3uc& _color) = 0;
00107 
00108   // set vertex color
00109   virtual void set_color(VertexHandle _vh, const Vec4uc& _color) = 0;
00110 
00111   // set vertex texture coordinate
00112   virtual void set_texcoord(VertexHandle _vh, const Vec2f& _texcoord) = 0;
00113 
00114   // set vertex texture coordinate
00115   virtual void set_texcoord(HalfedgeHandle _heh, const Vec2f& _texcoord) = 0;
00116 
00117   // set edge color
00118   virtual void set_color(EdgeHandle _eh, const Vec3uc& _color) = 0;
00119   
00120   // set edge color
00121   virtual void set_color(EdgeHandle _eh, const Vec4uc& _color) = 0;
00122   
00123   // set face normal
00124   virtual void set_normal(FaceHandle _fh, const Vec3f& _normal) = 0;
00125 
00126   // set face color
00127   virtual void set_color(FaceHandle _fh, const Vec3uc& _color) = 0;
00128 
00129   // set face color
00130   virtual void set_color(FaceHandle _fh, const Vec4uc& _color) = 0;
00131 
00132   // Store a property in the mesh mapping from an int to a texture file
00133   // Use set_face_texindex to set the index for each face
00134   virtual void add_texture_information( int _id , std::string _name ) = 0;
00135 
00136   // get reference to base kernel
00137   virtual BaseKernel* kernel() { return 0; }
00138 
00139   virtual bool is_triangle_mesh()     const { return false; }
00140 
00141   // reserve mem for elements
00142   virtual void reserve( unsigned int /* nV */,
00143                                   unsigned int /* nE */,
00144                                   unsigned int /* nF */) {}
00145 
00146   // query number of faces, vertices, normals, texcoords
00147   virtual size_t n_vertices()   const = 0;
00148   virtual size_t n_faces()      const = 0;
00149   virtual size_t n_edges()      const = 0;
00150 
00151 
00152   // pre-processing
00153   virtual void prepare()  {}
00154 
00155   // post-processing
00156   virtual void finish()  {}
00157 };
00158 
00159 
00160 //=============================================================================
00161 } // namespace IO
00162 } // namespace OpenMesh
00163 //=============================================================================
00164 #endif
00165 //=============================================================================
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines