xform-model.h

Go to the documentation of this file.

/*
 * xform-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.
 *
 *
 * A model format that wraps other model formats with simple transformations.
 */

#ifndef WAVE_GLUT_XFORM_MODEL_H__
#define WAVE_GLUT_XFORM_MODEL_H__

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

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



namespace glut {


////////////////////////////////////////////////////////////////////////////////
///
/// \ingroup models
/// \defgroup xform_model Transform Model Wrapper
///
/// This model type is a thin wrapper layer on top of other layers.  It adds
/// some simple transforms (scaling and rotation) on top of other formats.
///
/// For instance, if you find another MD3 or OBJ model that you like but need
/// to transform, you can take the other model and wrap it with this class.
///
/// The Aesop game engine commonly uses this format to scale and rotate
/// Quake MD3 models.
///
////////////////////////////////////////////////////////////////////////////////
/*@{*/



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


/// Given a 4x4 transform and a base model, returns a wrapper model that
///     applies the given transformation to the base model.
smart_ptr<Renderable> createXformModel(IN const matrix4_t& xform,
                                IN smart_ptr<Renderable>& model);


};      // glut namespace


#endif  // WAVE_GLUT_XFORM_MODEL_H__