dali-toolkit/internal/controls/renderers/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) 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 // EXTERNAL INCLUDES
  21 #include <string>
  22 #include <dali/public-api/common/vector-wrapper.h>
  23 #include <dali/public-api/object/ref-object.h>
  24 #include <dali/devel-api/rendering/texture-set.h>
  25
  26 // INTERNAL INCLUDES
  27 #include <dali-toolkit/devel-api/image-atlas/image-atlas.h>
  28
  29 namespace Dali
  30 {
  31
  32 namespace Toolkit
  33 {
  34
  35 namespace Internal
  36 {
  37
  38 /**
  39  * The manager for automatic image atlasing. Owned by RendererFactory
  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   /**
  50    * Construtor
  51    *
  52    */
  53   ImageAtlasManager();
  54
  55   /**
  56    * @brief Add an image to the atlas.
  57    *
  58    * @note To make the atlasing efficient, an valid size should be provided.
  59    *       If size is not provided, then the image file will be opened to read the actual size for loading.
  60    *
  61    * SamplingMode::BOX_THEN_LINEAR is used to sampling pixels from the input image while fitting it to desired size.
  62    *
  63    * @param [out] textureRect The texture area of the resource image in the atlas.
  64    * @param [in] url The URL of the resource image file to use.
  65    * @param [in] size The width and height to fit the loaded image to.
  66    * @param [in] fittingMode The method used to fit the shape of the image before loading to the shape defined by the size parameter.
  67    * @param [in] orientationCorrection Reorient the image to respect any orientation metadata in its header.
  68    * @return The texture set containing the image.
  69    */
  70   TextureSet Add( Vector4& textureRect,
  71                 const std::string& url,
  72                 ImageDimensions size = ImageDimensions(),
  73                 FittingMode::Type fittingMode = FittingMode::DEFAULT,
  74                 bool orientationCorrection = true );
  75
  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                 PixelDataPtr 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   /**
 109    * @brief Create a new atlas.
 110    *
 111    * This method is called when the newly added image or pixel buffer cannot fit into the current atlas list.
 112    */
 113   void CreateNewAtlas();
 114
 115 protected:
 116
 117   /**
 118    * Destructor
 119    */
 120   virtual ~ImageAtlasManager();
 121
 122   /**
 123    * Undefined copy constructor.
 124    */
 125   ImageAtlasManager(const ImageAtlasManager&);
 126
 127   /**
 128    * Undefined assignment operator.
 129    */
 130   ImageAtlasManager& operator=(const ImageAtlasManager& rhs);
 131
 132
 133 private:
 134
 135   AtlasContainer    mAtlasList;
 136   TextureSetContainer mTextureSetList;
 137   std::string       mBrokenImageUrl;
 138
 139 };
 140
 141 } // name Internal
 142
 143 } // namespace Toolkit
 144
 145 } // namespace Dali
 146
 147 #endif // __DALI_TOOLKIT_ATLAS_MANAGER_H__