SlimDXc_Jun2010(VC++2008)/source/directsound/Buffer3DSettings.h

   1 /*
   2 * Copyright (c) 2007-2010 SlimDX Group
   3 *
   4 * Permission is hereby granted, free of charge, to any person obtaining a copy
   5 * of this software and associated documentation files (the "Software"), to deal
   6 * in the Software without restriction, including without limitation the rights
   7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   8 * copies of the Software, and to permit persons to whom the Software is
   9 * furnished to do so, subject to the following conditions:
  10 *
  11 * The above copyright notice and this permission notice shall be included in
  12 * all copies or substantial portions of the Software.
  13 *
  14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  20 * THE SOFTWARE.
  21 */
  22 #pragma once
  23
  24 #include "Enums.h"
  25 #include "../math/Vector3.h"
  26
  27 namespace SlimDX
  28 {
  29         namespace DirectSound
  30         {
  31                 /// <summary>
  32                 /// Contains all information necessary to uniquely describe the location, orientation, and motion of a 3-D sound buffer.
  33                 /// </summary>
  34                 /// <unmanaged>DS3DBUFFER</unmanaged>
  35                 public value class Buffer3DSettings : System::IEquatable<Buffer3DSettings>
  36                 {
  37                 internal:
  38                         DS3DBUFFER ToUnmanaged();
  39                         Buffer3DSettings( const DS3DBUFFER& value );
  40
  41                 public:
  42                         /// <summary>
  43                         /// Describes the current orientation of this 3-D buffer's sound projection cone.
  44                         /// </summary>
  45                         property Vector3 ConeOrientation;
  46
  47                         /// <summary>
  48                         /// The cone outside volume.
  49                         /// </summary>
  50                         property int ConeOutsideVolume;
  51
  52                         /// <summary>
  53                         /// The angle of the inside sound projection cone.
  54                         /// </summary>
  55                         property int InsideConeAngle;
  56
  57                         /// <summary>
  58                         /// The maximum distance.
  59                         /// </summary>
  60                         property float MaxDistance;
  61
  62                         /// <summary>
  63                         /// The minimum distance.
  64                         /// </summary>
  65                         property float MinDistance;
  66
  67                         /// <summary>
  68                         /// The 3-D sound processing mode to be set.
  69                         /// </summary>
  70                         property Mode3D Mode;
  71
  72                         /// <summary>
  73                         /// The angle of the outside sound projection cone.
  74                         /// </summary>
  75                         property int OutsideConeAngle;
  76
  77                         /// <summary>
  78                         /// Describes the current position of the 3-D sound buffer.
  79                         /// </summary>
  80                         property Vector3 Position;
  81
  82                         /// <summary>
  83                         /// Describes the current velocity of the 3-D sound buffer.
  84                         /// </summary>
  85                         property Vector3 Velocity;
  86
  87                         /// <summary>
  88                         /// Tests for equality between two objects.
  89                         /// </summary>
  90                         /// <param name="left">The first value to compare.</param>
  91                         /// <param name="right">The second value to compare.</param>
  92                         /// <returns><c>true</c> if <paramref name="left"/> has the same value as <paramref name="right"/>; otherwise, <c>false</c>.</returns>
  93                         static bool operator == ( Buffer3DSettings left, Buffer3DSettings right );
  94
  95                         /// <summary>
  96                         /// Tests for inequality between two objects.
  97                         /// </summary>
  98                         /// <param name="left">The first value to compare.</param>
  99                         /// <param name="right">The second value to compare.</param>
 100                         /// <returns><c>true</c> if <paramref name="left"/> has a different value than <paramref name="right"/>; otherwise, <c>false</c>.</returns>
 101                         static bool operator != ( Buffer3DSettings left, Buffer3DSettings right );
 102
 103                         /// <summary>
 104                         /// Returns the hash code for this instance.
 105                         /// </summary>
 106                         /// <returns>A 32-bit signed integer hash code.</returns>
 107                         virtual int GetHashCode() override;
 108
 109                         /// <summary>
 110                         /// Returns a value that indicates whether the current instance is equal to a specified object.
 111                         /// </summary>
 112                         /// <param name="obj">Object to make the comparison with.</param>
 113                         /// <returns><c>true</c> if the current instance is equal to the specified object; <c>false</c> otherwise.</returns>
 114                         virtual bool Equals( System::Object^ obj ) override;
 115
 116                         /// <summary>
 117                         /// Returns a value that indicates whether the current instance is equal to the specified object.
 118                         /// </summary>
 119                         /// <param name="other">Object to make the comparison with.</param>
 120                         /// <returns><c>true</c> if the current instance is equal to the specified object; <c>false</c> otherwise.</returns>
 121                         virtual bool Equals( Buffer3DSettings other );
 122
 123                         /// <summary>
 124                         /// Determines whether the specified object instances are considered equal.
 125                         /// </summary>
 126                         /// <param name="value1">The first value to compare.</param>
 127                         /// <param name="value2">The second value to compare.</param>
 128                         /// <returns><c>true</c> if <paramref name="value1"/> is the same instance as <paramref name="value2"/> or
 129                         /// if both are <c>null</c> references or if <c>value1.Equals(value2)</c> returns <c>true</c>; otherwise, <c>false</c>.</returns>
 130                         static bool Equals( Buffer3DSettings% value1, Buffer3DSettings% value2 );
 131                 };
 132         }
 133 }