A flexible charting library for .NET

//============================================================================
//ZedGraph Class Library - A Flexible Line Graph/Bar Graph Library in C#
//Copyright (C) 2004  John Champion
//
//This library is free software; you can redistribute it and/or
//modify it under the terms of the GNU Lesser General Public
//License as published by the Free Software Foundation; either
//version 2.1 of the License, or (at your option) any later version.
//
//This library 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
//Lesser General Public License for more details.
//
//You should have received a copy of the GNU Lesser General Public
//License along with this library; if not, write to the Free Software
//Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//=============================================================================

#region Using directives

using System;
using System.Drawing;
using System.Drawing.Drawing2D;
using System.Collections;
using System.Runtime.Serialization;
using System.Security.Permissions;

#endregion

namespace ZedGraph
{
	/// <summary>
	/// A class that represents an image object on the graph.  A list of
	/// <see cref="GraphItem"/> objects is maintained by the <see cref="GraphItemList"/>
	/// collection class.
	/// </summary>
	/// 
	/// <author> John Champion </author>
	/// <version> $Revision: 3.9 $ $Date: 2006/02/14 06:14:22 $ </version>
	[Serializable]
	public class ImageItem : GraphItem, ICloneable, ISerializable
	{
	#region Fields
		/// <summary>
		/// Private field that stores the image.  Use the public property <see cref="Image"/>
		/// to access this value.
		/// </summary>
		private Image		image;
		/// <summary>
		/// Private field that determines if the image will be scaled to the output rectangle.
		/// </summary>
		/// <value>true to scale the image, false to draw the image unscaled, but clipped
		/// to the destination rectangle</value>
		private bool		isScaled;
	#endregion

	#region Defaults
		/// <summary>
		/// A simple struct that defines the
		/// default property values for the <see cref="ImageItem"/> class.
		/// </summary>
		new public struct Default
		{
			// Default text item properties
			/// <summary>
			/// Default value for the <see cref="ImageItem"/>
			/// <see cref="ImageItem.IsScaled"/> property.
			/// </summary>
			public static bool IsScaled = true;
		}
	#endregion

	#region Properties
		/// <summary>
		/// The <see cref="System.Drawing.Image"/> object.
		/// </summary>
        /// <value> A <see cref="System.Drawing.Image"/> class reference. </value>
		public Image Image
		{
			get { return image; }
			set { image = value; }
		}
		/// <summary>
		/// Gets or sets a property that determines if the image will be scaled to the
		/// output rectangle (see <see cref="Location"/>).
		/// </summary>
		/// <value>true to scale the image, false to draw the image unscaled, but clipped
		/// to the destination rectangle</value>
		public bool IsScaled
		{
			get { return isScaled; }
			set { isScaled = value; }
		}
	#endregion
	
	#region Constructors
		/// <overloads>Constructors for the <see cref="ImageItem"/> object</overloads>
		/// <summary>
		/// A default constructor that places a null <see cref="System.Drawing.Image"/> at a
		/// default <see cref="RectangleF"/> of (0,0,1,1)
		/// </summary>
		public ImageItem() :
			this( null, 0, 0, 1, 1 )
		{
		}

		/// <summary>
		/// A constructor that allows the <see cref="System.Drawing.Image"/> and
		/// <see cref="RectangleF"/> location for the
		/// <see cref="ImageItem"/> to be pre-specified.
		/// </summary>
		/// <param name="image">A <see cref="System.Drawing.Image"/> class that defines
		/// the image</param>
		/// <param name="rect">A <see cref="RectangleF"/> struct that defines the
		/// image location, specifed in units based on the
		/// <see cref="Location.CoordinateFrame"/> property.</param>
		public ImageItem( Image image, RectangleF rect ) :
			this( image, rect.X, rect.Y, rect.Width, rect.Height )
		{
		}

