dali-toolkit/internal/visuals/svg/svg-visual.h

   1 #ifndef DALI_TOOLKIT_INTERNAL_SVG_VISUAL_H
   2 #define DALI_TOOLKIT_INTERNAL_SVG_VISUAL_H
   3
   4 /*
   5  * Copyright (c) 2022 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
  21 // EXTERNAL INCLUDES
  22 #include <dali/public-api/common/intrusive-ptr.h>
  23 #include <dali/public-api/object/weak-handle.h>
  24
  25 // INTERNAL INCLUDES
  26 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
  27 #include <dali-toolkit/internal/visuals/visual-url.h>
  28
  29 namespace Dali
  30 {
  31 namespace Toolkit
  32 {
  33 namespace Internal
  34 {
  35 class ImageVisualShaderFactory;
  36 class SvgVisual;
  37 typedef IntrusivePtr<SvgVisual> SvgVisualPtr;
  38
  39 /**
  40  * The visual which renders a svg image
  41  *
  42  * The following property is essential
  43  *
  44  * | %Property Name           | Type             |
  45  * |--------------------------|------------------|
  46  * | url                      | STRING           |
  47  *
  48  */
  49 class SvgVisual : public Visual::Base
  50 {
  51 public:
  52   /**
  53    * @brief Create the SVG Visual using the image URL.
  54    *
  55    * The visual will parse the SVG image once it is set.
  56    * And rasterize it into BufferImage synchronously when the associated actor is put on stage, and destroy the BufferImage when it is off stage
  57    *
  58    * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
  59    * @param[in] shaderFactory The ImageVisualShaderFactory object
  60    * @param[in] imageUrl The URL to svg resource to use
  61    * @param[in] properties A Property::Map containing settings for this visual
  62    * @return A smart-pointer to the newly allocated visual.
  63    */
  64   static SvgVisualPtr New(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl, const Property::Map& properties);
  65
  66   /**
  67    * @brief Create the SVG Visual using the image URL.
  68    *
  69    * The visual will parse the SVG image once it is set.
  70    * And rasterize it into BufferImage synchronously when the associated actor is put on stage, and destroy the BufferImage when it is off stage
  71    *
  72    * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
  73    * @param[in] shaderFactory The ImageVisualShaderFactory object
  74    * @param[in] imageUrl The URL to svg resource to use
  75    * @param[in] size The width and height of the rasterized buffer. The visual size will be used if these are 0.
  76    * @return A smart-pointer to the newly allocated visual.
  77    */
  78   static SvgVisualPtr New(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl, ImageDimensions size = ImageDimensions());
  79
  80 public: // from Visual
  81   /**
  82    * @copydoc Visual::Base::GetNaturalSize
  83    */
  84   void GetNaturalSize(Vector2& naturalSize) override;
  85
  86   /**
  87    * @copydoc Visual::Base::CreatePropertyMap
  88    */
  89   void DoCreatePropertyMap(Property::Map& map) const override;
  90
  91   /**
  92    * @copydoc Visual::Base::CreateInstancePropertyMap
  93    */
  94   void DoCreateInstancePropertyMap(Property::Map& map) const override;
  95
  96   /**
  97    * @copydoc Visual::Base::EnablePreMultipliedAlpha
  98    */
  99   void EnablePreMultipliedAlpha(bool preMultiplied) override;
 100
 101 protected:
 102   /**
 103    * @brief Constructor.
 104    *
 105    * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
 106    * @param[in] shaderFactory The ImageVisualShaderFactory object
 107    * @param[in] imageUrl The URL to svg resource to use
 108    * @param[in] size The width and height of the rasterized buffer. The visual size will be used if these are 0.
 109    */
 110   SvgVisual(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl, ImageDimensions size);
 111
 112   /**
 113    * @brief A reference counted object may only be deleted by calling Unreference().
 114    */
 115   virtual ~SvgVisual();
 116
 117   /**
 118    * @copydoc Visual::Base::OnInitialize
 119    */
 120   void OnInitialize() override;
 121
 122   /**
 123    * @copydoc Visual::Base::DoSetProperties
 124    */
 125   void DoSetProperties(const Property::Map& propertyMap) override;
 126
 127   /**
 128    * @copydoc Visual::Base::DoSetOnScene
 129    */
 130   void DoSetOnScene(Actor& actor) override;
 131
 132   /**
 133    * @copydoc Visual::Base::DoSetOffScene
 134    */
 135   void DoSetOffScene(Actor& actor) override;
 136
 137   /**
 138    * @copydoc Visual::Base::OnSetTransform
 139    */
 140   void OnSetTransform() override;
 141
 142   /**
 143    * @copydoc Visual::Base::UpdateShader
 144    */
 145   void UpdateShader() override;
 146
 147   /**
 148    * @copydoc Visual::Base::GenerateShader
 149    */
 150   Shader GenerateShader() const override;
 151
 152 public:
 153   /**
 154    * @bried Apply the rasterized image to the visual.
 155    *
 156    * @param[in] rasterizedPixelData The pixel buffer with the rasterized pixels
 157    * @param[in] success Whether the task succeeds.
 158    */
 159   void ApplyRasterizedImage(PixelData rasterizedPixelData, bool success);
 160
 161 private:
 162   /**
 163    * @bried Rasterize the svg with the given size, and add it to the visual.
 164    *
 165    * @param[in] size The target size of the SVG rasterization.
 166    */
 167   void AddRasterizationTask(const Vector2& size);
 168
 169   /**
 170    * Helper method to set individual values by index key.
 171    * @param[in] index The index key of the value
 172    * @param[in] value The value
 173    */
 174   void DoSetProperty(Property::Index index, const Property::Value& value);
 175
 176   // Undefined
 177   SvgVisual(const SvgVisual& svgRenderer);
 178
 179   // Undefined
 180   SvgVisual& operator=(const SvgVisual& svgRenderer);
 181
 182 private:
 183   ImageVisualShaderFactory& mImageVisualShaderFactory;
 184   Vector4                   mAtlasRect;
 185   VisualUrl                 mImageUrl;
 186   VectorImageRenderer       mVectorRenderer;
 187   uint32_t                  mDefaultWidth;
 188   uint32_t                  mDefaultHeight;
 189   WeakHandle<Actor>         mPlacementActor;
 190   Vector2                   mRasterizedSize;
 191   Dali::ImageDimensions     mDesiredSize{};
 192   bool                      mLoadFailed;
 193   bool                      mAttemptAtlasing; ///< If true will attempt atlasing, otherwise create unique texture
 194 };
 195
 196 } // namespace Internal
 197
 198 } // namespace Toolkit
 199
 200 } // namespace Dali
 201
 202 #endif /* DALI_TOOLKIT_INTERNAL_SVG_VISUAL_H */