Trigger svg loading early
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / visuals / svg / svg-visual.h
index e516186..5c606f1 100644 (file)
@@ -2,7 +2,7 @@
 #define DALI_TOOLKIT_INTERNAL_SVG_VISUAL_H
 
 /*
- * Copyright (c) 2017 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2022 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 <dali-toolkit/internal/visuals/visual-base-impl.h>
 #include <dali-toolkit/internal/visuals/visual-url.h>
 
-struct NSVGimage;
-
 namespace Dali
 {
-
 namespace Toolkit
 {
-
 namespace Internal
 {
-
 class ImageVisualShaderFactory;
 class SvgVisual;
-typedef IntrusivePtr< SvgVisual > SvgVisualPtr;
+typedef IntrusivePtr<SvgVisual> SvgVisualPtr;
 
 /**
  * The visual which renders a svg image
@@ -51,10 +46,9 @@ typedef IntrusivePtr< SvgVisual > SvgVisualPtr;
  * | url                      | STRING           |
  *
  */
-class SvgVisual: public Visual::Base
+class SvgVisual : public Visual::Base
 {
 public:
-
   /**
    * @brief Create the SVG Visual using the image URL.
    *
@@ -67,7 +61,7 @@ public:
    * @param[in] properties A Property::Map containing settings for this visual
    * @return A smart-pointer to the newly allocated visual.
    */
-  static SvgVisualPtr New( VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl, const Property::Map& properties );
+  static SvgVisualPtr New(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl, const Property::Map& properties);
 
   /**
    * @brief Create the SVG Visual using the image URL.
@@ -80,34 +74,38 @@ public:
    * @param[in] imageUrl The URL to svg resource to use
    * @return A smart-pointer to the newly allocated visual.
    */
-  static SvgVisualPtr New( VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl );
-
-public:  // from Visual
+  static SvgVisualPtr New(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl);
 
+public: // from Visual
   /**
    * @copydoc Visual::Base::GetNaturalSize
    */
-  virtual void GetNaturalSize( Vector2& naturalSize );
+  void GetNaturalSize(Vector2& naturalSize) override;
 
   /**
    * @copydoc Visual::Base::CreatePropertyMap
    */
-  virtual void DoCreatePropertyMap( Property::Map& map ) const;
+  void DoCreatePropertyMap(Property::Map& map) const override;
 
   /**
    * @copydoc Visual::Base::CreateInstancePropertyMap
    */
-  virtual void DoCreateInstancePropertyMap( Property::Map& map ) const;
+  void DoCreateInstancePropertyMap(Property::Map& map) const override;
 
-protected:
+  /**
+   * @copydoc Visual::Base::EnablePreMultipliedAlpha
+   */
+  void EnablePreMultipliedAlpha(bool preMultiplied) override;
 
+protected:
   /**
    * @brief Constructor.
    *
    * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
    * @param[in] shaderFactory The ImageVisualShaderFactory object
+   * @param[in] imageUrl The URL to svg resource to use
    */
-  SvgVisual( VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory );
+  SvgVisual(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl);
 
   /**
    * @brief A reference counted object may only be deleted by calling Unreference().
@@ -115,72 +113,81 @@ protected:
   virtual ~SvgVisual();
 
   /**
+   * @copydoc Visual::Base::OnInitialize
+   */
+  void OnInitialize() override;
+
+  /**
    * @copydoc Visual::Base::DoSetProperties
    */
-  virtual void DoSetProperties( const Property::Map& propertyMap );
+  void DoSetProperties(const Property::Map& propertyMap) override;
 
   /**
-   * @copydoc Visual::Base::DoSetOnStage
+   * @copydoc Visual::Base::DoSetOnScene
    */
-  virtual void DoSetOnStage( Actor& actor );
+  void DoSetOnScene(Actor& actor) override;
 
   /**
-   * @copydoc Visual::Base::DoSetOffStage
+   * @copydoc Visual::Base::DoSetOffScene
    */
-  virtual void DoSetOffStage( Actor& actor );
+  void DoSetOffScene(Actor& actor) override;
 
   /**
    * @copydoc Visual::Base::OnSetTransform
    */
-  virtual void OnSetTransform();
-
-public:
+  void OnSetTransform() override;
 
   /**
-   * @bried Apply the rasterized image to the visual.
-   *
-   * @param[in] rasterizedPixelData The pixel buffer with the rasterized pixels
+   * @copydoc Visual::Base::UpdateShader
    */
-  void ApplyRasterizedImage( PixelData rasterizedPixelData );
+  void UpdateShader() override;
 
-private:
+  /**
+   * @copydoc Visual::Base::GenerateShader
+   */
+  Shader GenerateShader() const override;
 
+public:
   /**
-   * @brief Parses the SVG Image from the set URL.
+   * @bried Apply the rasterized image to the visual.
    *
-   * @param[in] imageUrl The URL of the image to parse the SVG from.
+   * @param[in] rasterizedPixelData The pixel buffer with the rasterized pixels
+   * @param[in] success Whether the task succeeds.
    */
-  void ParseFromUrl( const VisualUrl& imageUrl );
+  void ApplyRasterizedImage(PixelData rasterizedPixelData, bool success);
 
+private:
   /**
    * @bried Rasterize the svg with the given size, and add it to the visual.
    *
    * @param[in] size The target size of the SVG rasterization.
    */
-  void AddRasterizationTask( const Vector2& size );
+  void AddRasterizationTask(const Vector2& size);
 
   /**
    * Helper method to set individual values by index key.
    * @param[in] index The index key of the value
    * @param[in] value The value
    */
-  void DoSetProperty( Property::Index index, const Property::Value& value );
-
+  void DoSetProperty(Property::Index index, const Property::Value& value);
 
   // Undefined
-  SvgVisual( const SvgVisual& svgRenderer );
+  SvgVisual(const SvgVisual& svgRenderer);
 
   // Undefined
-  SvgVisual& operator=( const SvgVisual& svgRenderer );
+  SvgVisual& operator=(const SvgVisual& svgRenderer);
 
 private:
   ImageVisualShaderFactory& mImageVisualShaderFactory;
   Vector4                   mAtlasRect;
   VisualUrl                 mImageUrl;
-  NSVGimage*                mParsedImage;
+  VectorImageRenderer       mVectorRenderer;
+  uint32_t                  mDefaultWidth;
+  uint32_t                  mDefaultHeight;
   WeakHandle<Actor>         mPlacementActor;
-  Vector2                   mVisualSize;
-  bool                      mAttemptAtlasing;  ///< If true will attempt atlasing, otherwise create unique texture
+  Vector2                   mRasterizedSize;
+  bool                      mLoadFailed;
+  bool                      mAttemptAtlasing; ///< If true will attempt atlasing, otherwise create unique texture
 };
 
 } // namespace Internal