dali/public-api/common/light.h

   1 #ifndef __DALI_LIGHT_H__
   2 #define __DALI_LIGHT_H__
   3
   4 /*
   5  * Copyright (c) 2014 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <string>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali/public-api/object/base-handle.h>
  26
  27
  28 /**
  29  * The top level DALi namespace
  30  */
  31 namespace Dali DALI_IMPORT_API
  32 {
  33
  34 namespace Internal DALI_INTERNAL
  35 {
  36 class Light;
  37 }
  38
  39 class Light;
  40
  41 /**
  42  * @brief Light source types.
  43  */
  44 enum LightType
  45 {
  46   AMBIENT,        ///< Lights everything evenly
  47   DIRECTIONAL,    ///< Casts light evenly in a specific direction.
  48   SPOT,           ///< Casts light from a single point in the shape of a cone. Objects outside the cone are unlit. (EG: a search light)
  49   POINT           ///< Casts light outward from a single point in all directions. (EG: a light bulb)
  50 };
  51
  52 /**
  53  * @brief Encapsulates the data describing a light source.
  54  */
  55 class Light : public BaseHandle
  56 {
  57 public:
  58   /**
  59    * @brief Create an initialized Light.
  60    *
  61    * @param[in] name The light's name
  62    * @return A handle to a newly allocated Dali resource.
  63    */
  64   static Light New(const std::string& name);
  65
  66   /**
  67    * @brief Downcast an Object handle to Light handle.
  68    *
  69    * If handle points to a Light object the downcast produces valid
  70    * handle. If not the returned handle is left uninitialized.
  71    * @param[in] handle to An object
  72    * @return handle to a Light object or an uninitialized handle
  73    */
  74   static Light DownCast( BaseHandle handle );
  75
  76   /**
  77    * @brief Create an uninitialized light; this can be initialized with Light::New().
  78    *
  79    * Calling member functions with an uninitialized Dali::Object is not allowed.
  80    */
  81   Light()
  82   {
  83   }
  84
  85   /**
  86    * @brief Virtual destructor.
  87    */
  88   virtual ~Light();
  89
  90   /**
  91    * @copydoc Dali::BaseHandle::operator=
  92    */
  93   using BaseHandle::operator=;
  94
  95   /**
  96    * @brief Set the light's name.
  97    *
  98    * @param[in] name The light's name
  99    */
 100   void SetName(const std::string& name);
 101
 102   /**
 103    * @brief Get the light's name.
 104    *
 105    * @return The light's name
 106    */
 107   const std::string& GetName() const;
 108
 109   /**
 110    * @brief Set the light's type.
 111    *
 112    * @param[in] type The type of light
 113    */
 114   void SetType(LightType type);
 115
 116   /**
 117    * @brief Get the lights type.
 118    *
 119    * @return The light's type
 120    */
 121   LightType GetType() const;
 122
 123   /**
 124    * @brief Set the distances at which the light's intensity starts to fall off and reaches zero.
 125    *
 126    * @param[in] fallOff The fall off start and end. The start is in the x component and end is in the y component.
 127    */
 128   void SetFallOff(const Vector2& fallOff);
 129
 130   /**
 131    * @brief Get the distances at which the light's intensity starts to fall off and reaches zero.
 132    *
 133    * @return The distances at which the light's intensity starts to fall off, and reaches zero.
 134    * See @ref SetFallOff
 135    */
 136   const Vector2& GetFallOff() const;
 137
 138   /**
 139    * @brief Set the spotlight's inner and outer cone angles.
 140    *
 141    * @param[in] angle The spotlight's inner and outer cone angles.
 142    *                  The inner is in the x component and outer is in the y component.
 143    */
 144   void SetSpotAngle(const Vector2& angle);
 145
 146   /**
 147    * @brief Get the spotlight's inner and outer cone angles.
 148    *
 149    * @return The spotlight's inner and outer cone angles
 150    */
 151   const Vector2& GetSpotAngle() const;
 152
 153   /**
 154    * @brief Set the ambient color for the light.
 155    *
 156    * The color is composed of rgb
 157    * @param[in] color The color to set.
 158    */
 159   void SetAmbientColor(const Vector3& color);
 160
 161   /**
 162    * @brief Get the light's ambient color.
 163    *
 164    * @return the light's color as rgb
 165    */
 166   const Vector3& GetAmbientColor() const;
 167
 168   /**
 169    * @brief Set the diffuse color for the light.
 170    *
 171    * The color is composed of rgb
 172    * @param[in] color The color to set.
 173    */
 174   void SetDiffuseColor(const Vector3& color);
 175
 176   /**
 177    * @brief Get the light's ambient color.
 178    *
 179    * @return the light's color as rgb
 180    */
 181   const Vector3& GetDiffuseColor() const;
 182
 183   /**
 184    * @brief Set the specular color for the light.
 185    *
 186    * The color is composed of rgb
 187    * @param[in] color The color to set.
 188    */
 189   void SetSpecularColor(const Vector3& color);
 190
 191   /**
 192    * @brief Get the light's specular color.
 193    *
 194    * @return the light's specular color as rgb
 195    */
 196   const Vector3& GetSpecularColor() const;
 197
 198   /**
 199    * @brief Set the direction in which the light's rays are cast.
 200    *
 201    * Valid when the light's type is DIRECTIONAL (see @ref Dali::LightType).
 202    * @param [in] direction The direction in which the light's rays are cast.
 203    */
 204   void SetDirection(const Vector3& direction);
 205
 206   /**
 207    * @brief Get the direction in which the light's rays are cast.
 208    *
 209    * Valid when the light's type is DIRECTIONAL (see @ref LightType).
 210    * @return The direction in which the light's rays are cast.
 211    */
 212   const Vector3& GetDirection() const;
 213
 214 public: // Not intended for application developers
 215
 216   /**
 217    * @brief This constructor is used by Dali New() methods.
 218    *
 219    * @param [in] light A pointer to a newly allocated Dali resource
 220    */
 221   explicit DALI_INTERNAL Light(Internal::Light* light);
 222 };
 223
 224 } // namespace Dali
 225
 226 #endif // __DALI_LIGHT_H__