dali-toolkit/public-api/shader-effects/square-dissolve-effect.h

   1 #ifndef __DALI_TOOLKIT_SHADER_EFFECT_SQUARE_H__
   2 #define __DALI_TOOLKIT_SHADER_EFFECT_SQUARE_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  * SquareDissolveEffect is a custom shader effect to achieve square effects in Image actors
  31  */
  32 class SquareDissolveEffect : public ShaderEffect
  33 {
  34 public:
  35
  36   /**
  37    * Create an uninitialized SquareDissolveEffect; this can be initialized with BendyEffect::New()
  38    * Calling member functions with an uninitialized Dali::Object is not allowed.
  39    */
  40   SquareDissolveEffect();
  41
  42   /**
  43    * Virtual destructor.
  44    */
  45   virtual ~SquareDissolveEffect();
  46
  47   /**
  48    * Create an initialized SquareDissolveEffect.
  49    * @return A handle to a newly allocated Dali resource.
  50    */
  51   static SquareDissolveEffect New();
  52
  53   /**
  54    * Set the step of the square effect.
  55    * @param [in] step the new step.
  56    */
  57   void SetStep(float step);
  58
  59   /**
  60    * Set the rows of the square dissolve effect.
  61    * @param [in] rows the new rows value.
  62    */
  63   void SetRows(float rows);
  64
  65   /**
  66    * Set the columns of the square dissolve effect.
  67    * @param [in] columns the new columns value.
  68    */
  69   void SetColumns(float columns);
  70
  71   /**
  72    * Set the texture size of the square dissolve.
  73    * @param[in] textureSize The texture size in Vector2.
  74    */
  75   void SetTextureSize(const Vector2& textureSize);
  76
  77   /**
  78    * Get the name for the step property
  79    * which can be used in Animation API's
  80    * @return A std::string containing the property name
  81    */
  82   const std::string& GetStepPropertyName() const;
  83
  84   /**
  85    * Get the name for the rows property
  86    * which can be used in Animation API's
  87    * @return A std::string containing the property name
  88    */
  89   const std::string& GetRowsPropertyName() const;
  90
  91   /**
  92    * Get the name for the columns property
  93    * which can be used in Animation API's
  94    * @return A std::string containing the property name
  95    */
  96   const std::string& GetColumnsPropertyName() const;
  97
  98   /**
  99    * Get the name for the texSize property
 100    * which can be used in Animation API's
 101    * @return A std::string containing the property name
 102    */
 103   const std::string& GetTexSizePropertyName() const;
 104
 105 private: // Not intended for application developers
 106   SquareDissolveEffect(ShaderEffect handle);
 107 };
 108
 109 } // namespace Toolkit
 110
 111 } // namespace Dali
 112
 113 #endif // __DALI_TOOLKIT_SHADER_EFFECT_SQUARE_H__