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