#ifndef __ABSTRACTPLUGINUTILITIES_H__
#define __ABSTRACTPLUGINUTILITIES_H__

//-----------------------------------------------------------------------------
// Copyright (c) 2009, Jan Fietz, Cyrus Preuss
// 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 EduNetGames 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 THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 THE COPYRIGHT HOLDER OR CONTRIBUTORS 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.
//-----------------------------------------------------------------------------

#include "OpenSteerUT/OpenSteerUTTypes.h"

class GLUI_Panel;
class GLUI_Control;

//-----------------------------------------------------------------------------
namespace OpenSteer
{

	//-------------------------------------------------------------------------
	class AbstractPluginGui
	{
	public:
		static void addCommonPluginGui( GLUI_Panel* pluginPanel, osAbstractPlugin* pkPlugin );
		static void changePluginBoolValue( GLUI_Control* pkControl );
		static GLUI_Panel* initRootPluginGui( osAbstractPlugin* pkPlugin );
		static GLUI_Panel* initSubPluginGui( osAbstractPlugin* pkPlugin, void* pkUserdata );
	};


	template <class Super>
	class PluginAccessorMixin : public Super
	{
		ET_DECLARE_BASE( Super )
	public:

		// constructor
		PluginAccessorMixin():m_pkPlugin( NULL ) {};

		// destructor
		virtual ~PluginAccessorMixin()	{};


		virtual void setPlugin( class OpenSteer::AbstractPlugin* pPlugin )
		{
			this->m_pkPlugin = pPlugin;
		}

		virtual OpenSteer::AbstractPlugin* getPlugin( void ) const
		{
			return this->m_pkPlugin;
		}

	private:
		class OpenSteer::AbstractPlugin* m_pkPlugin;

	};

	typedef PluginAccessorMixin<OpenSteer::Entity> PluginAccessor_t;

	// an pure virtual interface to support plugin selections
	class VirtualPluginSelector
	{
	public:
		virtual ~VirtualPluginSelector()	{};

		virtual const char* getCurrentPluginName( void ) const ET_ABSTRACT;
		virtual void selectPluginByName( const char* pszPluginName ) ET_ABSTRACT;
	};

}

#endif //  __ABSTRACTPLUGINUTILITIES_H__