/*
 * PopupSprite.cs
 * Authors:
 * Copyright (c) 2007-2008 Cornell University

 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
*/

using System;
using System.Collections.Generic;
using System.Text;
using tAC_Engine.Graphics.Entities;
using Microsoft.Xna.Framework.Content;
using Microsoft.Xna.Framework;

namespace tAC_Engine.Graphics.Entities
{
	/// <summary>
	/// Defines a pop up sprite which can shrink or grow upon creation or death
	/// </summary>
	public class PopupSprite : EntitySprite
	{
		#region Fields

		// The current time
		private float mTime;

		// The time at which the pop up sprite started
		private float mStartTime;

		// The size the pop up sprite will end at
		private Point mFinalSize = Point.Zero;

		// The maximum size the sprite will grow to if a range isn't specified
		private Point mDefaultSize = Point.Zero;

		// The size the pop up sprite will start at
		private Point mStartSize = Point.Zero;

		// Whether or not the pop up sprite is dying
		private bool die = false;

		// Whether or not the pop up sprite is growing
		private bool mGetLarger = false;

		// Whether or not the pop up sprite is shrinking
		private bool mGetSmaller = false;

		// The center position of the pop up sprite
		private Vector2 mCenter = Vector2.Zero;

		#endregion

		#region Properties

		/// <summary>
		/// Gets/Sets the position of the center of the pop up sprite
		/// </summary>
		public virtual Vector2 Center
		{
			get { return mCenter; }
			set
			{
				mCenter = value;
				Recenter(mCenter);
			}
		}

		/// <summary>
		/// Gets whether or not the pop up sprite is getting larger
		/// </summary>
		public bool GettingLarger { get { return mGetLarger; } }

		/// <summary>
		/// Gets whether or not the pop up sprite is getting smaller
		/// </summary>
		public bool GettingSmaller { get { return mGetSmaller; } }

		#endregion

		#region Creation

		/// <summary>
		/// Constructor for pop up sprite
		/// </summary>
		/// <param name="pContent">Reference to the current content manager</param>
		/// <param name="pTextureName">Path name to the texture to be used</param>
		/// <param name="pCenter">Position of the center of the pop up sprite</param>
		/// <param name="pTime">Length of time the pop up sprite will last for</param>
		public PopupSprite(ContentManager pContent, string pTextureName, Vector2 pCenter, float pTime)
		:base(pContent, pTextureName, Vector2.Zero)
		{
			this.Visible = false;
			mTime = pTime;
			this.Center = pCenter;
			this.Height = 0;
			this.Width = 0;
		}

		/// <summary>
		/// Constructor for pop up sprite with a specified default size
		/// </summary>
		/// <param name="pContent">Reference to the current content manager</param>
		/// <param name="pTextureName">Path name to the texture to be used</param>
		/// <param name="pCenter">Position of the center of the pop up sprite</param>
		/// <param name="pTime">Length of time the pop up sprite will last for</param>
		/// <param name="pDefaultSize">Default size of the pop up sprite</param>
		public PopupSprite(ContentManager pContent, string pTextureName, Vector2 pCenter, float pTime, Point pDefaultSize)
			: this(pContent, pTextureName, pCenter, pTime)
		{
			mDefaultSize = pDefaultSize;
		}

		#endregion

		#region Initialization

		/// <summary>
		/// Initializes all need values upon creation
		/// </summary>
		public override void Initialize()
		{
			base.Initialize();
			Height = 0;
			Width = 0;
		}

		#endregion

		#region Update

		/// <summary>
		/// Updates the pop up sprite
		/// </summary>
		/// <param name="gameTime">Time that has passed in game</param>
		public override void Update(GameTime gameTime)
		{
			if ((Height < mFinalSize.Y && Width < mFinalSize.X && mGetLarger) ||
				(Height > mFinalSize.Y && Width > mFinalSize.X && mGetSmaller))
			{
				float timeRatio = (float)(gameTime.TotalGameTime.TotalMilliseconds - mStartTime) / (float)mTime;
				Width = (int)MathHelper.Lerp(mStartSize.X, mFinalSize.X, timeRatio);
				Height = (int)MathHelper.Lerp(mStartSize.Y, mFinalSize.Y, timeRatio);
				Recenter(Center);
			}
			
			if (Height >= mFinalSize.Y && Width >= mFinalSize.X && mGetLarger)
			{
				mGetLarger = false;
			}
			else if (Height <= mFinalSize.Y && Width <= mFinalSize.X && mGetSmaller)
			{
				mGetSmaller = false;
			}
			if (Width <= 0 || Height <= 0)
			{
				this.Visible = false;
			}

			base.Update(gameTime);

			if (!Visible && die)
				this.Dispose();
		}

		#endregion

		#region State Modifiers

		/// <summary>
		/// Sprite begins to pop up to the default size
		/// </summary>
		/// <param name="pCurrentTime">Current time in game</param>
		public void PopUp(GameTime pCurrentTime)
		{
			PopUp(pCurrentTime, mDefaultSize);
		}

		/// <summary>
		/// Sprite begins to pop up to the given size
		/// </summary>
		/// <param name="pCurrentTime">Current time in game</param>
		/// <param name="pSize">Size to grow to</param>
		public void PopUp(GameTime pCurrentTime, Point pSize)
		{
			this.Visible = true;
			mStartTime = (float)pCurrentTime.TotalGameTime.TotalMilliseconds;
			mFinalSize = pSize;
			mStartSize = Point.Zero;
			mGetLarger = true;
		}

		/// <summary>
		/// Starts to shrink and until the pop up sprite is gone
		/// </summary>
		/// <param name="pCurrentTime">Current time in game</param>
		public void GoAway(GameTime pCurrentTime)
		{
			mStartTime = (float)pCurrentTime.TotalGameTime.TotalMilliseconds;
			mStartSize = mFinalSize;
			mFinalSize = Point.Zero;
			mGetSmaller = true;
		}

		/// <summary>
		/// Starts to shrink and until the pop up sprite is gone then gets disposed of
		/// </summary>
		/// <param name="pCurrentTime">Current time in game</param>
		public void GoAwayAndDie(GameTime pCurrentTime)
		{
			GoAway(pCurrentTime);
			die = true;
		}

		#endregion

		#region Parameter Modifiers

		/// <summary>
		/// Recenters the pop up sprite to the given position
		/// </summary>
		/// <param name="pCenter">Postion to move the center of the pop up sprite to</param>
		protected void Recenter(Vector2 pCenter)
		{
			this.Position = new Vector2(pCenter.X - this.Width / 2, pCenter.Y - this.Height / 2);
		}

		#endregion
	}
}