1 #ifndef __DALI_NINE_PATCH_IMAGE_H__
2 #define __DALI_NINE_PATCH_IMAGE_H__
5 * Copyright (c) 2017 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/images/resource-image.h>
23 #include <dali/public-api/images/buffer-image.h>
24 #include <dali/public-api/math/rect.h>
29 * @addtogroup dali_core_images
33 namespace Internal DALI_INTERNAL
39 * @brief NinePatchImage represents an nine-patch image resource.
41 * It contains a bitmap that is synchronously loaded from the file system that contains
42 * a 9 patch border - a 1 pixel border that describes the stretch borders and the child
45 * The class offers an API to read the stretch area and child area, but it does not
46 * remove the border from it's bitmap. An API can be used to obtain a BufferImage with
49 * If you don't retain a handle to this object, it will be automatically destroyed.
52 class DALI_IMPORT_API NinePatchImage : public ResourceImage
55 typedef Vector< Uint16Pair > StretchRanges;
59 * @brief Constructor which creates an uninitialized NinePatchImage object.
61 * Use @ref NinePatchImage::New to create an initialised object.
67 * @brief Create a new NinePatchImage.
69 * A pixel buffer for image data is allocated and loaded from the filesystem.
70 * Dali has ownership of the buffer.
72 * @param [in] filename File to load synchronously into buffer
73 * @return A handle to a new instance of NinePatchImage
75 static NinePatchImage New( const std::string& filename );
78 * @brief Downcast a handle to NinePatchImage handle.
80 * If handle points to a NinePatchImage the downcast produces valid
81 * handle. If not the returned handle is left uninitialized.
84 * @param[in] handle Handle to an object
85 * @return Handle to a NinePatchImage or an uninitialized handle
87 static NinePatchImage DownCast( BaseHandle handle );
92 * This is non-virtual since derived Handle types must not contain data or virtual methods.
98 * @brief This copy constructor is required for (smart) pointer semantics.
101 * @param [in] handle A reference to the copied handle
103 NinePatchImage(const NinePatchImage& handle);
106 * @brief This assignment operator is required for (smart) pointer semantics.
109 * @param [in] rhs A reference to the copied handle
110 * @return A reference to this
112 NinePatchImage& operator=(const NinePatchImage& rhs);
115 * @DEPRECATED_1_1.4. Use GetStretchPixelsX and GetStretchPixelsY instead.
117 * @brief Get the stretch borders
120 * @return The border in pixels from the left, top, right, and bottom of the image respectively.
122 Vector4 GetStretchBorders();
125 * @brief Retrieves the horizontal stretch pixel ranges in the cropped image space
128 * @return the horizontal stretch pixel ranges in the cropped image space
130 const StretchRanges& GetStretchPixelsX();
133 * @brief Retrieves the vertical stretch pixel ranges in the cropped image space
136 * @return the vertical stretch pixel ranges in the cropped image space
138 const StretchRanges& GetStretchPixelsY();
141 * @brief Get the child rectangle
144 * @return The position and size of the child rectangle
146 Rect<int> GetChildRectangle();
149 * @brief Creates a buffer image from the bitmap with the 1 pixel border cropped off.
151 * This does not change the internal bitmap.
154 * @return The cropped BufferImage
156 BufferImage CreateCroppedBufferImage();
159 * @brief Helper method to determine if the filename indicates that the image has a 9 patch or n patch border.
162 * @param [in] url The URL of the image file.
163 * @return true if it is a 9 patch or n patch image
165 static bool IsNinePatchUrl( const std::string& url );
167 public: // Not intended for application developers
169 explicit DALI_INTERNAL NinePatchImage(Internal::NinePatchImage*);
177 #endif // __DALI_NINE_PATCH_IMAGE_H__