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