heightfield.h

Go to the documentation of this file.

/*
 * heightfield.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.
 *
 */

#ifndef WAVE_GLUT_HEIGHTFIELD_H__
#define WAVE_GLUT_HEIGHTFIELD_H__

// includes --------------------------------------------------------------------
#include "common/common.h"
#include "nstream/nstream.h"
#include "threadsafe/smart_ptr.h"

#include <iostream>


namespace hfield {

////////////////////////////////////////////////////////////////////////////////
///
/// \ingroup geometric
/// \defgroup hfield Wavepacket Heightfield Library
///
/// \n
/// This library provides basic heightfield support.  This is for modeling
/// terrains logically on the client and server.
///
/// \n
/// \b NOTE: this library does NOT support rendering!  It is just a logical
/// heightfield.  Other libraries (such as \ref terrain) know how to
/// render one of these.  The purpose of this library is to be useful on
/// the server (no rendering) and client.
///
////////////////////////////////////////////////////////////////////////////////

/*@{*/


////////////////////////////////////////////////////////////////////////////////
//
//      Heightfield API
//
////////////////////////////////////////////////////////////////////////////////

/// A logical heightfield.
class Heightfield {
public:
        // virtual destructor --------------------------------------------------
        virtual ~Heightfield(void) throw();

        // hfield::Heightfield class interface methods -------------------------
        virtual void dump(IN const char * txt) const throw() = 0;
        virtual int getWidth(void) const throw() = 0;
        virtual int getLength(void) const throw() = 0;
        virtual float getXZScale(void) const throw() = 0;
        virtual float getYScale(void) const throw() = 0;
        virtual short getMinHeight(void) const throw() = 0;
        virtual short getMaxHeight(void) const throw() = 0;

        /// returns raw height values, NOT multipled by yScale yet
        virtual const short * getHeightArray(void) const throw() = 0;

        virtual smart_ptr<nstream::Manager> getStreamManager(void) throw() = 0;
        virtual const char * getHeightfieldPath(void) const throw()  = 0;
        virtual const char * getTexturePath(void) const throw() = 0;

        /// returns true height values, already multiplied by yScale
        virtual float getHeight(IN float x, IN float z) const throw() = 0;

        // static factory methods ----------------------------------------------

        /// Create a heightfield from a named stream.  See the Wavepacket
        ///   named stream library for the nstream interface and usage:
        ///   http://wavepacket-lib.sourceforge.net/
        static smart_ptr<Heightfield> create(IO nstream::Stream * stream);
};



};      // hfield namespace

#endif  // WAVE_GLUT_HEIGHTFIELD_H__