src/ElmSharp/ElmSharp/Point.cs

   1 /*
   2  * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the License);
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an AS IS BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 using System;
  18
  19 namespace ElmSharp
  20 {
  21     /// <summary>
  22     /// The Point is a struct that defines a 2-D point as a pair of generic type.
  23     /// </summary>
  24     public struct Point : IEquatable<Point>
  25     {
  26         /// <summary>
  27         /// Location along the horizontal axis.
  28         /// </summary>
  29         public int X;
  30
  31         /// <summary>
  32         /// Location along the vertical axis.
  33         /// </summary>
  34         public int Y;
  35
  36         /// <summary>
  37         /// A human-readable representation of the <see cref="T:Tizen.UI.Point" />.
  38         /// </summary>
  39         /// <returns>The string is formatted as "{{X={0} Y={1}}}".</returns>
  40         public override string ToString()
  41         {
  42             return string.Format("{{X={0} Y={1}}}", X, Y);
  43         }
  44
  45         /// <summary>
  46         /// Gets hash code.
  47         /// </summary>
  48         /// <returns>The hash code.</returns>
  49         public override int GetHashCode()
  50         {
  51             unchecked
  52             {
  53                 return X.GetHashCode() ^ (Y.GetHashCode() * 397);
  54             }
  55         }
  56
  57         public override bool Equals(object obj)
  58         {
  59             if (!(obj is Point))
  60                 return false;
  61
  62             return Equals((Point)obj);
  63         }
  64
  65         public bool Equals(Point other)
  66         {
  67             return X.Equals(other.X) && Y.Equals(other.Y);
  68         }
  69
  70         /// <summary>
  71         /// Whether the two <see cref="T:Tizen.UI.Point" />s are equal.
  72         /// </summary>
  73         /// <param name="p1">A <see cref="T:Tizen.UI.Point" /> on the left hand side.</param>
  74         /// <param name="p2">A <see cref="T:Tizen.UI.Point" /> on the right hand side.</param>
  75         /// <returns>True if the two <see cref="T:Tizen.UI.Point" />s have equal values.</returns>
  76         public static bool operator ==(Point p1, Point p2)
  77         {
  78             return p1.Equals(p2);
  79         }
  80
  81         /// <summary>
  82         /// Whether two <see cref="T:Tizen.UI.Point" />s are not equal.
  83         /// </summary>
  84         /// <param name="p1">A <see cref="T:Tizen.UI.Point" /> on the left hand side.</param>
  85         /// <param name="p2">A <see cref="T:Tizen.UI.Point" /> on the right hand side.</param>
  86         /// <returns>True if the two <see cref="T:Tizen.UI.Point" />s do not have equal values.</returns>
  87         public static bool operator !=(Point p1, Point p2)
  88         {
  89             return !p1.Equals(p2);
  90         }
  91     }
  92 }