dali/internal/event/images/nine-patch-image-impl.h

   1 #ifndef __DALI_INTERNAL_NINE_PATCH_IMAGE_H__
   2 #define __DALI_INTERNAL_NINE_PATCH_IMAGE_H__
   3
   4 /*
   5  * Copyright (c) 2014 Samsung Electronics Co., Ltd.
   6  *
   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
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  *
  19  */
  20
  21 // INTERNAL INCLUDES
  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>
  25
  26 namespace Dali
  27 {
  28
  29 namespace Internal
  30 {
  31
  32 class NinePatchImage;
  33 typedef IntrusivePtr<NinePatchImage> NinePatchImagePtr;
  34
  35 class ResourceClient;
  36 class ResourceManager;
  37
  38 namespace SceneGraph
  39 {
  40 class UpdateManager;
  41 }
  42
  43 /**
  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.
  47  */
  48 class NinePatchImage : public ResourceImage
  49 {
  50 public:
  51   typedef Dali::Vector< Uint16Pair > StretchRanges;
  52
  53 public:
  54
  55   /**
  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).
  61    */
  62   static NinePatchImagePtr New( const std::string& filename,
  63                                 ReleasePolicy releasePol = IMAGE_RELEASE_POLICY_DEFAULT );
  64
  65   /**
  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).
  71    */
  72   NinePatchImage( const std::string& filename,
  73                   ReleasePolicy releasePol = IMAGE_RELEASE_POLICY_DEFAULT );
  74
  75   /**
  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.
  80    */
  81   static NinePatchImage* DownCast( Image* image);
  82
  83
  84 protected:
  85   /**
  86    * A reference counted object may only be deleted by calling Unreference()
  87    */
  88   virtual ~NinePatchImage();
  89
  90 public:
  91   /**
  92    * @copydoc Dali::NinePatchImage::GetStretchPixelsX
  93    */
  94   const StretchRanges& GetStretchPixelsX();
  95
  96   /**
  97    * @copydoc Dali::NinePatchImage::GetStretchPixelsY
  98    */
  99   const StretchRanges& GetStretchPixelsY();
 100
 101   /**
 102    * Get the child rectangle
 103    * @return the position and size of the child rectangle
 104    */
 105   Rect<int> GetChildRectangle();
 106
 107   /**
 108    * @brief Create a cropped image from the bitmap with the 1 pixel border cropped off.
 109    * This does not change the internal bitmap.
 110    *
 111    * @return the cropped bitmap.
 112    */
 113   BufferImagePtr CreateCroppedBufferImage();
 114
 115   /**
 116    *
 117    * @copydoc Dali::NinePatchImage::
 118    */
 119   static bool IsNinePatchUrl( const std::string& url );
 120
 121
 122 protected: // From Resource
 123   /**
 124    * @copydoc Dali::Internal::Image::Connect
 125    */
 126   virtual void Connect();
 127
 128   /**
 129    * @copydoc Dali::Internal::Image::Disconnect
 130    */
 131   virtual void Disconnect();
 132
 133 private:
 134   /**
 135    * Read the borders of the bitmap and determine the child area
 136    * and stretch borders
 137    */
 138   void ParseBorders();
 139
 140   Uint16Pair ParseRange( unsigned int& index, unsigned int width, const PixelBuffer* & pixel, unsigned int pixelStride, int testByte, int testBits, int testValue );
 141
 142 private:
 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;
 148   bool                          mParsedBorder;
 149 };
 150
 151 } // namespace Internal
 152
 153 /**
 154  * Helper methods for public API.
 155  */
 156 inline Internal::NinePatchImage& GetImplementation(Dali::NinePatchImage& handle)
 157 {
 158   DALI_ASSERT_ALWAYS( handle && "NinePatchImage handle is empty" );
 159
 160   BaseObject& image = handle.GetBaseObject();
 161
 162   return static_cast<Internal::NinePatchImage&>(image);
 163 }
 164
 165 inline const Internal::NinePatchImage& GetImplementation(const Dali::NinePatchImage& handle)
 166 {
 167   DALI_ASSERT_ALWAYS( handle && "NinePatchImage handle is empty" );
 168
 169   const BaseObject& image = handle.GetBaseObject();
 170
 171   return static_cast<const Internal::NinePatchImage&>(image);
 172 }
 173
 174 } // namespace Dali
 175
 176 #endif // __DALI_INTERNAL_NINE_PATCH_IMAGE_H__