Provide object to connect scrollable containers & scroll-bars etc.
[platform/core/uifw/dali-toolkit.git] / capi / dali-toolkit / public-api / shader-effects / image-region-effect.h
1 #ifndef __DALI_TOOLKIT_IMAGE_REGION_EFFECT_H__
2 #define __DALI_TOOLKIT_IMAGE_REGION_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 /**
21  * @addtogroup CAPI_DALI_FRAMEWORK
22  * @{
23  */
24
25 // INTERNAL INCLUDES
26 #include <dali/dali.h>
27
28 namespace Dali DALI_IMPORT_API
29 {
30
31 namespace Toolkit
32 {
33
34 /**
35  * ImageRegionEffect is a custom shader effect to show only a region of an Image actor
36  */
37 class ImageRegionEffect : public ShaderEffect
38 {
39 public:
40
41   /**
42    * Create an uninitialized ImageRegionEffect; this can be initialized with ImageRegionEffect::New()
43    * Calling member functions with an uninitialized Dali::Object is not allowed.
44    */
45   ImageRegionEffect();
46
47   /**
48    * Virtual destructor.
49    */
50   virtual ~ImageRegionEffect();
51
52   /**
53    * Create an initialized ~ImageRegionEffect.
54    * @return A handle to a newly allocated Dali resource.
55    */
56   static ImageRegionEffect New();
57
58   /**
59    * Set the top-left corner of the image region.
60    * The coordinates are in percentage, (0,0) being the top-left and (1,1) the bottom right of the original image.
61    * @param [in] point The top-left corner of the region.
62    */
63   void SetTopLeft(const Vector2& point);
64
65   /**
66    * Set the bottom-right corner of the image region.
67    * The coordinates are in percentage, (0,0) being the top-left and (1,1) the bottom right of the original image.
68    * @param [in] point The bottom-right corner of the region.
69    */
70   void SetBottomRight(const Vector2& point);
71
72   /**
73    * Get the name for the top-left point property
74    * which can be used in Animation API's
75    * @return A std::string containing the property name
76    */
77   const std::string& GetTopLeftPropertyName() const;
78
79   /**
80    * Get the name for the bottom-right point property
81    * which can be used in Animation API's
82    * @return A std::string containing the property name
83    */
84   const std::string& GetBottomRightPropertyName() const;
85
86 private: // Not intended for application developers
87   ImageRegionEffect(ShaderEffect handle);
88 };
89
90 } // namespace Toolkit
91
92 } // namespace Dali
93
94 /**
95  * @}
96  */
97 #endif // __DALI_TOOLKIT_IMAGE_REGION_EFFECT_H__