obj-model.h

Go to the documentation of this file.

/*
 * obj-model.h
 *
 * Copyright (C) 2009  Thomas A. Vaughan
 * 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.
 *     * Neither the name of the <organization> nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THOMAS A. VAUGHAN ''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 THOMAS A. VAUGHAN 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.
 *
 *
 * Rendering 3D OBJ models (the Wavefront OBJ format)
 */

#ifndef WAVE_GLUT_OBJ_MODEL_H__
#define WAVE_GLUT_OBJ_MODEL_H__

// includes --------------------------------------------------------------------
#include "common/common.h"

#include "nstream/nstream.h"
#include "threadsafe/smart_ptr.h"
#include "wave-glut/renderable.h"



namespace obj {


////////////////////////////////////////////////////////////////////////////////
///
/// \ingroup models
/// \defgroup obj_model OBJ 3D Models
///
/// A simple reference implemenation rendering Wavefront OBJ format
/// 3D models.  See http://en.wikipedia.org/wiki/Obj
///
/// The Open Asset Library implementation also supports OBJ, but there are
/// a few issues there:
///  - some bugs in how tags are parsed
///  - only works for native filesystem-based OBJ files
///
/// OBJ is simple enough so this is a quick reference implementation.
///
/// A note to users of this model: in the interest of rendering performance,
/// vertex data is copied per vertex.  That is, it is not \em indexed per
/// vertex, but instead the vertex data (including normals etc) is copied.
///
/// So if you have a large model with a lot of shared vertices, this approach
/// could be too memory intensive.
///
////////////////////////////////////////////////////////////////////////////////
/*@{*/



////////////////////////////////////////////////////////////////////////////////
//
//      public API
//
////////////////////////////////////////////////////////////////////////////////

class Model : public glut::Renderable {
public:
        // virtual destructor --------------------------------------------------
        virtual ~Model(void) throw();

        // obj::Model class interface methods ----------------------------------

        // static factory methods ----------------------------------------------

        /// loads an OBJ scene object (aiScene) which can render itself
        static smart_ptr<Model> create(IN nstream::Stream * stream,
                                IN float scale);
};



};      // obj namespace


#endif  // WAVE_GLUT_OBJ_MODEL_H__