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

   1 #ifndef __DALI_TOOLKIT_SHADER_EFFECT_RIPPLE2D_H__
   2 #define __DALI_TOOLKIT_SHADER_EFFECT_RIPPLE2D_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  * Ripple2DEffect is a custom shader effect to achieve 2d ripple effects on Image actors
  36  */
  37 class Ripple2DEffect : public ShaderEffect
  38 {
  39 public:
  40
  41   /**
  42    * Create an uninitialized Ripple2DEffect; this can be initialized with Ripple2DEffect::New()
  43    * Calling member functions with an uninitialized Dali::Object is not allowed.
  44    */
  45   Ripple2DEffect();
  46
  47   /**
  48    * Virtual destructor.
  49    */
  50   virtual ~Ripple2DEffect();
  51
  52   /**
  53    * Create an initialized Ripple2DEffect.
  54    * @return A handle to a newly allocated Dali resource.
  55    */
  56   static Ripple2DEffect New();
  57
  58   /**
  59    * Set the amplitude of the 2d ripple.
  60    * @param[in] amplitude The amplitude in float.
  61    */
  62   void SetAmplitude(float amplitude);
  63
  64   /**
  65    * Set the time duration for the 2d ripple.
  66    * @param[in] time The time duration in float.
  67    */
  68   void SetTime(float time);
  69
  70   /**
  71    * Get the name for the amplitude property
  72    * @return A std::string containing the property name
  73    */
  74   const std::string& GetAmplitudePropertyName() const;
  75
  76   /**
  77    * Get the name for the time property
  78    * which can be used in Animation API's
  79    * @return A std::string containing the property name
  80    */
  81   const std::string& GetTimePropertyName() const;
  82
  83 private:
  84   Ripple2DEffect(ShaderEffect handle);
  85
  86 };
  87
  88 } // namespace Toolkit
  89
  90 } // namespace Dali
  91
  92 /**
  93  * @}
  94  */
  95 #endif // __DALI_TOOLKIT_SHADER_EFFECT_RIPPLE2D_H__