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