/*
 * Util.Clear.cs
 * Authors: 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 Microsoft.Xna.Framework;
using Microsoft.Xna.Framework.Graphics;

namespace Util
{
    /// <summary>
    /// Defines an object which solely clears the game screen
    /// </summary>
	internal sealed class Clear : DrawableGameScreenComponent
    {
        #region Fields

        // The color to clear the screen to
		private readonly Color ClearColor;

        #endregion

        #region Creation

        /// <summary>
        /// Constructor
        /// </summary>
        /// <param name="screen">Reference to the current gamescreen</param>
		public Clear()
		{
			ClearColor = Color.Black;
		}

        /// <summary>
        /// Constructor
        /// </summary>
        /// <param name="screen">Reference to the current game screen</param>
        /// <param name="color">The color to clear to</param>
		public Clear(Color color)
		{
			ClearColor = color;
        }

        #endregion

        #region Render

        /// <summary>
        /// Renders the screen clearer
        /// </summary>
        /// <param name="gameTime">Time that has passed in game</param>
		public override void Draw(GameTime gameTime)
		{
			parent.GraphicsDevice.Clear(ClearColor);
			base.Draw(gameTime);
        }

        #endregion
    }
}