dali-toolkit/public-api/shader-effects/swirl-effect.h

   1 #ifndef __DALI_TOOLKIT_SHADER_EFFECT_SWIRL_H__
   2 #define __DALI_TOOLKIT_SHADER_EFFECT_SWIRL_H__
   3
   4 /*
   5  * Copyright (c) 2015 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 // EXTERNAL INCLUDES
  22 #include <dali/public-api/shader-effects/shader-effect.h>
  23
  24 namespace Dali
  25 {
  26
  27 namespace Toolkit
  28 {
  29
  30 /**
  31  * @brief SwirlEffect is a custom shader effect to achieve swirl effects in Image actors.
  32  */
  33 class DALI_IMPORT_API SwirlEffect : public ShaderEffect
  34 {
  35 public:
  36
  37   /**
  38    * @brief Create an uninitialized SwirlEffect; this can be initialized with SwirlEffect::New().
  39    *
  40    * Calling member functions with an uninitialized Dali::Object is not allowed.
  41    */
  42   SwirlEffect();
  43
  44   /**
  45    * @brief Destructor
  46    *
  47    * This is non-virtual since derived Handle types must not contain data or virtual methods.
  48    */
  49   ~SwirlEffect();
  50
  51   /**
  52    * @brief Create an initialized SwirlEffect.
  53    *
  54    * @param[in] warp True if the effect should warp.
  55    * @return A handle to a newly allocated Dali resource.
  56    */
  57   static SwirlEffect New(bool warp);
  58
  59   /**
  60    * @brief Set the angle of the swirl.
  61    *
  62    * @param[in] angle The angle in float.
  63    */
  64   void SetAngle(float angle);
  65
  66   /**
  67    * @brief Set the center of the swirl.
  68    *
  69    * @param[in] center The center in Vector2.
  70    */
  71   void SetCenter(const Vector2& center);
  72
  73   /**
  74    * @brief Set the radius of the swirl.
  75    *
  76    * @param[in] radius The radius in float.
  77    */
  78   void SetRadius(float radius);
  79
  80   /**
  81    * @brief Get the name for the angle property.
  82    *
  83    * @return A std::string containing the property name
  84    */
  85   const std::string& GetAnglePropertyName() const;
  86
  87   /**
  88    * @brief Get the name for the center property.
  89    *
  90    * @return A std::string containing the property name
  91    */
  92   const std::string& GetCenterPropertyName() const;
  93
  94   /**
  95    * @brief Get the name for the radius property.
  96    *
  97    * @return A std::string containing the property name
  98    */
  99   const std::string& GetRadiusPropertyName() const;
 100
 101 private: // Not intended for application developers
 102   DALI_INTERNAL SwirlEffect(ShaderEffect handle);
 103 };
 104
 105 } // namespace Toolkit
 106
 107 } // namespace Dali
 108
 109 #endif // __DALI_TOOLKIT_SHADER_EFFECT_SWIRL_H__