SlimDXc_Jun2010(VC++2008)/source/directsound/Buffer3DSettings.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 "Enums.h"\r
  25 #include "../math/Vector3.h"\r
  26 \r
  27 namespace SlimDX\r
  28 {\r
  29         namespace DirectSound\r
  30         {\r
  31                 /// <summary>\r
  32                 /// Contains all information necessary to uniquely describe the location, orientation, and motion of a 3-D sound buffer.\r
  33                 /// </summary>\r
  34                 /// <unmanaged>DS3DBUFFER</unmanaged>\r
  35                 public value class Buffer3DSettings : System::IEquatable<Buffer3DSettings>\r
  36                 {\r
  37                 internal:\r
  38                         DS3DBUFFER ToUnmanaged();\r
  39                         Buffer3DSettings( const DS3DBUFFER& value );\r
  40 \r
  41                 public:\r
  42                         /// <summary>\r
  43                         /// Describes the current orientation of this 3-D buffer's sound projection cone.\r
  44                         /// </summary>\r
  45                         property Vector3 ConeOrientation;\r
  46 \r
  47                         /// <summary>\r
  48                         /// The cone outside volume.\r
  49                         /// </summary>\r
  50                         property int ConeOutsideVolume;\r
  51 \r
  52                         /// <summary>\r
  53                         /// The angle of the inside sound projection cone.\r
  54                         /// </summary>\r
  55                         property int InsideConeAngle;\r
  56 \r
  57                         /// <summary>\r
  58                         /// The maximum distance.\r
  59                         /// </summary>\r
  60                         property float MaxDistance;\r
  61 \r
  62                         /// <summary>\r
  63                         /// The minimum distance.\r
  64                         /// </summary>\r
  65                         property float MinDistance;\r
  66 \r
  67                         /// <summary>\r
  68                         /// The 3-D sound processing mode to be set.\r
  69                         /// </summary>\r
  70                         property Mode3D Mode;\r
  71 \r
  72                         /// <summary>\r
  73                         /// The angle of the outside sound projection cone.\r
  74                         /// </summary>\r
  75                         property int OutsideConeAngle;\r
  76 \r
  77                         /// <summary>\r
  78                         /// Describes the current position of the 3-D sound buffer.\r
  79                         /// </summary>\r
  80                         property Vector3 Position;\r
  81 \r
  82                         /// <summary>\r
  83                         /// Describes the current velocity of the 3-D sound buffer.\r
  84                         /// </summary>\r
  85                         property Vector3 Velocity;\r
  86 \r
  87                         /// <summary>\r
  88                         /// Tests for equality between two objects.\r
  89                         /// </summary>\r
  90                         /// <param name="left">The first value to compare.</param>\r
  91                         /// <param name="right">The second value to compare.</param>\r
  92                         /// <returns><c>true</c> if <paramref name="left"/> has the same value as <paramref name="right"/>; otherwise, <c>false</c>.</returns>\r
  93                         static bool operator == ( Buffer3DSettings left, Buffer3DSettings right );\r
  94 \r
  95                         /// <summary>\r
  96                         /// Tests for inequality between two objects.\r
  97                         /// </summary>\r
  98                         /// <param name="left">The first value to compare.</param>\r
  99                         /// <param name="right">The second value to compare.</param>\r
 100                         /// <returns><c>true</c> if <paramref name="left"/> has a different value than <paramref name="right"/>; otherwise, <c>false</c>.</returns>\r
 101                         static bool operator != ( Buffer3DSettings left, Buffer3DSettings right );\r
 102 \r
 103                         /// <summary>\r
 104                         /// Returns the hash code for this instance.\r
 105                         /// </summary>\r
 106                         /// <returns>A 32-bit signed integer hash code.</returns>\r
 107                         virtual int GetHashCode() override;\r
 108 \r
 109                         /// <summary>\r
 110                         /// Returns a value that indicates whether the current instance is equal to a specified object. \r
 111                         /// </summary>\r
 112                         /// <param name="obj">Object to make the comparison with.</param>\r
 113                         /// <returns><c>true</c> if the current instance is equal to the specified object; <c>false</c> otherwise.</returns>\r
 114                         virtual bool Equals( System::Object^ obj ) override;\r
 115 \r
 116                         /// <summary>\r
 117                         /// Returns a value that indicates whether the current instance is equal to the specified object. \r
 118                         /// </summary>\r
 119                         /// <param name="other">Object to make the comparison with.</param>\r
 120                         /// <returns><c>true</c> if the current instance is equal to the specified object; <c>false</c> otherwise.</returns>\r
 121                         virtual bool Equals( Buffer3DSettings other );\r
 122 \r
 123                         /// <summary>\r
 124                         /// Determines whether the specified object instances are considered equal. \r
 125                         /// </summary>\r
 126                         /// <param name="value1">The first value to compare.</param>\r
 127                         /// <param name="value2">The second value to compare.</param>\r
 128                         /// <returns><c>true</c> if <paramref name="value1"/> is the same instance as <paramref name="value2"/> or \r
 129                         /// if both are <c>null</c> references or if <c>value1.Equals(value2)</c> returns <c>true</c>; otherwise, <c>false</c>.</returns>\r
 130                         static bool Equals( Buffer3DSettings% value1, Buffer3DSettings% value2 );\r
 131                 };\r
 132         }\r
 133 }