dali-toolkit/internal/atlas-manager/atlas-manager-impl.h

   1 #ifndef __DALI_TOOLKIT_ATLAS_MANAGER_IMPL_H__
   2 #define __DALI_TOOLKIT_ATLAS_MANAGER_IMPL_H__
   3
   4 /*
   5  * Copyright (c) 2015 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 // EXTERNAL INCLUDES
  22 #include <dali/public-api/common/vector-wrapper.h>
  23 #include <dali/public-api/object/base-object.h>
  24
  25 // INTERNAL INCLUDES
  26 #include <dali-toolkit/internal/atlas-manager/atlas-manager.h>
  27
  28 namespace Dali
  29 {
  30
  31 namespace Toolkit
  32 {
  33
  34 class AtlasManager;
  35
  36 } // namespace Toolkit
  37
  38 namespace Toolkit
  39 {
  40
  41 namespace Internal
  42 {
  43
  44 typedef Dali::Vector< Toolkit::AtlasManager::AtlasSlot > slotContainer;
  45
  46 class AtlasManager;
  47 typedef IntrusivePtr<AtlasManager> AtlasManagerPtr;
  48
  49 class AtlasManager : public Dali::BaseObject
  50 {
  51 public:
  52
  53   typedef uint32_t SizeType;
  54   typedef SizeType AtlasId;
  55   typedef SizeType ImageId;
  56
  57   /**
  58    * @brief Internal storage of atlas attributes and image upload results
  59    */
  60   struct AtlasDescriptor
  61   {
  62     Dali::Atlas mAtlas;                                                 // atlas image
  63     Toolkit::AtlasManager::AtlasSize mSize;                             // size of atlas
  64     Pixel::Format mPixelFormat;                                         // pixel format used by atlas
  65     BufferImage mHorizontalStrip;                                       // Image used to pad upload
  66     BufferImage mVerticalStrip;                                         // Image used to pad upload
  67     BufferImage mFilledPixelImage;                                      // Image used by atlas for operations such as underline
  68     PixelBuffer* mStripBuffer;                                          // Blank image buffer used to pad upload
  69     Material mMaterial;                                                 // material used for atlas texture
  70     SizeType mNextFreeBlock;                                            // next free block will be placed here ( actually +1 )
  71     Dali::Vector< SizeType > mFreeBlocksList;                           // unless there are any previously freed blocks
  72   };
  73
  74   struct AtlasSlotDescriptor
  75   {
  76     SizeType mCount;                                                    // Reference count for this slot
  77     SizeType mImageWidth;                                               // Width of image stored
  78     SizeType mImageHeight;                                              // Height of image stored
  79     AtlasId mAtlasId;                                                   // Image is stored in this Atlas
  80     Dali::Vector< SizeType > mBlocksList;                               // List of blocks within atlas used for image
  81   };
  82
  83   AtlasManager();
  84
  85   /**
  86    * Create a new AtlasManager
  87    */
  88   static AtlasManagerPtr New();
  89
  90   virtual ~AtlasManager();
  91
  92   /**
  93    * @copydoc: Toolkit::AtlasManager::CreateAtlas
  94    */
  95   AtlasId CreateAtlas( const Toolkit::AtlasManager::AtlasSize& size, Pixel::Format pixelformat );
  96
  97   /**
  98    * @copydoc Toolkit::AtlasManager::SetAddPolicy
  99    */
 100   void SetAddPolicy( Toolkit::AtlasManager::AddFailPolicy policy );
 101
 102   /**
 103    * @copydoc Toolkit::AtlasManager::Add
 104    */
 105   void Add( const BufferImage& image,
 106             Toolkit::AtlasManager::AtlasSlot& slot,
 107             Toolkit::AtlasManager::AtlasId atlas );
 108
 109   /**
 110    * @copydoc Toolkit::AtlasManager::GenerateMeshData
 111    */
 112   void GenerateMeshData( ImageId id,
 113                          const Vector2& position,
 114                          MeshData& mesh,
 115                          bool addReference );
 116
 117   /**
 118    * @copydoc Toolkit::AtlasManager::StitchMesh
 119    */
 120   void StitchMesh( MeshData& first,
 121                    const MeshData& second,
 122                    bool optimize );
 123
 124   /**
 125    * @copydoc Toolkit::AtlasManager::StitchMesh
 126    */
 127   void StitchMesh( const MeshData& first,
 128                    const MeshData& second,
 129                    MeshData& out, bool optimize );
 130
 131   /**
 132    * @copydoc Toolkit::AtlasManager::Remove
 133    */
 134   bool Remove( ImageId id );
 135
 136   /**
 137    * @copydoc Toolkit::AtlasManager::GetAtlasContainer
 138    */
 139   Dali::Atlas GetAtlasContainer( AtlasId atlas ) const;
 140
 141   /**
 142    * @copydoc Toolkit::AtlasManager::GetAtlas
 143    */
 144   AtlasId GetAtlas( ImageId id ) const;
 145
 146   /**
 147    * @copydoc Toolkit::AtlasManager::SetNewAtlasSize
 148    */
 149   void SetNewAtlasSize( const Toolkit::AtlasManager::AtlasSize& size );
 150
 151   /**
 152    * @copydoc Toolkit::AtlasManager::GetAtlasSize
 153    */
 154   const Toolkit::AtlasManager::AtlasSize& GetAtlasSize( AtlasId atlas );
 155
 156   /**
 157    * @copydoc Toolkit::AtlasManager::GetBlockSize
 158    */
 159   Vector2 GetBlockSize( AtlasId atlas );
 160
 161   /**
 162    * @copydoc Toolkit::AtlasManager::GetFreeBlocks
 163    */
 164   SizeType GetFreeBlocks( AtlasId atlas ) const;
 165
 166   /*
 167    * @copydoc Toolkit::AtlasManager::GetAtlasCount
 168    */
 169   SizeType GetAtlasCount() const;
 170
 171   /**
 172    * @copydoc Toolkit::AtlasManager::GetPixelFormat
 173    */
 174   Pixel::Format GetPixelFormat( AtlasId atlas );
 175
 176   /**
 177    * @copydoc Toolkit::AtlasManager::GetMetrics
 178    */
 179   void GetMetrics( Toolkit::AtlasManager::Metrics& metrics );
 180
 181 private:
 182
 183   std::vector< AtlasDescriptor > mAtlasList;        // List of atlases created
 184   std::vector< AtlasSlotDescriptor > mImageList;  // List of bitmaps store in atlases
 185
 186   SizeType CheckAtlas( SizeType atlas,
 187                        SizeType width,
 188                        SizeType height,
 189                        Pixel::Format pixelFormat,
 190                        SizeType& blockArea,
 191                        SizeType& totalBlocks );
 192
 193   void CreateMesh( SizeType atlas,
 194                    SizeType imageWidth,
 195                    SizeType imageHeight,
 196                    const Vector2& position,
 197                    SizeType widthInBlocks,
 198                    SizeType heightInBlocks,
 199                    Dali::MeshData& meshData,
 200                    AtlasSlotDescriptor& desc );
 201
 202   void OptimizeVertices( const MeshData::VertexContainer& in,
 203                          MeshData::FaceIndices& faces,
 204                          MeshData::VertexContainer& out );
 205
 206   void UploadImage( const BufferImage& image,
 207                     const AtlasSlotDescriptor& desc );
 208
 209   void PrintMeshData( const MeshData& meshData );
 210
 211   Toolkit::AtlasManager::AtlasSize mNewAtlasSize;
 212   Toolkit::AtlasManager::AddFailPolicy mAddFailPolicy;
 213   uint32_t mFilledPixel;
 214 };
 215
 216 } // namespace Internal
 217
 218 inline const Internal::AtlasManager& GetImplementation(const Toolkit::AtlasManager& manager)
 219 {
 220   DALI_ASSERT_ALWAYS( manager && "AtlasManager handle is empty" );
 221
 222   const BaseObject& handle = manager.GetBaseObject();
 223
 224   return static_cast<const Internal::AtlasManager&>(handle);
 225 }
 226
 227 inline Internal::AtlasManager& GetImplementation(Toolkit::AtlasManager& manager)
 228 {
 229   DALI_ASSERT_ALWAYS( manager && "AtlasManager handle is empty" );
 230
 231   BaseObject& handle = manager.GetBaseObject();
 232
 233   return static_cast<Internal::AtlasManager&>(handle);
 234 }
 235
 236 } // namespace Toolkit
 237
 238 } // namespace Dali
 239
 240
 241  #endif // __DALI_TOOLKIT_ATLAS_MANAGER_IMPL_H__