dali-toolkit/internal/visuals/visual-factory-cache.h

   1 #ifndef DALI_TOOLKIT_VISUAL_FACTORY_CACHE_H
   2 #define DALI_TOOLKIT_VISUAL_FACTORY_CACHE_H
   3
   4 /*
   5  * Copyright (c) 2016 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/math/uint-16-pair.h>
  22 #include <dali/public-api/object/ref-object.h>
  23 #include <dali/public-api/rendering/geometry.h>
  24 #include <dali/public-api/rendering/renderer.h>
  25 #include <dali/public-api/rendering/shader.h>
  26 #include <dali/devel-api/common/owner-container.h>
  27 #include <dali/devel-api/object/weak-handle.h>
  28
  29 // INTERNAL INCLUDES
  30 #include <dali-toolkit/internal/visuals/npatch-loader.h>
  31 #include <dali-toolkit/internal/visuals/svg/svg-rasterize-thread.h>
  32
  33 namespace Dali
  34 {
  35
  36 namespace Toolkit
  37 {
  38
  39 namespace Internal
  40 {
  41
  42 class ImageAtlasManager;
  43 typedef IntrusivePtr<ImageAtlasManager> ImageAtlasManagerPtr;
  44
  45 class NPatchLoader;
  46
  47 /**
  48  * Caches shaders and geometries. Owned by VisualFactory.
  49  */
  50 class VisualFactoryCache : public RefObject
  51 {
  52 public:
  53
  54   /**
  55    * Type of shader for caching.
  56    */
  57   enum ShaderType
  58   {
  59     COLOR_SHADER,
  60     BORDER_SHADER,
  61     BORDER_SHADER_ANTI_ALIASING,
  62     GRADIENT_SHADER_LINEAR_USER_SPACE,
  63     GRADIENT_SHADER_LINEAR_BOUNDING_BOX,
  64     GRADIENT_SHADER_RADIAL_USER_SPACE,
  65     GRADIENT_SHADER_RADIAL_BOUNDING_BOX,
  66     IMAGE_SHADER,
  67     BATCH_IMAGE_SHADER,
  68     IMAGE_SHADER_ATLAS_DEFAULT_WRAP,
  69     IMAGE_SHADER_ATLAS_CUSTOM_WRAP,
  70     NINE_PATCH_SHADER,
  71     SVG_SHADER,
  72     SHADER_TYPE_MAX = SVG_SHADER
  73   };
  74
  75   /**
  76    * Type of geometry for caching.
  77    */
  78   enum GeometryType
  79   {
  80     QUAD_GEOMETRY,
  81     BORDER_GEOMETRY,
  82     NINE_PATCH_GEOMETRY,
  83     NINE_PATCH_BORDER_GEOMETRY,
  84     GEOMETRY_TYPE_MAX = NINE_PATCH_BORDER_GEOMETRY
  85   };
  86
  87 public:
  88
  89   /**
  90    * @brief Constructor
  91    */
  92   VisualFactoryCache();
  93
  94   /**
  95    * Request geometry of the given type.
  96    * @return The geometry of the required type if it exist in the cache. Otherwise, an empty handle is returned.
  97    */
  98   Geometry GetGeometry( GeometryType type );
  99
 100   /**
 101    * Cache the geometry of the give type.
 102    * @param[in] type The geometry type.
 103    * @param[in] geometry The geometry for caching.
 104    */
 105   void SaveGeometry( GeometryType type, Geometry geometry);
 106
 107   /**
 108    * Request shader of the given type.
 109    * @return The shader of the required type if it exist in the cache. Otherwise, an empty handle is returned.
 110    */
 111   Shader GetShader( ShaderType type );
 112
 113   /**
 114    * Cache the geometry of the give type.
 115    * @param[in] type The geometry type.
 116    * @param[in] geometry The geometry for caching.
 117    */
 118   void SaveShader( ShaderType type, Shader shader );
 119
 120   /*
 121    * Greate the quad geometry.
 122    * Quad geometry is shared by multiple kind of Renderer, so implement it in the factory-cache.
 123    */
 124   static Geometry CreateQuadGeometry();
 125
 126   /**
 127    * Create the grid geometry.
 128    * @param[in] gridSize The size of the grid.
 129    * @return The created grid geometry.
 130    */
 131   static Geometry CreateGridGeometry( Uint16Pair gridSize );
 132
 133   /**
 134    * Create the batchable geometry
 135    * @param[in] texCoords The texture atlas rect coordinates
 136    * @return The created batchable geometry
 137    */
 138   static Geometry CreateBatchQuadGeometry( Vector4 texCoords );
 139
 140   /**
 141    * @brief Returns an image to be used when a visual has failed to correctly render
 142    * @return The broken image handle.
 143    */
 144   static Image GetBrokenVisualImage();
 145
 146 public:
 147
 148   /**
 149    * @brief Request renderer from the url
 150    *
 151    * @return The cached renderer if exist in the cache. Otherwise an empty handle is returned.
 152    */
 153   Renderer GetRenderer( const std::string& key ) const;
 154
 155   /**
 156    * @brief Cache the renderer based on the given key.
 157    *
 158    * If the key already exists in the cache, then the cache will save an additional renderer to the cache.
 159    * RemoveRenderer will then need to be called twice to remove both items from the cache.
 160    *
 161    * @param[in] key The key to use for caching
 162    * @param[in] renderer The Renderer to be cached
 163    */
 164   void SaveRenderer( const std::string& key, Renderer& renderer );
 165
 166   /**
 167    * @brief Cleans the renderer cache by removing the renderer from the cache based on the given key if there are no longer any references to it
 168    *
 169    * @param[in] key The key used for caching
 170    *
 171    * @return True if the renderer is no longer used anywhere, false otherwise
 172    */
 173   bool CleanRendererCache( const std::string& key );
 174
 175   /**
 176    * @brief Cache the wireframe renderer
 177    */
 178   void CacheWireframeRenderer( Renderer& renderer );
 179
 180   /**
 181    * @brief Request the wireframe renderer;
 182    */
 183   Renderer GetWireframeRenderer();
 184
 185   /**
 186    * Get the image atlas manager.
 187    * @return A pointer to the atlas manager
 188    */
 189   ImageAtlasManagerPtr GetAtlasManager();
 190
 191   /**
 192    * Get the N-Patch texture cache.
 193    * @return A reference to the N patch loader
 194    */
 195   NPatchLoader& GetNPatchLoader();
 196
 197   /**
 198    * Get the SVG rasterization thread.
 199    * @return A raw pointer pointing to the SVG rasterization thread.
 200    */
 201   SvgRasterizeThread* GetSVGRasterizationThread();
 202
 203 private: // for svg rasterization thread
 204
 205   /**
 206    * Applies the rasterized image to material
 207    */
 208   void ApplyRasterizedSVGToSampler();
 209
 210 protected:
 211
 212   /**
 213    * A reference counted object may only be deleted by calling Unreference()
 214    */
 215   virtual ~VisualFactoryCache();
 216
 217   /**
 218    * Undefined copy constructor.
 219    */
 220   VisualFactoryCache(const VisualFactoryCache&);
 221
 222   /**
 223    * Undefined assignment operator.
 224    */
 225   VisualFactoryCache& operator=(const VisualFactoryCache& rhs);
 226
 227 private:
 228   struct CachedRenderer
 229   {
 230     std::string mKey;
 231     WeakHandle< Renderer > mRenderer;
 232
 233     CachedRenderer( const std::string& key, Renderer& renderer )
 234     : mKey( key ),
 235       mRenderer( renderer)
 236     {}
 237   };
 238
 239   typedef Dali::Vector< std::size_t > HashVector;
 240   typedef Dali::OwnerContainer< const CachedRenderer* > CachedRenderers;
 241
 242   /**
 243    * @brief Finds the first index into the cached visuals from the url
 244    *
 245    * @return Returns the first index into the cached renderer from the url if it exists in the cache, otherwise returns -1
 246    */
 247   int FindRenderer( const std::string& key ) const;
 248
 249 private:
 250   Geometry mGeometry[GEOMETRY_TYPE_MAX+1];
 251   Shader mShader[SHADER_TYPE_MAX+1];
 252
 253   HashVector mRendererHashes;
 254   CachedRenderers mRenderers;
 255
 256   Renderer mWireframeRenderer;
 257
 258   ImageAtlasManagerPtr mAtlasManager;
 259   NPatchLoader mNPatchLoader;
 260
 261   SvgRasterizeThread*  mSvgRasterizeThread;
 262 };
 263
 264 } // namespace Internal
 265
 266 } // namespace Toolkit
 267
 268 } // namespace Dali
 269
 270 #endif // DALI_TOOLKIT_VISUAL_FACTORY_CACHE_H