1 #ifndef DALI_TOOLKIT_INTERNAL_IMAGE_VISUAL_H
2 #define DALI_TOOLKIT_INTERNAL_IMAGE_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/public-api/images/image.h>
24 #include <dali/public-api/images/image-operations.h>
25 #include <dali/public-api/images/resource-image.h>
26 #include <dali/devel-api/object/weak-handle.h>
29 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
30 #include <dali-toolkit/devel-api/image-loader/atlas-upload-observer.h>
44 typedef IntrusivePtr< ImageVisual > ImageVisualPtr;
47 * The visual which renders an image to the control's quad
49 * The following properties are optional
51 * | %Property Name | Type |
52 * |--------------------|------------------|
54 * | fittingMode | STRING |
55 * | samplingMode | STRING |
56 * | desiredWidth | INT |
57 * | desiredHeight | INT |
58 * | synchronousLoading | BOOLEAN |
60 * where imageFittingMode should be one of the following fitting modes:
67 * where imageSamplingMode should be one of the following sampling modes:
78 class ImageVisual: public Visual::Base, public ConnectionTracker, public AtlasUploadObserver
83 * @brief Create a new image visual with a URL.
85 * The visual will load the Image asynchronously when the associated actor is put on stage, and destroy the image when it is off stage
87 * @param[in] factoryCache The VisualFactoryCache object
88 * @param[in] imageUrl The URL of the image resource to use
89 * @param[in] properties A Property::Map containing settings for this visual
90 * @param[in] size The width and height to fit the loaded image to.
91 * @param[in] fittingMode The FittingMode of the resource to load
92 * @param[in] samplingMode The SamplingMode of the resource to load
93 * @return A smart-pointer to the newly allocated visual.
95 static ImageVisualPtr New( VisualFactoryCache& factoryCache,
96 const std::string& imageUrl,
97 const Property::Map& properties,
98 ImageDimensions size = ImageDimensions(),
99 FittingMode::Type fittingMode = FittingMode::DEFAULT,
100 Dali::SamplingMode::Type samplingMode = SamplingMode::BOX_THEN_LINEAR );
103 * @brief Create a new image visual with a URL.
105 * The visual will load the Image asynchronously when the associated actor is put on stage, and destroy the image when it is off stage
107 * @param[in] factoryCache The VisualFactoryCache object
108 * @param[in] imageUrl The URL of the image resource to use
109 * @param[in] size The width and height to fit the loaded image to.
110 * @param[in] fittingMode The FittingMode of the resource to load
111 * @param[in] samplingMode The SamplingMode of the resource to load
112 * @return A smart-pointer to the newly allocated visual.
114 static ImageVisualPtr New( VisualFactoryCache& factoryCache,
115 const std::string& imageUrl,
116 ImageDimensions size = ImageDimensions(),
117 FittingMode::Type fittingMode = FittingMode::DEFAULT,
118 Dali::SamplingMode::Type samplingMode = SamplingMode::BOX_THEN_LINEAR );
121 * @brief Create a new image visual with an Image type.
123 * @param[in] factoryCache The VisualFactoryCache object
124 * @param[in] image The image to use
126 static ImageVisualPtr New( VisualFactoryCache& factoryCache, const Image& image );
128 public: // from Visual
131 * @copydoc Visual::Base::GetNaturalSize
133 virtual void GetNaturalSize( Vector2& naturalSize );
136 * @copydoc Visual::Base::CreatePropertyMap
138 virtual void DoCreatePropertyMap( Property::Map& map ) const;
143 * @brief Constructor with a URL.
145 * The visual will load the Image asynchronously when the associated actor is put on stage, and destroy the image when it is off stage
147 * @param[in] factoryCache The VisualFactoryCache object
148 * @param[in] imageUrl The URL of the image resource to use
149 * @param[in] size The width and height to fit the loaded image to.
150 * @param[in] fittingMode The FittingMode of the resource to load
151 * @param[in] samplingMode The SamplingMode of the resource to load
153 ImageVisual( VisualFactoryCache& factoryCache,
154 const std::string& imageUrl,
155 ImageDimensions size,
156 FittingMode::Type fittingMode,
157 Dali::SamplingMode::Type samplingMode );
160 * @brief Constructor with an Image type.
162 * @param[in] factoryCache The VisualFactoryCache object
163 * @param[in] image The image to use
165 ImageVisual( VisualFactoryCache& factoryCache, const Image& image );
168 * @brief A reference counted object may only be deleted by calling Unreference().
170 virtual ~ImageVisual();
173 * @copydoc Visual::Base::DoSetProperties
175 virtual void DoSetProperties( const Property::Map& propertyMap );
178 * @copydoc Visual::Base::DoSetOnStage
180 virtual void DoSetOnStage( Actor& actor );
183 * @copydoc Visual::Base::DoSetOffStage
185 virtual void DoSetOffStage( Actor& actor );
188 * @copydoc Visual::Base::OnSetTransform
190 virtual void OnSetTransform();
195 * Get the standard image rendering shader.
196 * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
197 * @param[in] atlasing Whether texture atlasing is applied.
198 * @param[in] defaultTextureWrapping Whether the default texture wrap mode is applied.
200 static Shader GetImageShader( VisualFactoryCache& factoryCache, bool atlasing, bool defaultTextureWrapping );
203 * @copydoc AtlasUploadObserver::UploadCompleted
205 * To avoid rendering garbage pixels, renderer should be added to actor after the resources are ready.
206 * This callback is the place to add the renderer as it would be called once the loading is finished.
208 virtual void UploadCompleted();
213 * @brief Applies the image to the texture set used for this renderer
215 * @param[in] image The Image to apply to the texture set used for this renderer
217 void ApplyImageToSampler( const Image& image );
220 * @brief Initializes the Dali::Renderer from an image url string
222 * @param[in] imageUrl The image url string to intialize this ImageVisual from
224 void InitializeRenderer( const std::string& imageUrl );
227 * @brief Initializes the Dali::Renderer from an image handle
229 * @param[in] image The image handle to intialize this ImageVisual from
231 void InitializeRenderer( const Image& image );
234 * @brief Creates the Dali::Renderer (potentially from the renderer cache), initializing it
235 * @param[in] textures to use
237 void CreateRenderer( TextureSet& textures );
240 * @brief Creates the Dali::Renderer for NativeImage with custom sampler type and prefix, initializing it
241 * @param NativeImageRenderer
243 void CreateNativeImageRenderer( NativeImage& nativeImage );
246 * @brief Query whether resources requires to be loaded synchronously.
247 * @return Returns true if synchronous resource loading is required, false otherwise.
249 bool IsSynchronousResourceLoading() const;
252 * @brief Load the resource synchronously
254 void LoadResourceSynchronously();
257 * Creates the texture set and adds the texture to it
258 * @param[out] textureRect The texture area of the texture in the atlas.
259 * @param[in] url The URL of the image resource to use.
260 * @param[in] synchronousLoading If true, the resource is loaded synchronously, otherwise asynchronously.
261 * @param[in] attemptAtlasing If true will attempt atlasing, otherwise create unique texture
262 * @return the texture set to use
264 TextureSet CreateTextureSet( Vector4& textureRect, const std::string& url, bool synchronousLoading, bool attemptAtlasing );
267 * Callback function of image resource loading succeed
268 * @param[in] image The Image content that we attempted to load from mImageUrl
270 void OnImageLoaded( ResourceImage image );
273 * Set the value to the uTextureRect uniform
274 * @param[in] textureRect The texture rectangular area.
276 void SetTextureRectUniform( const Vector4& textureRect );
279 * Clean the renderer from cache, and remove the image from atlas if it is not used anymore
281 void CleanCache(const std::string& url);
288 WeakHandle<Actor> mPlacementActor;
289 std::string mImageUrl;
291 Dali::ImageDimensions mDesiredSize;
292 Dali::FittingMode::Type mFittingMode:3;
293 Dali::SamplingMode::Type mSamplingMode:4;
294 Dali::WrapMode::Type mWrapModeU:3;
295 Dali::WrapMode::Type mWrapModeV:3;
299 } // namespace Internal
301 } // namespace Toolkit
305 #endif /* DALI_TOOLKIT_INTERNAL_IMAGE_VISUAL_H */