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