package org.as3lib.kitchensync.action.tweentarget
{
	/**
	 * A bundle that wraps up a property or other value that can be tweened by a KSTween.
	 * Generally speaking, a KSTween will handle the timing of the tween while the lib_flex_animation_code_10_org_as3lib_kitchensync_action_tweentarget_ITweenTarget
	 * handles the values of the tween.
	 * 
	 * @author Mims Wright
	 * @since 1.5
	 * @see org.as3lib.kitchensync.action.KSTween
	 */
	public interface lib_flex_animation_code_10_org_as3lib_kitchensync_action_tweentarget_ITweenTarget extends INumericController
	{
		/**
		 * The main function that the Tween uses to update the TweenTarget. 
		 * Sets the percentage complete.
		 * 
		 * @use Typically this is implemented as such: 
		 * <code>	
		 * 	public function updateTween(percentComplete:Number):Number {
		 * 		return currentValue = percentComplete * (endValue - startValue) + startValue;
		 *	}
		 * </code>
		 * 
		 * @param percentComplete a number between 0 and 1 (but sometimes more or less) that represents
		 * 		  the percentage of the tween that has been completed. This should update
		 * @return Number the new current value of the tween.
		 */
		function updateTween (percentComplete:Number):Number;
		
		/**
		 * The value that the tweenTarget will begin from.
		 */
		function get startValue():Number;
		function set startValue(startValue:Number):void;
		
		/**
		 * The value that the tweenTarget will end on.
		 */
		function get endValue():Number;
		function set endValue(endValue:Number):void;
		
		/** 
		 * Reset the value to it's pre-tweened state.
		 * (typically, sets the currentValue equal to the startValue) 
		 */
		function reset():void;
		
		/** Create a copy of the tweenTarget object */
		function clone():lib_flex_animation_code_10_org_as3lib_kitchensync_action_tweentarget_ITweenTarget;
	}
}