1 #ifndef DALI_TOOLKIT_INTERNAL_SVG_VISUAL_H
2 #define DALI_TOOLKIT_INTERNAL_SVG_VISUAL_H
5 * Copyright (c) 2016 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
22 #include <dali/public-api/common/intrusive-ptr.h>
23 #include <dali/devel-api/object/weak-handle.h>
26 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
40 typedef IntrusivePtr< SvgVisual > SvgVisualPtr;
43 * The visual which renders a svg image
45 * The following property is essential
47 * | %Property Name | Type |
48 * |--------------------------|------------------|
52 class SvgVisual: public Visual::Base
57 * @brief Create the SVG Visual using the image URL.
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
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
66 static SvgVisualPtr New( VisualFactoryCache& factoryCache, const std::string& imageUrl, ImageDimensions size = ImageDimensions() );
68 public: // from Visual
71 * @copydoc Visual::Base::GetNaturalSize
73 virtual void GetNaturalSize( Vector2& naturalSize ) const;
76 * @copydoc Visual::Base::SetSize
78 virtual void SetSize( const Vector2& size );
81 * @copydoc Visual::Base::CreatePropertyMap
83 virtual void DoCreatePropertyMap( Property::Map& map ) const;
86 * @copydoc Visual::Base::DoSetProperty
88 virtual void DoSetProperty( Dali::Property::Index index, const Dali::Property::Value& propertyValue );
91 * @copydoc Visual::Base::DoGetProperty
93 virtual Dali::Property::Value DoGetProperty( Dali::Property::Index index );
100 * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
102 SvgVisual( VisualFactoryCache& factoryCache );
105 * @brief A reference counted object may only be deleted by calling Unreference().
107 virtual ~SvgVisual();
110 * @copydoc Visual::Base::DoSetProperties
112 virtual void DoSetProperties( const Property::Map& propertyMap );
115 * @copydoc Visual::Base::DoSetOnStage
117 virtual void DoSetOnStage( Actor& actor );
120 * @copydoc Visual::Base::DoSetOffStage
122 virtual void DoSetOffStage( Actor& actor );
127 * @bried Apply the rasterized image to the visual.
129 * @param[in] rasterizedPixelData The pixel buffer with the rasterized pixels
131 void ApplyRasterizedImage( PixelData rasterizedPixelData );
136 * @brief Parses the SVG Image from the set URL.
138 * @param[in] imageUrl The URL of the image to parse the SVG from.
139 * @param[in] size The required size of the SVG
141 void ParseFromUrl( const std::string& imageUrl, ImageDimensions size = ImageDimensions() );
144 * @bried Rasterize the svg with the given size, and add it to the visual.
146 * @param[in] size The target size of the SVG rasterization.
148 void AddRasterizationTask( const Vector2& size );
152 SvgVisual( const SvgVisual& svgRenderer );
155 SvgVisual& operator=( const SvgVisual& svgRenderer );
159 std::string mImageUrl;
160 NSVGimage* mParsedImage;
161 WeakHandle<Actor> mPlacementActor;
165 } // namespace Internal
167 } // namespace Toolkit
171 #endif /* DALI_TOOLKIT_INTERNAL_SVG_VISUAL_H */