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