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 Virtual destructor.
  51    */
  52   virtual ~SwirlEffect();
  53
  54   /**
  55    * @brief Create an initialized SwirlEffect.
  56    *
  57    * @param[in] warp True if the effect should warp.
  58    * @return A handle to a newly allocated Dali resource.
  59    */
  60   static SwirlEffect New(bool warp);
  61
  62   /**
  63    * @brief Set the angle of the swirl.
  64    *
  65    * @param[in] angle The angle in float.
  66    */
  67   void SetAngle(float angle);
  68
  69   /**
  70    * @brief Set the center of the swirl.
  71    *
  72    * @param[in] center The center in Vector2.
  73    */
  74   void SetCenter(const Vector2& center);
  75
  76   /**
  77    * @brief Set the radius of the swirl.
  78    *
  79    * @param[in] radius The radius in float.
  80    */
  81   void SetRadius(float radius);
  82
  83   /**
  84    * @brief Get the name for the angle property.
  85    *
  86    * @return A std::string containing the property name
  87    */
  88   const std::string& GetAnglePropertyName() const;
  89
  90   /**
  91    * @brief Get the name for the center property.
  92    *
  93    * @return A std::string containing the property name
  94    */
  95   const std::string& GetCenterPropertyName() const;
  96
  97   /**
  98    * @brief Get the name for the radius property.
  99    *
 100    * @return A std::string containing the property name
 101    */
 102   const std::string& GetRadiusPropertyName() const;
 103
 104 private: // Not intended for application developers
 105   SwirlEffect(ShaderEffect handle);
 106 };
 107
 108 } // namespace Toolkit
 109
 110 } // namespace Dali
 111
 112 /**
 113  * @}
 114  */
 115 #endif // __DALI_TOOLKIT_SHADER_EFFECT_SWIRL_H__