1 #ifndef __DALI_TOOLKIT_SHADER_EFFECT_SWIRL_H__
2 #define __DALI_TOOLKIT_SHADER_EFFECT_SWIRL_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.
22 * @addtogroup CAPI_DALI_TOOLKIT_SHADER_EFFECTS_MODULE
27 #include <dali/dali.h>
29 namespace Dali DALI_IMPORT_API
36 * @brief SwirlEffect is a custom shader effect to achieve swirl effects in Image actors.
38 class SwirlEffect : public ShaderEffect
43 * @brief Create an uninitialized SwirlEffect; this can be initialized with SwirlEffect::New().
45 * Calling member functions with an uninitialized Dali::Object is not allowed.
50 * @brief Virtual destructor.
52 virtual ~SwirlEffect();
55 * @brief Create an initialized SwirlEffect.
57 * @param[in] warp True if the effect should warp.
58 * @return A handle to a newly allocated Dali resource.
60 static SwirlEffect New(bool warp);
63 * @brief Set the angle of the swirl.
65 * @param[in] angle The angle in float.
67 void SetAngle(float angle);
70 * @brief Set the center of the swirl.
72 * @param[in] center The center in Vector2.
74 void SetCenter(const Vector2& center);
77 * @brief Set the radius of the swirl.
79 * @param[in] radius The radius in float.
81 void SetRadius(float radius);
84 * @brief Get the name for the angle property.
86 * @return A std::string containing the property name
88 const std::string& GetAnglePropertyName() const;
91 * @brief Get the name for the center property.
93 * @return A std::string containing the property name
95 const std::string& GetCenterPropertyName() const;
98 * @brief Get the name for the radius property.
100 * @return A std::string containing the property name
102 const std::string& GetRadiusPropertyName() const;
104 private: // Not intended for application developers
105 SwirlEffect(ShaderEffect handle);
108 } // namespace Toolkit
115 #endif // __DALI_TOOLKIT_SHADER_EFFECT_SWIRL_H__