/*=============================================================================

  Project:   SharpImage
  Module:    siActor.cs
  Language:  C#
  Author:    Dan Mueller
  Date:      $Date: 2007-07-06 10:57:00 +1000 (Fri, 06 Jul 2007) $
  Revision:  $Revision: 2 $

  Copyright (c) Queensland University of Technology (QUT) 2007.
  All rights reserved.

  This software is distributed WITHOUT ANY WARRANTY; without even
  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  PURPOSE.  See the above copyright notices for more information.
  
=============================================================================*/

using System;
using System.Collections.Generic;
using System.Text;
using System.Drawing;
using System.Drawing.Drawing2D;
using System.Drawing.Imaging;
using System.Windows.Forms;
using System.Diagnostics;

using SharpImage.Main;
using SharpImage.Properties;

namespace SharpImage.Rendering
{
    public class siActor<TParent> where TParent: class
    {
        #region Instance Variables
        //=====================================================================

        //=========================================================================
        #endregion

        #region Construction and Disposal
        //=====================================================================
        /// <summary>
        /// Protected parameterless constructor for serialization.
        /// </summary>
        protected siActor()
        {

        }
        //=====================================================================
        #endregion

        #region Properties
        //=====================================================================

        #region Visible
        //=====================================================================
        private bool m_Visible = true;

        /// <summary>
        /// Gets/sets if the actor is visible in the Renderer.
        /// </summary>
        [System.ComponentModel.Browsable(true)]
        [System.ComponentModel.Category("General")]
        public bool Visible
        {
            get { return this.m_Visible; }
            set { this.m_Visible = value; this.RaiseModified(); }
        }
        //=====================================================================
        #endregion

        #region Metadata
        //=====================================================================
        private Dictionary<string, object> m_Metadata = new Dictionary<string, object>();

        /// <summary>
        /// Gets the Metadata variable list.
        /// </summary>
        [System.ComponentModel.Browsable(false)]
        [System.Xml.Serialization.XmlIgnore]
        public Dictionary<string, object> Metadata
        {
            get { return this.m_Metadata; }
        }
        //=====================================================================
        #endregion

        //=====================================================================
        #endregion

        #region Events
        //=====================================================================
        public delegate void siActorHandler(siActor<TParent> sender);
        public delegate void siActorModifiedHandler(siActor<TParent> sender, bool partial);
        private siActorModifiedHandler m_EventStorage_Modified;
        private MouseEventHandler m_EventStorage_MouseDown;

        /// <summary>
        /// An event raised when the actor is modified.
        /// </summary>
        public event siActorModifiedHandler Modified
        {
            add { this.m_EventStorage_Modified += value; }
            remove { this.m_EventStorage_Modified -= value; }
        }

        /// <summary>
        /// Raises the Modified event. Actor subclasses should call this
        /// when a change occurs in the actor that requires the parent
        /// Renderer to be repainted. This signals a full modification
        /// (ie. partial = false).
        /// </summary>
        public void RaiseModified()
        {
            if (this.m_EventStorage_Modified != null)
                this.m_EventStorage_Modified(this, false);
        }

        /// <summary>
        /// Raises the Modified event. Actor subclasses should call this
        /// when a change occurs in the actor that requires the parent
        /// Renderer to be repainted.
        /// </summary>
        /// <param name="partial">True and only a partial modification occured, otherwise
        ///                       False and a full modification occurred.</param>
        public void RaiseModified(bool partial)
        {
            if (this.m_EventStorage_Modified != null)
                this.m_EventStorage_Modified(this, partial);
        }

        /// <summary>
        /// An event raised when the mouse is clicked.
        /// </summary>
        public event MouseEventHandler MouseDownEvent
        {
            add { this.m_EventStorage_MouseDown += value; }
            remove { this.m_EventStorage_MouseDown -= value; }
        }

        /// <summary>
        /// Raises the MouseDown event.
        /// </summary>
        protected void RaiseMouseDownEvent(MouseEventArgs e)
        {
            if (this.m_EventStorage_MouseDown != null)
                this.m_EventStorage_MouseDown(this, e);
        }
        //=====================================================================
        #endregion

        #region Public Methods
        //=====================================================================
        
        //=====================================================================
        #endregion

        #region Event Methods
        //=====================================================================
        /// <summary>
        /// Renders the actor.
        /// </summary>
        /// <param name="renderer"></param>
        /// <param name="e"></param>
        public void Paint(TParent parent, PaintEventArgs e)
        {
            this.OnPaint(parent, e);
        }

        /// <summary>
        /// Allows the actor to render itself.
        /// </summary>
        /// <param name="renderer"></param>
        /// <param name="e"></param>
        protected virtual void OnPaint(TParent parent, PaintEventArgs e)
        {
            return;
        }

        /// <summary>
        /// Gives the actor a chance to consume a MouseDown event.
        /// Returns true if the actor has consumed the event.
        /// </summary>
        /// <param name="e"></param>
        /// <returns>true AND the event was consumed OR 
        ///          false AND the event was ignores/not relevant.</returns>
        public bool MouseDown(TParent parent, MouseEventArgs e)
        {
            return this.OnMouseDown(parent, e);
        }

        /// <summary>
        /// Allows the actor to consume the MouseDown event.
        /// </summary>
        /// <param name="e"></param>
        /// <returns></returns>
        protected virtual bool OnMouseDown(TParent parent, MouseEventArgs e)
        {
            this.RaiseMouseDownEvent(e);
            return false;
        }

        /// <summary>
        /// Gives the actor a chance to consume a MouseUp event.
        /// Returns true if the actor has consumed the event.
        /// </summary>
        /// <param name="e"></param>
        /// <returns>true AND the event was consumed OR 
        ///          false AND the event was ignores/not relevant.</returns>
        public bool MouseUp(TParent parent, MouseEventArgs e)
        {
            return this.OnMouseUp(parent, e);
        }

        /// <summary>
        /// Allows the actor to consume the MouseDown event.
        /// </summary>
        /// <param name="e"></param>
        /// <returns></returns>
        protected virtual bool OnMouseUp(TParent parent, MouseEventArgs e)
        {
            return false;
        }

        /// <summary>
        /// Gives the actor a chance to consume a MouseMove event.
        /// Returns true if the actor has consumed the event.
        /// </summary>
        /// <param name="e"></param>
        /// <returns>true AND the event was consumed OR 
        ///          false AND the event was ignores/not relevant.</returns>
        public bool MouseMove(TParent parent, MouseEventArgs e)
        {
            return this.OnMouseMove(parent, e);
        }

        /// <summary>
        /// Allows the actor to consume the MouseMove event.
        /// </summary>
        /// <param name="e"></param>
        /// <returns></returns>
        protected virtual bool OnMouseMove(TParent parent, MouseEventArgs e)
        {
            return false;
        }
        //=====================================================================
        #endregion
    }
}