package org.as3commoncode.utils
{
	import flash.display.DisplayObject;
	import flash.geom.Rectangle;	
 
	/**
	 * Utility class for determining if the mouse is currently within the bounds
	 * of any display object.
	 * 
	 * @author Tony Birleffi
	 */
	public class MouseUtil
	{
		/**
		 * Method used to determine if the mouse is within the bounds of a DisplayObject.
		 * 
		 * @example
		 * <listing>
                 * import com.target.utils.MouseUtil;
                 * var ifMouse:Boolean = MouseUtil.checkMouseInBounds(do);
                 * </listing>
                 *
		 * @param level				which sprite level.
		 * @param displayObject		any display object, sprite, movie clip, shape.
		 * @return Boolean.
		 */
		public static function checkMouseInBounds(displayObject:DisplayObject = null):Boolean
		{
			// Define.
			var res:Boolean = false;
			var rect:Rectangle;
 
			// If defined then continue.
			if(displayObject != null)
			{
				// Define the bounds rectangle.
				rect = displayObject.getBounds(displayObject);
 
				// Get the current mouse position
				var mouseX:Number = displayObject.mouseX;
				var mouseY:Number = displayObject.mouseY;
 
				// Check the x boundry, if in boundry then return true.
				if ((mouseX >= rect.left) && (mouseX <= rect.right))
				{
					// Check the y boundry.
					if ((mouseY >= rect.top) && (mouseY <= rect.bottom)) res = true;
				} 
				else res = false;
			}
 
			// Return.
			return res;
		}
	}
}