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