namespace View_by_Distance.FaceRecognitionDotNet.Models;

/// <summary>
/// Represents an ordered pair of integer x- and y-coordinates that defines a point in a two-dimensional plane.
/// </summary>
public readonly struct Point : IEquatable<Point>
{

    #region Constructors

    /// <summary>
    /// Initializes a new instance of the <see cref="Point"/> structure with the specified coordinates.
    /// </summary>
    /// <param name="x">The horizontal position of the point.</param>
    /// <param name="y">The vertical position of the point.</param>
    public Point(int x, int y)
    {
        X = x;
        Y = y;
    }

    internal Point(DlibDotNet.Point point)
    {
        X = point.X;
        Y = point.Y;
    }

    #endregion

    #region Properties

    /// <summary>
    /// Gets the x-coordinate of this <see cref="Point"/>.
    /// </summary>
    public int X
    {
        get;
    }

    /// <summary>
    /// Gets the y-coordinate of this <see cref="Point"/>.
    /// </summary>
    public int Y
    {
        get;
    }

    #endregion

    #region Methods

    /// <summary>
    /// Compares two <see cref="Point"/> structures for equality.
    /// </summary>
    /// <param name="other">The point to compare to this instance.</param>
    /// <returns><code>true</code> if both <see cref="Point"/> structures contain the same <see cref="X"/> and <see cref="Y"/> values; otherwise, <code>false</code>.</returns>
    public bool Equals(Point other)
    {
        return X == other.X &&
               Y == other.Y;
    }

    #region overrides

    /// <summary>
    /// Determines whether the specified <see cref="object"/> is a <see cref="Point"/> and whether it contains the same coordinates as this <see cref="Point"/>.
    /// </summary>
    /// <param name="obj">The <see cref="object"/> to compare.</param>
    /// <returns><code>true</code> if <paramref name="obj"/> is a <see cref="Point"/> and contains the same <see cref="X"/> and <see cref="Y"/> values as this <see cref="Point"/>; otherwise, <code>false</code>.</returns>
    public override bool Equals(object? obj) => obj is Point point && Equals(point);

    /// <summary>
    /// Returns the hash code for this <see cref="Point"/>.
    /// </summary>
    /// <returns>The hash code for this <see cref="Point"/> structure.</returns>
#pragma warning disable IDE0070
    public override int GetHashCode()
#pragma warning restore IDE0070
    {
        int hashCode = 1861411795;
        hashCode = hashCode * -1521134295 + X.GetHashCode();
        hashCode = hashCode * -1521134295 + Y.GetHashCode();
        return hashCode;
    }

    /// <summary>
    /// Compares two <see cref="Point"/> structures for equality.
    /// </summary>
    /// <param name="point1">The first <see cref="Point"/> structure to compare.</param>
    /// <param name="point2">The second <see cref="Point"/> structure to compare.</param>
    /// <returns><code>true</code> if both the <see cref="X"/> and <see cref="Y"/> coordinates of <paramref name="point1"/> and <paramref name="point2"/> are equal; otherwise, <code>false</code>.</returns>
    public static bool operator ==(Point point1, Point point2) => point1.Equals(point2);

    /// <summary>
    /// Compares two <see cref="Point"/> structures for inequality.
    /// </summary>
    /// <param name="point1">The first <see cref="Point"/> structure to compare.</param>
    /// <param name="point2">The second <see cref="Point"/> structure to compare.</param>
    /// <returns><code>true</code> if <paramref name="point1"/> and <paramref name="point2"/> have different <see cref="X"/> or <see cref="Y"/> coordinates; <code>false</code> if <paramref name="point1"/> and <paramref name="point2"/> have the same <see cref="X"/> and <see cref="Y"/> coordinates.</returns>

    public static bool operator !=(Point point1, Point point2) => !(point1 == point2);

    #endregion

    #endregion

}