#ifndef TWEEN_H
#define TWEEN_H

#include "EnumHelper.h"

struct lua_State;
typedef lua_State Lua;

/** @brief The different tweening types available. */
enum TweenType
{ 
	TWEEN_LINEAR, /**< A linear tween. */
	TWEEN_ACCELERATE, /**< An accelerating tween. */
	TWEEN_DECELERATE, /**< A decelerating tween. */
	TWEEN_SPRING, /**< A spring tween. */
	TWEEN_BEZIER, /**< A bezier tween. */
	NUM_TweenType, /**< The number of tween types. */
	TweenType_Invalid
};
/** @brief A custom foreach loop iterating through the tween types. */
#define FOREACH_TweenType( tt ) FOREACH_ENUM( TweenType, tt )
LuaDeclareType( TweenType );

/** 
 * @brief The interface for simple interpolation.
 *
 * Funny enough, this is a class. */
class ITween
{
public:
	/** @brief Create the initial interface. */
	virtual ~ITween() { }
	virtual float Tween( float f ) const = 0;
	virtual ITween *Copy() const = 0;

	static ITween *CreateFromType( TweenType iType );
	static ITween *CreateFromStack( Lua *L, int iStackPos );
};

#endif

/**
 * @file
 * @author Glenn Maynard (c) 2006
 * @section LICENSE
 * All rights reserved.
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, and/or sell copies of the Software, and to permit persons to
 * whom the Software is furnished to do so, provided that the above
 * copyright notice(s) and this permission notice appear in all copies of
 * the Software and that both the above copyright notice(s) and this
 * permission notice appear in supporting documentation.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF
 * THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR HOLDERS
 * INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL INDIRECT
 * OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
 * OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
 * OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 * PERFORMANCE OF THIS SOFTWARE.
 */