model-loader.h

Go to the documentation of this file.
00001 /*
00002  * model-loader.h
00003  *
00004  * Copyright (C) 2008,2009  Thomas A. Vaughan
00005  * All rights reserved.
00006  *
00007  *
00008  * Redistribution and use in source and binary forms, with or without
00009  * modification, are permitted provided that the following conditions are met:
00010  *     * Redistributions of source code must retain the above copyright
00011  *       notice, this list of conditions and the following disclaimer.
00012  *     * Redistributions in binary form must reproduce the above copyright
00013  *       notice, this list of conditions and the following disclaimer in the
00014  *       documentation and/or other materials provided with the distribution.
00015  *     * Neither the name of the <organization> nor the
00016  *       names of its contributors may be used to endorse or promote products
00017  *       derived from this software without specific prior written permission.
00018  *
00019  * THIS SOFTWARE IS PROVIDED BY THOMAS A. VAUGHAN ''AS IS'' AND ANY
00020  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
00021  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00022  * DISCLAIMED. IN NO EVENT SHALL THOMAS A. VAUGHAN BE LIABLE FOR ANY
00023  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
00024  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00025  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00026  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00027  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00028  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00029  *
00030  * An object that can load glut 3D models.
00031  */
00032 
00033 #ifndef AESOP_CLIENT_MODEL_LOADER_H__
00034 #define AESOP_CLIENT_MODEL_LOADER_H__
00035 
00036 // includes --------------------------------------------------------------------
00037 #include "typeinst/typeinst.h"
00038 
00039 #include "glut-model/glut-model.h"
00040 #include "story/story.h"
00041 
00042 
00043 namespace aesop {
00044 
00045 
00046 /// \ingroup aesop_client_lib
00047 /// \defgroup model_loader AESOP Model Loader
00048 ///
00049 /// \n
00050 /// This module has basic model loading capabilities.  It can load:
00051 ///  - heightfield models
00052 ///  - MD3 models
00053 ///  - glut models
00054 ///  - OBJ models
00055 ///
00056 /// See the Wavepacket GLUT libraries for more information on those
00057 /// formats: http://sourceforge.net/projects/wave-glut/
00058 ///
00059 /// Developers are encouraged to register their own model loaders,
00060 /// rather than extending this one.
00061 /*@{*/
00062 
00063 
00064 /// create object capable of loading some of the standard AESOP models
00065 smart_ptr<TypeComponentLoader> createModelLoader(
00066                                 smart_ptr<story::Story>& story);
00067 
00068 /// want to retrieve an already-loaded model?  Use this
00069 smart_ptr<glut::Renderable> getModel(IN smart_ptr<Instance>& instance);
00070 
00071 
00072 };      // aesop namespace
00073 
00074 #endif  // AESOP_CLIENT_MODEL_LOADER_H__
00075