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_FRAMEWORK
26 #include <dali/dali.h>
28 namespace Dali DALI_IMPORT_API
35 * SwirlEffect is a custom shader effect to achieve swirl effects in Image actors
37 class SwirlEffect : public ShaderEffect
42 * Create an uninitialized SwirlEffect; this can be initialized with SwirlEffect::New()
43 * Calling member functions with an uninitialized Dali::Object is not allowed.
50 virtual ~SwirlEffect();
53 * Create an initialized SwirlEffect.
54 * @return A handle to a newly allocated Dali resource.
56 static SwirlEffect New(bool warp);
59 * Set the angle of the swirl.
60 * @param[in] angle The angle in float.
62 void SetAngle(float angle);
65 * Set the center of the swirl.
66 * @param[in] center The center in Vector2.
68 void SetCenter(const Vector2& center);
71 * Set the radius of the swirl.
72 * @param[in] radius The radius in float.
74 void SetRadius(float radius);
77 * Get the name for the angle property
78 * @return A std::string containing the property name
80 const std::string& GetAnglePropertyName() const;
83 * Get the name for the center property
84 * @return A std::string containing the property name
86 const std::string& GetCenterPropertyName() const;
89 * Get the name for the radius property
90 * @return A std::string containing the property name
92 const std::string& GetRadiusPropertyName() const;
94 private: // Not intended for application developers
95 SwirlEffect(ShaderEffect handle);
98 } // namespace Toolkit
105 #endif // __DALI_TOOLKIT_SHADER_EFFECT_SWIRL_H__