1 #ifndef __DALI_TOOLKIT_IMAGE_REGION_EFFECT_H__
2 #define __DALI_TOOLKIT_IMAGE_REGION_EFFECT_H__
5 * Copyright (c) 2015 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 #include <dali/public-api/shader-effects/shader-effect.h>
31 * @brief ImageRegionEffect is a custom shader effect to show only a region of an Image actor.
33 class DALI_IMPORT_API ImageRegionEffect : public ShaderEffect
38 * @brief Create an uninitialized ImageRegionEffect; this can be initialized with ImageRegionEffect::New().
40 * Calling member functions with an uninitialized Dali::Object is not allowed.
47 * This is non-virtual since derived Handle types must not contain data or virtual methods.
52 * @brief Create an initialized ImageRegionEffect.
54 * @return A handle to a newly allocated Dali resource.
56 static ImageRegionEffect New();
59 * @brief Set the top-left corner of the image region.
61 * The coordinates are in percentage, (0,0) being the top-left and (1,1) the bottom right of the original image.
62 * @param [in] point The top-left corner of the region.
64 void SetTopLeft(const Vector2& point);
67 * @brief Set the bottom-right corner of the image region.
69 * The coordinates are in percentage, (0,0) being the top-left and (1,1) the bottom right of the original image.
70 * @param [in] point The bottom-right corner of the region.
72 void SetBottomRight(const Vector2& point);
75 * @brief Get the name for the top-left point property.
77 * which can be used in Animation API's
78 * @return A std::string containing the property name
80 const std::string& GetTopLeftPropertyName() const;
83 * @brief Get the name for the bottom-right point property which can be used in Animation APIs.
85 * @return A std::string containing the property name
87 const std::string& GetBottomRightPropertyName() const;
89 private: // Not intended for application developers
90 DALI_INTERNAL ImageRegionEffect(ShaderEffect handle);
93 } // namespace Toolkit
97 #endif // __DALI_TOOLKIT_IMAGE_REGION_EFFECT_H__