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 // INTERNAL INCLUDES
  22 #include <dali/dali.h>
  23
  24 namespace Dali DALI_IMPORT_API
  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 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    * Virtual destructor.
  45    */
  46   virtual ~ShearEffect();
  47
  48   /**
  49    * Create an initialized ShearEffect.
  50    * @return A handle to a newly allocated Dali resource.
  51    */
  52   static ShearEffect New();
  53
  54   /**
  55    * Set the center point of the shear effect in screen coordinates.
  56    * @param [in] center The new center point.
  57    */
  58   void SetCenter(const Vector2& center);
  59
  60   /**
  61    * Set the angle of the shear effect in the X axis.
  62    * @param [in] angle The new angle.
  63    */
  64   void SetAngleXAxis(float angle);
  65
  66   /**
  67    * Set the angle of the shear effect in the Y axis.
  68    * @param [in] angle The new angle.
  69    */
  70   void SetAngleYAxis(float angle);
  71
  72   /**
  73    * Get the name for the center property
  74    * @return A std::string containing the property name
  75    */
  76   const std::string& GetCenterPropertyName() const;
  77
  78   /**
  79    * Get the name for the X axis property
  80    * @return A std::string containing the property name
  81    */
  82   const std::string& GetAngleXAxisPropertyName() const;
  83
  84   /**
  85    * Get the name for the Y axis property
  86    * @return A std::string containing the property name
  87    */
  88   const std::string& GetAngleYAxisPropertyName() const;
  89
  90
  91 private: // Not intended for application developers
  92   ShearEffect(ShaderEffect handle);
  93 };
  94
  95 } // namespace Toolkit
  96
  97 } // namespace Dali
  98
  99 #endif // __DALI_TOOLKIT_SHEAR_EFFECT_H__