md3-model.h

Go to the documentation of this file.

/*
 * md3-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.
 *
 * Library that supports the Quake 3 MD3 model format.
 */

#ifndef WAVE_GLUT_MD3_MODEL_H__
#define WAVE_GLUT_MD3_MODEL_H__

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


namespace md3 {


////////////////////////////////////////////////////////////////////////////////
///
/// \ingroup models.h
/// \defgroup md3_model Quake 3 MD3 Format 3D Model Library
///
/// \n
/// This library supports loading and rendering of md3 models.
///
/// For references, see:
///  - http://en.wikipedia.org/wiki/MD3
///  - http://ioquake3.org/extras/models/  (many models here!)
///
/// Pretty much all of this code is from David Henry, see
/// http://tfc.duke.free.fr/
///
/// His code is released under the MIT License, and everything in this
/// module (md3-model) is likewise released under that license.  Thanks
/// again, David Henry!
///
/// <b>Note to implementers:</b> do not modify the original MD3 model files!
/// They are the ones with the David Henry copyright.  This way, it will be
/// easy to pick up changes from his source if necessary.  Any wave-glut-specific
/// changes should be made in a layer on top of those objects.
///
////////////////////////////////////////////////////////////////////////////////
/*@{*/


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

smart_ptr<glut::Renderable> loadMd3Player(IN const char * model_path);



};      // md3 namespace


#endif  // WAVE_GLUT_MD3_MODEL_H__