//
// C++ Interface: IPolygonPositionProvider
//
// Description:
//
//
// Author: Erik Ogenvik <erik@ogenvik.org>, (C) 2009
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software Foundation,
// Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.//
//
#ifndef EMBEROGRE_MANIPULATIONIPOLYGONPOSITIONPROVIDER_H
#define EMBEROGRE_MANIPULATIONIPOLYGONPOSITIONPROVIDER_H

namespace Ember
{
namespace OgreView
{

namespace Authoring
{

/**
 @brief Provides the ability to provide a height value to the otherwise 2d polygons.
 For example, if a polygon is placed on terrain we want the height to be adjusted so that it snaps to the ground.
 @author Erik Ogenvik <erik@ogenvik.org>
 */
struct IPolygonPositionProvider
{
	/**
	 * @brief Dtor.
	 */
	virtual ~IPolygonPositionProvider() = default;

	/**
	 * @brief Gets the height for the local position, within the polygon's space.
	 * @param localPosition The local position within the polygon's space.
	 * @return The height.
	 */
	virtual double getHeightForPosition(const WFMath::Point<2>& localPosition) const = 0;

};

}

}

}

#endif
