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 Flora License, Version 1.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://floralicense.org/license/
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.
21 * @addtogroup CAPI_DALI_TOOLKIT_SHADER_EFFECTS_MODULE
26 #include <dali/dali.h>
28 namespace Dali DALI_IMPORT_API
35 * @brief SwirlEffect is a custom shader effect to achieve swirl effects in Image actors.
37 class SwirlEffect : public ShaderEffect
42 * @brief Create an uninitialized SwirlEffect; this can be initialized with SwirlEffect::New().
44 * Calling member functions with an uninitialized Dali::Object is not allowed.
49 * @brief Virtual destructor.
51 virtual ~SwirlEffect();
54 * @brief Create an initialized SwirlEffect.
56 * @param[in] warp True if the effect should warp.
57 * @return A handle to a newly allocated Dali resource.
59 static SwirlEffect New(bool warp);
62 * @brief Set the angle of the swirl.
64 * @param[in] angle The angle in float.
66 void SetAngle(float angle);
69 * @brief Set the center of the swirl.
71 * @param[in] center The center in Vector2.
73 void SetCenter(const Vector2& center);
76 * @brief Set the radius of the swirl.
78 * @param[in] radius The radius in float.
80 void SetRadius(float radius);
83 * @brief Get the name for the angle property.
85 * @return A std::string containing the property name
87 const std::string& GetAnglePropertyName() const;
90 * @brief Get the name for the center property.
92 * @return A std::string containing the property name
94 const std::string& GetCenterPropertyName() const;
97 * @brief Get the name for the radius property.
99 * @return A std::string containing the property name
101 const std::string& GetRadiusPropertyName() const;
103 private: // Not intended for application developers
104 SwirlEffect(ShaderEffect handle);
107 } // namespace Toolkit
114 #endif // __DALI_TOOLKIT_SHADER_EFFECT_SWIRL_H__