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) 2016 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/devel-api/object/weak-handle.h>
  24
  25 // INTERNAL INCLUDES
  26 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
  27
  28 struct NSVGimage;
  29
  30 namespace Dali
  31 {
  32
  33 namespace Toolkit
  34 {
  35
  36 namespace Internal
  37 {
  38
  39 class SvgVisual;
  40 typedef IntrusivePtr< SvgVisual > SvgVisualPtr;
  41
  42 /**
  43  * The visual which renders a svg image
  44  *
  45  * The following property is essential
  46  *
  47  * | %Property Name           | Type             |
  48  * |--------------------------|------------------|
  49  * | url                      | STRING           |
  50  *
  51  */
  52 class SvgVisual: public Visual::Base
  53 {
  54 public:
  55
  56   /**
  57    * @brief Create the SVG Visual using the image URL.
  58    *
  59    * The visual will parse the SVG image once it is set.
  60    * And rasterize it into BufferImage synchronously when the associated actor is put on stage, and destroy the BufferImage when it is off stage
  61    *
  62    * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
  63    * @param[in] imageUrl The URL to svg resource to use
  64    * @param[in] size The required size for the SVG
  65    */
  66   static SvgVisualPtr New( VisualFactoryCache& factoryCache, const std::string& imageUrl, ImageDimensions size = ImageDimensions() );
  67
  68 public:  // from Visual
  69
  70   /**
  71    * @copydoc Visual::Base::GetNaturalSize
  72    */
  73   virtual void GetNaturalSize( Vector2& naturalSize ) const;
  74
  75   /**
  76    * @copydoc Visual::Base::SetSize
  77    */
  78   virtual void SetSize( const Vector2& size );
  79
  80   /**
  81    * @copydoc Visual::Base::CreatePropertyMap
  82    */
  83   virtual void DoCreatePropertyMap( Property::Map& map ) const;
  84
  85   /**
  86    * @copydoc Visual::Base::DoSetProperty
  87    */
  88   virtual void DoSetProperty( Dali::Property::Index index, const Dali::Property::Value& propertyValue );
  89
  90   /**
  91    * @copydoc Visual::Base::DoGetProperty
  92    */
  93   virtual Dali::Property::Value DoGetProperty( Dali::Property::Index index );
  94
  95 protected:
  96
  97   /**
  98    * @brief Constructor.
  99    *
 100    * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
 101    */
 102   SvgVisual( VisualFactoryCache& factoryCache );
 103
 104   /**
 105    * @brief A reference counted object may only be deleted by calling Unreference().
 106    */
 107   virtual ~SvgVisual();
 108
 109   /**
 110    * @copydoc Visual::Base::DoSetProperties
 111    */
 112   virtual void DoSetProperties( const Property::Map& propertyMap );
 113
 114   /**
 115    * @copydoc Visual::Base::DoSetOnStage
 116    */
 117   virtual void DoSetOnStage( Actor& actor );
 118
 119   /**
 120    * @copydoc Visual::Base::DoSetOffStage
 121    */
 122   virtual void DoSetOffStage( Actor& actor );
 123
 124 public:
 125
 126   /**
 127    * @bried Apply the rasterized image to the visual.
 128    *
 129    * @param[in] rasterizedPixelData The pixel buffer with the rasterized pixels
 130    */
 131   void ApplyRasterizedImage( PixelData rasterizedPixelData );
 132
 133 private:
 134
 135   /**
 136    * @brief Parses the SVG Image from the set URL.
 137    *
 138    * @param[in] imageUrl The URL of the image to parse the SVG from.
 139    * @param[in] size The required size of the SVG
 140    */
 141   void ParseFromUrl( const std::string& imageUrl, ImageDimensions size = ImageDimensions() );
 142
 143   /**
 144    * @bried Rasterize the svg with the given size, and add it to the visual.
 145    *
 146    * @param[in] size The target size of the SVG rasterization.
 147    */
 148   void AddRasterizationTask( const Vector2& size );
 149
 150
 151   // Undefined
 152   SvgVisual( const SvgVisual& svgRenderer );
 153
 154   // Undefined
 155   SvgVisual& operator=( const SvgVisual& svgRenderer );
 156
 157 private:
 158   Vector4              mAtlasRect;
 159   std::string          mImageUrl;
 160   NSVGimage*           mParsedImage;
 161   WeakHandle<Actor>    mPlacementActor;
 162
 163 };
 164
 165 } // namespace Internal
 166
 167 } // namespace Toolkit
 168
 169 } // namespace Dali
 170
 171 #endif /* DALI_TOOLKIT_INTERNAL_SVG_VISUAL_H */