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.
52 * This is non-virtual since derived Handle types must not contain data or virtual methods.
57 * @brief Create an initialized RippleEffect.
59 * @return A handle to a newly allocated Dali resource.
61 static RippleEffect New();
64 * @brief Set the amplitude of the effect.
66 * @param [in] amplitude The new amplitude.
68 void SetAmplitude(float amplitude);
71 * @brief Set the center point of the effect as screen coordinates.
73 * @param [in] center The new center point.
75 void SetCenter(const Vector2& center);
78 * @brief Set the time duration for the ripple.
80 * @param[in] time The time duration in float.
82 void SetTime(float time);
85 * @brief Get the name for the amplitude property.
87 * @return A std::string containing the property name
89 const std::string& GetAmplitudePropertyName() const;
92 * @brief Get the name for the center property.
94 * which can be used in Animation API's
95 * @return A std::string containing the property name
97 const std::string& GetCenterPropertyName() const;
100 * @brief Get the name for the time property.
102 * which can be used in Animation API's
103 * @return A std::string containing the property name
105 const std::string& GetTimePropertyName() const;
108 RippleEffect(ShaderEffect handle);
112 } // namespace Toolkit
119 #endif // __DALI_TOOLKIT_SHADER_EFFECT_RIPPLE_H__