110401(DTXMania089)/SlimDXc_Jun2010(VC++2008)/source/xinput/State.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 "Gamepad.h"\r
  25 \r
  26 namespace SlimDX\r
  27 {\r
  28         namespace XInput\r
  29         {\r
  30                 /// <summary>\r
  31                 /// Represents the state of a controller.\r
  32                 /// </summary>\r
  33                 /// <unmanaged>XINPUT_STATE</unmanaged>\r
  34                 public value class State : System::IEquatable<State>\r
  35                 {\r
  36                 private:\r
  37                         System::UInt32 m_PacketNumber;\r
  38                         XInput::Gamepad m_Gamepad;\r
  39                 \r
  40                 internal:\r
  41                         State( const XINPUT_STATE& native );\r
  42                 \r
  43                 public:\r
  44                         /// <summary>\r
  45                         /// Gets the state packet number.\r
  46                         /// </summary>\r
  47                         /// <remarks>\r
  48                         /// The packet number indicates whether there have been any changes in the state of the controller. If the value\r
  49                         /// does not change in sequentially returned State structures, the controller state has not changed. \r
  50                         /// </remarks>\r
  51                         property System::UInt32 PacketNumber\r
  52                         {\r
  53                                 System::UInt32 get();\r
  54                         }\r
  55       \r
  56                         /// <summary>\r
  57                         /// Gets a <see cref="XInput::Gamepad"/> structure describing the current state of the gamepad.\r
  58                         /// </summary>\r
  59                         property XInput::Gamepad Gamepad\r
  60                         {\r
  61                                 XInput::Gamepad get();\r
  62                         }\r
  63 \r
  64                         /// <summary>\r
  65                         /// Tests for equality between two objects.\r
  66                         /// </summary>\r
  67                         /// <param name="left">The first value to compare.</param>\r
  68                         /// <param name="right">The second value to compare.</param>\r
  69                         /// <returns><c>true</c> if <paramref name="left"/> has the same value as <paramref name="right"/>; otherwise, <c>false</c>.</returns>\r
  70                         static bool operator == ( State left, State right );\r
  71 \r
  72                         /// <summary>\r
  73                         /// Tests for inequality 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 a different value than <paramref name="right"/>; otherwise, <c>false</c>.</returns>\r
  78                         static bool operator != ( State left, State right );\r
  79 \r
  80                         /// <summary>\r
  81                         /// Returns the hash code for this instance.\r
  82                         /// </summary>\r
  83                         /// <returns>A 32-bit signed integer hash code.</returns>\r
  84                         virtual int GetHashCode() override;\r
  85 \r
  86                         /// <summary>\r
  87                         /// Returns a value that indicates whether the current instance is equal to a specified object. \r
  88                         /// </summary>\r
  89                         /// <param name="obj">Object to make the comparison with.</param>\r
  90                         /// <returns><c>true</c> if the current instance is equal to the specified object; <c>false</c> otherwise.</returns>\r
  91                         virtual bool Equals( System::Object^ obj ) override;\r
  92 \r
  93                         /// <summary>\r
  94                         /// Returns a value that indicates whether the current instance is equal to the specified object. \r
  95                         /// </summary>\r
  96                         /// <param name="other">Object to make the comparison with.</param>\r
  97                         /// <returns><c>true</c> if the current instance is equal to the specified object; <c>false</c> otherwise.</returns>\r
  98                         virtual bool Equals( State other );\r
  99 \r
 100                         /// <summary>\r
 101                         /// Determines whether the specified object instances are considered equal. \r
 102                         /// </summary>\r
 103                         /// <param name="value1">The first value to compare.</param>\r
 104                         /// <param name="value2">The second value to compare.</param>\r
 105                         /// <returns><c>true</c> if <paramref name="value1"/> is the same instance as <paramref name="value2"/> or \r
 106                         /// if both are <c>null</c> references or if <c>value1.Equals(value2)</c> returns <c>true</c>; otherwise, <c>false</c>.</returns>\r
 107                         static bool Equals( State% value1, State% value2 );\r
 108                 };\r
 109         }\r
 110 }