Request load texture again if the observer is destroyed during loading.
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / visuals / npatch-loader.h
index d1df302..51f2482 100644 (file)
@@ -2,7 +2,7 @@
 #define DALI_TOOLKIT_NPATCH_LOADER_H
 
 /*
- * Copyright (c) 2016 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2020 Samsung Electronics Co., Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
 #include <string>
 #include <dali/public-api/rendering/texture-set.h>
 #include <dali/devel-api/common/owner-container.h>
-#include <dali/devel-api/images/nine-patch-image.h>
+#include <dali/devel-api/adaptor-framework/pixel-buffer.h>
 
 // INTERNAL INCLUDES
-#include <dali-toolkit/devel-api/image-loader/image-atlas.h>
+#include <dali-toolkit/internal/visuals/texture-manager-impl.h>
+#include <dali-toolkit/devel-api/utility/npatch-utilities.h>
 
 namespace Dali
 {
@@ -47,6 +48,18 @@ namespace Internal
 class NPatchLoader
 {
 public:
+  /**
+   * Observer class to inform the npatch image is loaded.
+   */
+  class NPatchLoadObserver: public Dali::Toolkit::TextureUploadObserver
+  {
+  public:
+    /**
+     * Informs observer when the npatch image is loaded.
+     * @param[in] preMultiplied True if the image had pre-multiplied alpha applied
+     */
+    virtual void NPatchLoadComplete ( bool preMultiplied ) = 0;
+  };
 
   enum
   {
@@ -55,14 +68,34 @@ public:
 
   struct Data
   {
-    std::string url;                              ///< Url of the N-Patch
-    TextureSet textureSet;                        ///< Texture containing the cropped image
-    NinePatchImage::StretchRanges stretchPixelsX; ///< X stretch pixels
-    NinePatchImage::StretchRanges stretchPixelsY; ///< Y stretch pixels
-    std::size_t hash;                             ///< Hash code for the Url
-    uint32_t croppedWidth;                        ///< Width of the cropped middle part of N-patch
-    uint32_t croppedHeight;                       ///< Height of the cropped middle part of N-patch
-    Rect< int > border;                           ///< The size of the border
+    Data()
+    : url(),
+      textureSet(),
+      hash( 0 ),
+      croppedWidth( 0 ),
+      croppedHeight( 0 ),
+      border( 0, 0, 0, 0 ),
+      loadCompleted( false ),
+      renderingMap{ nullptr }
+    {}
+
+    ~Data();
+
+    using ObserverListType = Dali::Vector< NPatchLoadObserver* >;
+
+    TextureUploadObserver* textureObserver;              ///< TextureUploadObserver that requests to load texture.
+    ObserverListType observerList;                       ///< Container used to store all observer clients of this Texture
+    std::string url;                                     ///< Url of the N-Patch
+    TextureSet textureSet;                               ///< Texture containing the cropped image
+    NPatchUtility::StretchRanges stretchPixelsX;         ///< X stretch pixels
+    NPatchUtility::StretchRanges stretchPixelsY;         ///< Y stretch pixels
+    std::size_t hash;                                    ///< Hash code for the Url
+    uint32_t croppedWidth;                               ///< Width of the cropped middle part of N-patch
+    uint32_t croppedHeight;                              ///< Height of the cropped middle part of N-patch
+    Rect< int > border;                                  ///< The size of the border
+    bool preMultiplyOnLoad;                              ///< Whether to multiply alpha into color channels on load 
+    bool loadCompleted;                                  ///< True if the data loading is completed
+    void* renderingMap;                                  ///< NPatch rendering data
   };
 
 public:
@@ -80,11 +113,25 @@ public:
   /**
    * @brief Retrieve a texture matching the n-patch url.
    *
+   * @param [in] textureManager that will be used to loading image
+   * @param [in] nPatchObserver The NPatchVisual that requested loading.
    * @param [in] url to retrieve
    * @param [in] border The border size of the image
+   * @param [in,out] preMultiplyOnLoad True if the image color should be multiplied by it's alpha. Set to false if the
+   *                                   image has no alpha channel
+   * @param [in] synchronousLoading True if the image will be loaded in synchronous time.
    * @return id of the texture.
    */
-  std::size_t Load( const std::string& url, const Rect< int >& border );
+  std::size_t Load( TextureManager& textureManager, NPatchLoadObserver* nPatchObserver, const std::string& url, const Rect< int >& border, bool& preMultiplyOnLoad, bool synchronousLoading );
+
+  /**
+   * @brief Set loaded PixelBuffer and its information
+   *
+   * @param [in] id cache data id
+   * @param [in] pixelBuffer of loaded image
+   * @param [in] preMultiplied True if the image had pre-multiplied alpha applied
+   */
+  void SetNPatchData( std::size_t id, Devel::PixelBuffer& pixelBuffer, bool preMultiplied );
 
   /**
    * @brief Retrieve N patch data matching to an id
@@ -94,6 +141,8 @@ public:
    */
   bool GetNPatchData( std::size_t id, const Data*& data );
 
+  void Remove( std::size_t id, TextureManager& textureManager, NPatchLoadObserver* nPatchObserver, bool synchronousLoading );
+
 protected:
 
   /**