capi/dali-toolkit/public-api/shader-effects/ripple-effect.h

   1 #ifndef __DALI_TOOLKIT_SHADER_EFFECT_RIPPLE_H__
   2 #define __DALI_TOOLKIT_SHADER_EFFECT_RIPPLE_H__
   3
   4 //
   5 // Copyright (c) 2014 Samsung Electronics Co., Ltd.
   6 //
   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
  10 //
  11 //     http://floralicense.org/license/
  12 //
  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.
  18 //
  19
  20 /**
  21  * @addtogroup CAPI_DALI_TOOLKIT_SHADER_EFFECTS_MODULE
  22  * @{
  23  */
  24
  25 // INTERNAL INCLUDES
  26 #include <dali/dali.h>
  27
  28 namespace Dali DALI_IMPORT_API
  29 {
  30
  31 namespace Toolkit
  32 {
  33
  34 /**
  35  * @brief RippleEffect is a custom shader effect to achieve ripple effects on Image actors.
  36  */
  37 class RippleEffect : public ShaderEffect
  38 {
  39 public:
  40
  41   /**
  42    * @brief Create an uninitialized RippleEffect; this can be initialized with RippleEffect::New().
  43    *
  44    * Calling member functions with an uninitialized Dali::Object is not allowed.
  45    */
  46   RippleEffect();
  47
  48   /**
  49    * @brief Virtual destructor.
  50    */
  51   virtual ~RippleEffect();
  52
  53   /**
  54    * @brief Create an initialized RippleEffect.
  55    *
  56    * @return A handle to a newly allocated Dali resource.
  57    */
  58   static RippleEffect New();
  59
  60   /**
  61    * @brief Set the amplitude of the effect.
  62    *
  63    * @param [in] amplitude The new amplitude.
  64    */
  65   void SetAmplitude(float amplitude);
  66
  67   /**
  68    * @brief Set the center point of the effect as screen coordinates.
  69    *
  70    * @param [in] center The new center point.
  71    */
  72   void SetCenter(const Vector2& center);
  73
  74   /**
  75    * @brief Set the time duration for the ripple.
  76    *
  77    * @param[in] time The time duration in float.
  78    */
  79   void SetTime(float time);
  80
  81   /**
  82    * @brief Get the name for the amplitude property.
  83    *
  84    * @return A std::string containing the property name
  85    */
  86   const std::string& GetAmplitudePropertyName() const;
  87
  88   /**
  89    * @brief Get the name for the center property.
  90    *
  91    * which can be used in Animation API's
  92    * @return A std::string containing the property name
  93    */
  94   const std::string& GetCenterPropertyName() const;
  95
  96   /**
  97    * @brief Get the name for the time property.
  98    *
  99    * which can be used in Animation API's
 100    * @return A std::string containing the property name
 101    */
 102   const std::string& GetTimePropertyName() const;
 103
 104 private:
 105   RippleEffect(ShaderEffect handle);
 106
 107 };
 108
 109 } // namespace Toolkit
 110
 111 } // namespace Dali
 112
 113 /**
 114  * @}
 115  */
 116 #endif // __DALI_TOOLKIT_SHADER_EFFECT_RIPPLE_H__