Automatic image atlasing
[platform/core/uifw/dali-toolkit.git] / 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/material.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< Material > MaterialContainer;
46
47 public:
48
49   /**
50    * Construtor
51    *
52    * @param[in] shader The shader for material.
53    * @param[in] textureUniformName The texture uniform name for the atlas image.
54    */
55   ImageAtlasManager( Shader shader, const std::string& textureUniformName );
56
57   /**
58    * @brief Add an image to the atlas.
59    *
60    * @note To make the atlasing efficient, an valid size should be provided.
61    *       If size is not provided, then the image file will be opened to read the actual size for loading.
62    *
63    * SamplingMode::BOX_THEN_LINEAR is used to sampling pixels from the input image while fitting it to desired size.
64    *
65    * @param [out] textureRect The texture area of the resource image in the atlas.
66    * @param [in] url The URL of the resource image file to use.
67    * @param [in] size The width and height to fit the loaded image to.
68    * @param [in] fittingMode The method used to fit the shape of the image before loading to the shape defined by the size parameter.
69    * @param [in] orientationCorrection Reorient the image to respect any orientation metadata in its header.
70    * @return True if there is enough space to fit this image in,false otherwise.
71    */
72   Material Add( Vector4& textureRect,
73                 const std::string& url,
74                 ImageDimensions size = ImageDimensions(),
75                 FittingMode::Type fittingMode = FittingMode::DEFAULT,
76                 bool orientationCorrection = true );
77
78   /**
79    * Remove the image at the given rectangle from the material.
80    *
81    * @param [in] material The material containing the atlas image.
82    * @param [in] textureRect The texture area to be removed.
83    */
84   void Remove( Material material, const Vector4& textureRect );
85
86   /**
87    * @brief Set the broken image which is used to replace the image if loading fails.
88    *
89    * @param[in] brokenImageUrl The url of the broken image.
90    */
91   void SetBrokenImage( const std::string& brokenImageUrl );
92
93 protected:
94
95   /**
96    * Destructor
97    */
98   virtual ~ImageAtlasManager();
99
100   /**
101    * Undefined copy constructor.
102    */
103   ImageAtlasManager(const ImageAtlasManager&);
104
105   /**
106    * Undefined assignment operator.
107    */
108   ImageAtlasManager& operator=(const ImageAtlasManager& rhs);
109
110
111 private:
112
113   AtlasContainer    mAtlasList;
114   MaterialContainer mMaterialList;
115   Shader            mShader;
116   std::string       mTextureUniformName;
117   std::string       mBrokenImageUrl;
118
119 };
120
121 } // name Internal
122
123 } // namespace Toolkit
124
125 } // namespace Dali
126
127 #endif // __DALI_TOOLKIT_ATLAS_MANAGER_H__