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