// Copyright (C) Stichting Deltares 2024. 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 for pure X,Z coors, to be used in calculation
/// </summary>
[TypeConverter(typeof(ExpandableObjectConverter))]
public class Point2D : IComparable, IGeometryObject
{
    /// <summary>
    /// Initializes a new instance of the <see cref="Point2D"/> class.
    /// </summary>
    public Point2D() {}

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

    /// <summary>
    /// The x
    /// </summary>
    public double X { get; set; }

    /// <summary>
    /// The z
    /// </summary>
    public double Z { get; set; }

    public string Name { get; set; }

    /// <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(Point2D other)
    {
        return LocationEquals(other, GeometryConstants.Accuracy);
    }

    /// <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(Point2D 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>
    /// Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.
    /// </summary>
    /// <param name="obj">An object to compare with this instance.</param>
    /// <returns>
    /// A value that indicates the relative order of the objects being compared. The return value has these meanings: Value Meaning Less than zero This instance precedes <paramref name="obj" /> in the sort order. Zero This instance occurs in the same position in the sort order as <paramref name="obj" />. Greater than zero This instance follows <paramref name="obj" /> in the sort order.
    /// </returns>
    public int CompareTo(object obj)
    {
        var point = obj as Point2D;
        if (point != null)
        {
            return X.CompareTo(point.X);
        }

        return String.Compare(ToString(), obj.ToString(), StringComparison.Ordinal);
    }
}