1 #ifndef __DALI_RESOURCE_IMAGE_H__
2 #define __DALI_RESOURCE_IMAGE_H__
5 * Copyright (c) 2015 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.
25 #include <dali/public-api/common/loading-state.h>
26 #include <dali/public-api/images/image.h>
27 #include <dali/public-api/signals/dali-signal.h>
28 #include <dali/public-api/images/image-operations.h>
33 * @addtogroup dali_core_images
37 namespace Internal DALI_INTERNAL
43 * @brief ResourceImage is an image loaded using a URL
45 * <i>Customizing load requests</i>
47 * Size, scaling mode, filter mode, and orientation compensation can be set when requesting an image.
49 * <i>Reloading images</i>
51 * The same request used on creating the ResourceImage is re-issued when reloading images.
52 * If the file changed since the last load operation, this might result in a different resource.
53 * Reload only takes effect if the ResourceImage has already finished loading.
56 * | %Signal Name | Method |
57 * |----------------------|------------------------------|
58 * | imageLoadingFinished | @ref LoadingFinishedSignal() |
61 class DALI_IMPORT_API ResourceImage : public Image
66 * @brief Type of signal for LoadingFinished and Uploaded.
69 typedef Signal< void (ResourceImage) > ResourceImageSignal;
74 * @brief Get the size of an image from disk.
76 * This function will read the header info from file on disk and is
77 * synchronous, so it should not be used repeatedly or in tight
82 * @param [in] url The URL of the image file.
83 * @return The width and height in pixels of the image.
85 static ImageDimensions GetImageSize( const std::string& url );
88 * @brief Constructor which creates an empty ResourceImage object.
90 * Use ResourceImage::New(...) to create an initialised object.
98 * This is non-virtual since derived Handle types must not contain data or virtual methods.
104 * @brief This copy constructor is required for (smart) pointer semantics.
107 * @param [in] handle A reference to the copied handle
109 ResourceImage( const ResourceImage& handle );
112 * @brief This assignment operator is required for (smart) pointer semantics.
115 * @param [in] rhs A reference to the copied handle
116 * @return A reference to this
118 ResourceImage& operator=( const ResourceImage& rhs );
121 * @name ResourceImageFactoryFunctions
122 * Create ResourceImage object instances using these functions.
127 * @brief Create an initialised ResourceImage object.
129 * Uses defaults for all options.
131 * @sa Dali::FittingMode::Type Dali::SamplingMode::Type
135 * @param [in] url The URL of the image file to use.
136 * @param [in] orientationCorrection Reorient the image to respect any orientation metadata in its header.
137 * @return A handle to a newly allocated object
139 static ResourceImage New( const std::string& url, bool orientationCorrection = true );
142 * @brief Create an initialised ResourceImage object.
147 * @param [in] url The URL of the image file to use.
148 * @param [in] size The width and height to fit the loaded image to.
149 * @param [in] fittingMode The method used to fit the shape of the image before loading to the shape defined by the size parameter.
150 * @param [in] samplingMode The filtering method used when sampling pixels from the input image while fitting it to desired size.
151 * @param [in] orientationCorrection Reorient the image to respect any orientation metadata in its header.
152 * @return A handle to a newly allocated object
154 static ResourceImage New( const std::string& url,
155 ImageDimensions size,
156 FittingMode::Type fittingMode = FittingMode::DEFAULT,
157 SamplingMode::Type samplingMode = SamplingMode::DEFAULT,
158 bool orientationCorrection = true );
163 * @brief Downcast a handle to ResourceImage handle.
165 * If handle points to a ResourceImage object the
166 * downcast produces valid handle. If not the returned handle is left uninitialized.
168 * @param[in] handle Handle to an object
169 * @return Handle to a Image object or an uninitialized handle
171 static ResourceImage DownCast( BaseHandle handle );
174 * @brief Query whether the image data has loaded.
176 * The asynchronous loading begins when the Image object is created.
177 * After the Image object is discarded, the image data will be released from memory.
179 * @return The loading state, either Loading, Success or Failed.
181 LoadingState GetLoadingState() const;
184 * @brief Returns the URL of the image.
187 * @return The URL of the image file.
189 std::string GetUrl() const;
192 * @brief Reload image from filesystem.
194 * The original set of image loading attributes (requested dimensions, scaling
195 * mode and filter mode) are used when requesting the image again.
197 * @note If image is offstage and OnDemand policy is set, the reload request is
205 * @brief Emitted when the image data loads successfully, or when the loading fails.
208 * @return A signal object to Connect() with.
210 ResourceImageSignal& LoadingFinishedSignal();
212 public: // Not intended for application developers
214 explicit DALI_INTERNAL ResourceImage( Internal::ResourceImage* );
222 #endif // __DALI_RESOURCE_IMAGE_H__