SlimDXc_Jun2010(VC++2008)/source/xinput/Vibration.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 namespace SlimDX\r
  25 {\r
  26         namespace XInput\r
  27         {\r
  28                 /// <summary>\r
  29                 /// Specifies motor speed levels for the vibration function of a controller.\r
  30                 /// </summary>\r
  31                 /// <remarks>\r
  32                 /// The left motor is the low-frequency rumble motor. The right motor is the high-frequency rumble motor. \r
  33                 /// The two motors are not the same, and they create different vibration effects.\r
  34                 /// </remarks>\r
  35                 /// <unmanaged>XINPUT_VIBRATION</unmanaged>\r
  36                 public value class Vibration : System::IEquatable<Vibration>\r
  37                 {\r
  38                 private:\r
  39                         System::UInt16 m_LeftMotorSpeed;\r
  40                         System::UInt16 m_RightMotorSpeed;\r
  41                 \r
  42                 internal:\r
  43                         Vibration( const XINPUT_VIBRATION& native );\r
  44                         \r
  45                         XINPUT_VIBRATION CreateNativeVersion();\r
  46                         \r
  47                 public:\r
  48                         /// <summary>\r
  49                         /// Gets or sets the left motor speed. \r
  50                         /// </summary>\r
  51                         /// <remarks>\r
  52                         /// Valid values are in the range 0 to 65,535. Zero signifies no motor use; 65,535 signifies 100% motor use.\r
  53                         /// </remarks>\r
  54                         property System::UInt16 LeftMotorSpeed\r
  55                         {\r
  56                                 System::UInt16 get();\r
  57                                 void set( System::UInt16 value );\r
  58                         }\r
  59 \r
  60                         /// <summary>\r
  61                         /// Gets or sets the right motor speed. \r
  62                         /// </summary>\r
  63                         /// <remarks>\r
  64                         /// Valid values are in the range 0 to 65,535. Zero signifies no motor use; 65,535 signifies 100% motor use.\r
  65                         /// </remarks>\r
  66                         property System::UInt16 RightMotorSpeed\r
  67                         {\r
  68                                 System::UInt16 get();\r
  69                                 void set( System::UInt16 value );\r
  70                         }\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 == ( Vibration left, Vibration 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 != ( Vibration left, Vibration 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( Vibration 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">The first value to compare.</param>\r
 112                         /// <param name="value2">The second value to compare.</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( Vibration% value1, Vibration% value2 );\r
 116                 };\r
 117         }\r
 118 }