OBJReader.cc 19.6 KB
Newer Older
Jan Möbius's avatar
Jan Möbius committed
1 2 3
/*===========================================================================*\
 *                                                                           *
 *                               OpenMesh                                    *
Jan Möbius's avatar
Jan Möbius committed
4
 *      Copyright (C) 2001-2012 by Computer Graphics Group, RWTH Aachen      *
Jan Möbius's avatar
Jan Möbius committed
5 6
 *                           www.openmesh.org                                *
 *                                                                           *
7
 *---------------------------------------------------------------------------*
8
 *  This file is part of OpenMesh.                                           *
Jan Möbius's avatar
Jan Möbius committed
9
 *                                                                           *
10
 *  OpenMesh is free software: you can redistribute it and/or modify         *
11 12 13 14
 *  it under the terms of the GNU Lesser General Public License as           *
 *  published by the Free Software Foundation, either version 3 of           *
 *  the License, or (at your option) any later version with the              *
 *  following exceptions:                                                    *
Jan Möbius's avatar
Jan Möbius committed
15
 *                                                                           *
16 17 18 19 20 21 22
 *  If other files instantiate templates or use macros                       *
 *  or inline functions from this file, or you compile this file and         *
 *  link it with other files to produce an executable, this file does        *
 *  not by itself cause the resulting executable to be covered by the        *
 *  GNU Lesser General Public License. This exception does not however       *
 *  invalidate any other reasons why the executable file might be            *
 *  covered by the GNU Lesser General Public License.                        *
Jan Möbius's avatar
Jan Möbius committed
23
 *                                                                           *
24 25 26 27
 *  OpenMesh 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 Lesser General Public License for more details.                      *
Jan Möbius's avatar
Jan Möbius committed
28
 *                                                                           *
29 30 31 32
 *  You should have received a copy of the GNU LesserGeneral Public          *
 *  License along with OpenMesh.  If not,                                    *
 *  see <http://www.gnu.org/licenses/>.                                      *
 *                                                                           *
33
\*===========================================================================*/
34 35

/*===========================================================================*\
36
 *                                                                           *
37 38
 *   $Revision$                                                         *
 *   $Date$                   *
Jan Möbius's avatar
Jan Möbius committed
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82
 *                                                                           *
\*===========================================================================*/


//== INCLUDES =================================================================


// OpenMesh
#include <OpenMesh/Core/IO/reader/OBJReader.hh>
#include <OpenMesh/Core/IO/IOManager.hh>
#include <OpenMesh/Core/System/omstream.hh>
#include <OpenMesh/Core/Utils/vector_cast.hh>
#include <OpenMesh/Core/Utils/color_cast.hh>
// STL
#if defined(OM_CC_MIPS)
#  include <ctype.h>
/// \bug Workaround for STLPORT 4.6: isspace seems not to be in namespace std!
#elif defined(_STLPORT_VERSION) && (_STLPORT_VERSION==0x460)
#  include <cctype>
#else
#  include <cctype>
using std::isspace;
#endif

#ifndef WIN32
#include <string.h>
#endif

//=== NAMESPACES ==============================================================


