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_FRAMEWORK
  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  * 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    * Create an uninitialized RippleEffect; this can be initialized with RippleEffect::New()
  43    * Calling member functions with an uninitialized Dali::Object is not allowed.
  44    */
  45   RippleEffect();
  46
  47   /**
  48    * Virtual destructor.
  49    */
  50   virtual ~RippleEffect();
  51
  52   /**
  53    * Create an initialized RippleEffect.
  54    * @return A handle to a newly allocated Dali resource.
  55    */
  56   static RippleEffect New();
  57
  58   /**
  59    * Set the amplitude of the effect.
  60    * @param [in] amplitude The new amplitude.
  61    */
  62   void SetAmplitude(float amplitude);
  63
  64   /**
  65    * Set the center point of the effect as screen coordinates.
  66    * @param [in] center The new center point.
  67    */
  68   void SetCenter(const Vector2& center);
  69
  70   /**
  71    * Set the time duration for the ripple.
  72    * @param[in] time The time duration in float.
  73    */
  74   void SetTime(float time);
  75
  76   /**
  77    * Get the name for the amplitude property
  78    * @return A std::string containing the property name
  79    */
  80   const std::string& GetAmplitudePropertyName() const;
  81
  82   /**
  83    * Get the name for the center property
  84    * which can be used in Animation API's
  85    * @return A std::string containing the property name
  86    */
  87   const std::string& GetCenterPropertyName() const;
  88
  89   /**
  90    * Get the name for the time property
  91    * which can be used in Animation API's
  92    * @return A std::string containing the property name
  93    */
  94   const std::string& GetTimePropertyName() const;
  95
  96 private:
  97   RippleEffect(ShaderEffect handle);
  98
  99 };
 100
 101 } // namespace Toolkit
 102
 103 } // namespace Dali
 104
 105 /**
 106  * @}
 107  */
 108 #endif // __DALI_TOOLKIT_SHADER_EFFECT_RIPPLE_H__