SlimDXc_Jun2010(VC++2008)/source/direct3d9/Light.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 "../math/Color4.h"\r
  25 #include "../math/Vector3.h"\r
  26 \r
  27 #include "Enums.h"\r
  28 \r
  29 namespace SlimDX\r
  30 {\r
  31         namespace Direct3D9\r
  32         {\r
  33                 /// <summary>Defines a set of lighting properties.</summary>\r
  34                 /// <unmanaged>D3DLIGHT9</unmanaged>\r
  35                 [System::Runtime::InteropServices::StructLayout( System::Runtime::InteropServices::LayoutKind::Sequential )]\r
  36                 public value class Light : System::IEquatable<Light>\r
  37                 {\r
  38                 public:\r
  39                         /// <summary>\r
  40                         /// Gets or sets the type of the light source.\r
  41                         /// </summary>\r
  42                         property LightType Type;\r
  43 \r
  44                         /// <summary>\r
  45                         /// Gets or sets the diffuse color of the light.\r
  46                         /// </summary>\r
  47                         property Color4 Diffuse;\r
  48 \r
  49                         /// <summary>\r
  50                         /// Gets or sets the specular color of the light.\r
  51                         /// </summary>\r
  52                         property Color4 Specular;\r
  53 \r
  54                         /// <summary>\r
  55                         /// Gets or sets the ambient color of the light.\r
  56                         /// </summary>\r
  57                         property Color4 Ambient;\r
  58 \r
  59                         /// <summary>\r
  60                         /// Gets or sets the position of the light in world space. This member does not affect directional lights.\r
  61                         /// </summary>\r
  62                         property Vector3 Position;\r
  63 \r
  64                         /// <summary>\r
  65                         /// Gets or sets the direction of the light. This vector need not be normalized, but should have a non-zero length.\r
  66                         /// </summary>\r
  67                         property Vector3 Direction;\r
  68 \r
  69                         /// <summary>\r
  70                         /// Gets or sets the distance beyond which the light has no effect. This member does not affect directional lights.\r
  71                         /// </summary>\r
  72                         property float Range;\r
  73 \r
  74                         /// <summary>\r
  75                         /// Gets or sets the decrease in illumination between a spotlight's inner cone and the outer edge of the outer cone.\r
  76                         /// </summary>\r
  77                         property float Falloff;\r
  78 \r
  79                         /// <summary>\r
  80                         /// Gets or sets the first value in the equation that determines how the light intensity changes over distance.\r
  81                         /// </summary>\r
  82                         property float Attenuation0;\r
  83 \r
  84                         /// <summary>\r
  85                         /// Gets or sets the second value in the equation that determines how the light intensity changes over distance.\r
  86                         /// </summary>\r
  87                         property float Attenuation1;\r
  88 \r
  89                         /// <summary>\r
  90                         /// Gets or sets the third value in the equation that determines how the light intensity changes over distance.\r
  91                         /// </summary>\r
  92                         property float Attenuation2;\r
  93 \r
  94                         /// <summary>\r
  95                         /// Gets or sets angle, in radians, of the spotlight's inner cone.\r
  96                         /// </summary>\r
  97                         property float Theta;\r
  98 \r
  99                         /// <summary>\r
 100                         /// Gets or sets the angle, in radians, of the spotlight's outer cone.\r
 101                         /// </summary>\r
 102                         property float Phi;\r
 103 \r
 104                         /// <summary>\r
 105                         /// Tests for equality between two objects.\r
 106                         /// </summary>\r
 107                         /// <param name="left">The first value to compare.</param>\r
 108                         /// <param name="right">The second value to compare.</param>\r
 109                         /// <returns><c>true</c> if <paramref name="left"/> has the same value as <paramref name="right"/>; otherwise, <c>false</c>.</returns>\r
 110                         static bool operator == ( Light left, Light right );\r
 111 \r
 112                         /// <summary>\r
 113                         /// Tests for inequality between two objects.\r
 114                         /// </summary>\r
 115                         /// <param name="left">The first value to compare.</param>\r
 116                         /// <param name="right">The second value to compare.</param>\r
 117                         /// <returns><c>true</c> if <paramref name="left"/> has a different value than <paramref name="right"/>; otherwise, <c>false</c>.</returns>\r
 118                         static bool operator != ( Light left, Light right );\r
 119 \r
 120                         /// <summary>\r
 121                         /// Returns the hash code for this instance.\r
 122                         /// </summary>\r
 123                         /// <returns>A 32-bit signed integer hash code.</returns>\r
 124                         virtual int GetHashCode() override;\r
 125 \r
 126                         /// <summary>\r
 127                         /// Returns a value that indicates whether the current instance is equal to a specified object. \r
 128                         /// </summary>\r
 129                         /// <param name="obj">Object to make the comparison with.</param>\r
 130                         /// <returns><c>true</c> if the current instance is equal to the specified object; <c>false</c> otherwise.</returns>\r
 131                         virtual bool Equals( System::Object^ obj ) override;\r
 132 \r
 133                         /// <summary>\r
 134                         /// Returns a value that indicates whether the current instance is equal to the specified object. \r
 135                         /// </summary>\r
 136                         /// <param name="other">Object to make the comparison with.</param>\r
 137                         /// <returns><c>true</c> if the current instance is equal to the specified object; <c>false</c> otherwise.</returns>\r
 138                         virtual bool Equals( Light other );\r
 139 \r
 140                         /// <summary>\r
 141                         /// Determines whether the specified object instances are considered equal. \r
 142                         /// </summary>\r
 143                         /// <param name="value1">The first value to compare.</param>\r
 144                         /// <param name="value2">The second value to compare.</param>\r
 145                         /// <returns><c>true</c> if <paramref name="value1"/> is the same instance as <paramref name="value2"/> or \r
 146                         /// if both are <c>null</c> references or if <c>value1.Equals(value2)</c> returns <c>true</c>; otherwise, <c>false</c>.</returns>\r
 147                         static bool Equals( Light% value1, Light% value2 );\r
 148                 };\r
 149         }\r
 150 }