include/cinder/ObjLoader.h

Go to the documentation of this file.

/*
 Copyright (c) 2010, The Barbarian Group
 All rights reserved.

 Redistribution and use in source and binary forms, with or without modification, are permitted provided that
 the following conditions are met:

    * Redistributions of source code must retain the above copyright notice, this list of conditions and
    the following disclaimer.
    * 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.

 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.
*/

#pragma once

#include "cinder/TriMesh.h"
#include "cinder/Stream.h"

#include <boost/logic/tribool.hpp>
#include <boost/tuple/tuple_comparison.hpp>
#include <map>

namespace cinder {

class ObjLoader {
 public:
    ObjLoader( std::shared_ptr<IStream> aStream, bool includeUVs = true );
    ObjLoader( DataSourceRef dataSource, bool includeUVs = true );
    ObjLoader( DataSourceRef dataSource, DataSourceRef materialSource, bool includeUVs = true );
    ~ObjLoader();

    void    load( TriMesh *destTriMesh, boost::tribool loadNormals = boost::logic::indeterminate, boost::tribool loadTexCoords = boost::logic::indeterminate, bool optimizeVertices = true );
    void    load( size_t groupIndex, TriMesh *destTriMesh, boost::tribool loadNormals = boost::logic::indeterminate, boost::tribool loadTexCoords = boost::logic::indeterminate, bool optimizeVertices = true );
    
    struct Material {
        Material() {
            Ka[0] = Ka[1] = Ka[2] = 0;
            Kd[0] = Kd[1] = Kd[2] = 1;
        }

        Material( const Material& rhs ) {
            mName = rhs.mName;
            Ka[0] = rhs.Ka[0];
            Ka[1] = rhs.Ka[1];
            Ka[2] = rhs.Ka[2];
            Kd[0] = rhs.Kd[0];
            Kd[1] = rhs.Kd[1];
            Kd[2] = rhs.Kd[2];
        }

        std::string mName;
        float       Ka[3];
        float       Kd[3];
    };
    
    struct Face {
        int                 mNumVertices;
        std::vector<int>    mVertexIndices;
        std::vector<int>    mTexCoordIndices;
        std::vector<int>    mNormalIndices;
        const Material*     mMaterial;
    };

    struct Group {
        std::string             mName;
        int                     mBaseVertexOffset, mBaseTexCoordOffset, mBaseNormalOffset;
        std::vector<Face>       mFaces;
        bool                    mHasTexCoords;
        bool                    mHasNormals;
    };

    static void     write( DataTargetRef dataTarget, const TriMesh &mesh, bool writeNormals = true, bool writeUVs = true );
    
    size_t      getNumGroups() const { return mGroups.size(); }
    
    const std::vector<Group>&       getGroups() const { return mGroups; }
    
 private:
    typedef boost::tuple<int,int> VertexPair;
    typedef boost::tuple<int,int,int> VertexTriple;

    void    parse( bool includeUVs );

    void    parseFace( Group *group, const Material *material, const std::string &s, bool includeUVs );
    void    parseMaterial( std::shared_ptr<IStream> material );
    void    loadInternalNoOptimize( const Group &group, TriMesh *destTriMesh, bool texCoords, bool normals );
    void    loadInternalNormalsTextures( const Group &group, std::map<boost::tuple<int,int,int>,int> &uniqueVerts, TriMesh *destTriMesh );
    void    loadInternalNormals( const Group &group, std::map<boost::tuple<int,int>,int> &uniqueVerts, TriMesh *destTriMesh );
    void    loadInternalTextures( const Group &group, std::map<boost::tuple<int,int>,int> &uniqueVerts, TriMesh *destTriMesh );
    void    loadInternal( const Group &group, std::map<int,int> &uniqueVerts, TriMesh *destTriMesh );   
 
    std::shared_ptr<IStream>        mStream;
    std::vector<Vec3f>              mVertices, mNormals;
    std::vector<Vec2f>              mTexCoords;
    std::vector<Group>              mGroups;
    std::map<std::string, Material> mMaterials;
};

} // namespace cinder