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 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 // EXTERNAL INCLUDES
  22 #include <dali/public-api/shader-effects/shader-effect.h>
  23
  24 namespace Dali
  25 {
  26
  27 namespace Toolkit
  28 {
  29
  30 /**
  31  * ShearEffect is a custom shader effect to achieve shear effects in Image actors
  32  */
  33 class DALI_IMPORT_API ShearEffect : public ShaderEffect
  34 {
  35 public:
  36
  37   /**
  38    * Create an uninitialized ShearEffect; this can be initialized with ShearEffect::New()
  39    * Calling member functions with an uninitialized Dali::Object is not allowed.
  40    */
  41   ShearEffect();
  42
  43   /**
  44    * @brief Destructor
  45    *
  46    * This is non-virtual since derived Handle types must not contain data or virtual methods.
  47    */
  48   ~ShearEffect();
  49
  50   /**
  51    * Create an initialized ShearEffect.
  52    * @return A handle to a newly allocated Dali resource.
  53    */
  54   static ShearEffect New();
  55
  56   /**
  57    * Set the center point of the shear effect in screen coordinates.
  58    * @param [in] center The new center point.
  59    */
  60   void SetCenter(const Vector2& center);
  61
  62   /**
  63    * Set the angle of the shear effect in the X axis.
  64    * @param [in] angle The new angle.
  65    */
  66   void SetAngleXAxis(float angle);
  67
  68   /**
  69    * Set the angle of the shear effect in the Y axis.
  70    * @param [in] angle The new angle.
  71    */
  72   void SetAngleYAxis(float angle);
  73
  74   /**
  75    * Get the name for the center property
  76    * @return A std::string containing the property name
  77    */
  78   const std::string& GetCenterPropertyName() const;
  79
  80   /**
  81    * Get the name for the X axis property
  82    * @return A std::string containing the property name
  83    */
  84   const std::string& GetAngleXAxisPropertyName() const;
  85
  86   /**
  87    * Get the name for the Y axis property
  88    * @return A std::string containing the property name
  89    */
  90   const std::string& GetAngleYAxisPropertyName() const;
  91
  92
  93 private: // Not intended for application developers
  94   DALI_INTERNAL ShearEffect(ShaderEffect handle);
  95 };
  96
  97 } // namespace Toolkit
  98
  99 } // namespace Dali
 100
 101 #endif // __DALI_TOOLKIT_SHEAR_EFFECT_H__