class/WindowsBase/System.Windows/Vector.cs

   1 // Permission is hereby granted, free of charge, to any person obtaining
   2 // a copy of this software and associated documentation files (the
   3 // "Software"), to deal in the Software without restriction, including
   4 // without limitation the rights to use, copy, modify, merge, publish,
   5 // distribute, sublicense, and/or sell copies of the Software, and to
   6 // permit persons to whom the Software is furnished to do so, subject to
   7 // the following conditions:
   8 //
   9 // The above copyright notice and this permission notice shall be
  10 // included in all copies or substantial portions of the Software.
  11 //
  12 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  13 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  14 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  15 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  16 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  17 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  18 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  19 //
  20 // Copyright (c) 2007 Novell, Inc. (http://www.novell.com)
  21 //
  22 // Authors:
  23 //      Chris Toshok (toshok@novell.com)
  24 //
  25
  26 using System;
  27 using System.ComponentModel;
  28 using System.Windows.Converters;
  29 using System.Windows.Markup;
  30 using System.Windows.Media;
  31
  32 namespace System.Windows {
  33
  34         [Serializable]
  35         [ValueSerializer (typeof (VectorValueSerializer))]
  36         [TypeConverter (typeof (VectorConverter))]
  37         public struct Vector : IFormattable
  38         {
  39                 public Vector (double x, double y)
  40                 {
  41                         this.x = x;
  42                         this.y = y;
  43                 }
  44
  45                 public bool Equals (Vector value)
  46                 {
  47                         return x == value.X && y == value.Y;
  48                 }
  49
  50                 public override bool Equals (object o)
  51                 {
  52                         if (!(o is Vector))
  53                                 return false;
  54
  55                         return Equals ((Vector)o);
  56                 }
  57
  58                 public override int GetHashCode ()
  59                 {
  60                         throw new NotImplementedException ();
  61                 }
  62
  63                 string IFormattable.ToString(string format, IFormatProvider formatProvider) {
  64                         throw new NotImplementedException ();
  65                 }
  66
  67                 public static bool Equals (Vector vector1, Vector vector2)
  68                 {
  69                         return vector1.Equals (vector2);
  70                 }
  71
  72                 public static Point Add (Vector vector, Point point)
  73                 {
  74                         return new Point (vector.X + point.X, vector.Y + point.Y);
  75                 }
  76
  77                 public static Vector Add (Vector vector1, Vector vector2)
  78                 {
  79                         return new Vector (vector1.X + vector2.X,
  80                                            vector1.Y + vector2.Y);
  81                 }
  82
  83                 public static double AngleBetween (Vector vector1, Vector vector2)
  84                 {
  85                         double cos_theta = (vector1.X * vector2.X + vector1.Y * vector2.Y) / (vector1.Length * vector2.Length);
  86
  87                         return Math.Acos (cos_theta) / Math.PI * 180;
  88                 }
  89
  90                 public static double CrossProduct (Vector vector1, Vector vector2)
  91                 {
  92                         // ... what operation is this exactly?
  93                         return vector1.X * vector2.Y - vector1.Y * vector2.X;
  94                 }
  95
  96                 public static double Determinant (Vector vector1, Vector vector2)
  97                 {
  98                         // same as CrossProduct, it appears.
  99                         return vector1.X * vector2.Y - vector1.Y * vector2.X;
 100                 }
 101
 102                 public static Vector Divide (Vector vector, double scalar)
 103                 {
 104                         return new Vector (vector.X / scalar, vector.Y / scalar);
 105                 }
 106
 107                 public static double Multiply (Vector vector1, Vector vector2)
 108                 {
 109                         return vector1.X * vector2.X + vector1.Y * vector2.Y;
 110                 }
 111
 112                 public static Vector Multiply (Vector vector, Matrix matrix)
 113                 {
 114                         return new Vector (vector.X * matrix.M11 + vector.Y * matrix.M21,
 115                                            vector.X * matrix.M12 + vector.Y * matrix.M22);
 116                 }
 117
 118                 public static Vector Multiply (double scalar, Vector vector)
 119                 {
 120                         return new Vector (scalar * vector.X, scalar * vector.Y);
 121                 }
 122
 123                 public static Vector Multiply (Vector vector, double scalar)
 124                 {
 125                         return new Vector (scalar * vector.X, scalar * vector.Y);
 126                 }
 127
 128                 public void Negate ()
 129                 {
 130                         x = -x;
 131                         y = -y;
 132                 }
 133
 134                 public void Normalize ()
 135                 {
 136                         double ls = LengthSquared;
 137                         if (ls == 1)
 138                                 return;
 139
 140                         double l = Math.Sqrt (ls);
 141                         x /= l;
 142                         y /= l;
 143                 }
 144
 145                 public static Vector Subtract (Vector vector1, Vector vector2)
 146                 {
 147                         return new Vector (vector1.X - vector2.X, vector1.Y - vector2.Y);
 148                 }
 149
 150                 public static Vector Parse (string source)
 151                 {
 152                         throw new NotImplementedException ();
 153                 }
 154
 155                 public override string ToString ()
 156                 {
 157                         return String.Format ("{0},{1}", x, y);
 158                 }
 159
 160                 public string ToString (IFormatProvider provider)
 161                 {
 162                         throw new NotImplementedException ();
 163                 }
 164
 165                 public double Length {
 166                         get { return Math.Sqrt (LengthSquared); }
 167                 }
 168
 169                 public double LengthSquared {
 170                         get { return x * x + y * y; }
 171                 }
 172
 173                 public double X {
 174                         get { return x; }
 175                         set { x = value; }
 176                 }
 177
 178                 public double Y {
 179                         get { return y; }
 180                         set { y = value; }
 181                 }
 182
 183                 /* operators */
 184                 public static explicit operator Point (Vector vector)
 185                 {
 186                         return new Point (vector.X, vector.Y);
 187                 }
 188
 189                 public static explicit operator Size (Vector vector)
 190                 {
 191                         return new Size (vector.X, vector.Y);
 192                 }
 193
 194                 public static Vector operator - (Vector vector1, Vector vector2)
 195                 {
 196                         return Subtract (vector1, vector2);
 197                 }
 198
 199                 public static Vector operator - (Vector vector)
 200                 {
 201                         Vector result = vector;
 202                         result.Negate ();
 203                         return result;
 204                 }
 205
 206                 public static bool operator != (Vector vector1, Vector vector2)
 207                 {
 208                         return !Equals (vector1, vector2);
 209                 }
 210
 211                 public static bool operator == (Vector vector1, Vector vector2)
 212                 {
 213                         return Equals (vector1, vector2);
 214                 }
 215
 216                 public static double operator * (Vector vector1, Vector vector2)
 217                 {
 218                         return Multiply (vector1, vector2);
 219                 }
 220
 221                 public static Vector operator * (Vector vector, Matrix matrix)
 222                 {
 223                         return Multiply (vector, matrix);
 224                 }
 225
 226                 public static Vector operator * (double scalar, Vector vector)
 227                 {
 228                         return Multiply (scalar, vector);
 229                 }
 230
 231                 public static Vector operator * (Vector vector, double scalar)
 232                 {
 233                         return Multiply (vector, scalar);
 234                 }
 235
 236                 public static Vector operator / (Vector vector, double scalar)
 237                 {
 238                         return Divide (vector, scalar);
 239                 }
 240
 241                 public static Point operator + (Vector vector, Point point)
 242                 {
 243                         return Add (vector, point);
 244                 }
 245
 246                 public static Vector operator + (Vector vector1, Vector vector2)
 247                 {
 248                         return Add (vector1, vector2);
 249                 }
 250
 251                 double x;
 252                 double y;
 253         }
 254
 255 }