dali-toolkit/internal/visuals/npatch-loader.h

   1 #ifndef DALI_TOOLKIT_NPATCH_LOADER_H
   2 #define DALI_TOOLKIT_NPATCH_LOADER_H
   3
   4 /*
   5  * Copyright (c) 2020 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 // EXTERNAL INCLUDES
  21 #include <string>
  22 #include <dali/public-api/rendering/texture-set.h>
  23 #include <dali/devel-api/common/owner-container.h>
  24 #include <dali/devel-api/adaptor-framework/pixel-buffer.h>
  25
  26 // INTERNAL INCLUDES
  27 #include <dali-toolkit/internal/visuals/texture-manager-impl.h>
  28 #include <dali-toolkit/devel-api/utility/npatch-utilities.h>
  29
  30 namespace Dali
  31 {
  32
  33 namespace Toolkit
  34 {
  35
  36 namespace Internal
  37 {
  38
  39 /**
  40  * The manager for loading Npatch textures.
  41  * It caches them internally for better performance; i.e. to avoid loading and
  42  * parsing the files over and over.
  43  *
  44  * Cache is not cleaned during app lifecycle as N patches take considerably
  45  * small space and there's not usually a lot of them. Usually N patches are specified in
  46  * toolkit default style and there is 1-2 per control that are shared across the whole application.
  47  */
  48 class NPatchLoader
  49 {
  50 public:
  51
  52   enum
  53   {
  54     UNINITIALIZED_ID = 0 ///< uninitialised id, use to initialize ids
  55   };
  56
  57   struct Data
  58   {
  59     Data()
  60     : url(),
  61       textureSet(),
  62       hash( 0 ),
  63       croppedWidth( 0 ),
  64       croppedHeight( 0 ),
  65       border( 0, 0, 0, 0 ),
  66       loadCompleted( false )
  67     {}
  68
  69     std::string url;                              ///< Url of the N-Patch
  70     TextureSet textureSet;                        ///< Texture containing the cropped image
  71     NPatchUtility::StretchRanges stretchPixelsX;  ///< X stretch pixels
  72     NPatchUtility::StretchRanges stretchPixelsY;  ///< Y stretch pixels
  73     std::size_t hash;                             ///< Hash code for the Url
  74     uint32_t croppedWidth;                        ///< Width of the cropped middle part of N-patch
  75     uint32_t croppedHeight;                       ///< Height of the cropped middle part of N-patch
  76     Rect< int > border;                           ///< The size of the border
  77     bool loadCompleted;                           ///< True if the data loading is completed
  78   };
  79
  80 public:
  81
  82   /**
  83    * Constructor
  84    */
  85   NPatchLoader();
  86
  87   /**
  88    * Destructor, non-virtual as not a base class
  89    */
  90   ~NPatchLoader();
  91
  92   /**
  93    * @brief Retrieve a texture matching the n-patch url.
  94    *
  95    * @param [in] textureManager that will be used to loading image
  96    * @param [in] textureObserver The NPatchVisual that requested loading.
  97    * @param [in] url to retrieve
  98    * @param [in] border The border size of the image
  99    * @param [in,out] preMultiplyOnLoad True if the image color should be multiplied by it's alpha. Set to false if the
 100    *                                   image has no alpha channel
 101    * @param [in] synchronousLoading True if the image will be loaded in synchronous time.
 102    * @return id of the texture.
 103    */
 104   std::size_t Load( TextureManager& textureManager, TextureUploadObserver* textureObserver, const std::string& url, const Rect< int >& border, bool& preMultiplyOnLoad, bool synchronousLoading );
 105
 106   /**
 107    * @brief Set loaded PixelBuffer and its information
 108    *
 109    * @param [in] id cache data id
 110    * @param [in] pixelBuffer of loaded image
 111    */
 112   void SetNPatchData( std::size_t id, Devel::PixelBuffer& pixelBuffer );
 113
 114   /**
 115    * @brief Retrieve N patch data matching to an id
 116    * @param [in] id of data
 117    * @param [out] data const pointer to the data
 118    * @return true if data matching to id was really found
 119    */
 120   bool GetNPatchData( std::size_t id, const Data*& data );
 121
 122 protected:
 123
 124   /**
 125    * Undefined copy constructor.
 126    */
 127   NPatchLoader(const NPatchLoader&);
 128
 129   /**
 130    * Undefined assignment operator.
 131    */
 132   NPatchLoader& operator=(const NPatchLoader& rhs);
 133
 134 private:
 135
 136   OwnerContainer< Data* > mCache;
 137
 138 };
 139
 140 } // name Internal
 141
 142 } // namespace Toolkit
 143
 144 } // namespace Dali
 145
 146 #endif // DALI_TOOLKIT_NPATCH_LOADER_H