110401(DTXMania089)/SlimDXc_Jun2010(VC++2008)/source/math/Half3.h

   1 /*\r
   2 * Copyright (c) 2007-2010 SlimDX Group\r
   3 * \r
   4 * Permission is hereby granted, free of charge, to any person obtaining a copy\r
   5 * of this software and associated documentation files (the "Software"), to deal\r
   6 * in the Software without restriction, including without limitation the rights\r
   7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\r
   8 * copies of the Software, and to permit persons to whom the Software is\r
   9 * furnished to do so, subject to the following conditions:\r
  10 * \r
  11 * The above copyright notice and this permission notice shall be included in\r
  12 * all copies or substantial portions of the Software.\r
  13 * \r
  14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
  15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\r
  16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\r
  17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\r
  18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\r
  19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\r
  20 * THE SOFTWARE.\r
  21 */\r
  22 #pragma once\r
  23 \r
  24 #include "../design/Half3Converter.h"\r
  25 \r
  26 using System::Runtime::InteropServices::OutAttribute;\r
  27 \r
  28 namespace SlimDX\r
  29 {\r
  30         /// <summary>\r
  31         /// Defines a three component vector, using half precision floating point coordinates.\r
  32         /// </summary>\r
  33         /// <unmanaged>D3DXVECTOR3_16F</unmanaged>\r
  34         [System::Serializable]\r
  35         [System::Runtime::InteropServices::StructLayout( System::Runtime::InteropServices::LayoutKind::Sequential )]\r
  36         [System::ComponentModel::TypeConverter( SlimDX::Design::Half3Converter::typeid )]\r
  37         public value class Half3 : System::IEquatable<Half3>\r
  38         {\r
  39         public:\r
  40                 /// <summary>\r
  41                 /// Gets or sets the X component of the vector.\r
  42                 /// </summary>\r
  43                 /// <value>The X component of the vector.</value>\r
  44                 Half X;\r
  45 \r
  46                 /// <summary>\r
  47                 /// Gets or sets the Y component of the vector.\r
  48                 /// </summary>\r
  49                 /// <value>The Y component of the vector.</value>\r
  50                 Half Y;\r
  51 \r
  52                 /// <summary>\r
  53                 /// Gets or sets the Z component of the vector.\r
  54                 /// </summary>\r
  55                 /// <value>The Z component of the vector.</value>\r
  56                 Half Z;\r
  57 \r
  58                 /// <summary>\r
  59                 /// Initializes a new instance of the <see cref="Half3"/> structure.\r
  60                 /// </summary>\r
  61                 /// <param name="value">The value to set for the X, Y, and Z components.</param>\r
  62                 Half3( Half value );\r
  63 \r
  64                 /// <summary>\r
  65                 /// Initializes a new instance of the <see cref="Half3"/> structure.\r
  66                 /// </summary>\r
  67                 /// <param name="x">The X component.</param>\r
  68                 /// <param name="y">The Y component.</param>\r
  69                 /// <param name="z">The Z component.</param>\r
  70                 Half3( Half x, Half y, Half z );\r
  71 \r
  72                 /// <summary>\r
  73                 /// Tests for equality between two objects.\r
  74                 /// </summary>\r
  75                 /// <param name="left">The first value to compare.</param>\r
  76                 /// <param name="right">The second value to compare.</param>\r
  77                 /// <returns><c>true</c> if <paramref name="left"/> has the same value as <paramref name="right"/>; otherwise, <c>false</c>.</returns>\r
  78                 static bool operator == ( Half3 left, Half3 right );\r
  79 \r
  80                 /// <summary>\r
  81                 /// Tests for inequality between two objects.\r
  82                 /// </summary>\r
  83                 /// <param name="left">The first value to compare.</param>\r
  84                 /// <param name="right">The second value to compare.</param>\r
  85                 /// <returns><c>true</c> if <paramref name="left"/> has a different value than <paramref name="right"/>; otherwise, <c>false</c>.</returns>\r
  86                 static bool operator != ( Half3 left, Half3 right );\r
  87 \r
  88                 /// <summary>\r
  89                 /// Returns the hash code for this instance.\r
  90                 /// </summary>\r
  91                 /// <returns>A 32-bit signed integer hash code.</returns>\r
  92                 virtual int GetHashCode() override;\r
  93 \r
  94                 /// <summary>\r
  95                 /// Returns a value that indicates whether the current instance is equal to a specified object. \r
  96                 /// </summary>\r
  97                 /// <param name="obj">Object to make the comparison with.</param>\r
  98                 /// <returns><c>true</c> if the current instance is equal to the specified object; <c>false</c> otherwise.</returns>\r
  99                 virtual bool Equals( System::Object^ obj ) override;\r
 100 \r
 101                 /// <summary>\r
 102                 /// Returns a value that indicates whether the current instance is equal to the specified object. \r
 103                 /// </summary>\r
 104                 /// <param name="other">Object to make the comparison with.</param>\r
 105                 /// <returns><c>true</c> if the current instance is equal to the specified object; <c>false</c> otherwise.</returns>\r
 106                 virtual bool Equals( Half3 other );\r
 107 \r
 108                 /// <summary>\r
 109                 /// Determines whether the specified object instances are considered equal. \r
 110                 /// </summary>\r
 111                 /// <param name="value1"></param>\r
 112                 /// <param name="value2"></param>\r
 113                 /// <returns><c>true</c> if <paramref name="value1"/> is the same instance as <paramref name="value2"/> or \r
 114                 /// if both are <c>null</c> references or if <c>value1.Equals(value2)</c> returns <c>true</c>; otherwise, <c>false</c>.</returns>\r
 115                 static bool Equals( Half3% value1, Half3% value2 );\r
 116         };\r
 117 }\r