//-----------------------------------------------------------------------
// <copyright file="BackgroundImage.cs" company="N/A">
//     Copyright © 2005-2006 Erik Tigerholm, 2013 Nils Hammar
// </copyright>
//-----------------------------------------------------------------------

/*
 * Copyright (c) 2005-2006 Erik Tigerholm <eriktigerholm@gmail.com>
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

namespace OpenTraffic.Model
{
    using System;
    using System.IO;
    using System.Xml.Serialization;

    /// <summary>
    /// Possible image states.
    /// </summary>
    [XmlType("VISIBLE")]
    public enum IMAGE_STATES
    {
        /// <summary>
        /// Show image.
        /// </summary>
        SHOW,

        /// <summary>
        /// Hide image.
        /// </summary>
        HIDE,
    }

    /// <summary>
    /// Background image data record.
    /// </summary>
    [Serializable]
    public class BackgroundImage
    {
        #region XmlExport

        /// <summary>
        /// Gets or sets file name for image.
        /// </summary>
        public string XmlExportFileName
        {
            get
            {
                return this.File.FullName;
            }

            set
            {
                this.File = new FileInfo(value);
            }
        }

        /// <summary>
        /// Gets or sets image state.
        /// </summary>
        [XmlAttribute(AttributeName = "State")]
        public IMAGE_STATES State { get; set; }

        /// <summary>
        /// Gets or sets minimum X position.
        /// </summary>
        [XmlAttribute(AttributeName = "MinX")]
        public float MinX { get; set; }

        /// <summary>
        /// Gets or sets maximum X position.
        /// </summary>
        [XmlAttribute(AttributeName = "MaxX")]
        public float MaxX { get; set; }

        /// <summary>
        /// Gets or sets maximum Y position.
        /// </summary>
        [XmlAttribute(AttributeName = "MaxY")]
        public float MaxY { get; set; }

        #endregion

        /// <summary>
        /// Gets name of image file.
        /// </summary>
        [XmlIgnore]
        public FileInfo File { get; set; }

        /// <summary>
        /// Initializes a new instance of the <see cref="BackgroundImage" /> class.
        /// </summary>
        public BackgroundImage()
        {
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="BackgroundImage" /> class.
        /// </summary>
        /// <param name="file">Name of image file.</param>
        /// <param name="minX">Minimum X position.</param>
        /// <param name="maxX">Maximum X position.</param>
        /// <param name="maxY">Maximum Y position.</param>
        /// <param name="imageState">Image State (SHOW/HIDE)</param>
        public BackgroundImage(FileInfo file, float minX, float maxX, float maxY, IMAGE_STATES imageState)
        {
            this.File = file;
            this.MinX = minX;
            this.MaxX = maxX;
            this.MaxY = maxY;
            this.State = imageState;
        }
    }
}