dali-toolkit/internal/visuals/image-atlas-manager.h

   1 #ifndef DALI_TOOLKIT_IMAGE_ATLAS_MANAGER_H
   2 #define DALI_TOOLKIT_IMAGE_ATLAS_MANAGER_H
   3
   4 /*
   5  * Copyright (c) 2021 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 <dali/public-api/common/vector-wrapper.h>
  22 #include <dali/public-api/object/ref-object.h>
  23 #include <dali/public-api/rendering/texture-set.h>
  24 #include <string>
  25
  26 // INTERNAL INCLUDES
  27 #include <dali-toolkit/devel-api/image-loader/image-atlas.h>
  28 #include <dali-toolkit/internal/visuals/visual-url.h>
  29
  30 namespace Dali
  31 {
  32 namespace Toolkit
  33 {
  34 class AtlasUploadObserver;
  35
  36 namespace Internal
  37 {
  38 /**
  39  * The manager for automatic image atlasing. Owned by VisualFactory
  40  */
  41 class ImageAtlasManager : public RefObject
  42 {
  43 public:
  44   typedef std::vector<Toolkit::ImageAtlas> AtlasContainer;
  45   typedef std::vector<TextureSet>          TextureSetContainer;
  46
  47 public:
  48   /**
  49    * Construtor
  50    *
  51    */
  52   ImageAtlasManager();
  53
  54   /**
  55    * @brief Add an image to the atlas.
  56    *
  57    * @note To make the atlasing efficient, an valid size should be provided.
  58    *       If size is not provided, then the image file will be opened to read the actual size for loading.
  59    *
  60    * SamplingMode::BOX_THEN_LINEAR is used to sampling pixels from the input image while fitting it to desired size.
  61    *
  62    * @param [out] textureRect The texture area of the resource image in the atlas.
  63    * @param [in] url The URL of the resource image file to use.
  64    * @param [in, out] size The width and height to fit the loaded image to.
  65    * @param [in] fittingMode The method used to fit the shape of the image before loading to the shape defined by the size parameter.
  66    * @param [in] orientationCorrection Reorient the image to respect any orientation metadata in its header.
  67    * @param [in] atlasUploadObserver The object to observe the uploading state inside ImageAtlas.
  68    * @return The texture set containing the image.
  69    */
  70   TextureSet Add(Vector4&             textureRect,
  71                  const VisualUrl&     url,
  72                  ImageDimensions&     size,
  73                  FittingMode::Type    fittingMode           = FittingMode::DEFAULT,
  74                  bool                 orientationCorrection = true,
  75                  AtlasUploadObserver* atlasUploadObserver   = NULL);
  76   /**
  77    * @brief Add a pixel buffer to the atlas
  78    *
  79    * @param [out] textureRect The texture area of the resource image in the atlas.
  80    * @param [in] pixelData The pixel data.
  81    * @return The texture set containing the image.
  82    */
  83   TextureSet Add(Vector4&  textureRect,
  84                  PixelData pixelData);
  85
  86   /**
  87    * Remove the image at the given rectangle from the texture set.
  88    *
  89    * @param [in] textureSet The texture set containing the atlas image.
  90    * @param [in] textureRect The texture area to be removed.
  91    */
  92   void Remove(TextureSet textureSet, const Vector4& textureRect);
  93
  94   /**
  95    * @brief Set the broken image which is used to replace the image if loading fails.
  96    *
  97    * @param[in] brokenImageUrl The url of the broken image.
  98    */
  99   void SetBrokenImage(const std::string& brokenImageUrl);
 100
 101   /**
 102    * @brief Get shader
 103    */
 104   Shader GetShader() const;
 105
 106 private:
 107   /**
 108    * @brief Create a new atlas.
 109    *
 110    * This method is called when the newly added image or pixel buffer cannot fit into the current atlas list.
 111    */
 112   void CreateNewAtlas();
 113
 114 protected:
 115   /**
 116    * Destructor
 117    */
 118   ~ImageAtlasManager() override;
 119
 120   /**
 121    * Undefined copy constructor.
 122    */
 123   ImageAtlasManager(const ImageAtlasManager&);
 124
 125   /**
 126    * Undefined assignment operator.
 127    */
 128   ImageAtlasManager& operator=(const ImageAtlasManager& rhs);
 129
 130 private:
 131   AtlasContainer      mAtlasList;
 132   TextureSetContainer mTextureSetList;
 133   std::string         mBrokenImageUrl;
 134 };
 135
 136 } // namespace Internal
 137
 138 } // namespace Toolkit
 139
 140 } // namespace Dali
 141
 142 #endif // DALI_TOOLKIT_ATLAS_MANAGER_H