dali/internal/event/images/resource-image-impl.h

   1 #ifndef __DALI_INTERNAL_RESOURCE_IMAGE_H__
   2 #define __DALI_INTERNAL_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/images/resource-image.h>
  26 #include <dali/internal/event/images/image-impl.h>
  27 #include <dali/internal/event/images/image-factory-cache.h>
  28 #include <dali/integration-api/debug.h> // For DALI_LOG_OBJECT_STRING_DECLARATION
  29
  30 namespace Dali
  31 {
  32
  33 namespace Internal
  34 {
  35
  36 class ResourceImage;
  37 typedef IntrusivePtr<ResourceImage> ResourceImagePtr;
  38
  39 /**
  40  * ResourceImage is an image loaded using a URL, it is an image resource that can be added to actors etc.
  41  */
  42 class ResourceImage : public Image
  43 {
  44 public:
  45
  46   /**
  47    * Creates a pointer to an uninitialized Image object.
  48    * @return a pointer to a newly created object.
  49    */
  50   static ResourceImagePtr New();
  51
  52   /**
  53    * Creates object and loads image from filesystem
  54    * the maximum size of the image is limited by GL_MAX_TEXTURE_SIZE
  55    * @param [in] url The URL of the image file.
  56    * @param [in] attributes requested parameters for loading (size, scaling etc.)
  57    *                        if width or height is specified as 0, the natural size will be used.
  58    * @return a pointer to a newly created object.
  59    */
  60   static ResourceImagePtr New( const std::string& url,
  61                           const ImageAttributes& attributes );
  62
  63   /**
  64    * @copydoc Dali::ResourceImage::GetLoadingState()
  65    */
  66   Dali::LoadingState GetLoadingState() const { return mTicket ? mTicket->GetLoadingState() : ResourceLoading; }
  67
  68   /**
  69    * @copydoc Dali::ResourceImage::LoadingFinishedSignal()
  70    */
  71   Dali::ResourceImage::ResourceImageSignal& LoadingFinishedSignal() { return mLoadingFinished; }
  72
  73   /**
  74    * Connects a callback function with the object's signals.
  75    * @param[in] object The object providing the signal.
  76    * @param[in] tracker Used to disconnect the signal.
  77    * @param[in] signalName The signal to connect to.
  78    * @param[in] functor A newly allocated FunctorDelegate.
  79    * @return True if the signal was connected.
  80    * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
  81    */
  82   static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
  83
  84   /**
  85    * Get the attributes of the image.
  86    * Only to be used after the image has finished loading.
  87    * (Ticket's LoadingSucceeded callback was called)
  88    * Reflects the last cached values after a LoadComplete.
  89    * If requested width or height was 0, they are replaced by concrete dimensions.
  90    * @return a copy of the attributes
  91    */
  92   const ImageAttributes& GetAttributes() const;
  93
  94   /**
  95    * @copydoc Dali::ResourceImage::GetUrl()
  96    * virtual so deriving class can override it
  97    */
  98   virtual const std::string& GetUrl() const;
  99
 100   /**
 101    * @copydoc Dali::ResourceImage::Reload()
 102    */
 103   void Reload();
 104
 105   /**
 106    * @copydoc Dali::Image::GetWidth()
 107    */
 108   virtual unsigned int GetWidth() const;
 109
 110   /**
 111    * @copydoc Dali::Image::GetWidth()
 112    */
 113   virtual unsigned int GetHeight() const;
 114
 115   /**
 116    * @copydoc Dali::Internal::Image::GetNaturalSize()
 117    */
 118   virtual Vector2 GetNaturalSize() const;
 119
 120   /**
 121    * Indicates that the image is used.
 122    */
 123   virtual void Connect();
 124
 125   /**
 126    * Indicates that the image is not used anymore.
 127    */
 128   virtual void Disconnect();
 129
 130 public: // From ResourceTicketObserver
 131
 132   /**
 133    * @copydoc Dali::Internal::ResourceTicketObserver::ResourceLoadingFailed()
 134    */
 135   virtual void ResourceLoadingFailed(const ResourceTicket& ticket);
 136
 137   /**
 138    * @copydoc Dali::Internal::ResourceTicketObserver::ResourceLoadingSucceeded()
 139    */
 140   virtual void ResourceLoadingSucceeded(const ResourceTicket& ticket);
 141
 142 protected:
 143
 144   /**
 145    * A reference counted object may only be deleted by calling Unreference()
 146    */
 147   virtual ~ResourceImage();
 148
 149   /**
 150    * Constructor, with default parameters
 151    */
 152   ResourceImage();
 153
 154 private:
 155
 156   /**
 157    * Helper method to set new resource ticket. Stops observing current ticket if any, and starts observing
 158    * the new one or just resets the intrusive pointer.
 159    * @param[in] ticket pointer to new resource Ticket or NULL.
 160    */
 161   void SetTicket( ResourceTicket* ticket );
 162
 163 private:
 164
 165   ImageFactory& mImageFactory;
 166
 167   ImageFactoryCache::RequestPtr mRequest; ///< contains the initially requested attributes for image. Request is reissued when memory was released.
 168
 169   Dali::ResourceImage::ResourceImageSignal mLoadingFinished;
 170
 171   // Changes scope, should be at end of class
 172   DALI_LOG_OBJECT_STRING_DECLARATION;
 173 };
 174
 175 } // namespace Internal
 176
 177 /**
 178  * Helper methods for public API.
 179  */
 180 inline Internal::ResourceImage& GetImplementation(Dali::ResourceImage& image)
 181 {
 182   DALI_ASSERT_ALWAYS( image && "Image handle is empty" );
 183
 184   BaseObject& handle = image.GetBaseObject();
 185
 186   return static_cast<Internal::ResourceImage&>(handle);
 187 }
 188
 189 inline const Internal::ResourceImage& GetImplementation(const Dali::ResourceImage& image)
 190 {
 191   DALI_ASSERT_ALWAYS( image && "Image handle is empty" );
 192
 193   const BaseObject& handle = image.GetBaseObject();
 194
 195   return static_cast<const Internal::ResourceImage&>(handle);
 196 }
 197
 198 } // namespace Dali
 199 #endif // __DALI_INTERNAL_RESOURCE_IMAGE_H__