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/rendering/texture-impl.h>
28 #include <dali/internal/event/resources/resource-client.h>
29 #include <dali/internal/event/resources/resource-ticket-observer.h>
39 typedef IntrusivePtr<Image> ImagePtr;
42 * Image represents an image resource that can be added to actors etc.
43 * When the Image object is created, resource loading will be attempted.
44 * Provided this is successful, the resource will exist until the Image is destroyed.
46 class Image : public BaseObject, public ResourceTicketObserver
51 * @copydoc Dali::Image::UploadedSignal()
53 Dali::Image::ImageSignalType& UploadedSignal() { return mUploaded; }
56 * Connects a callback function with the object's signals.
57 * @param[in] object The object providing the signal.
58 * @param[in] tracker Used to disconnect the signal.
59 * @param[in] signalName The signal to connect to.
60 * @param[in] functor A newly allocated FunctorDelegate.
61 * @return True if the signal was connected.
62 * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
64 static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
67 * returns the Id used for lookups
68 * @note if LoadPolicy::OnDemand is used and Image is off Stage, this will return 0.
69 * @return the unique ID of the image data resource. This is actually also the same as Dali Texture id.
71 ResourceId GetResourceId() const;
74 * Get the width of the image.
75 * Only to be used after the image has finished loading.
76 * (Ticket's LoadingSucceeded callback was called)
77 * The returned value will reflect the true image dimensions once the asynchronous loading has finished.
78 * @pre image should be loaded
80 virtual unsigned int GetWidth() const;
83 * Get the height of the image.
84 * Only to be used after the image has finished loading.
85 * (Ticket's LoadingSucceeded callback was called)
86 * The returned value will reflect the true image dimensions once the asynchronous loading has finished.
87 * @pre image should be loaded
89 virtual unsigned int GetHeight() const;
92 * Return the natural size of the image.
93 * This is the size that the loaded image will take
95 virtual Vector2 GetNaturalSize() const;
98 * Returns a pointer to the internal texture used by the image
100 NewTexture* GetTexture() const
102 return mTexture.Get();
105 public: // From ResourceTicketObserver
108 * @copydoc Dali::Internal::ResourceTicketObserver::ResourceLoadingFailed()
110 virtual void ResourceLoadingFailed(const ResourceTicket& ticket);
113 * @copydoc Dali::Internal::ResourceTicketObserver::ResourceLoadingSucceeded()
115 virtual void ResourceLoadingSucceeded(const ResourceTicket& ticket);
118 * @copydoc Dali::Internal::ResourceTicketObserver::ResourceUploaded()
120 virtual void ResourceUploaded(const ResourceTicket& ticket);
125 * Indicates that the image is used.
127 virtual void Connect() {}
130 * Indicates that the image is not used anymore.
132 virtual void Disconnect() {}
137 * A reference counted object may only be deleted by calling Unreference()
142 * Constructor, with default parameters
147 * Second stage initialization
153 ResourceTicketPtr mTicket; ///< smart pointer to the ticket object that gets completed when load finishes
154 NewTexturePtr mTexture; ///< smart pointer to the texture used by the image
156 unsigned int mWidth; ///< natural width of the image
157 unsigned int mHeight; ///< natural height of the image
159 unsigned int mConnectionCount; ///< number of on-stage objects using this image
163 Dali::Image::ImageSignalType mUploaded;
166 } // namespace Internal
169 * Helper methods for public API.
171 inline Internal::Image& GetImplementation(Dali::Image& image)
173 DALI_ASSERT_ALWAYS( image && "Image handle is empty" );
175 BaseObject& handle = image.GetBaseObject();
177 return static_cast<Internal::Image&>(handle);
180 inline const Internal::Image& GetImplementation(const Dali::Image& image)
182 DALI_ASSERT_ALWAYS( image && "Image handle is empty" );
184 const BaseObject& handle = image.GetBaseObject();
186 return static_cast<const Internal::Image&>(handle);
190 #endif // __DALI_INTERNAL_IMAGE_H__