/**************************************************************************** * VCGLib o o * * Visual and Computer Graphics Library o o * * _ O _ * * Copyright(C) 2004 \/)\/ * * Visual Computing Lab /\/| * * ISTI - Italian National Research Council | * * \ * * All rights reserved. * * * * This program is free software; you can redistribute it and/or modify * * it under the terms of the GNU General Public License as published by * * the Free Software Foundation; either version 2 of the License, or * * (at your option) any later version. * * * * This program is distributed in the hope that it will be useful, * * but WITHOUT ANY WARRANTY; without even the implied warranty of * * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * * GNU General Public License (http://www.gnu.org/licenses/gpl.txt) * * for more details. * * * ****************************************************************************/ /**************************************************************************** History $Log: not supported by cvs2svn $ Revision 1.7 2006/06/21 04:26:26 cignoni added initial test on end of file in the tokenize Revision 1.6 2006/05/21 07:01:04 cignoni Added mask clamping to the effective capabilities of the mesh Revision 1.5 2006/04/11 09:48:00 zifnab1974 changes needed for compilation on linux 64b with gcc 3.4.5 Revision 1.4 2006/03/29 09:27:07 cignoni Added managemnt of non critical errors Revision 1.3 2006/03/29 08:51:16 corsini reset to zero warnings Revision 1.2 2006/03/27 07:18:22 cignoni added missing std:: Revision 1.1 2006/03/07 13:19:29 cignoni First Release with OBJ import support Initial Working version coded by Buzzelli. ****************************************************************************/ #ifndef __VCGLIB_IMPORT_OBJ #define __VCGLIB_IMPORT_OBJ #include #include #include #include #include #include namespace vcg { namespace tri { namespace io { /** This class encapsulate a filter for importing obj (Alias Wavefront) meshes. Warning: this code assume little endian (PC) architecture!!! */ template class ImporterOBJ { public: typedef typename OpenMeshType::VertexPointer VertexPointer; typedef typename OpenMeshType::ScalarType ScalarType; typedef typename OpenMeshType::VertexType VertexType; typedef typename OpenMeshType::FaceType FaceType; typedef typename OpenMeshType::VertexIterator VertexIterator; typedef typename OpenMeshType::FaceIterator FaceIterator; typedef typename OpenMeshType::CoordType CoordType; class Info { public: Info() { mask = 0; cb = 0; numTexCoords=0; } /// It returns a bit mask describing the field preesnt in the ply file int mask; /// a Simple callback that can be used for long obj parsing. // it returns the current position, and formats a string with a description of what th efunction is doing (loading vertexes, faces...) CallBackPos *cb; /// number of vertices int numVertices; /// number of faces (the number of triangles could be /// larger in presence of polygonal faces int numFaces; /// number of texture coords indexes int numTexCoords; }; // end class //struct OBJFacet //{ // CoordType n; // CoordType t; // CoordType v[3]; // // short attr; // material index //}; struct ObjIndexedFace { int v[3]; int n[3]; int t[3]; int tInd; Color4b c; }; struct ObjTexCoord { float u; float v; }; struct Material { Material() { strcpy(name, "default_material"); ambient = Point3f( .2f, .2f, .2f); diffuse = Point3f(1.0f, 1.0f, 1.0f); specular = Point3f(1.0f, 1.0f, 1.0f); shininess = 0; alpha = 1.0f; strcpy(textureFileName, ""); textureIdx = -1; }; char name[FILENAME_MAX]; Point3f ambient; Point3f diffuse; Point3f specular; int shininess; float alpha; bool bSpecular; char textureFileName[FILENAME_MAX]; short textureIdx; }; enum OBJError { // Successfull opening E_NOERROR = 0x000, // 0 (position of correspondig string in the array) // Non Critical Errors (only odd numbers) E_NON_CRITICAL_ERROR = 0x001, E_MATERIAL_FILE_NOT_FOUND = 0x003, // 1 E_MATERIAL_NOT_FOUND = 0x005, // 2 E_TEXTURE_NOT_FOUND = 0x007, // 3 E_VERTICES_WITH_SAME_IDX_IN_FACE = 0x009, // 4 // Critical Opening Errors (only even numbers) E_CANTOPEN = 0x00A, // 5 E_UNESPECTEDEOF = 0x00C, // 6 E_ABORTED = 0x00E, // 7 E_NO_VERTEX = 0x010, // 8 E_NO_FACE = 0x012, // 9 E_BAD_VERTEX_STATEMENT = 0x014, // 10 E_BAD_VERT_TEX_STATEMENT = 0x016, // 11 E_BAD_VERT_NORMAL_STATEMENT = 0x018, // 12 E_LESS_THAN_3VERTINFACE = 0x01A, // 13 E_BAD_VERT_INDEX = 0x01C, // 14 E_BAD_VERT_TEX_INDEX = 0x01E, // 15 E_BAD_VERT_NORMAL_INDEX = 0x020 // 16 }; // to check if a given error is critical or not. static bool ErrorCritical(int err) { if(err<0x00A && err>=0) return false; return true; } static const char* ErrorMsg(int error) { static const char* obj_error_msg[] = { "No errors", // 0 "Material library file not found, a default white material is used", // 1 "Some materials definitions were not found, a default white material is used where no material was available", // 2 "Texture file not found", // 3 "Identical index vertices found in the same face", // 4 "Can't open file", // 5 "Premature End of file", // 6 "File opening aborted", // 7 "No vertex field found", // 8 "No face field found", // 9 "Vertex statement with less than 3 coords", // 10 "Texture coords statement with less than 2 coords", // 11 "Vertex normal statement with less than 3 coords", // 12 "Face with less than 3 vertices", // 13 "Bad vertex index in face", // 14 "Bad texture coords index in face", // 15 "Bad vertex normal index in face" // 16 }; // due to approximation, following line works well for either even (critical err codes) // or odd (non critical ones) numbers error = (int) error/2; if(error>15 || error<0) return "Unknown error"; else return obj_error_msg[error]; }; // Helper functions that checks the range of indexes // putting them in the correct range if less than zero (as in the obj style) static bool GoodObjIndex(int &index, const int maxVal) { if (index > maxVal) return false; if (index < 0) { index += maxVal+1; if (index<0 || index > maxVal) return false; } return true; } static int Open(OpenMeshType &mesh, const char *filename, int &loadmask, CallBackPos *cb=0) { Info oi; oi.mask=-1; oi.cb=cb; int ret=Open(mesh,filename,oi); loadmask=oi.mask; return ret; } /*! * Opens an object file (in ascii format) and populates the mesh passed as first * accordingly to read data * \param m The mesh model to be populated with data stored into the file * \param filename The name of the file to be opened * \param oi A structure containing infos about the object to be opened */ static int Open( OpenMeshType &m, const char * filename, Info &oi) { int result = E_NOERROR; m.Clear(); CallBackPos *cb = oi.cb; // if LoadMask has not been called yet, we call it here if (oi.mask == -1) LoadMask(filename, oi); Mask::ClampMask(m,oi.mask); if (oi.numVertices == 0) return E_NO_VERTEX; if (oi.numFaces == 0) return E_NO_FACE; std::ifstream stream(filename); if (stream.fail()) return E_CANTOPEN; std::vector materials; // materials vector std::vector texCoords; // texture coordinates std::vector normals; // vertex normals std::vector indexedFaces; std::vector< std::string > tokens; std::string header; short currentMaterialIdx = 0; // index of current material into materials vector Color4b currentColor=Color4b::LightGray; // we declare this outside code block since other // triangles of this face will share the same color Material defaultMaterial; // default material: white materials.push_back(defaultMaterial); int numVertices = 0; // stores the number of vertices been read till now int numTriangles = 0; // stores the number of faces been read till now int numTexCoords = 0; // stores the number of texture coordinates been read till now int numVNormals = 0; // stores the number of vertex normals been read till now int numVerticesPlusFaces = oi.numVertices + oi.numFaces; // vertices and faces allocatetion VertexIterator vi = Allocator::AddVertices(m,oi.numVertices); //FaceIterator fi = Allocator::AddFaces(m,oi.numFaces); ObjIndexedFace ff; while (!stream.eof()) { tokens.clear(); TokenizeNextLine(stream, tokens); unsigned int numTokens = static_cast(tokens.size()); if (numTokens > 0) { header.clear(); header = tokens[0]; if (header.compare("v")==0) // vertex { if (numTokens < 4) return E_BAD_VERTEX_STATEMENT; (*vi).P()[0] = (ScalarType) atof(tokens[1].c_str()); (*vi).P()[1] = (ScalarType) atof(tokens[2].c_str()); (*vi).P()[2] = (ScalarType) atof(tokens[3].c_str()); ++numVertices; // assigning vertex color // ---------------------- if( oi.mask & vcg::tri::io::Mask::IOM_VERTCOLOR) (*vi).C() = currentColor; ++vi; // move to next vertex iterator // callback invocation, abort loading process if the call returns false if ((cb !=NULL) && (((numTriangles + numVertices)%100)==0) && !(*cb)((100*(numTriangles + numVertices))/numVerticesPlusFaces, "Vertex Loading")) return E_ABORTED; } else if (header.compare("vt")==0) // vertex texture coords { if (numTokens < 3) return E_BAD_VERT_TEX_STATEMENT; ObjTexCoord t; t.u = static_cast(atof(tokens[1].c_str())); t.v = static_cast(atof(tokens[2].c_str())); texCoords.push_back(t); numTexCoords++; } else if (header.compare("vn")==0) // vertex normal { if (numTokens != 4) return E_BAD_VERT_NORMAL_STATEMENT; CoordType n; n[0] = (ScalarType) atof(tokens[1].c_str()); n[1] = (ScalarType) atof(tokens[2].c_str()); n[2] = (ScalarType) atof(tokens[3].c_str()); normals.push_back(n); numVNormals++; } else if (header.compare("f")==0) // face { if (numTokens < 4) return E_LESS_THAN_3VERTINFACE; std::string vertex; std::string texcoord; std::string normal; for(int i=0;i<3;++i) // remember index starts from 1 instead of 0 SplitToken(tokens[i+1], ff.v[i], ff.n[i], ff.t[i], oi.mask); if ( oi.mask & vcg::tri::io::Mask::IOM_WEDGTEXCOORD ) { // verifying validity of texture coords indices for(int i=0;i<3;i++) if(!GoodObjIndex(ff.t[i],oi.numTexCoords)) return E_BAD_VERT_TEX_INDEX; ff.tInd=materials[currentMaterialIdx].textureIdx; } // verifying validity of vertex indices if ((ff.v[0] == ff.v[1]) || (ff.v[0] == ff.v[2]) || (ff.v[1] == ff.v[2])) result = E_VERTICES_WITH_SAME_IDX_IN_FACE; for(int i=0;i<3;i++) if(!GoodObjIndex(ff.v[i],numVertices)) return E_BAD_VERT_INDEX; // assigning face normal // --------------------- if ( oi.mask & vcg::tri::io::Mask::IOM_WEDGNORMAL ) { // verifying validity of vertex normal indices // ------------------------------------------- for(int i=0;i<3;i++) if(!GoodObjIndex(ff.n[i],numVNormals)) return E_BAD_VERT_NORMAL_INDEX; } // assigning face color // -------------------- if( oi.mask & vcg::tri::io::Mask::IOM_FACECOLOR) ff.c = currentColor; ++numTriangles; indexedFaces.push_back(ff); /* // A face polygon composed of more than three vertices is triangulated // according to the following schema: // v5 // / \ // / \ // / \ // v1------v4 // |\ / // | \ / // | \ / // v2---v3 // // As shown above, the 5 vertices polygon (v1,v2,v3,v4,v5) // has been split into the triangles (v1,v2,v3), (v1,v3,v4) e (v1,v4,v5). // This way vertex v1 becomes the common vertex of all newly generated // triangles, and this may lead to the creation of very thin triangles. */ int vertexesPerFace = static_cast(tokens.size()-1); int iVertex = 3; while (iVertex < vertexesPerFace) // add other triangles { ObjIndexedFace ffNew=ff; int v4_index; int vt4_index; int vn4_index; SplitToken(tokens[++iVertex], v4_index, vn4_index, vt4_index, oi.mask); // assigning wedge texture coordinates // ----------------------------------- if( oi.mask & vcg::tri::io::Mask::IOM_WEDGTEXCOORD ) { // verifying validity of texture coords index // ------------------------------------------ if(!GoodObjIndex(v4_index, numVertices)) return E_BAD_VERT_INDEX; if(!GoodObjIndex(vn4_index,numVNormals)) return E_BAD_VERT_NORMAL_INDEX; if(!GoodObjIndex(vt4_index,oi.numTexCoords)) return E_BAD_VERT_TEX_INDEX; ffNew.t[1]=ff.t[2]; ffNew.t[2]=vt4_index; } if ((ff.v[0] == v4_index) || (ff.v[2] == v4_index)) result = E_VERTICES_WITH_SAME_IDX_IN_FACE; ffNew.v[1]=ff.v[2]; ffNew.v[2]=v4_index; // assigning face normal // --------------------- if ( oi.mask & vcg::tri::io::Mask::IOM_WEDGNORMAL ) { ffNew.n[1]=ff.n[2]; ffNew.n[2]=vn4_index; } ++numTriangles; indexedFaces.push_back(ffNew); ff.v[2] = v4_index; } // callback invocation, abort loading process if the call returns false if ((cb !=NULL)&& (((numTriangles + numVertices)%100)==0) ) { if (!(*cb)((100.0f * (numTriangles +numVertices) / numVerticesPlusFaces), "Face Loading")) return E_ABORTED; } } else if (header.compare("mtllib")==0) // material library { // obtain the name of the file containing materials library std::string materialFileName = tokens[1]; if (!LoadMaterials( materialFileName.c_str(), materials, m.textures)) result = E_MATERIAL_FILE_NOT_FOUND; } else if (header.compare("usemtl")==0) // material usage { std::string materialName = tokens[1]; bool found = false; unsigned i = 0; while (!found && (i < materials.size())) { std::string currentMaterialName = materials[i].name; if (currentMaterialName == materialName) { currentMaterialIdx = i; Material &material = materials[currentMaterialIdx]; Point3f diffuseColor = material.diffuse; unsigned char r = (unsigned char) (diffuseColor[0] * 255.0); unsigned char g = (unsigned char) (diffuseColor[1] * 255.0); unsigned char b = (unsigned char) (diffuseColor[2] * 255.0); unsigned char alpha = (unsigned char) (material.alpha * 255.0); currentColor= Color4b(r, g, b, alpha); found = true; } ++i; } if (!found) { currentMaterialIdx = 0; result = E_MATERIAL_NOT_FOUND; } } // we simply ignore other situations } // end for each line... } // end while stream not eof FaceIterator fi = Allocator::AddFaces(m,numTriangles); //------------------------------------------------------------------------------- // Now the final pass to convert indexes into pointers for face to vert/norm/tex references for(int i=0;i &tokens) { if(stream.eof()) return; std::string line; do std::getline(stream, line, '\n'); while ((line[0] == '#' || line.length()==0) && !stream.eof()); // skip comments and empty lines if ((line[0] == '#') || (line.length() == 0)) // can be true only on last line of file return; size_t from = 0; size_t to = 0; size_t length = line.size(); tokens.clear(); do { while ((line[from]==' ' || line[from]=='\t') && from!=length) from++; if(from!=length) { to = from+1; while (line[to]!=' ' && to!=length) to++; tokens.push_back(line.substr(from, to-from).c_str()); from = to; } } while (from tokens; int numVertices = 0; // stores the number of vertexes been read till now int numTriangles = 0; // stores the number of triangular faces been read till now const int deltaPos = 100; int currPos = 0; int lastPos = currPos; // cycle till we encounter first face while (!stream.eof()) { tokens.clear(); header.clear(); TokenizeNextLine(stream, tokens); if (tokens.size() > 0) { header = tokens[0]; if (header.compare("v")==0) { ++numVertices; if (bUsingMaterial) bHasPerVertexColor = true; } if (header.compare("vt")==0) { ++oi.numTexCoords; } else if (header.compare("f")==0) { numTriangles += (tokens.size() - 3); std::string remainingText = tokens[1]; // we base our assumption on the fact that the way vertex data is // referenced into faces must be consistent among the entire file int charIdx = 0; size_t length = remainingText.size(); char c; while((charIdx != length) && ((c = remainingText[charIdx])!='/') && (c != ' ')) ++charIdx; if (c == '/') { ++charIdx; if ((charIdx != length) && ((c = remainingText[charIdx])!='/')) { bHasPerWedgeTexCoord = true; ++charIdx; while((charIdx != length) && ((c = remainingText[charIdx])!='/') && (c != ' ')) ++charIdx; if (c == '/') bHasPerWedgeNormal = true; break; } else { bHasPerWedgeNormal = true; break; } } if (bUsingMaterial) bHasPerFaceColor = true; } else if (header.compare("usemtl")==0) bUsingMaterial = true; } // callback invocation, abort loading process if the call returns false if (oi.cb !=NULL) { currPos = stream.tellg(); if ((currPos - lastPos) > deltaPos) { if (!(*oi.cb)((100 * currPos)/length, "Loading mask...")) return false; lastPos = currPos; } } } // after the encounter of first face we avoid to do additional tests while (!stream.eof()) { tokens.clear(); header.clear(); TokenizeNextLine(stream, tokens); if (tokens.size() > 0) { header = tokens[0]; if (header.compare("v")==0) { ++numVertices; if (bUsingMaterial) bHasPerVertexColor = true; } else if (header.compare("f")==0) { numTriangles += (static_cast(tokens.size()) - 3); if (bUsingMaterial) bHasPerFaceColor = true; } else if (header.compare("vt")==0) { ++oi.numTexCoords; } else if (header.compare("usemtl")==0) bUsingMaterial = true; } // callback invocation, abort loading process if the call returns false if (oi.cb !=NULL) { currPos = stream.tellg(); if ((currPos - lastPos) > deltaPos) { if (!(*oi.cb)((100 * currPos)/length, "Loading mask...")) return false; lastPos = currPos; } } } oi.mask = 0; if (bHasPerWedgeTexCoord) oi.mask |= vcg::tri::io::Mask::IOM_WEDGTEXCOORD; if (bHasPerWedgeNormal) oi.mask |= vcg::tri::io::Mask::IOM_WEDGNORMAL; if (bHasPerVertexColor) oi.mask |= vcg::tri::io::Mask::IOM_VERTCOLOR; if (bHasPerFaceColor) oi.mask |= vcg::tri::io::Mask::IOM_FACECOLOR; oi.numVertices = numVertices; oi.numFaces = numTriangles; return true; } static bool LoadMaterials(const char * filename, std::vector &materials, std::vector &textures) { // assumes we are in the right directory std::ifstream stream(filename); if (stream.fail()) return false; std::vector< std::string > tokens; std::string header; materials.clear(); Material currentMaterial; bool first = true; while (!stream.eof()) { tokens.clear(); TokenizeNextLine(stream, tokens); if (tokens.size() > 0) { header.clear(); header = tokens[0]; if (header.compare("newmtl")==0) { if (!first) { materials.push_back(currentMaterial); currentMaterial = Material(); } else first = false; strcpy(currentMaterial.name, tokens[1].c_str()); } else if (header.compare("Ka")==0) { float r = (float) atof(tokens[1].c_str()); float g = (float) atof(tokens[2].c_str()); float b = (float) atof(tokens[3].c_str()); currentMaterial.ambient = Point3f(r, g, b); } else if (header.compare("Kd")==0) { float r = (float) atof(tokens[1].c_str()); float g = (float) atof(tokens[2].c_str()); float b = (float) atof(tokens[3].c_str()); currentMaterial.diffuse = Point3f(r, g, b); } else if (header.compare("Ks")==0) { float r = (float) atof(tokens[1].c_str()); float g = (float) atof(tokens[2].c_str()); float b = (float) atof(tokens[3].c_str()); currentMaterial.specular = Point3f(r, g, b); } else if ( (header.compare("d")==0) || (header.compare("Tr")==0) ) // alpha { currentMaterial.alpha = (float) atof(tokens[1].c_str()); } else if (header.compare("Ns")==0) // shininess { currentMaterial.shininess = atoi(tokens[1].c_str()); } else if (header.compare("illum")==0) // specular illumination on/off { int illumination = atoi(tokens[1].c_str()); currentMaterial.bSpecular = (illumination == 2); } else if (header.compare("map_Kd")==0) // texture name { std::string textureName = tokens[1]; strcpy(currentMaterial.textureFileName, textureName.c_str()); // adding texture name into textures vector (if not already present) // avoid adding the same name twice bool found = false; unsigned int size = static_cast(textures.size()); unsigned j = 0; while (!found && (j < size)) { if (textureName.compare(textures[j])==0) { currentMaterial.textureIdx = (int)j; found = true; } ++j; } if (!found) { textures.push_back(textureName); currentMaterial.textureIdx = (int)size; } } // we simply ignore other situations } } materials.push_back(currentMaterial); // add last read material stream.close(); return true; } }; // end class } // end Namespace tri } // end Namespace io } // end Namespace vcg #endif // ndef __VCGLIB_IMPORT_OBJ