/*
 * StaticSprite.cs
 * Authors: August Zinsser, Adam Nabinger
 * 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 Microsoft.Xna.Framework;
using Microsoft.Xna.Framework.Content;
using Microsoft.Xna.Framework.Graphics;

namespace MaritimeDefender
{
	/// <summary>
	/// A very simple class for drawing a static image, designed to be used by HUD elements. Game objects should use Entity instead of this struct.
	/// </summary>
	public class StaticSprite
	{
		#region Fields

		/// <summary>
		/// The position and dimensions of the sprite
		/// </summary>
		internal Rectangle Location;
		
		/// <summary>
		/// The Z depth position for the sprite
		/// </summary>
		internal float ZDepth;
		
		/// <summary>
		/// The path name of the texture file to use
		/// </summary>
		internal readonly string TextureName;
		
		/// <summary>
		/// The texture that represents the sprite
		/// </summary>
		internal Texture2D Texture;

		/// <summary>
		/// The color tint of the sprite
		/// </summary>
		internal Color Tint;

		/// <summary>
		/// The position of the sprite
		/// </summary>
		internal Vector2 Origin;

		#endregion

		#region Creation

		/// <summary>
		/// Constructor
		/// </summary>
		/// <param name="location">The position and dimensions of the sprite</param>
		/// <param name="zDepth">The z dpeth of the sprite for draw order</param>
		/// <param name="textureName">The path name of the texture file to use</param>
		public StaticSprite(Rectangle location, float zDepth, string textureName)
		{
			Location = location;
			ZDepth = zDepth;
			TextureName = textureName;
			Tint = Color.White;
		}

		#endregion

		#region Management

		/// <summary>
		/// Loads in all necessary information for all content dependent objects
		/// </summary>
		/// <param name="Content">Reference to the current content manager for loading in content</param>
		public void LoadContent(ContentManager Content)
		{
			Texture = Content.Load<Texture2D>(TextureName);
			Origin = new Vector2(Texture.Width * 0.5f, Texture.Height * 0.5f);
		}

		#endregion

		#region Render

		/// <summary>
		/// Draw to the given spritebatch
		/// </summary>
		/// <param name="spriteBatch">Reference to the current sprite batch for rendering textures</param>
		public void Draw(SpriteBatch spriteBatch)
		{
			spriteBatch.Draw( Texture, Location, null, Tint, 0f, Origin, SpriteEffects.None, ZDepth);
		}

		#endregion
	}
}