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

   1 #ifndef __DALI_TOOLKIT_SHADER_EFFECT_BENDY_H__
   2 #define __DALI_TOOLKIT_SHADER_EFFECT_BENDY_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 // INTERNAL INCLUDES
  21 #include <dali/dali.h>
  22
  23 namespace Dali DALI_IMPORT_API
  24 {
  25
  26 namespace Toolkit
  27 {
  28
  29 /**
  30  * BendyEffect is a custom shader effect to achieve bendy effects in Image actors
  31  */
  32 class BendyEffect : public ShaderEffect
  33 {
  34 public:
  35
  36   /**
  37    * Create an uninitialized BendyEffect; this can be initialized with BendyEffect::New()
  38    * Calling member functions with an uninitialized Dali::Object is not allowed.
  39    */
  40   BendyEffect();
  41
  42   /**
  43    * Virtual destructor.
  44    */
  45   virtual ~BendyEffect();
  46
  47   /**
  48    * Create an initialized BendyEffect.
  49    * @return A handle to a newly allocated Dali resource.
  50    */
  51   static BendyEffect New();
  52
  53   /**
  54    * Set the center point of the bendy effect.
  55    * @param [in] center The new center point.
  56    */
  57   void SetCenter(const Vector2& center);
  58
  59   /**
  60    * Set the direction of the bendy effect.
  61    * @param [in] direction The new direction.
  62    */
  63   void SetDirection(const Vector2& direction);
  64
  65   /**
  66    * Set the radius of the bendy effect.
  67    * @param [in] radius The new radius.
  68    */
  69   void SetRadius(float radius);
  70
  71   /**
  72    * Get the name for the center property
  73    * @return A std::string containing the property name
  74    */
  75   const std::string& GetCenterPropertyName() const;
  76
  77   /**
  78    * Get the name for the direction property
  79    * which can be used in Animation API's
  80    * @return A std::string containing the property name
  81    */
  82   const std::string& GetDirectionPropertyName() const;
  83
  84   /**
  85    * Get the name for the radius property
  86    * which can be used in Animation API's
  87    * @return A std::string containing the property name
  88    */
  89   const std::string& GetRadiusPropertyName() const;
  90
  91
  92 private: // Not intended for application developers
  93   BendyEffect(ShaderEffect handle);
  94 };
  95
  96 } // namespace Toolkit
  97
  98 } // namespace Dali
  99
 100 #endif // __DALI_TOOLKIT_SHADER_EFFECT_BENDY_H__