// Copyright (C) Stichting Deltares 2019. All rights reserved.
//
// This file is part of the Dam Engine.
//
// The Dam Engine is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 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 Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
//
// All names, logos, and references to "Deltares" are registered trademarks of
// Stichting Deltares and remain full property of Stichting Deltares at all times.
// All rights reserved.

using System;
using System.ComponentModel;
using Deltares.DamEngine.Data.Standard;

namespace Deltares.DamEngine.Data.Geometry
{
    /// <summary>
    /// Class to manage a geometry point.
    /// </summary>
    [Serializable]
    [TypeConverter(typeof(ExpandableObjectConverter))]
    public class GeometryPoint : GeometryObject, ICloneable, IComparable
    {
        /// <summary>
        /// The precision
        /// </summary>
        public const double Precision = GeometryConstants.Accuracy;

        private object owner;

        /// <summary>
        /// Initializes a new instance of the <see cref="GeometryPoint"/> class.
        /// </summary>
        public GeometryPoint() : this(0.0, 0.0) {}

        /// <summary>
        /// Initializes a new instance of the <see cref="GeometryPoint"/> class.
        /// </summary>
        /// <param name="aPoint">A point.</param>
        public GeometryPoint(GeometryPoint aPoint) : this(aPoint.X, aPoint.Z) {}

        /// <summary>
        /// Initializes a new instance of the <see cref="GeometryPoint"/> class.
        /// </summary>
        /// <param name="aX">A x.</param>
        /// <param name="aZ">A z.</param>
        public GeometryPoint(double aX, double aZ)
        {
            X = aX;
            Z = aZ;           
        }

        /// <summary>
        /// Gets or sets the X coordinate of GeometryPoint
        /// </summary>
        public virtual double X { get; set; }

        /// <summary>
        /// Gets or sets the Y coordinate of GeometryPoint
        /// </summary>
        public virtual double Y { get; set; }

        /// <summary>
        /// Gets or sets the Z coordinate of GeometryPoint
        /// </summary>
        public virtual double Z { get; set; }
        
        /// <summary>
        /// Identifies the object which owns this point.
        /// </summary>
        /// <remarks>
        /// Usually set by a delegated list, such as in <see cref="GeometryPointString"/>.
        /// </remarks>
        public object Owner
        {
            get
            {
                return owner;
            }
            set
            {
                owner = value;
            }
        }

        /// <summary>
        /// Determines whether the location of the given point and this one are the same. 
        /// </summary>
        /// <param name="other">The other.</param>
        /// <returns></returns>
        public bool LocationEquals(GeometryPoint other)
        {
            return LocationEquals(other, Precision);
        }

        /// <summary>
        /// Determines whether the difference between the location of the given point and 
        /// this one are within the given precision. 
        /// </summary>
        /// <param name="other">The other.</param>
        /// <param name="precision">The precision.</param>
        /// <returns></returns>
        public bool LocationEquals(GeometryPoint other, double precision)
        {
            if (ReferenceEquals(other, null))
            {
                return false;
            }
            if (ReferenceEquals(other, this))
            {
                return true;
            }

            return X.AlmostEquals(other.X, precision) &&
                   Z.AlmostEquals(other.Z, precision);
        }

        /// <summary>
        /// Gets the geometry bounds.
        /// </summary>
        /// <returns></returns>
        public override GeometryBounds GetGeometryBounds()
        {
            return new GeometryBounds(X, X, Z, Z);
        }

        /// <summary>
        /// Returns a <see cref="System.String" /> that represents this instance.
        /// </summary>
        /// <returns>
        /// A <see cref="System.String" /> that represents this instance.
        /// </returns>
        public override string ToString()
        {
            return "(" + X.ToString("F3") + ";" + Z.ToString("F3") + ")";
        }

        

        #region ICloneable Members

        /// <summary>
        /// Clones this instance.
        /// </summary>
        /// <remarks>Only copies <see cref="X"/> and <see cref="Z"/>.</remarks>
        public virtual object Clone()
        {
            return new GeometryPoint(this);
        }

        #endregion

        #region IComparable Members

        /// <summary>
        /// Compares the current instance with another object of the same type
        /// Eventhough this method does not seem to be used it is! (via GPstring which is a delegated list, using a Sort which needs this).
        /// So do NOT delete this as long as GPS stays a delegated list.
        /// </summary>
        /// <param name="obj">An object to compare with this instance.</param>
        /// <returns>
        /// Result of comparing the X values
        /// </returns>
        public int CompareTo(object obj)
        {
            var point = obj as GeometryPoint;
            if (point != null)
            {
                return X.CompareTo(point.X);
            }
            return ToString().CompareTo(obj.ToString());
        }

        #endregion
    }
}