1 #ifndef DALI_TOOLKIT_INTERNAL_SVG_VISUAL_H
2 #define DALI_TOOLKIT_INTERNAL_SVG_VISUAL_H
5 * Copyright (c) 2021 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/public-api/object/weak-handle.h>
26 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
27 #include <dali-toolkit/internal/visuals/visual-url.h>
38 class ImageVisualShaderFactory;
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] shaderFactory The ImageVisualShaderFactory object
64 * @param[in] imageUrl The URL to svg resource to use
65 * @param[in] properties A Property::Map containing settings for this visual
66 * @return A smart-pointer to the newly allocated visual.
68 static SvgVisualPtr New( VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl, const Property::Map& properties );
71 * @brief Create the SVG Visual using the image URL.
73 * The visual will parse the SVG image once it is set.
74 * And rasterize it into BufferImage synchronously when the associated actor is put on stage, and destroy the BufferImage when it is off stage
76 * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
77 * @param[in] shaderFactory The ImageVisualShaderFactory object
78 * @param[in] imageUrl The URL to svg resource to use
79 * @return A smart-pointer to the newly allocated visual.
81 static SvgVisualPtr New( VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl );
83 public: // from Visual
86 * @copydoc Visual::Base::GetNaturalSize
88 void GetNaturalSize( Vector2& naturalSize ) override;
91 * @copydoc Visual::Base::CreatePropertyMap
93 void DoCreatePropertyMap( Property::Map& map ) const override;
96 * @copydoc Visual::Base::CreateInstancePropertyMap
98 void DoCreateInstancePropertyMap( Property::Map& map ) const override;
103 * @brief Constructor.
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
109 SvgVisual( VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl );
112 * @brief A reference counted object may only be deleted by calling Unreference().
114 virtual ~SvgVisual();
117 * @copydoc Visual::Base::OnInitialize
119 void OnInitialize() override;
122 * @copydoc Visual::Base::DoSetProperties
124 void DoSetProperties( const Property::Map& propertyMap ) override;
127 * @copydoc Visual::Base::DoSetOnScene
129 void DoSetOnScene( Actor& actor ) override;
132 * @copydoc Visual::Base::DoSetOffScene
134 void DoSetOffScene( Actor& actor ) override;
137 * @copydoc Visual::Base::OnSetTransform
139 void OnSetTransform() override;
142 * @copydoc Visual::Base::IsResourceReady
144 bool IsResourceReady() const override;
149 * @bried Apply the rasterized image to the visual.
151 * @param[in] vectorImage The data of vector image.
152 * @param[in] rasterizedPixelData The pixel buffer with the rasterized pixels
153 * @param[in] bool Whether the resource is loaded
155 void ApplyRasterizedImage( VectorImageRenderer vectorImage, PixelData rasterizedPixelData, bool isLoaded );
159 * @brief Load the SVG Image from the set URL.
164 * @bried Rasterize the svg with the given size, and add it to the visual.
166 * @param[in] size The target size of the SVG rasterization.
168 void AddRasterizationTask( const Vector2& size );
171 * Helper method to set individual values by index key.
172 * @param[in] index The index key of the value
173 * @param[in] value The value
175 void DoSetProperty( Property::Index index, const Property::Value& value );
178 SvgVisual( const SvgVisual& svgRenderer );
181 SvgVisual& operator=( const SvgVisual& svgRenderer );
184 ImageVisualShaderFactory& mImageVisualShaderFactory;
187 VectorImageRenderer mVectorRenderer;
188 uint32_t mDefaultWidth;
189 uint32_t mDefaultHeight;
190 WeakHandle<Actor> mPlacementActor;
193 bool mAttemptAtlasing; ///< If true will attempt atlasing, otherwise create unique texture
196 } // namespace Internal
198 } // namespace Toolkit
202 #endif /* DALI_TOOLKIT_INTERNAL_SVG_VISUAL_H */