capi/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) 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 SwirlEffect is a custom shader effect to achieve swirl effects in Image actors.
  36  */
  37 class SwirlEffect : public ShaderEffect
  38 {
  39 public:
  40
  41   /**
  42    * @brief Create an uninitialized SwirlEffect; this can be initialized with SwirlEffect::New().
  43    *
  44    * Calling member functions with an uninitialized Dali::Object is not allowed.
  45    */
  46   SwirlEffect();
  47
  48   /**
  49    * @brief Virtual destructor.
  50    */
  51   virtual ~SwirlEffect();
  52
  53   /**
  54    * @brief Create an initialized SwirlEffect.
  55    *
  56    * @param[in] warp True if the effect should warp.
  57    * @return A handle to a newly allocated Dali resource.
  58    */
  59   static SwirlEffect New(bool warp);
  60
  61   /**
  62    * @brief Set the angle of the swirl.
  63    *
  64    * @param[in] angle The angle in float.
  65    */
  66   void SetAngle(float angle);
  67
  68   /**
  69    * @brief Set the center of the swirl.
  70    *
  71    * @param[in] center The center in Vector2.
  72    */
  73   void SetCenter(const Vector2& center);
  74
  75   /**
  76    * @brief Set the radius of the swirl.
  77    *
  78    * @param[in] radius The radius in float.
  79    */
  80   void SetRadius(float radius);
  81
  82   /**
  83    * @brief Get the name for the angle property.
  84    *
  85    * @return A std::string containing the property name
  86    */
  87   const std::string& GetAnglePropertyName() const;
  88
  89   /**
  90    * @brief Get the name for the center property.
  91    *
  92    * @return A std::string containing the property name
  93    */
  94   const std::string& GetCenterPropertyName() const;
  95
  96   /**
  97    * @brief Get the name for the radius property.
  98    *
  99    * @return A std::string containing the property name
 100    */
 101   const std::string& GetRadiusPropertyName() const;
 102
 103 private: // Not intended for application developers
 104   SwirlEffect(ShaderEffect handle);
 105 };
 106
 107 } // namespace Toolkit
 108
 109 } // namespace Dali
 110
 111 /**
 112  * @}
 113  */
 114 #endif // __DALI_TOOLKIT_SHADER_EFFECT_SWIRL_H__