optional/dali-toolkit/public-api/shader-effects/shear-effect.h

   1 #ifndef __DALI_TOOLKIT_SHEAR_EFFECT_H__
   2 #define __DALI_TOOLKIT_SHEAR_EFFECT_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  * ShearEffect is a custom shader effect to achieve shear effects in Image actors
  31  */
  32 class ShearEffect : public ShaderEffect
  33 {
  34 public:
  35
  36   /**
  37    * Create an uninitialized ShearEffect; this can be initialized with ShearEffect::New()
  38    * Calling member functions with an uninitialized Dali::Object is not allowed.
  39    */
  40   ShearEffect();
  41
  42   /**
  43    * Virtual destructor.
  44    */
  45   virtual ~ShearEffect();
  46
  47   /**
  48    * Create an initialized ShearEffect.
  49    * @return A handle to a newly allocated Dali resource.
  50    */
  51   static ShearEffect New();
  52
  53   /**
  54    * Set the center point of the shear effect in screen coordinates.
  55    * @param [in] center The new center point.
  56    */
  57   void SetCenter(const Vector2& center);
  58
  59   /**
  60    * Set the angle of the shear effect in the X axis.
  61    * @param [in] angle The new angle.
  62    */
  63   void SetAngleXAxis(float angle);
  64
  65   /**
  66    * Set the angle of the shear effect in the Y axis.
  67    * @param [in] angle The new angle.
  68    */
  69   void SetAngleYAxis(float angle);
  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 X axis property
  79    * @return A std::string containing the property name
  80    */
  81   const std::string& GetAngleXAxisPropertyName() const;
  82
  83   /**
  84    * Get the name for the Y axis property
  85    * @return A std::string containing the property name
  86    */
  87   const std::string& GetAngleYAxisPropertyName() const;
  88
  89
  90 private: // Not intended for application developers
  91   ShearEffect(ShaderEffect handle);
  92 };
  93
  94 } // namespace Toolkit
  95
  96 } // namespace Dali
  97
  98 #endif // __DALI_TOOLKIT_SHEAR_EFFECT_H__