namespace OpenMesh {
namespace IO {


//=== INSTANCIATE =============================================================


_OBJReader_  __OBJReaderInstance;
_OBJReader_& OBJReader() { return __OBJReaderInstance; }


//=== IMPLEMENTATION ==========================================================

83 84 85 86 87
//-----------------------------------------------------------------------------

void trimString( std::string& _string) {
  // Trim Both leading and trailing spaces

88 89
  size_t start = _string.find_first_not_of(" \t\r\n");
  size_t end   = _string.find_last_not_of(" \t\r\n");
90 91 92 93 94 95 96 97

  if(( std::string::npos == start ) || ( std::string::npos == end))
    _string = "";
  else
    _string = _string.substr( start, end-start+1 );
}

//-----------------------------------------------------------------------------
Jan Möbius's avatar
Jan Möbius committed
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114

_OBJReader_::
_OBJReader_()
{
  IOManager().register_module(this);
}


//-----------------------------------------------------------------------------


bool
_OBJReader_::
read(const std::string& _filename, BaseImporter& _bi, Options& _opt)
{
  std::fstream in( _filename.c_str(), std::ios_base::in );

115
  if (!in.is_open() || !in.good())
Jan Möbius's avatar
Jan Möbius committed
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
  {
    omerr() << "[OBJReader] : cannot not open file "
          << _filename
          << std::endl;
    return false;
  }

  {
#if defined(WIN32)
    std::string::size_type dot = _filename.find_last_of("\\/");
#else
    std::string::size_type dot = _filename.rfind("/");
#endif
    path_ = (dot == std::string::npos)
      ? "./"
      : std::string(_filename.substr(0,dot+1));
  }

  bool result = read(in, _bi, _opt);

  in.close();
  return result;
}

//-----------------------------------------------------------------------------

bool
_OBJReader_::
read_material(std::fstream& _in)
{
  std::string line;
  std::string keyWrd;
148
  std::string textureName;
Jan Möbius's avatar
Jan Möbius committed
149 150 151 152 153

  std::string key;
  Material    mat;
  float       f1,f2,f3;
  bool        indef = false;
154
  int         textureId = 1;
Jan Möbius's avatar
Jan Möbius committed
155 156


Martin Habbecke's avatar
Martin Habbecke committed
157
  materials_.clear();
Jan Möbius's avatar
Jan Möbius committed
158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174
  mat.cleanup();

  while( _in && !_in.eof() )
  {
    std::getline(_in,line);
    if ( _in.bad() ){
      omerr() << "  Warning! Could not read file properly!\n";
      return false;
    }

    if ( line.empty() )
      continue;

    std::stringstream stream(line);

    stream >> keyWrd;

175
    if( ( isspace(line[0]) && line[0] != '\t' ) || line[0] == '#' )
Jan Möbius's avatar
Jan Möbius committed
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 230 231 232
    {
      if (indef && !key.empty() && mat.is_valid())
      {
        materials_[key] = mat;
        mat.cleanup();
      }
    }

    else if (keyWrd == "newmtl") // begin new material definition
    {
      stream >> key;
      indef = true;
    }

    else if (keyWrd == "Kd") // diffuse color
    {
      stream >> f1; stream >> f2; stream >> f3;

      if( !stream.fail() )
        mat.set_Kd(f1,f2,f3);
    }

    else if (keyWrd == "Ka") // ambient color
    {
      stream >> f1; stream >> f2; stream >> f3;

      if( !stream.fail() )
        mat.set_Ka(f1,f2,f3);
    }

    else if (keyWrd == "Ks") // specular color
    {
      stream >> f1; stream >> f2; stream >> f3;

      if( !stream.fail() )
        mat.set_Ks(f1,f2,f3);
    }
#if 0
    else if (keyWrd == "illum") // diffuse/specular shading model
    {
      ; // just skip this
    }

    else if (keyWrd == "Ns") // Shininess [0..200]
    {
      ; // just skip this
    }

    else if (keyWrd == "map_") // map images
    {
      // map_Ks, specular map
      // map_Ka, ambient map
      // map_Bump, bump map
      // map_d,  opacity map
      ; // just skip this
    }
#endif
233
    else if (keyWrd == "map_Kd" ) {
234 235
      // Get the rest of the line, removing leading or trailing spaces
      // This will define the filename of the texture
236 237
      std::getline(stream,textureName);
      trimString(textureName);
238 239
      if ( ! textureName.empty() )
        mat.set_map_Kd( textureName, textureId++ );
240
    }
Jan Möbius's avatar
Jan Möbius committed
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
    else if (keyWrd == "Tr") // transparency value
    {
      stream >> f1;

      if( !stream.fail() )
        mat.set_Tr(f1);
    }
    else if (keyWrd == "d") // transparency value
    {
      stream >> f1;

      if( !stream.fail() )
        mat.set_Tr(f1);
    }

    if ( _in && indef && mat.is_valid() && !key.empty())
      materials_[key] = mat;
  }
  return true;
}

//-----------------------------------------------------------------------------

bool
_OBJReader_::
266
read(std::istream& _in, BaseImporter& _bi, Options& _opt)
Jan Möbius's avatar
Jan Möbius committed
267 268 269 270 271 272 273
{
  omlog() << "[OBJReader] : read file\n";


  std::string line;
  std::string keyWrd;

274 275 276 277 278 279 280 281
  float                     x, y, z, u, v;
  int                       r, g, b;
  BaseImporter::VHandles    vhandles;
  std::vector<Vec3f>        normals;
  std::vector<Vec3uc>       colors;
  std::vector<Vec2f>        texcoords;
  std::vector<Vec2f>        face_texcoords;
  std::vector<VertexHandle> vertexHandles;
282

283
  std::string               matname;
Jan Möbius's avatar
Jan Möbius committed
284 285


286 287 288 289 290 291 292
  // Options supplied by the user
  Options userOptions = _opt;

  // Options collected via file parsing
  Options fileOptions;


Jan Möbius's avatar
Jan Möbius committed
293 294 295 296 297 298 299 300
  while( _in && !_in.eof() )
  {
    std::getline(_in,line);
    if ( _in.bad() ){
      omerr() << "  Warning! Could not read file properly!\n";
      return false;
    }

Jan Möbius's avatar
Jan Möbius committed
301
    // Trim Both leading and trailing spaces
302
    trimString(line);
Jan Möbius's avatar
Jan Möbius committed
303

Jan Möbius's avatar
Jan Möbius committed
304 305 306 307 308 309 310 311 312 313 314 315 316 317
    // comment
    if ( line.size() == 0 || line[0] == '#' || isspace(line[0]) ) {
      continue;
    }

    std::stringstream stream(line);

    stream >> keyWrd;

    // material file
    if (keyWrd == "mtllib")
    {
      std::string matFile;

Jan Möbius's avatar
Jan Möbius committed
318 319 320 321
      // Get the rest of the line, removing leading or trailing spaces
      // This will define the filename of the texture
      std::getline(stream,matFile);
      trimString(matFile);
Jan Möbius's avatar
Jan Möbius committed
322 323 324 325 326 327 328 329 330 331 332 333 334 335 336

      matFile = path_ + matFile;

      omlog() << "Load material file " << matFile << std::endl;

      std::fstream matStream( matFile.c_str(), std::ios_base::in );

      if ( matStream ){

        if ( !read_material( matStream ) )
	        omerr() << "  Warning! Could not read file properly!\n";
        matStream.close();

      }else
	      omerr() << "  Warning! Material file '" << matFile << "' not found!\n";
337 338 339

      omlog() << "  " << materials_.size() << " materials loaded.\n";

Jan Möbius's avatar
Jan Möbius committed
340
      for ( MaterialList::iterator material = materials_.begin(); material != materials_.end(); ++material )
341
      {
Jan Möbius's avatar
Jan Möbius committed
342 343 344
        // Save the texture information in a property
        if ( (*material).second.has_map_Kd() )
          _bi.add_texture_information( (*material).second.map_Kd_index() , (*material).second.map_Kd() );
345 346
      }

Jan Möbius's avatar
Jan Möbius committed
347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366
    }

    // usemtl
    else if (keyWrd == "usemtl")
    {
      stream >> matname;
      if (materials_.find(matname)==materials_.end())
      {
        omerr() << "Warning! Material '" << matname
              << "' not defined in material file.\n";
        matname="";
      }
    }

    // vertex
    else if (keyWrd == "v")
    {
      stream >> x; stream >> y; stream >> z;

      if ( !stream.fail() )
367 368
      {
        vertexHandles.push_back(_bi.add_vertex(OpenMesh::Vec3f(x,y,z)));
369
        stream >> r; stream >> g; stream >> b;
370

371 372
        if ( !stream.fail() )
        {
373 374 375 376
          if (  userOptions.vertex_has_color() ) {
            fileOptions += Options::VertexColor;
            colors.push_back(OpenMesh::Vec3uc((unsigned char)r,(unsigned char)g,(unsigned char)b));
          }
377
        }
378
      }
Jan Möbius's avatar
Jan Möbius committed
379 380 381 382 383 384 385
    }

    // texture coord
    else if (keyWrd == "vt")
    {
      stream >> u; stream >> v;

386
      if ( !stream.fail()  ){
Jan Möbius's avatar
Jan Möbius committed
387

388 389 390 391 392 393 394
        if ( userOptions.vertex_has_texcoord() || userOptions.face_has_texcoord() ) {
          texcoords.push_back(OpenMesh::Vec2f(u, v));

          // Can be used for both!
          fileOptions += Options::VertexTexCoord;
          fileOptions += Options::FaceTexCoord;
        }
Jan Möbius's avatar
Jan Möbius committed
395 396 397 398 399 400 401 402 403

      }else{

        omerr() << "Only single 2D texture coordinate per vertex"
              << "allowed!" << std::endl;
        return false;
      }
    }

404 405 406 407 408
    // color per vertex
    else if (keyWrd == "vc")
    {
      stream >> r; stream >> g; stream >> b;

409 410 411 412 413
      if ( !stream.fail()   ){
        if ( userOptions.vertex_has_color() ) {
          colors.push_back(OpenMesh::Vec3uc((unsigned char)r,(unsigned char)g,(unsigned char)b));
          fileOptions += Options::VertexColor;
        }
414 415
      }
    }
Jan Möbius's avatar
Jan Möbius committed
416 417 418 419 420 421

    // normal
    else if (keyWrd == "vn")
    {
      stream >> x; stream >> y; stream >> z;

422 423 424 425 426
      if ( !stream.fail() ) {
        if (userOptions.vertex_has_normal() ){
          normals.push_back(OpenMesh::Vec3f(x,y,z));
          fileOptions += Options::VertexNormal;
        }
Jan Möbius's avatar
Jan Möbius committed
427 428 429 430 431 432 433 434 435 436 437
      }
    }


    // face
    else if (keyWrd == "f")
    {
      int component(0), nV(0);
      int value;

      vhandles.clear();
438
      face_texcoords.clear();
Jan Möbius's avatar
Jan Möbius committed
439 440 441 442 443 444

      // read full line after detecting a face
      std::string faceLine;
      std::getline(stream,faceLine);
      std::stringstream lineData( faceLine );

445 446 447
      FaceHandle fh;
      BaseImporter::VHandles faceVertices;

Jan Möbius's avatar
Jan Möbius committed
448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489
      // work on the line until nothing left to read
      while ( !lineData.eof() )
      {
        // read one block from the line ( vertex/texCoord/normal )
        std::string vertex;
        lineData >> vertex;

        do{

          //get the component (vertex/texCoord/normal)
          size_t found=vertex.find("/");

          // parts are seperated by '/' So if no '/' found its the last component
          if( found != std::string::npos ){

            // read the index value
            std::stringstream tmp( vertex.substr(0,found) );

            // If we get an empty string this property is undefined in the file
            if ( vertex.substr(0,found).empty() ) {
              // Switch to next field
              vertex = vertex.substr(found+1);

              // Now we are at the next component
              ++component;

              // Skip further processing of this component
              continue;
            }

            // Read current value
            tmp >> value;

            // remove the read part from the string
            vertex = vertex.substr(found+1);

          } else {

            // last component of the vertex, read it.
            std::stringstream tmp( vertex );
            tmp >> value;

Jan Möbius's avatar
Jan Möbius committed
490 491 492
            // Clear vertex after finished reading the line
            vertex="";

Jan Möbius's avatar
Jan Möbius committed
493 494 495 496 497 498 499 500 501 502 503
            // Nothing to read here ( garbage at end of line )
            if ( tmp.fail() ) {
              continue;
            }
          }

          // store the component ( each component is referenced by the index here! )
          switch (component)
          {
            case 0: // vertex
              if ( value < 0 ) {
504 505 506
                // Calculation of index :
                // -1 is the last vertex in the list
                // As obj counts from 1 and not zero add +1
Jan Möbius's avatar
Jan Möbius committed
507 508
                value = _bi.n_vertices() + value + 1;
              }
509
              // Obj counts from 1 and not zero .. array counts from zero therefore -1
Jan Möbius's avatar
Jan Möbius committed
510
              vhandles.push_back(VertexHandle(value-1));
511
              faceVertices.push_back(VertexHandle(value-1));
512
              if (fileOptions.vertex_has_color() )
513
                _bi.set_color(vhandles.back(), colors[value-1]);
Jan Möbius's avatar
Jan Möbius committed
514
              break;
515
	      
Jan Möbius's avatar
Jan Möbius committed
516 517
            case 1: // texture coord
              if ( value < 0 ) {
518 519 520 521
                // Calculation of index :
                // -1 is the last vertex in the list
                // As obj counts from 1 and not zero add +1
                value = texcoords.size() + value + 1;
Jan Möbius's avatar
Jan Möbius committed
522 523
              }
              assert(!vhandles.empty());
524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545


              if ( fileOptions.vertex_has_texcoord() && userOptions.vertex_has_texcoord() ) {

                if (!texcoords.empty() && (unsigned int) (value - 1) < texcoords.size()) {
                  // Obj counts from 1 and not zero .. array counts from zero therefore -1
                  _bi.set_texcoord(vhandles.back(), texcoords[value - 1]);
                } else {
                  omerr() << "Error setting Texture coordinates" << std::endl;
                }

                }

                if (fileOptions.face_has_texcoord() && userOptions.face_has_texcoord() ) {

                  if (!texcoords.empty() && (unsigned int) (value - 1) < texcoords.size()) {
                    face_texcoords.push_back( texcoords[value-1] );
                  } else {
                    omerr() << "Error setting Texture coordinates" << std::endl;
                  }
                }

546

Jan Möbius's avatar
Jan Möbius committed
547 548 549 550
              break;

            case 2: // normal
              if ( value < 0 ) {
551 552 553 554
                // Calculation of index :
                // -1 is the last vertex in the list
                // As obj counts from 1 and not zero add +1
                value = normals.size() + value + 1;
Jan Möbius's avatar
Jan Möbius committed
555
              }
556

557
              // Obj counts from 1 and not zero .. array counts from zero therefore -1
558 559 560 561 562
              if (fileOptions.vertex_has_normal() ) {
                assert(!vhandles.empty());
                assert((unsigned int)(value-1) < normals.size());
                _bi.set_normal(vhandles.back(), normals[value-1]);
              }
Jan Möbius's avatar
Jan Möbius committed
563 564 565 566 567 568
              break;
          }

          // Prepare for reading next component
          ++component;

Jan Möbius's avatar
Jan Möbius committed
569 570
          // Read until line does not contain any other info
        } while ( !vertex.empty() );
Jan Möbius's avatar
Jan Möbius committed
571 572 573 574

        component = 0;
        nV++;

575
      }
Jan Möbius's avatar
Jan Möbius committed
576

577 578
      // note that add_face can possibly triangulate the faces, which is why we have to
      // store the current number of faces first
Jan Möbius's avatar
Jan Möbius committed
579
      size_t n_faces = _bi.n_faces();
580
      fh = _bi.add_face(faceVertices);
Jan Möbius's avatar
Jan Möbius committed
581

582 583
      if (!vhandles.empty() && fh.is_valid() )
        _bi.add_face_texcoords(fh, vhandles[0], face_texcoords);
584

585
      if ( !matname.empty()  )
Jan Möbius's avatar
Jan Möbius committed
586 587 588 589 590 591
      {
        std::vector<FaceHandle> newfaces;

        for( size_t i=0; i < _bi.n_faces()-n_faces; ++i )
          newfaces.push_back(FaceHandle(n_faces+i));

592 593 594 595 596
        Material& mat = materials_[matname];

        if ( mat.has_Kd() ) {
          Vec3uc fc = color_cast<Vec3uc, Vec3f>(mat.Kd());

597 598 599 600
          if ( userOptions.face_has_color()) {

            for (std::vector<FaceHandle>::iterator it = newfaces.begin(); it != newfaces.end(); ++it)
              _bi.set_color(*it, fc);
601

602 603
            fileOptions += Options::FaceColor;
          }
604 605 606 607
        }

        // Set the texture index in the face index property
        if ( mat.has_map_Kd() ) {
Jan Möbius's avatar
Jan Möbius committed
608

609 610 611 612 613 614 615 616
          if (userOptions.face_has_texcoord()) {

            for (std::vector<FaceHandle>::iterator it = newfaces.begin(); it != newfaces.end(); ++it)
              _bi.set_face_texindex(*it, mat.map_Kd_index());

            fileOptions += Options::FaceTexCoord;

          }
Jan Möbius's avatar
Jan Möbius committed
617

618
        } else {
619

620
          // If we don't have the info, set it to no texture
621 622 623 624 625 626
          if (userOptions.face_has_texcoord()) {

            for (std::vector<FaceHandle>::iterator it = newfaces.begin(); it != newfaces.end(); ++it)
              _bi.set_face_texindex(*it, 0);

          }
627
        }
Jan Möbius's avatar
Jan Möbius committed
628

629 630 631 632 633 634 635
      } else {
        std::vector<FaceHandle> newfaces;

        for( size_t i=0; i < _bi.n_faces()-n_faces; ++i )
          newfaces.push_back(FaceHandle(n_faces+i));

        // Set the texture index to zero as we don't have any information
636 637 638
        if ( userOptions.face_has_texcoord() )
          for (std::vector<FaceHandle>::iterator it = newfaces.begin(); it != newfaces.end(); ++it)
            _bi.set_face_texindex(*it, 0);
Jan Möbius's avatar
Jan Möbius committed
639
      }
640

Jan Möbius's avatar
Jan Möbius committed
641
    }
642

Jan Möbius's avatar
Jan Möbius committed
643 644
  }

645 646
  // If we do not have any faces,
  // assume this is a point cloud and read the normals and colors directly
647
  if (_bi.n_faces() == 0)
648
  {
649
    int i = 0;
650 651
    // add normal per vertex

652 653 654 655 656 657
    if (normals.size() == _bi.n_vertices()) {
      if ( fileOptions.vertex_has_normal() && userOptions.vertex_has_normal() ) {
        for (std::vector<VertexHandle>::iterator it = vertexHandles.begin(); it != vertexHandles.end(); ++it, i++)
          _bi.set_normal(*it, normals[i]);
      }
    }
658 659

    // add color per vertex
660 661 662 663 664
    i = 0;
    if (colors.size() >= _bi.n_vertices())
      if (fileOptions.vertex_has_color() && userOptions.vertex_has_color()) {
        for (std::vector<VertexHandle>::iterator it = vertexHandles.begin(); it != vertexHandles.end(); ++it, i++)
          _bi.set_color(*it, colors[i]);
665 666 667 668
      }

  }

Jan Möbius's avatar
Jan Möbius committed
669 670 671
  // Return, what we actually read
  _opt = fileOptions;

Jan Möbius's avatar
Jan Möbius committed
672 673 674 675 676 677 678 679
  return true;
}


//=============================================================================
} // namespace IO
} // namespace OpenMesh
//=============================================================================