1 #ifndef __DALI_LIGHT_H__
2 #define __DALI_LIGHT_H__
5 * Copyright (c) 2014 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
25 #include <dali/public-api/object/base-handle.h>
29 * The top level DALi namespace
31 namespace Dali DALI_IMPORT_API
34 namespace Internal DALI_INTERNAL
42 * @brief Light source types.
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)
53 * @brief Encapsulates the data describing a light source.
55 class Light : public BaseHandle
59 * @brief Create an initialized Light.
61 * @param[in] name The light's name
62 * @return A handle to a newly allocated Dali resource.
64 static Light New(const std::string& name);
67 * @brief Downcast an Object handle to Light handle.
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
74 static Light DownCast( BaseHandle handle );
77 * @brief Create an uninitialized light; this can be initialized with Light::New().
79 * Calling member functions with an uninitialized Dali::Object is not allowed.
86 * @brief Virtual destructor.
91 * @copydoc Dali::BaseHandle::operator=
93 using BaseHandle::operator=;
96 * @brief Set the light's name.
98 * @param[in] name The light's name
100 void SetName(const std::string& name);
103 * @brief Get the light's name.
105 * @return The light's name
107 const std::string& GetName() const;
110 * @brief Set the light's type.
112 * @param[in] type The type of light
114 void SetType(LightType type);
117 * @brief Get the lights type.
119 * @return The light's type
121 LightType GetType() const;
124 * @brief Set the distances at which the light's intensity starts to fall off and reaches zero.
126 * @param[in] fallOff The fall off start and end. The start is in the x component and end is in the y component.
128 void SetFallOff(const Vector2& fallOff);
131 * @brief Get the distances at which the light's intensity starts to fall off and reaches zero.
133 * @return The distances at which the light's intensity starts to fall off, and reaches zero.
134 * See @ref SetFallOff
136 const Vector2& GetFallOff() const;
139 * @brief Set the spotlight's inner and outer cone angles.
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.
144 void SetSpotAngle(const Vector2& angle);
147 * @brief Get the spotlight's inner and outer cone angles.
149 * @return The spotlight's inner and outer cone angles
151 const Vector2& GetSpotAngle() const;
154 * @brief Set the ambient color for the light.
156 * The color is composed of rgb
157 * @param[in] color The color to set.
159 void SetAmbientColor(const Vector3& color);
162 * @brief Get the light's ambient color.
164 * @return the light's color as rgb
166 const Vector3& GetAmbientColor() const;
169 * @brief Set the diffuse color for the light.
171 * The color is composed of rgb
172 * @param[in] color The color to set.
174 void SetDiffuseColor(const Vector3& color);
177 * @brief Get the light's ambient color.
179 * @return the light's color as rgb
181 const Vector3& GetDiffuseColor() const;
184 * @brief Set the specular color for the light.
186 * The color is composed of rgb
187 * @param[in] color The color to set.
189 void SetSpecularColor(const Vector3& color);
192 * @brief Get the light's specular color.
194 * @return the light's specular color as rgb
196 const Vector3& GetSpecularColor() const;
199 * @brief Set the direction in which the light's rays are cast.
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.
204 void SetDirection(const Vector3& direction);
207 * @brief Get the direction in which the light's rays are cast.
209 * Valid when the light's type is DIRECTIONAL (see @ref LightType).
210 * @return The direction in which the light's rays are cast.
212 const Vector3& GetDirection() const;
214 public: // Not intended for application developers
217 * @brief This constructor is used by Dali New() methods.
219 * @param [in] light A pointer to a newly allocated Dali resource
221 explicit DALI_INTERNAL Light(Internal::Light* light);
226 #endif // __DALI_LIGHT_H__