		/// <overloads>Constructors for the <see cref="ImageItem"/> object</overloads>
		/// <summary>
		/// A constructor that allows the <see cref="System.Drawing.Image"/> and
		/// <see cref="RectangleF"/> location for the
		/// <see cref="ImageItem"/> to be pre-specified.
		/// </summary>
		/// <param name="image">A <see cref="System.Drawing.Image"/> class that defines
		/// the image</param>
		/// <param name="rect">A <see cref="RectangleF"/> struct that defines the
		/// image location, specifed in units based on the
		/// <see cref="Location.CoordinateFrame"/> property.</param>
		/// <param name="coordType">The <see cref="CoordType"/> enum value that
		/// indicates what type of coordinate system the x and y parameters are
		/// referenced to.</param>
		/// <param name="alignH">The <see cref="ZedGraph.AlignH"/> enum that specifies
		/// the horizontal alignment of the object with respect to the (x,y) location</param>
		/// <param name="alignV">The <see cref="ZedGraph.AlignV"/> enum that specifies
		/// the vertical alignment of the object with respect to the (x,y) location</param>
		public ImageItem( Image image, RectangleF rect, CoordType coordType,
					AlignH alignH, AlignV alignV ) :
				base( rect.X, rect.Y, rect.Width, rect.Height, coordType,
					alignH, alignV )
		{
			this.image = image;
			isScaled = Default.IsScaled;
		}

		/// <overloads>Constructors for the <see cref="ImageItem"/> object</overloads>
		/// <summary>
		/// A constructor that allows the <see cref="System.Drawing.Image"/> and
		/// individual <see cref="System.Single"/> coordinate locations for the
		/// <see cref="ImageItem"/> to be pre-specified.
		/// </summary>
		/// <param name="image">A <see cref="System.Drawing.Image"/> class that defines
		/// the image</param>
		/// <param name="left">The position of the left side of the rectangle that defines the
		/// <see cref="ImageItem"/> location.  The units of this position are specified by the
		/// <see cref="Location.CoordinateFrame"/> property.</param>
		/// <param name="top">The position of the top side of the rectangle that defines the
		/// <see cref="ImageItem"/> location.  The units of this position are specified by the
		/// <see cref="Location.CoordinateFrame"/> property.</param>
		/// <param name="width">The width of the rectangle that defines the
		/// <see cref="ImageItem"/> location.  The units of this position are specified by the
		/// <see cref="Location.CoordinateFrame"/> property.</param>
		/// <param name="height">The height of the rectangle that defines the
		/// <see cref="ImageItem"/> location.  The units of this position are specified by the
		/// <see cref="Location.CoordinateFrame"/> property.</param>
		public ImageItem( Image image, float left, float top,
					float width, float height ) :
				base( left, top, width, height )
		{
			this.image = image;
			isScaled = Default.IsScaled;
		}

		/// <summary>
		/// The Copy Constructor
		/// </summary>
		/// <param name="rhs">The <see cref="ImageItem"/> object from which to copy</param>
		public ImageItem( ImageItem rhs ) : base( rhs )
		{
			image = rhs.image;
			isScaled = rhs.IsScaled;
		}

		/// <summary>
		/// Implement the <see cref="ICloneable" /> interface in a typesafe manner by just
		/// calling the typed version of <see cref="Clone" />
		/// </summary>
		/// <returns>A deep copy of this object</returns>
		object ICloneable.Clone()
		{
			return this.Clone();
		}

		/// <summary>
		/// Typesafe, deep-copy clone method.
		/// </summary>
		/// <returns>A new, independent copy of this class</returns>
		public ImageItem Clone()
		{
			return new ImageItem( this );
		}
	#endregion

	#region Serialization
		/// <summary>
		/// Current schema value that defines the version of the serialized file
		/// </summary>
		public const int schema2 = 1;

