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 #include <dali-toolkit/internal/visuals/svg/svg-task.h>
  29
  30 namespace Dali
  31 {
  32 namespace Toolkit
  33 {
  34 namespace Internal
  35 {
  36 class ImageVisualShaderFactory;
  37 class SvgVisual;
  38 typedef IntrusivePtr<SvgVisual> SvgVisualPtr;
  39
  40 /**
  41  * The visual which renders a svg image
  42  *
  43  * The following property is essential
  44  *
  45  * | %Property Name           | Type             |
  46  * |--------------------------|------------------|
  47  * | url                      | STRING           |
  48  *
  49  */
  50 class SvgVisual : public Visual::Base
  51 {
  52 public:
  53   /**
  54    * @brief Create the SVG Visual using the image URL.
  55    *
  56    * The visual will parse the SVG image once it is set.
  57    * And rasterize it into BufferImage synchronously when the associated actor is put on stage, and destroy the BufferImage when it is off stage
  58    *
  59    * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
  60    * @param[in] shaderFactory The ImageVisualShaderFactory object
  61    * @param[in] imageUrl The URL to svg resource to use
  62    * @param[in] properties A Property::Map containing settings for this visual
  63    * @return A smart-pointer to the newly allocated visual.
  64    */
  65   static SvgVisualPtr New(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl, const Property::Map& properties);
  66
  67   /**
  68    * @brief Create the SVG Visual using the image URL.
  69    *
  70    * The visual will parse the SVG image once it is set.
  71    * And rasterize it into BufferImage synchronously when the associated actor is put on stage, and destroy the BufferImage when it is off stage
  72    *
  73    * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
  74    * @param[in] shaderFactory The ImageVisualShaderFactory object
  75    * @param[in] imageUrl The URL to svg resource to use
  76    * @param[in] size The width and height of the rasterized buffer. The visual size will be used if these are 0.
  77    * @return A smart-pointer to the newly allocated visual.
  78    */
  79   static SvgVisualPtr New(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl, ImageDimensions size = ImageDimensions());
  80
  81 public: // from Visual
  82   /**
  83    * @copydoc Visual::Base::GetNaturalSize
  84    */
  85   void GetNaturalSize(Vector2& naturalSize) override;
  86
  87   /**
  88    * @copydoc Visual::Base::CreatePropertyMap
  89    */
  90   void DoCreatePropertyMap(Property::Map& map) const override;
  91
  92   /**
  93    * @copydoc Visual::Base::CreateInstancePropertyMap
  94    */
  95   void DoCreateInstancePropertyMap(Property::Map& map) const override;
  96
  97   /**
  98    * @copydoc Visual::Base::EnablePreMultipliedAlpha
  99    */
 100   void EnablePreMultipliedAlpha(bool preMultiplied) override;
 101
 102 protected:
 103   /**
 104    * @brief Constructor.
 105    *
 106    * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
 107    * @param[in] shaderFactory The ImageVisualShaderFactory object
 108    * @param[in] imageUrl The URL to svg resource to use
 109    * @param[in] size The width and height of the rasterized buffer. The visual size will be used if these are 0.
 110    */
 111   SvgVisual(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl, ImageDimensions size);
 112
 113   /**
 114    * @brief A reference counted object may only be deleted by calling Unreference().
 115    */
 116   virtual ~SvgVisual();
 117
 118   /**
 119    * @copydoc Visual::Base::OnInitialize
 120    */
 121   void OnInitialize() override;
 122
 123   /**
 124    * @copydoc Visual::Base::DoSetProperties
 125    */
 126   void DoSetProperties(const Property::Map& propertyMap) override;
 127
 128   /**
 129    * @copydoc Visual::Base::DoSetOnScene
 130    */
 131   void DoSetOnScene(Actor& actor) override;
 132
 133   /**
 134    * @copydoc Visual::Base::DoSetOffScene
 135    */
 136   void DoSetOffScene(Actor& actor) override;
 137
 138   /**
 139    * @copydoc Visual::Base::OnSetTransform
 140    */
 141   void OnSetTransform() override;
 142
 143   /**
 144    * @copydoc Visual::Base::UpdateShader
 145    */
 146   void UpdateShader() override;
 147
 148   /**
 149    * @copydoc Visual::Base::GenerateShader
 150    */
 151   Shader GenerateShader() const override;
 152
 153 public:
 154   /**
 155    * @bried Apply the rasterized image to the visual.
 156    *
 157    * @param[in] task SvgTaskPtr
 158    */
 159   void ApplyRasterizedImage(SvgTaskPtr task);
 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   SvgTaskPtr                mLoadingTask;
 193   SvgTaskPtr                mRasterizingTask;
 194   bool                      mLoadFailed;
 195   bool                      mAttemptAtlasing; ///< If true will attempt atlasing, otherwise create unique texture
 196 };
 197
 198 } // namespace Internal
 199
 200 } // namespace Toolkit
 201
 202 } // namespace Dali
 203
 204 #endif /* DALI_TOOLKIT_INTERNAL_SVG_VISUAL_H */