1 #ifndef __DALI_NINE_PATCH_IMAGE_H__
2 #define __DALI_NINE_PATCH_IMAGE_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/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 * Adding this image to an ImageActor using an Image handle will automatically convert
50 * to use the cropped BufferImage - if you don't retain a handle to this object, it will
51 * be automatically destroyed.
54 class DALI_IMPORT_API NinePatchImage : public ResourceImage
57 typedef Vector< Uint16Pair > StretchRanges;
61 * @brief Constructor which creates an uninitialized NinePatchImage object.
63 * Use @ref NinePatchImage::New to create an initialised object.
69 * @brief Create a new NinePatchImage.
71 * A pixel buffer for image data is allocated and loaded from the filesystem.
72 * Dali has ownership of the buffer.
74 * @param [in] filename File to load synchronously into buffer
75 * @return A handle to a new instance of NinePatchImage
77 static NinePatchImage New( const std::string& filename );
80 * @brief Downcast a handle to NinePatchImage handle.
82 * If handle points to a NinePatchImage the downcast produces valid
83 * handle. If not the returned handle is left uninitialized.
86 * @param[in] handle Handle to an object
87 * @return Handle to a NinePatchImage or an uninitialized handle
89 static NinePatchImage DownCast( BaseHandle handle );
94 * This is non-virtual since derived Handle types must not contain data or virtual methods.
100 * @brief This copy constructor is required for (smart) pointer semantics.
103 * @param [in] handle A reference to the copied handle
105 NinePatchImage(const NinePatchImage& handle);
108 * @brief This assignment operator is required for (smart) pointer semantics.
111 * @param [in] rhs A reference to the copied handle
112 * @return A reference to this
114 NinePatchImage& operator=(const NinePatchImage& rhs);
117 * @DEPRECATED_1_1.4. Use GetStretchPixelsX and GetStretchPixelsY instead.
119 * @brief Get the stretch borders
122 * @return The border in pixels from the left, top, right, and bottom of the image respectively.
124 Vector4 GetStretchBorders();
127 * @brief Retrieves the horizontal stretch pixel ranges in the cropped image space
130 * @return the horizontal stretch pixel ranges in the cropped image space
132 const StretchRanges& GetStretchPixelsX();
135 * @brief Retrieves the vertical stretch pixel ranges in the cropped image space
138 * @return the vertical stretch pixel ranges in the cropped image space
140 const StretchRanges& GetStretchPixelsY();
143 * @brief Get the child rectangle
146 * @return The position and size of the child rectangle
148 Rect<int> GetChildRectangle();
151 * @brief Creates a buffer image from the bitmap with the 1 pixel border cropped off.
153 * This does not change the internal bitmap.
156 * @return The cropped BufferImage
158 BufferImage CreateCroppedBufferImage();
161 * @brief Helper method to determine if the filename indicates that the image has a 9 patch or n patch border.
164 * @param [in] url The URL of the image file.
165 * @return true if it is a 9 patch or n patch image
167 static bool IsNinePatchUrl( const std::string& url );
169 public: // Not intended for application developers
171 explicit DALI_INTERNAL NinePatchImage(Internal::NinePatchImage*);
179 #endif // __DALI_NINE_PATCH_IMAGE_H__