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