1 #ifndef __DALI_TOOLKIT_IMAGE_REGION_EFFECT_H__
2 #define __DALI_TOOLKIT_IMAGE_REGION_EFFECT_H__
5 * Copyright (c) 2014 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
22 * @addtogroup CAPI_DALI_TOOLKIT_SHADER_EFFECTS_MODULE
27 #include <dali/dali.h>
29 namespace Dali DALI_IMPORT_API
36 * @brief ImageRegionEffect is a custom shader effect to show only a region of an Image actor.
38 class ImageRegionEffect : public ShaderEffect
43 * @brief Create an uninitialized ImageRegionEffect; this can be initialized with ImageRegionEffect::New().
45 * Calling member functions with an uninitialized Dali::Object is not allowed.
50 * @brief Virtual destructor.
52 virtual ~ImageRegionEffect();
55 * @brief Create an initialized ImageRegionEffect.
57 * @return A handle to a newly allocated Dali resource.
59 static ImageRegionEffect New();
62 * @brief Set the top-left corner of the image region.
64 * The coordinates are in percentage, (0,0) being the top-left and (1,1) the bottom right of the original image.
65 * @param [in] point The top-left corner of the region.
67 void SetTopLeft(const Vector2& point);
70 * @brief Set the bottom-right corner of the image region.
72 * The coordinates are in percentage, (0,0) being the top-left and (1,1) the bottom right of the original image.
73 * @param [in] point The bottom-right corner of the region.
75 void SetBottomRight(const Vector2& point);
78 * @brief Get the name for the top-left point property.
80 * which can be used in Animation API's
81 * @return A std::string containing the property name
83 const std::string& GetTopLeftPropertyName() const;
86 * @brief Get the name for the bottom-right point property which can be used in Animation APIs.
88 * @return A std::string containing the property name
90 const std::string& GetBottomRightPropertyName() const;
92 private: // Not intended for application developers
93 ImageRegionEffect(ShaderEffect handle);
96 } // namespace Toolkit
103 #endif // __DALI_TOOLKIT_IMAGE_REGION_EFFECT_H__