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
  29 namespace Dali
  30 {
  31 struct Vector2;
  32 class ImageAttributes;
  33
  34 namespace Internal DALI_INTERNAL
  35 {
  36 class ResourceImage;
  37 }
  38
  39 /**
  40  * @brief ResourceImage is an image loaded using a URL
  41  *
  42  * <h3>ResourceImage Loading</h3>
  43  *
  44  * When the ResourceImage is created, resource loading will be attempted unless
  45  * the ResourceImage is created with IMMEDIATE loading policy or a compatible resource is found in cache.
  46  * In case of loading images ON_DEMAND, resource loading will only be attempted if the associated ImageActor
  47  * is put on Stage.
  48  * Custom loading requests can be made by providing an ImageAttributes object to ResourceImage::New().
  49  *
  50  * <i>LoadPolicies</i>
  51  * - IMMEDIATE: acquire image resource when creating ResourceImage.
  52  * - ON_DEMAND: only load in case the associated ImageActor is put on Stage
  53  *
  54  * <i>Resolution of conflicting policies</i>
  55  * If the same image is created more than once with conflicting policies, LoadPolicy "IMMEDIATE" overrides "ON_DEMAND".
  56  *
  57  * <i>Custom load requests</i>
  58  * Size, scaling mode, orientation compensation can be set when requesting an image.
  59  * See ImageAttributes for more details.
  60  *
  61  * <i>Compatible resources</i>
  62  *
  63  * Before loading a new ResourceImage the internal image resource cache is checked by dali.
  64  * If there is an image already loaded in memory and is deemed "compatible" with the requested image,
  65  * that resource is reused.
  66  * This happens for example if a loaded image exists with the same URL, and the difference between both
  67  * of the dimensions is less than 50%.
  68  *
  69  * <i>Reloading images</i>
  70  *
  71  * The same request used on creating the ResourceImage is re-issued when reloading images.
  72  * If the file changed since the last load operation, this might result in a different resource.
  73  * Reload only takes effect if both of these conditions apply:
  74  * - The ResourceImage has already finished loading
  75  * - The ResourceImage is either on Stage or using IMMEDIATE load policy
  76  */
  77 class DALI_IMPORT_API ResourceImage : public Image
  78 {
  79 public:
  80   /**
  81    * @brief Resource management options.
  82    */
  83
  84   /**
  85    * @brief LoadPolicy controls the way images are loaded into memory.
  86    */
  87   enum LoadPolicy
  88   {
  89     IMMEDIATE, ///< load image once it is created (default)
  90     ON_DEMAND  ///< delay loading until the image is being used (a related actor is added to Stage)
  91   };
  92
  93   /**
  94    * @brief Type of signal for LoadingFinished and Uploaded.
  95    */
  96   typedef Signal< void (ResourceImage) > ResourceImageSignal;
  97
  98   // Signal Names
  99   static const char* const SIGNAL_IMAGE_LOADING_FINISHED; ///< Name of LoadingFinished signal
 100
 101 public:
 102
 103   /**
 104    * @brief Get the size of an image from disk.
 105    *
 106    * This function will read the header info from file on disk and is
 107    * synchronous, so it should not be used repeatedly or in tight
 108    * loops.
 109    *
 110    * @param [in] url The URL of the image file.
 111    * @return The width and height in pixels of the image.
 112    */
 113   static Vector2 GetImageSize( const std::string& url );
 114
 115   /**
 116    * @brief Constructor which creates an empty ResourceImage object.
 117    *
 118    * Use ResourceImage::New(...) to create an initialised object.
 119    */
 120   ResourceImage();
 121
 122   /**
 123    * @brief Destructor
 124    *
 125    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 126    */
 127   ~ResourceImage();
 128
 129   /**
 130    * @brief This copy constructor is required for (smart) pointer semantics.
 131    *
 132    * @param [in] handle A reference to the copied handle
 133    */
 134   ResourceImage( const ResourceImage& handle );
 135
 136   /**
 137    * @brief This assignment operator is required for (smart) pointer semantics.
 138    *
 139    * @param [in] rhs  A reference to the copied handle
 140    * @return A reference to this
 141    */
 142   ResourceImage& operator=( const ResourceImage& rhs );
 143
 144   /**
 145    * @brief Create an initialised ResourceImage object.
 146    *
 147    * @param [in] url The URL of the image file to use.
 148    * @return A handle to a newly allocated object
 149    */
 150   static ResourceImage New( const std::string& url );
 151
 152   /**
 153    * @brief Create an initialised ResourceImage object.
 154    *
 155    * @param [in] url The URL of the image file to use.
 156    * @param [in] loadPol    The LoadPolicy to apply when loading the image resource.
 157    * @param [in] releasePol The ReleasePolicy to apply to Image.
 158    * @return A handle to a newly allocated object
 159    */
 160   static ResourceImage New( const std::string& url, LoadPolicy loadPol, ReleasePolicy releasePol );
 161
 162   /**
 163    * @brief Create an initialised ResourceImage object.
 164    *
 165    * @param [in] url The URL of the image file to use.
 166    * @param [in] attributes Requested parameters for loading (size, scaling etc.).
 167    * @return A handle to a newly allocated object
 168    */
 169   static ResourceImage New( const std::string& url, const ImageAttributes& attributes );
 170
 171   /**
 172    * @brief Create an initialised ResourceImage object.
 173    *
 174    * @param [in] url The URL of the image file to use.
 175    * @param [in] attributes Requested parameters for loading (size, scaling etc.).
 176    * @param [in] loadPol    The LoadPolicy to apply when loading the image resource.
 177    * @param [in] releasePol The ReleasePolicy to apply to Image.
 178    * @return A handle to a newly allocated object
 179    */
 180   static ResourceImage New( const std::string& url, const ImageAttributes& attributes, LoadPolicy loadPol, ReleasePolicy releasePol );
 181
 182   /**
 183    * @brief Downcast an Object handle to ResourceImage handle.
 184    *
 185    * If handle points to a ResourceImage object the
 186    * downcast produces valid handle. If not the returned handle is left uninitialized.
 187    * @param[in] handle to An object
 188    * @return handle to a Image object or an uninitialized handle
 189    */
 190   static ResourceImage DownCast( BaseHandle handle );
 191
 192   /**
 193    * @brief Return load policy.
 194    *
 195    * @return resource load policy
 196    */
 197   LoadPolicy GetLoadPolicy() const;
 198
 199   /**
 200    * @brief Query whether the image data has loaded.
 201    *
 202    * The asynchronous loading begins when the Image object is created.
 203    * After the Image object is discarded, the image data will be released from memory.
 204    * @return The loading state, either Loading, Success or Failed.
 205    */
 206   LoadingState GetLoadingState() const;
 207
 208   /**
 209    * @brief Returns the URL of the image.
 210    *
 211    * @return The URL of the image file.
 212    */
 213   std::string GetUrl() const;
 214
 215   /**
 216    * @brief Reload image from filesystem.
 217    *
 218    * The set ImageAttributes are used when requesting the image again.
 219    * @note if Image is offstage and OnDemand policy is set, reload request is ignored.
 220    */
 221   void Reload();
 222
 223   /**
 224    * @brief Get the attributes of an image.
 225    *
 226    * Only to be used after the image has finished loading.
 227    * (Ticket's LoadingSucceeded callback was called)
 228    * The returned value will reflect the true image dimensions once the asynchronous loading has finished.
 229    * Connect to SignalLoadingFinished or use GetLoadingState to make sure this value is actual.
 230    * @pre image should be loaded
 231    * @return a copy of the attributes
 232    */
 233   ImageAttributes GetAttributes() const;
 234
 235 public: // Signals
 236
 237   /**
 238    * @brief Emitted when the image data loads successfully, or when the loading fails.
 239    *
 240    * @return A signal object to Connect() with.
 241    */
 242   ResourceImageSignal& LoadingFinishedSignal();
 243
 244 public: // Not intended for application developers
 245
 246   explicit DALI_INTERNAL ResourceImage( Internal::ResourceImage* );
 247 };
 248
 249 } // namespace Dali
 250
 251 #endif // __DALI_RESOURCE_IMAGE_H__