wave-glut/lib/terrain/terrain.h

Go to the documentation of this file.

/*
 * terrain.h
 *
 * Copyright (C) 2008,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.
 *
 * Implementation of a terrain (heightfield) renderer.  This is just a thin
 * wrapper around the libmini libraries.
 */

#ifndef WAVE_GLUT_TERRAIN_H__
#define WAVE_GLUT_TERRAIN_H__

// includes --------------------------------------------------------------------
#include "hfield/heightfield.h"
#include "glut/renderable.h"


////////////////////////////////////////////////////////////////////////////////
///
/// \ingroup terra
/// \defgroup terrain Terrain Renderer
///
/// \n
/// This library provides an object for rendering terrain.  This is a thin
/// wrapper around the libmini library.
///
////////////////////////////////////////////////////////////////////////////////
/*@{*/


namespace glut {


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


/// create a renderable heightfield model
smart_ptr<glut::Renderable> createTerrain(IN hfield::Heightfield * hfield);


};      // glut namespace


#endif  // WAVE_GLUT_TERRAIN_H__