imeshloader.h

Go to the documentation of this file.

/*
    Sheep - A Rigid Body Dynamics Engine
    Copyright (C) 2001-2004 Francois Beaune
    Contact: http://toxicengine.sourceforge.net/

    This file is part of Sheep.

    Sheep 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.

    Sheep 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 for more details.

    You should have received a copy of the GNU General Public License
    along with Sheep; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/

#ifndef SHEEP_MESHIO_IMESHLOADER_H
#define SHEEP_MESHIO_IMESHLOADER_H

#include "common/misc/config.h"

#include <cstdio>
#include <string>

namespace sheep {

    class IMeshBuilder;
    class ProgressMonitor;

    class IMeshLoader {
    public:
        struct LoadingException {};

        //! A resource file is missing
        struct FileNotFoundException : public LoadingException {
            FileNotFoundException(const std::string &filename) :
                m_filename(filename) {}

            const std::string m_filename;   //!< The name of the file the loader failed to open.
        };

        enum OptionBits {
            //! [All] Use default configuration.
            DEFAULT_CONFIGURATION_BIT = 0,

            //! [All] Stop loading mesh file if a material or texture file is missing.
            //! Default behaviour: loading continues even if a material file or texture
            //! file is missing, or if an I/O error occurs when loading a texture file
            //! (parse errors in material files are not recoverable). Note that an
            //! exception is still thrown if the primary file is missing or broken.
            STOP_ON_MISSING_FILE_BIT = 1,

            //! [OBJ] Stop loading mesh file if a degenerate face is encountered.
            //! Default behaviour: invalid faces are ignored (they are not inserted
            //! into the mesh).
            STOP_ON_INVALID_FACE = 2,

            //! [OBJ] Disable polygons triangulation.
            //! Default behaviour: polygons are always triangulated.
            DISABLE_TRIANGULATION_BIT = 4,

            //! [OBJ] Stop loading mesh file if a triangulation error occurs.
            //! Default behaviour: triangulation errors are ignored (polygons which
            //! could not be triangulated are not inserted into the mesh).
            STOP_ON_TRIANGULATION_ERROR_BIT = 8
        };

        virtual ~IMeshLoader() {}

        virtual void Load(
            const std::string &filename,
            IMeshBuilder &builder,
            int option_mask = DEFAULT_CONFIGURATION_BIT,
            ProgressMonitor *progmon = 0
        ) throw(LoadingException) = 0;
    };

    // Common utility functions.
    bool LoadImage(const std::string &filename);
    bool TryLoadingImage(const std::string &path, const std::string &filename);
    FILE *TryOpeningFile(
        const std::string &path,
        const std::string &filename,
        const char *mode);

#include "imeshloader.inl"

}

#endif  // !SHEEP_MESHIO_IMESHLOADER_H

---