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
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 DALI_IMPORT_API 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 * @brief This copy constructor is required for (smart) pointer semantics.
95 * @param [in] handle A reference to the copied handle
97 Light(const Light& handle);
100 * @brief This assignment operator is required for (smart) pointer semantics.
102 * @param [in] rhs A reference to the copied handle
103 * @return A reference to this
105 Light& operator=(const Light& rhs);
108 * @brief Set the light's name.
110 * @param[in] name The light's name
112 void SetName(const std::string& name);
115 * @brief Get the light's name.
117 * @return The light's name
119 const std::string& GetName() const;
122 * @brief Set the light's type.
124 * @param[in] type The type of light
126 void SetType(LightType type);
129 * @brief Get the lights type.
131 * @return The light's type
133 LightType GetType() const;
136 * @brief Set the distances at which the light's intensity starts to fall off and reaches zero.
138 * @param[in] fallOff The fall off start and end. The start is in the x component and end is in the y component.
140 void SetFallOff(const Vector2& fallOff);
143 * @brief Get the distances at which the light's intensity starts to fall off and reaches zero.
145 * @return The distances at which the light's intensity starts to fall off, and reaches zero.
146 * See @ref SetFallOff
148 const Vector2& GetFallOff() const;
151 * @brief Set the spotlight's inner and outer cone angles.
153 * @param[in] angle The spotlight's inner and outer cone angles.
154 * The inner is in the x component and outer is in the y component.
156 void SetSpotAngle(const Vector2& angle);
159 * @brief Get the spotlight's inner and outer cone angles.
161 * @return The spotlight's inner and outer cone angles
163 const Vector2& GetSpotAngle() const;
166 * @brief Set the ambient color for the light.
168 * The color is composed of rgb
169 * @param[in] color The color to set.
171 void SetAmbientColor(const Vector3& color);
174 * @brief Get the light's ambient color.
176 * @return the light's color as rgb
178 const Vector3& GetAmbientColor() const;
181 * @brief Set the diffuse color for the light.
183 * The color is composed of rgb
184 * @param[in] color The color to set.
186 void SetDiffuseColor(const Vector3& color);
189 * @brief Get the light's ambient color.
191 * @return the light's color as rgb
193 const Vector3& GetDiffuseColor() const;
196 * @brief Set the specular color for the light.
198 * The color is composed of rgb
199 * @param[in] color The color to set.
201 void SetSpecularColor(const Vector3& color);
204 * @brief Get the light's specular color.
206 * @return the light's specular color as rgb
208 const Vector3& GetSpecularColor() const;
211 * @brief Set the direction in which the light's rays are cast.
213 * Valid when the light's type is DIRECTIONAL (see @ref Dali::LightType).
214 * @param [in] direction The direction in which the light's rays are cast.
216 void SetDirection(const Vector3& direction);
219 * @brief Get the direction in which the light's rays are cast.
221 * Valid when the light's type is DIRECTIONAL (see @ref LightType).
222 * @return The direction in which the light's rays are cast.
224 const Vector3& GetDirection() const;
226 public: // Not intended for application developers
229 * @brief This constructor is used by Dali New() methods.
231 * @param [in] light A pointer to a newly allocated Dali resource
233 explicit DALI_INTERNAL Light(Internal::Light* light);
238 #endif // __DALI_LIGHT_H__