1 #ifndef __DALI_TOOLKIT_SHADER_EFFECT_RIPPLE_H__
2 #define __DALI_TOOLKIT_SHADER_EFFECT_RIPPLE_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 RippleEffect is a custom shader effect to achieve ripple effects on Image actors.
38 class RippleEffect : public ShaderEffect
43 * @brief Create an uninitialized RippleEffect; this can be initialized with RippleEffect::New().
45 * Calling member functions with an uninitialized Dali::Object is not allowed.
50 * @brief Virtual destructor.
52 virtual ~RippleEffect();
55 * @brief Create an initialized RippleEffect.
57 * @return A handle to a newly allocated Dali resource.
59 static RippleEffect New();
62 * @brief Set the amplitude of the effect.
64 * @param [in] amplitude The new amplitude.
66 void SetAmplitude(float amplitude);
69 * @brief Set the center point of the effect as screen coordinates.
71 * @param [in] center The new center point.
73 void SetCenter(const Vector2& center);
76 * @brief Set the time duration for the ripple.
78 * @param[in] time The time duration in float.
80 void SetTime(float time);
83 * @brief Get the name for the amplitude property.
85 * @return A std::string containing the property name
87 const std::string& GetAmplitudePropertyName() const;
90 * @brief Get the name for the center property.
92 * which can be used in Animation API's
93 * @return A std::string containing the property name
95 const std::string& GetCenterPropertyName() const;
98 * @brief Get the name for the time property.
100 * which can be used in Animation API's
101 * @return A std::string containing the property name
103 const std::string& GetTimePropertyName() const;
106 RippleEffect(ShaderEffect handle);
110 } // namespace Toolkit
117 #endif // __DALI_TOOLKIT_SHADER_EFFECT_RIPPLE_H__