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.
88 * This is non-virtual since derived Handle types must not contain data or virtual methods.
93 * @copydoc Dali::BaseHandle::operator=
95 using BaseHandle::operator=;
98 * @brief Set the light's name.
100 * @param[in] name The light's name
102 void SetName(const std::string& name);
105 * @brief Get the light's name.
107 * @return The light's name
109 const std::string& GetName() const;
112 * @brief Set the light's type.
114 * @param[in] type The type of light
116 void SetType(LightType type);
119 * @brief Get the lights type.
121 * @return The light's type
123 LightType GetType() const;
126 * @brief Set the distances at which the light's intensity starts to fall off and reaches zero.
128 * @param[in] fallOff The fall off start and end. The start is in the x component and end is in the y component.
130 void SetFallOff(const Vector2& fallOff);
133 * @brief Get the distances at which the light's intensity starts to fall off and reaches zero.
135 * @return The distances at which the light's intensity starts to fall off, and reaches zero.
136 * See @ref SetFallOff
138 const Vector2& GetFallOff() const;
141 * @brief Set the spotlight's inner and outer cone angles.
143 * @param[in] angle The spotlight's inner and outer cone angles.
144 * The inner is in the x component and outer is in the y component.
146 void SetSpotAngle(const Vector2& angle);
149 * @brief Get the spotlight's inner and outer cone angles.
151 * @return The spotlight's inner and outer cone angles
153 const Vector2& GetSpotAngle() const;
156 * @brief Set the ambient color for the light.
158 * The color is composed of rgb
159 * @param[in] color The color to set.
161 void SetAmbientColor(const Vector3& color);
164 * @brief Get the light's ambient color.
166 * @return the light's color as rgb
168 const Vector3& GetAmbientColor() const;
171 * @brief Set the diffuse color for the light.
173 * The color is composed of rgb
174 * @param[in] color The color to set.
176 void SetDiffuseColor(const Vector3& color);
179 * @brief Get the light's ambient color.
181 * @return the light's color as rgb
183 const Vector3& GetDiffuseColor() const;
186 * @brief Set the specular color for the light.
188 * The color is composed of rgb
189 * @param[in] color The color to set.
191 void SetSpecularColor(const Vector3& color);
194 * @brief Get the light's specular color.
196 * @return the light's specular color as rgb
198 const Vector3& GetSpecularColor() const;
201 * @brief Set the direction in which the light's rays are cast.
203 * Valid when the light's type is DIRECTIONAL (see @ref Dali::LightType).
204 * @param [in] direction The direction in which the light's rays are cast.
206 void SetDirection(const Vector3& direction);
209 * @brief Get the direction in which the light's rays are cast.
211 * Valid when the light's type is DIRECTIONAL (see @ref LightType).
212 * @return The direction in which the light's rays are cast.
214 const Vector3& GetDirection() const;
216 public: // Not intended for application developers
219 * @brief This constructor is used by Dali New() methods.
221 * @param [in] light A pointer to a newly allocated Dali resource
223 explicit DALI_INTERNAL Light(Internal::Light* light);
228 #endif // __DALI_LIGHT_H__