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] size The width and height to fit the loaded image to.
90 * @param[in] fittingMode The FittingMode of the resource to load
91 * @param[in] samplingMode The SamplingMode of the resource to load
93 static ImageVisualPtr New( VisualFactoryCache& factoryCache,
94 const std::string& imageUrl,
95 ImageDimensions size = ImageDimensions(),
96 FittingMode::Type fittingMode = FittingMode::DEFAULT,
97 Dali::SamplingMode::Type samplingMode = SamplingMode::BOX_THEN_LINEAR );
100 * @brief Create a new image visual with an Image type.
102 * @param[in] factoryCache The VisualFactoryCache object
103 * @param[in] image The image to use
105 static ImageVisualPtr New( VisualFactoryCache& factoryCache, const Image& image );
107 public: // from Visual
110 * @copydoc Visual::Base::GetNaturalSize
112 virtual void GetNaturalSize( Vector2& naturalSize );
115 * @copydoc Visual::Base::CreatePropertyMap
117 virtual void DoCreatePropertyMap( Property::Map& map ) const;
122 * @brief Constructor with a URL.
124 * The visual will load the Image asynchronously when the associated actor is put on stage, and destroy the image when it is off stage
126 * @param[in] factoryCache The VisualFactoryCache object
127 * @param[in] imageUrl The URL of the image resource to use
128 * @param[in] size The width and height to fit the loaded image to.
129 * @param[in] fittingMode The FittingMode of the resource to load
130 * @param[in] samplingMode The SamplingMode of the resource to load
132 ImageVisual( VisualFactoryCache& factoryCache,
133 const std::string& imageUrl,
134 ImageDimensions size,
135 FittingMode::Type fittingMode,
136 Dali::SamplingMode::Type samplingMode );
139 * @brief Constructor with an Image type.
141 * @param[in] factoryCache The VisualFactoryCache object
142 * @param[in] image The image to use
144 ImageVisual( VisualFactoryCache& factoryCache, const Image& image );
147 * @brief A reference counted object may only be deleted by calling Unreference().
149 virtual ~ImageVisual();
152 * @copydoc Visual::Base::DoSetProperties
154 virtual void DoSetProperties( const Property::Map& propertyMap );
157 * @copydoc Visual::Base::DoSetOnStage
159 virtual void DoSetOnStage( Actor& actor );
162 * @copydoc Visual::Base::DoSetOffStage
164 virtual void DoSetOffStage( Actor& actor );
167 * @copydoc Visual::Base::OnSetTransform
169 virtual void OnSetTransform();
174 * Get the standard image rendering shader.
175 * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
176 * @param[in] atlasing Whether texture atlasing is applied.
177 * @param[in] defaultTextureWrapping Whether the default texture wrap mode is applied.
179 static Shader GetImageShader( VisualFactoryCache& factoryCache, bool atlasing, bool defaultTextureWrapping );
182 * @copydoc AtlasUploadObserver::UploadCompleted
184 * To avoid rendering garbage pixels, renderer should be added to actor after the resources are ready.
185 * This callback is the place to add the renderer as it would be called once the loading is finished.
187 virtual void UploadCompleted();
192 * @brief Applies the image to the texture set used for this renderer
194 * @param[in] image The Image to apply to the texture set used for this renderer
196 void ApplyImageToSampler( const Image& image );
199 * @brief Initializes the Dali::Renderer from an image url string
201 * @param[in] imageUrl The image url string to intialize this ImageVisual from
203 void InitializeRenderer( const std::string& imageUrl );
206 * @brief Initializes the Dali::Renderer from an image handle
208 * @param[in] image The image handle to intialize this ImageVisual from
210 void InitializeRenderer( const Image& image );
213 * @brief Creates the Dali::Renderer (potentially from the renderer cache), initializing it
214 * @param[in] textures to use
216 void CreateRenderer( TextureSet& textures );
219 * @brief Creates the Dali::Renderer for NativeImage with custom sampler type and prefix, initializing it
220 * @param NativeImageRenderer
222 void CreateNativeImageRenderer( NativeImage& nativeImage );
225 * @brief Query whether resources requires to be loaded synchronously.
226 * @return Returns true if synchronous resource loading is required, false otherwise.
228 bool IsSynchronousResourceLoading() const;
231 * @brief Load the resource synchronously
233 void LoadResourceSynchronously();
236 * Creates the texture set and adds the texture to it
237 * @param[out] textureRect The texture area of the texture in the atlas.
238 * @param[in] url The URL of the image resource to use.
239 * @param[in] synchronousLoading If true, the resource is loaded synchronously, otherwise asynchronously.
240 * @param[in] attemptAtlasing If true will attempt atlasing, otherwise create unique texture
241 * @return the texture set to use
243 TextureSet CreateTextureSet( Vector4& textureRect, const std::string& url, bool synchronousLoading, bool attemptAtlasing );
246 * Callback function of image resource loading succeed
247 * @param[in] image The Image content that we attempted to load from mImageUrl
249 void OnImageLoaded( ResourceImage image );
252 * Set the value to the uTextureRect uniform
253 * @param[in] textureRect The texture rectangular area.
255 void SetTextureRectUniform( const Vector4& textureRect );
258 * Clean the renderer from cache, and remove the image from atlas if it is not used anymore
260 void CleanCache(const std::string& url);
267 WeakHandle<Actor> mPlacementActor;
268 std::string mImageUrl;
270 Dali::ImageDimensions mDesiredSize;
271 Dali::FittingMode::Type mFittingMode:3;
272 Dali::SamplingMode::Type mSamplingMode:4;
273 Dali::WrapMode::Type mWrapModeU:3;
274 Dali::WrapMode::Type mWrapModeV:3;
278 } // namespace Internal
280 } // namespace Toolkit
284 #endif /* DALI_TOOLKIT_INTERNAL_IMAGE_VISUAL_H */