physics-loader.h

Go to the documentation of this file.
00001 /*
00002  * physics-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  *
00031  * Module that can load physics information for types.
00032  */
00033 
00034 #ifndef AESOP_PHYSICS_LOADER_H__
00035 #define AESOP_PHYSICS_LOADER_H__
00036 
00037 // includes --------------------------------------------------------------------
00038 #include "typeinst/typeinst.h"
00039 
00040 #include "aesop-physics/aesop-physics.h"
00041 
00042 
00043 // forward declarations
00044 class Datahash;
00045  
00046 namespace aesop {
00047 
00048 /// \ingroup aesop_physics_mgmt
00049 /// \defgroup physics_loader physics-loader Library: Reference Physics Loader
00050 ///
00051 /// \n
00052 /// This is a reference implementation of a physics loader, although this is
00053 /// probably going to be commonly used since I suspect most people will continue
00054 /// to use Bullet rather than other physics engines.
00055 ///
00056 /// Create one of these using getPhysicsLoader(), register it with the
00057 /// \ref typeinst library, and then you'll be able to load and use physics
00058 /// models in physics simulations.
00059 /*@{*/
00060 
00061 
00062 /// get object capable of loading aesop physics objects (type components)
00063 smart_ptr<TypeComponentLoader> getPhysicsLoader(void);
00064 
00065 
00066 /// given an instance, return a physics_meta_t object
00067 bool getPhysicsMetaFromInstance(IN smart_ptr<Instance>& instance,
00068                                 OUT physics_meta_t& meta);
00069 
00070 
00071 };      // aesop namespace
00072 
00073 #endif  // AESOP_PHYSICS_LOADER_H__
00074