dali/public-api/images/resource-image.h

   1 #ifndef __DALI_RESOURCE_IMAGE_H__
   2 #define __DALI_RESOURCE_IMAGE_H__
   3
   4 /*
   5  * Copyright (c) 2015 Samsung Electronics Co., Ltd.
   6  *
   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
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <string>
  23
  24 // INTERNAL INCLUDES
  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>
  29
  30 namespace Dali
  31 {
  32 /**
  33  * @addtogroup dali_core_images
  34  * @{
  35  */
  36
  37 namespace Internal DALI_INTERNAL
  38 {
  39 class ResourceImage;
  40 }
  41
  42 /**
  43  * @brief ResourceImage is an image loaded using a URL
  44  *
  45  * <h3>ResourceImage Loading</h3>
  46  *
  47  * When the ResourceImage is created, resource loading will be attempted unless a compatible resource is found in cache.
  48  * Scaling of images to a desired smaller size can be requested by providing desired dimensions,
  49  * scaling mode and filter mode to to ResourceImage::New().
  50  *
  51  * <i>Custom load requests</i>
  52  * Size, scaling mode, filter mode, and orientation compensation can be set when requesting an image.
  53  *
  54  * <i>Compatible resources</i>
  55  *
  56  * Before loading a new ResourceImage the internal image resource cache is checked by DALi.
  57  * If there is an image already loaded in memory and is deemed "compatible" with the requested image,
  58  * that resource is reused.
  59  * This happens for example if a loaded image exists with the same URL, scaling and filtering modes,
  60  * and the difference between both of the dimensions is less than a few pixels.
  61  *
  62  * <i>Reloading images</i>
  63  *
  64  * The same request used on creating the ResourceImage is re-issued when reloading images.
  65  * If the file changed since the last load operation, this might result in a different resource.
  66  * Reload only takes effect if the ResourceImage has already finished loading
  67  *
  68  * Signals
  69  * | %Signal Name         | Method                       |
  70  * |----------------------|------------------------------|
  71  * | imageLoadingFinished | @ref LoadingFinishedSignal() |
  72  */
  73 class DALI_IMPORT_API ResourceImage : public Image
  74 {
  75 public:
  76
  77   /**
  78    * @deprecated DALi 1.1.3 Image loading starts immediately in the frame when then ResourceImage object is created
  79    *
  80    * @brief LoadPolicy controls the way images are loaded into memory.
  81    */
  82   enum LoadPolicy
  83   {
  84     IMMEDIATE, ///< load image once it is created (default)
  85     ON_DEMAND  ///< delay loading until the image is being used (a related actor is added to Stage)
  86   };
  87
  88   /**
  89    * @brief Type of signal for LoadingFinished and Uploaded.
  90    */
  91   typedef Signal< void (ResourceImage) > ResourceImageSignal;
  92
  93 public:
  94
  95   /**
  96    * @brief Get the size of an image from disk.
  97    *
  98    * This function will read the header info from file on disk and is
  99    * synchronous, so it should not be used repeatedly or in tight
 100    * loops.
 101    *
 102    * @param [in] url The URL of the image file.
 103    * @return The width and height in pixels of the image.
 104    */
 105   static ImageDimensions GetImageSize( const std::string& url );
 106
 107   /**
 108    * @brief Constructor which creates an empty ResourceImage object.
 109    *
 110    * Use ResourceImage::New(...) to create an initialised object.
 111    */
 112   ResourceImage();
 113
 114   /**
 115    * @brief Destructor
 116    *
 117    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 118    */
 119   ~ResourceImage();
 120
 121   /**
 122    * @brief This copy constructor is required for (smart) pointer semantics.
 123    *
 124    * @param [in] handle A reference to the copied handle
 125    */
 126   ResourceImage( const ResourceImage& handle );
 127
 128   /**
 129    * @brief This assignment operator is required for (smart) pointer semantics.
 130    *
 131    * @param [in] rhs  A reference to the copied handle
 132    * @return A reference to this
 133    */
 134   ResourceImage& operator=( const ResourceImage& rhs );
 135
 136   /**
 137    * @name ResourceImageFactoryFunctions
 138    * Create ResourceImage object instances using these functions.
 139    */
 140   ///@{
 141
 142   /**
 143    * @brief Create an initialised ResourceImage object.
 144    *
 145    * Uses defaults for all options.
 146    *
 147    * @sa Dali::FittingMode::Type Dali::SamplingMode::Type
 148    * @param [in] url The URL of the image file to use.
 149    * @param [in] orientationCorrection Reorient the image to respect any orientation metadata in its header.
 150    * @return A handle to a newly allocated object
 151    */
 152   static ResourceImage New( const std::string& url, bool orientationCorrection = true );
 153
 154   /**
 155    * @deprecated DALi 1.1.3 use New( const std::string& url ) instead.
 156    *
 157    * @brief Create an initialised ResourceImage object.
 158    *
 159    * @param [in] url The URL of the image file to use.
 160    * @param [in] loadPol    The LoadPolicy to apply when loading the image resource.
 161    * @param [in] releasePol The ReleasePolicy to apply to Image.
 162    * @param [in] orientationCorrection Reorient the image to respect any orientation metadata in its header.
 163    * @return A handle to a newly allocated object
 164    */
 165   static ResourceImage New( const std::string& url, LoadPolicy loadPol, ReleasePolicy releasePol, bool orientationCorrection = true );
 166
 167   /**
 168    * @brief Create an initialised ResourceImage object.
 169    *
 170    * @param [in] url The URL of the image file to use.
 171    * @param [in] size The width and height to fit the loaded image to.
 172    * @param [in] fittingMode The method used to fit the shape of the image before loading to the shape defined by the size parameter.
 173    * @param [in] samplingMode The filtering method used when sampling pixels from the input image while fitting it to desired size.
 174    * @param [in] orientationCorrection Reorient the image to respect any orientation metadata in its header.
 175    * @return A handle to a newly allocated object
 176    */
 177   static ResourceImage New( const std::string& url,
 178                             ImageDimensions size,
 179                             FittingMode::Type fittingMode = FittingMode::DEFAULT,
 180                             SamplingMode::Type samplingMode = SamplingMode::DEFAULT,
 181                             bool orientationCorrection = true );
 182
 183   /**
 184    * @deprecated DALi 1.1.3 use New( const std::string& url, ImageDimensions size ) instead.
 185    *
 186    * @brief Create an initialised ResourceImage object.
 187    *
 188    * @param [in] url The URL of the image file to use.
 189    * @param [in] loadPol    The LoadPolicy to apply when loading the image resource.
 190    * @param [in] releasePol The ReleasePolicy to apply to Image.
 191    * @param [in] size The width and height to fit the loaded image to.
 192    * @param [in] fittingMode The method used to fit the shape of the image before loading to the shape defined by the size parameter.
 193    * @param [in] samplingMode The filtering method used when sampling pixels from the input image while fitting it to desired size.
 194    * @param [in] orientationCorrection Reorient the image to respect any orientation metadata in its header.
 195    * @return A handle to a newly allocated object
 196    */
 197   static ResourceImage New( const std::string& url,
 198                             LoadPolicy loadPol,
 199                             ReleasePolicy releasePol,
 200                             ImageDimensions size,
 201                             FittingMode::Type fittingMode = FittingMode::DEFAULT,
 202                             SamplingMode::Type samplingMode = SamplingMode::DEFAULT,
 203                             bool orientationCorrection = true );
 204
 205   ///@}
 206
 207   /**
 208    * @brief Downcast an Object handle to ResourceImage handle.
 209    *
 210    * If handle points to a ResourceImage object the
 211    * downcast produces valid handle. If not the returned handle is left uninitialized.
 212    * @param[in] handle to An object
 213    * @return handle to a Image object or an uninitialized handle
 214    */
 215   static ResourceImage DownCast( BaseHandle handle );
 216
 217   /**
 218    * @deprecated DALi 1.1.3
 219    *
 220    * @brief Return load policy.
 221    *
 222    * @return resource load policy
 223    */
 224   LoadPolicy GetLoadPolicy() const;
 225
 226   /**
 227    * @brief Query whether the image data has loaded.
 228    *
 229    * The asynchronous loading begins when the Image object is created.
 230    * After the Image object is discarded, the image data will be released from memory.
 231    * @return The loading state, either Loading, Success or Failed.
 232    */
 233   LoadingState GetLoadingState() const;
 234
 235   /**
 236    * @brief Returns the URL of the image.
 237    *
 238    * @return The URL of the image file.
 239    */
 240   std::string GetUrl() const;
 241
 242   /**
 243    * @brief Reload image from filesystem.
 244    *
 245    * The original set of image loading attributes (requested dimensions, scaling
 246    * mode and filter mode) are used when requesting the image again.
 247    * @note If image is offstage and OnDemand policy is set, the reload request is
 248    * ignored.
 249    */
 250   void Reload();
 251
 252 public: // Signals
 253
 254   /**
 255    * @brief Emitted when the image data loads successfully, or when the loading fails.
 256    *
 257    * @return A signal object to Connect() with.
 258    */
 259   ResourceImageSignal& LoadingFinishedSignal();
 260
 261 public: // Not intended for application developers
 262
 263   explicit DALI_INTERNAL ResourceImage( Internal::ResourceImage* );
 264 };
 265
 266 /**
 267  * @}
 268  */
 269 } // namespace Dali
 270
 271 #endif // __DALI_RESOURCE_IMAGE_H__