ioOBJ.hpp

Go to the documentation of this file.

/**************************************************************************************/
/*                                                                                    */
/*  Visualization Library                                                             */
/*  http://visualizationlibrary.org                                                   */
/*                                                                                    */
/*  Copyright (c) 2005-2020, Michele Bosi                                             */
/*  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.                      */
/*                                                                                    */
/**************************************************************************************/

#if !defined(LoadOBJ_INCLUDE_ONCE)
#define LoadOBJ_INCLUDE_ONCE

#include <vlCore/String.hpp>
#include <vlGraphics/Geometry.hpp>
#include <vlCore/ResourceLoadWriter.hpp>
#include <vlCore/ResourceDatabase.hpp>
#include <map>

namespace vl
{
  class VirtualFile;

//-----------------------------------------------------------------------------
  VLGRAPHICS_EXPORT ref<ResourceDatabase> loadOBJ( const String& path );
//-----------------------------------------------------------------------------
  VLGRAPHICS_EXPORT ref<ResourceDatabase> loadOBJ( VirtualFile* file );
//---------------------------------------------------------------------------
// LoadWriterOBJ
//---------------------------------------------------------------------------
  class LoadWriterOBJ: public ResourceLoadWriter
  {
    VL_INSTRUMENT_CLASS(vl::LoadWriterOBJ, ResourceLoadWriter)

  public:
    LoadWriterOBJ(): ResourceLoadWriter("|obj|", "|obj|") {}

    void registerLoadWriter();

    ref<ResourceDatabase> loadResource(const String& path) const
    {
      return loadOBJ(path);
    }

    ref<ResourceDatabase> loadResource(VirtualFile* file) const
    {
      return loadOBJ(file);
    }

    bool writeResource(const String& /*path*/, ResourceDatabase* /*resource*/) const
    {
      return false;
    }

    bool writeResource(VirtualFile* /*file*/, ResourceDatabase* /*resource*/) const
    {
      return false;
    }
  };
//-----------------------------------------------------------------------------
// ObjTexture
//-----------------------------------------------------------------------------
  class VLGRAPHICS_EXPORT ObjTexture
  {
  public:
    ObjTexture();
    const ObjTexture& parseLine(const String& line, const String& file);
    bool valid() const { return !mFileName.empty(); }
    void print();

    const String& path() const { return mFileName; }
    bool blendU() const { return mBlendU; }
    bool blendV() const { return mBlendV; }
    bool cc() const { return mCC; }
    bool clamp() const { return mClamp; }
    float mm_Base() const { return mMM_Base; }
    float mm_Gain() const { return mMM_Gain; }
    const fvec3& o_UVW() const { return mO_UVW; }
    const fvec3& s_UVW() const { return mS_UVW; }
    const fvec3& t_UVW() const { return mT_UVW; }
    float texres_Value() const { return mTexres_Value; }
    char imfchan() const { return mImfchan; }
    float bm() const { return mBM; }

    void setPath(const String& filename) { mFileName = filename; }
    void setBlendU(bool on) { mBlendU = on; }
    void setBlendV(bool on) { mBlendV = on; }
    void setCC(bool on) { mCC = on; }
    void setClamp(bool on) { mClamp = on; }
    void setMM_Base(float base) { mMM_Base = base; }
    void setMM_Gain(float gain) { mMM_Gain = gain; }
    void setO_UVW(const fvec3& o_uvw) { mO_UVW = o_uvw; }
    void setS_UVW(const fvec3& s_uvw) { mS_UVW = s_uvw; }
    void setT_UVW(const fvec3& t_uvw) { mT_UVW = t_uvw; }
    void setTexres_Value(float value) { mTexres_Value = value; }
    void setImfchan(char val) { mImfchan = val; }
    void setBM(float bm) { mBM = bm; }

  protected:
    String mFileName;
    bool   mBlendU;
    bool   mBlendV;
    bool   mCC;
    bool   mClamp;
    float  mMM_Base;
    float  mMM_Gain;
    fvec3 mO_UVW;
    fvec3 mS_UVW;
    fvec3 mT_UVW;
    float  mTexres_Value;
    char   mImfchan;
    float  mBM;
  };
//-----------------------------------------------------------------------------
// ObjMaterial
//-----------------------------------------------------------------------------
  class ObjMaterial: public Object
  {
    VL_INSTRUMENT_CLASS(vl::ObjMaterial, Object)

  public:
    ObjMaterial(): mTr(1.0f), mNs(0.0f), mIllum(0), mNi(1.0f) {}