		/// <summary>
		/// Constructor for deserializing objects
		/// </summary>
		/// <param name="info">A <see cref="SerializationInfo"/> instance that defines the serialized data
		/// </param>
		/// <param name="context">A <see cref="StreamingContext"/> instance that contains the serialized data
		/// </param>
		protected ImageItem( SerializationInfo info, StreamingContext context ) : base( info, context )
		{
			// The schema value is just a file version parameter.  You can use it to make future versions
			// backwards compatible as new member variables are added to classes
			int sch = info.GetInt32( "schema2" );

			image = (Image) info.GetValue( "image", typeof(Image) );
			isScaled = info.GetBoolean( "isScaled" );
		}
		/// <summary>
		/// Populates a <see cref="SerializationInfo"/> instance with the data needed to serialize the target object
		/// </summary>
		/// <param name="info">A <see cref="SerializationInfo"/> instance that defines the serialized data</param>
		/// <param name="context">A <see cref="StreamingContext"/> instance that contains the serialized data</param>
		[SecurityPermissionAttribute(SecurityAction.Demand,SerializationFormatter=true)]
		public override void GetObjectData( SerializationInfo info, StreamingContext context )
		{
			base.GetObjectData( info, context );
			info.AddValue( "schema2", schema2 );
			info.AddValue( "image", image );
			info.AddValue( "isScaled", isScaled );
		}
	#endregion
	
	#region Rendering Methods
		/// <summary>
		/// Render this object to the specified <see cref="Graphics"/> device
		/// This method is normally only called by the Draw method
		/// of the parent <see cref="GraphItemList"/> collection object.
		/// </summary>
		/// <param name="g">
		/// A graphic device object to be drawn into.  This is normally e.Graphics from the
		/// PaintEventArgs argument to the Paint() method.
		/// </param>
		/// <param name="pane">
		/// A reference to the <see cref="PaneBase"/> object that is the parent or
		/// owner of this object.
		/// </param>
		/// <param name="scaleFactor">
		/// The scaling factor to be used for rendering objects.  This is calculated and
		/// passed down by the parent <see cref="GraphPane"/> object using the
		/// <see cref="PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
		/// font sizes, etc. according to the actual size of the graph.
		/// </param>
		override public void Draw( Graphics g, PaneBase pane, float scaleFactor )
		{
			if ( this.image != null )
			{
				// Convert the rectangle coordinates from the user coordinate system
				// to the screen coordinate system
				RectangleF tmpRect = this.location.TransformRect( pane );

				if ( isScaled )
					g.DrawImage( this.image, tmpRect );
				else
				{
					Region clip = g.Clip;
					g.SetClip( tmpRect );
					g.DrawImageUnscaled( image, Rectangle.Round( tmpRect ) );
					g.SetClip( clip, CombineMode.Replace );
					//g.DrawImageUnscaledAndClipped( image, Rectangle.Round( tmpRect ) );
				}
			}

		}
		
		/// <summary>
		/// Determine if the specified screen point lies inside the bounding box of this
		/// <see cref="ArrowItem"/>.  The bounding box is calculated assuming a distance
		/// of <see cref="GraphPane.Default.NearestTol"/> pixels around the arrow segment.
		/// </summary>
		/// <param name="pt">The screen point, in pixels</param>
		/// <param name="pane">
		/// A reference to the <see cref="PaneBase"/> object that is the parent or
		/// owner of this object.
		/// </param>
		/// <param name="g">
		/// A graphic device object to be drawn into.  This is normally e.Graphics from the
		/// PaintEventArgs argument to the Paint() method.
		/// </param>
		/// <param name="scaleFactor">
		/// The scaling factor to be used for rendering objects.  This is calculated and
		/// passed down by the parent <see cref="GraphPane"/> object using the
		/// <see cref="PaneBase.CalcScaleFactor"/> method, and is used to proportionally adjust
		/// font sizes, etc. according to the actual size of the graph.
		/// </param>
		/// <returns>true if the point lies in the bounding box, false otherwise</returns>
		override public bool PointInBox( PointF pt, PaneBase pane, Graphics g, float scaleFactor )
		{
			if ( this.image != null )
			{
				// transform the x,y location from the user-defined
				// coordinate frame to the screen pixel location
				RectangleF tmpRect = this.location.TransformRect( pane );

				return tmpRect.Contains( pt );
			}
			else
				return false;
		}
		
	#endregion
	}
}