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) 2019 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 struct NSVGimage;
  30
  31 namespace Dali
  32 {
  33
  34 namespace Toolkit
  35 {
  36
  37 namespace Internal
  38 {
  39
  40 class ImageVisualShaderFactory;
  41 class SvgVisual;
  42 typedef IntrusivePtr< SvgVisual > SvgVisualPtr;
  43
  44 /**
  45  * The visual which renders a svg image
  46  *
  47  * The following property is essential
  48  *
  49  * | %Property Name           | Type             |
  50  * |--------------------------|------------------|
  51  * | url                      | STRING           |
  52  *
  53  */
  54 class SvgVisual: public Visual::Base
  55 {
  56 public:
  57
  58   /**
  59    * @brief Create the SVG Visual using the image URL.
  60    *
  61    * The visual will parse the SVG image once it is set.
  62    * And rasterize it into BufferImage synchronously when the associated actor is put on stage, and destroy the BufferImage when it is off stage
  63    *
  64    * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
  65    * @param[in] shaderFactory The ImageVisualShaderFactory object
  66    * @param[in] imageUrl The URL to svg resource to use
  67    * @param[in] properties A Property::Map containing settings for this visual
  68    * @return A smart-pointer to the newly allocated visual.
  69    */
  70   static SvgVisualPtr New( VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl, const Property::Map& properties );
  71
  72   /**
  73    * @brief Create the SVG Visual using the image URL.
  74    *
  75    * The visual will parse the SVG image once it is set.
  76    * And rasterize it into BufferImage synchronously when the associated actor is put on stage, and destroy the BufferImage when it is off stage
  77    *
  78    * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
  79    * @param[in] shaderFactory The ImageVisualShaderFactory object
  80    * @param[in] imageUrl The URL to svg resource to use
  81    * @return A smart-pointer to the newly allocated visual.
  82    */
  83   static SvgVisualPtr New( VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl );
  84
  85 public:  // from Visual
  86
  87   /**
  88    * @copydoc Visual::Base::GetNaturalSize
  89    */
  90   void GetNaturalSize( Vector2& naturalSize ) override;
  91
  92   /**
  93    * @copydoc Visual::Base::CreatePropertyMap
  94    */
  95   void DoCreatePropertyMap( Property::Map& map ) const override;
  96
  97   /**
  98    * @copydoc Visual::Base::CreateInstancePropertyMap
  99    */
 100   void DoCreateInstancePropertyMap( Property::Map& map ) const override;
 101
 102 protected:
 103
 104   /**
 105    * @brief Constructor.
 106    *
 107    * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
 108    * @param[in] shaderFactory The ImageVisualShaderFactory object
 109    */
 110   SvgVisual( VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory );
 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::DoSetProperties
 119    */
 120   void DoSetProperties( const Property::Map& propertyMap ) override;
 121
 122   /**
 123    * @copydoc Visual::Base::DoSetOnStage
 124    */
 125   void DoSetOnStage( Actor& actor ) override;
 126
 127   /**
 128    * @copydoc Visual::Base::DoSetOffStage
 129    */
 130   void DoSetOffStage( Actor& actor ) override;
 131
 132   /**
 133    * @copydoc Visual::Base::OnSetTransform
 134    */
 135   void OnSetTransform() override;
 136
 137 public:
 138
 139   /**
 140    * @bried Apply the rasterized image to the visual.
 141    *
 142    * @param[in] rasterizedPixelData The pixel buffer with the rasterized pixels
 143    */
 144   void ApplyRasterizedImage( PixelData rasterizedPixelData );
 145
 146 private:
 147
 148   /**
 149    * @brief Parses the SVG Image from the set URL.
 150    *
 151    * @param[in] imageUrl The URL of the image to parse the SVG from.
 152    */
 153   void ParseFromUrl( const VisualUrl& imageUrl );
 154
 155   /**
 156    * @bried Rasterize the svg with the given size, and add it to the visual.
 157    *
 158    * @param[in] size The target size of the SVG rasterization.
 159    */
 160   void AddRasterizationTask( const Vector2& size );
 161
 162   /**
 163    * Helper method to set individual values by index key.
 164    * @param[in] index The index key of the value
 165    * @param[in] value The value
 166    */
 167   void DoSetProperty( Property::Index index, const Property::Value& value );
 168
 169
 170   // Undefined
 171   SvgVisual( const SvgVisual& svgRenderer );
 172
 173   // Undefined
 174   SvgVisual& operator=( const SvgVisual& svgRenderer );
 175
 176 private:
 177   ImageVisualShaderFactory& mImageVisualShaderFactory;
 178   Vector4                   mAtlasRect;
 179   VisualUrl                 mImageUrl;
 180   NSVGimage*                mParsedImage;
 181   WeakHandle<Actor>         mPlacementActor;
 182   Vector2                   mVisualSize;
 183   bool                      mAttemptAtlasing;  ///< If true will attempt atlasing, otherwise create unique texture
 184 };
 185
 186 } // namespace Internal
 187
 188 } // namespace Toolkit
 189
 190 } // namespace Dali
 191
 192 #endif /* DALI_TOOLKIT_INTERNAL_SVG_VISUAL_H */