1 #ifndef __DALI_INTERNAL_NINE_PATCH_IMAGE_H__
2 #define __DALI_INTERNAL_NINE_PATCH_IMAGE_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 #include <dali/public-api/images/nine-patch-image.h>
23 #include <dali/internal/event/images/resource-image-impl.h>
24 #include <dali/internal/event/images/buffer-image-impl.h>
33 typedef IntrusivePtr<NinePatchImage> NinePatchImagePtr;
36 class ResourceManager;
44 * NinePatchImage represents an image resource that can be added to actors etc.
45 * It's image data has a border which determines stretch and fill areas
46 * Its pixel buffer data is loaded synchronously from file.
48 class NinePatchImage : public ResourceImage
51 typedef Dali::Vector< Uint16Pair > StretchRanges;
56 * Create a new NinePatchImage.
57 * Also a pixel buffer for image data is allocated.
58 * Dali has ownership of the buffer.
59 * @param [in] filename File to load synchronously into buffer
60 * @param [in] releasePol optionally relase memory when image is not visible on screen (default: keep image data until Image object is alive).
62 static NinePatchImagePtr New( const std::string& filename,
63 ReleasePolicy releasePol = IMAGE_RELEASE_POLICY_DEFAULT );
66 * Create a new NinePatchImage
67 * For better performance and portability use power of two dimensions.
68 * The maximum size of the image is limited by GL_MAX_TEXTURE_SIZE.
69 * @param [in] filename File to load synchronously into buffer
70 * @param [in] releasePol optionally relase memory when image is not visible on screen (default: keep image data until Image object is alive).
72 NinePatchImage( const std::string& filename,
73 ReleasePolicy releasePol = IMAGE_RELEASE_POLICY_DEFAULT );
76 * Convert Image object to a 9 patch image object if possible.
77 * @param[in] image The image to convert
78 * @return A pointer to the 9 patch image object, or NULL
79 * if the conversion is not possible.
81 static NinePatchImage* DownCast( Image* image);
86 * A reference counted object may only be deleted by calling Unreference()
88 virtual ~NinePatchImage();
92 * @copydoc Dali::NinePatchImage::GetStretchPixelsX
94 const StretchRanges& GetStretchPixelsX();
97 * @copydoc Dali::NinePatchImage::GetStretchPixelsY
99 const StretchRanges& GetStretchPixelsY();
102 * Get the child rectangle
103 * @return the position and size of the child rectangle
105 Rect<int> GetChildRectangle();
108 * @brief Create a cropped image from the bitmap with the 1 pixel border cropped off.
109 * This does not change the internal bitmap.
111 * @return the cropped bitmap.
113 BufferImagePtr CreateCroppedBufferImage();
117 * @copydoc Dali::NinePatchImage::
119 static bool IsNinePatchUrl( const std::string& url );
122 protected: // From Resource
124 * @copydoc Dali::Internal::Image::Connect
126 virtual void Connect();
129 * @copydoc Dali::Internal::Image::Disconnect
131 virtual void Disconnect();
135 * Read the borders of the bitmap and determine the child area
136 * and stretch borders
140 Uint16Pair ParseRange( unsigned int& index, unsigned int width, const PixelBuffer* & pixel, unsigned int pixelStride, int testByte, int testBits, int testValue );
143 ResourceClient* mResourceClient;
144 Integration::BitmapPtr mBitmap;
145 StretchRanges mStretchPixelsX; //< The horizontal stretchable pixels in the cropped image space
146 StretchRanges mStretchPixelsY; //< The vertical stretchable pixels in the cropped image space
147 Rect<int> mChildRectangle;
151 } // namespace Internal
154 * Helper methods for public API.
156 inline Internal::NinePatchImage& GetImplementation(Dali::NinePatchImage& handle)
158 DALI_ASSERT_ALWAYS( handle && "NinePatchImage handle is empty" );
160 BaseObject& image = handle.GetBaseObject();
162 return static_cast<Internal::NinePatchImage&>(image);
165 inline const Internal::NinePatchImage& GetImplementation(const Dali::NinePatchImage& handle)
167 DALI_ASSERT_ALWAYS( handle && "NinePatchImage handle is empty" );
169 const BaseObject& image = handle.GetBaseObject();
171 return static_cast<const Internal::NinePatchImage&>(image);
176 #endif // __DALI_INTERNAL_NINE_PATCH_IMAGE_H__