    const fvec3& ka() const { return mKa; }
    const fvec3& kd() const { return mKd; }
    const fvec3& ks() const { return mKs; }
    const fvec3& ke() const { return mKe; }
    float tr() const { return mTr; }
    float ns() const { return mNs; }
    int illum() const { return mIllum; }
    float ni() const { return mNi; }
    const ObjTexture& map_Kd() const { return mMap_Kd; }
    const ObjTexture& map_Ka() const { return mMap_Ka; }
    const ObjTexture& map_Ks() const { return mMap_Ks; }
    const ObjTexture& map_Ns() const { return mMap_Ns; }
    const ObjTexture& map_d() const { return mMap_d; }
    const ObjTexture& map_Decal() const { return mMap_Decal; }
    const ObjTexture& map_Disp() const { return mMap_Disp; }
    const ObjTexture& map_Bump() const { return mMap_Bump; }

    void setKa(const fvec3& ka) { mKa = ka; }
    void setKd(const fvec3& kd) { mKd = kd; }
    void setKs(const fvec3& ks) { mKs = ks; }
    void setKe(const fvec3& ke) { mKe = ke; }
    void setTr(float tr) { mTr = tr; }
    void setNs(float ns) { mNs = ns; }
    void setIllum(int illum) { mIllum = illum; }
    void setNi(float ni) { mNi = ni; }
    void setMap_Kd(const ObjTexture& map_kd) { mMap_Kd = map_kd; }
    void setMap_Ka(const ObjTexture& map_ka) { mMap_Ka = map_ka; }
    void setMap_Ks(const ObjTexture& map_ks) { mMap_Ks = map_ks; }
    void setMap_Ns(const ObjTexture& map_ns) { mMap_Ns = map_ns; }
    void setMap_d(const ObjTexture& map_d) { mMap_d = map_d; }
    void setMap_Decal(const ObjTexture& map_decal) { mMap_Decal = map_decal; }
    void setMap_Disp(const ObjTexture& map_disp) { mMap_Disp = map_disp; }
    void setMap_Bump(const ObjTexture& map_bump) { mMap_Bump = map_bump; }

  protected:
    fvec3 mKa;
    fvec3 mKd;
    fvec3 mKs;
    fvec3 mKe;
    float mTr;
    float mNs;
    int mIllum;
    float mNi;
    ObjTexture mMap_Kd;
    ObjTexture mMap_Ka;
    ObjTexture mMap_Ks;
    ObjTexture mMap_Ns;
    ObjTexture mMap_d;
    ObjTexture mMap_Decal;
    ObjTexture mMap_Disp;
    ObjTexture mMap_Bump;
  };
//-----------------------------------------------------------------------------
// ObjMesh
//-----------------------------------------------------------------------------
  class ObjMesh: public Object
  {
    VL_INSTRUMENT_CLASS(vl::ObjMesh, Object)

  public:
    void setMaterial(ObjMaterial* mat)  { mMaterial = mat; }

    const ObjMaterial* material() const { return mMaterial.get(); }
    const std::vector<int>& facePositionIndex() const { return mFace_icoords; }
    const std::vector<int>& faceNormalIndex() const { return mFace_inormals; }
    const std::vector<int>& faceTexCoordIndex() const { return mFace_itexcoords; }
    const std::vector<int>& face_type() const { return mFace_type; }

    ObjMaterial* material() { return mMaterial.get(); }
    std::vector<int>& facePositionIndex()  { return mFace_icoords; }
    std::vector<int>& faceNormalIndex()  { return mFace_inormals; }
    std::vector<int>& faceTexCoordIndex()  { return mFace_itexcoords; }
    std::vector<int>& face_type()  { return mFace_type; }

  protected:
    ref<ObjMaterial> mMaterial;
    std::vector<int> mFace_icoords;
    std::vector<int> mFace_inormals;
    std::vector<int> mFace_itexcoords;
    std::vector<int> mFace_type;
  };
//-----------------------------------------------------------------------------
// ObjLoader
//-----------------------------------------------------------------------------
  class ObjLoader
  {
  public:
    const std::vector<fvec4>& vertexArray() const { return mCoords; }
    const std::vector<fvec3>& normalArray() const { return mNormals; }
    const std::vector<fvec3>& texCoordsArray() const { return mTexCoords; }
    const std::map< std::string, ref<ObjMaterial> >& materials() const { return mMaterials; }
    const std::vector< ref<ObjMesh> >& meshes() const { return mMeshes; }

    std::vector<fvec4>& vertexArray() { return mCoords; }
    std::vector<fvec3>& normalArray() { return mNormals; }
    std::vector<fvec3>& texCoordsArray() { return mTexCoords; }
    std::map< std::string, ref<ObjMaterial> >& materials() { return mMaterials; }
    std::vector< ref<ObjMesh> >& meshes() { return mMeshes; }

    ref<ResourceDatabase> loadOBJ( VirtualFile* file );

    void loadObjMaterials(VirtualFile* file, std::vector<ObjMaterial>& materials );

  protected:
    std::vector<fvec4> mCoords;
    std::vector<fvec3> mNormals;
    std::vector<fvec3> mTexCoords;
    std::map< std::string, ref<ObjMaterial> > mMaterials;
    std::vector< ref<ObjMesh> > mMeshes;
  };
//-----------------------------------------------------------------------------
}

#endif