1 #ifndef __DALI_INTERNAL_IMAGE_H__
2 #define __DALI_INTERNAL_IMAGE_H__
5 * Copyright (c) 2014 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/images/image.h>
26 #include <dali/public-api/object/base-object.h>
27 #include <dali/internal/event/resources/resource-client.h>
28 #include <dali/internal/event/resources/resource-ticket-observer.h>
38 typedef IntrusivePtr<Image> ImagePtr;
41 * Image represents an image resource that can be added to actors etc.
42 * When the Image object is created, resource loading will be attempted.
43 * Provided this is successful, the resource will exist until the Image is destroyed.
45 class Image : public BaseObject, public ResourceTicketObserver
50 * @copydoc Dali::Image::UploadedSignal()
52 Dali::Image::ImageSignalType& UploadedSignal() { return mUploaded; }
55 * Connects a callback function with the object's signals.
56 * @param[in] object The object providing the signal.
57 * @param[in] tracker Used to disconnect the signal.
58 * @param[in] signalName The signal to connect to.
59 * @param[in] functor A newly allocated FunctorDelegate.
60 * @return True if the signal was connected.
61 * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
63 static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
66 * returns the Id used for lookups
67 * @note if LoadPolicy::OnDemand is used and Image is off Stage, this will return 0.
68 * @return the unique ID of the image data resource. This is actually also the same as Dali Texture id.
70 ResourceId GetResourceId() const;
73 * Get the width of the image.
74 * Only to be used after the image has finished loading.
75 * (Ticket's LoadingSucceeded callback was called)
76 * The returned value will reflect the true image dimensions once the asynchronous loading has finished.
77 * @pre image should be loaded
79 virtual unsigned int GetWidth() const;
82 * Get the height of the image.
83 * Only to be used after the image has finished loading.
84 * (Ticket's LoadingSucceeded callback was called)
85 * The returned value will reflect the true image dimensions once the asynchronous loading has finished.
86 * @pre image should be loaded
88 virtual unsigned int GetHeight() const;
91 * Return the natural size of the image.
92 * This is the size that the loaded image will take
94 virtual Vector2 GetNaturalSize() const;
96 public: // From ResourceTicketObserver
99 * @copydoc Dali::Internal::ResourceTicketObserver::ResourceLoadingFailed()
101 virtual void ResourceLoadingFailed(const ResourceTicket& ticket);
104 * @copydoc Dali::Internal::ResourceTicketObserver::ResourceLoadingSucceeded()
106 virtual void ResourceLoadingSucceeded(const ResourceTicket& ticket);
109 * @copydoc Dali::Internal::ResourceTicketObserver::ResourceUploaded()
111 virtual void ResourceUploaded(const ResourceTicket& ticket);
116 * Indicates that the image is used.
118 virtual void Connect() {}
121 * Indicates that the image is not used anymore.
123 virtual void Disconnect() {}
128 * A reference counted object may only be deleted by calling Unreference()
133 * Constructor, with default parameters
138 * Second stage initialization
144 ResourceTicketPtr mTicket; ///< smart pointer to the ticket object that gets completed when load finishes
146 mutable unsigned int mWidth; ///< natural width of the image, needs to be mutable for lazy resolving and as the API for GetWidth is const
147 mutable unsigned int mHeight; ///< natural height of the image, needs to be mutable for lazy resolving and as the API for GetHeight is const
149 unsigned int mConnectionCount; ///< number of on-stage objects using this image
153 Dali::Image::ImageSignalType mUploaded;
156 } // namespace Internal
159 * Helper methods for public API.
161 inline Internal::Image& GetImplementation(Dali::Image& image)
163 DALI_ASSERT_ALWAYS( image && "Image handle is empty" );
165 BaseObject& handle = image.GetBaseObject();
167 return static_cast<Internal::Image&>(handle);
170 inline const Internal::Image& GetImplementation(const Dali::Image& image)
172 DALI_ASSERT_ALWAYS( image && "Image handle is empty" );
174 const BaseObject& handle = image.GetBaseObject();
176 return static_cast<const Internal::Image&>(handle);
180 #endif // __DALI_INTERNAL_IMAGE_H__