1 #ifndef __DALI_INTERNAL_IMAGE_ACTOR_H__
2 #define __DALI_INTERNAL_IMAGE_ACTOR_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.
22 #include <dali/public-api/object/ref-object.h>
23 #include <dali/public-api/actors/image-actor.h>
24 #include <dali/internal/event/actors/actor-declarations.h>
25 #include <dali/internal/event/actors/renderable-actor-impl.h>
26 #include <dali/internal/event/actor-attachments/image-attachment-impl.h>
27 #include <dali/internal/event/animation/animation-impl.h>
28 #include <dali/internal/event/images/nine-patch-image-impl.h>
39 * An actor which displays an Image object.
41 * This handles image fade-in if required, waiting for the image to load.
43 * If a new image is set on the actor, then this ensures that the old image
44 * is displayed until the new image is ready to render to prevent flashing
45 * to the actor color. This will also happen if the image is reloaded.
47 * This is achieved by using two connector objects to Image: mImageNext and
48 * mImageAttachment's member object. The first one points to the Image object that is going to
49 * be displayed next, the second one to the Image that is currently being displayed.
51 class ImageActor : public RenderableActor
55 typedef Dali::ImageActor::Style Style;
56 typedef Dali::ImageActor::PixelArea PixelArea;
59 * @brief Create an image actor instance.
60 * @return A smart-pointer to a newly allocated image actor.
62 static ImageActorPtr New();
65 * @copydoc Dali::Internal::Actor::OnInitialize
70 * @see Dali::ImageActor::SetImage()
71 * @param[in] ImagePtr reference to the image object to display. Reference to avoid unnecessary increment/decrement reference.
73 void SetImage( ImagePtr& image );
76 * Retrieve the image rendered by the actor's attachment.
77 * @return smart pointer to the image or an empty one if no image is assigned
82 * @copydoc Dali::ImageActor::SetToNaturalSize()
84 void SetToNaturalSize();
87 * @copydoc Dali::ImageActor::SetPixelArea()
89 void SetPixelArea( const PixelArea& pixelArea );
92 * @copydoc Dali::ImageActor::GetPixelArea()
94 const PixelArea& GetPixelArea() const;
97 * @copydoc Dali::ImageActor::IsPixelAreaSet()
99 bool IsPixelAreaSet() const;
102 * @copydoc Dali::ImageActor::ClearPixelArea()
104 void ClearPixelArea();
107 * @copydoc Dali::ImageActor::SetStyle()
109 void SetStyle( Style style );
112 * @copydoc Dali::ImageActor::GetStyle()
114 Style GetStyle() const;
117 * @copydoc Dali::ImageActor::SetNinePatchBorder
119 void SetNinePatchBorder( const Vector4& border, bool inPixels = false );
122 * @copydoc Dali::ImageActor::GetNinePatchBorder
124 Vector4 GetNinePatchBorder() const;
127 * Retrieve the attachment which renders the image.
128 * @return The attachment.
130 ImageAttachment& GetImageAttachment();
132 public: // Default property extensions from ProxyObject
135 * @copydoc Dali::Internal::ProxyObject::GetDefaultPropertyCount()
137 virtual unsigned int GetDefaultPropertyCount() const;
140 * @copydoc Dali::Internal::ProxyObject::GetDefaultPropertyIndices()
142 virtual void GetDefaultPropertyIndices( Property::IndexContainer& indices ) const;
145 * @copydoc Dali::Internal::ProxyObject::GetDefaultPropertyName()
147 virtual const char* GetDefaultPropertyName(Property::Index index) const;
150 * @copydoc Dali::Internal::ProxyObject::GetDefaultPropertyIndex()
152 virtual Property::Index GetDefaultPropertyIndex(const std::string& name) const;
155 * @copydoc Dali::Internal::ProxyObject::IsDefaultPropertyWritable()
157 virtual bool IsDefaultPropertyWritable(Property::Index index) const;
160 * @copydoc Dali::Internal::ProxyObject::IsDefaultPropertyAnimatable()
162 virtual bool IsDefaultPropertyAnimatable(Property::Index index) const;
165 * @copydoc Dali::Internal::ProxyObject::IsDefaultPropertyAConstraintInput()
167 virtual bool IsDefaultPropertyAConstraintInput( Property::Index index ) const;
170 * @copydoc Dali::Internal::ProxyObject::GetDefaultPropertyType()
172 virtual Property::Type GetDefaultPropertyType(Property::Index index) const;
175 * @copydoc Dali::Internal::ProxyObject::SetDefaultProperty()
177 virtual void SetDefaultProperty(Property::Index index, const Property::Value& propertyValue);
180 * @copydoc Dali::Internal::ProxyObject::GetDefaultProperty()
182 virtual Property::Value GetDefaultProperty( Property::Index index ) const;
184 public: // From Actor
187 * @copydoc Dali::Actor::GetNaturalSize()
189 virtual Vector3 GetNaturalSize() const;
191 private: // From RenderableActor
194 * @copydoc RenderableActor::GetRenderableAttachment
196 virtual RenderableAttachment& GetRenderableAttachment() const;
201 * Protected constructor; see also ImageActor::New()
206 * A reference counted object may only be deleted by calling Unreference()
208 virtual ~ImageActor();
213 * Helper to set the actor to the image's natural size
215 void SetNaturalSize();
218 * Calculate the natural size of this image actor
220 * @return Return the natural size as a Vector2
222 Vector2 CalculateNaturalSize() const;
226 * This is called after SizeSet() has been called.
228 virtual void OnSizeSet( const Vector3& targetSize );
231 * @copydoc Actor::OnSizeAnimation( Animation& animation, const Vector3& targetSize )
233 virtual void OnSizeAnimation(Animation& animation, const Vector3& targetSize);
236 * From Actor; used to trigger fade-in animations.
238 virtual void OnStageConnectionInternal();
241 * From Actor; used to notify Image.
243 virtual void OnStageDisconnectionInternal();
247 ImageAttachmentPtr mImageAttachment; ///< Used to display the image (holds a pointer to currently showed Image)
249 // flags, compressed to bitfield (uses only 1 byte)
250 bool mUsingNaturalSize:1; ///< True only when the actor is using
251 bool mInternalSetSize:1; ///< True whilst setting size internally, false at all other times
255 } // namespace Internal
257 // Helpers for public-api forwarding methods
259 inline Internal::ImageActor& GetImplementation(Dali::ImageActor& image)
261 DALI_ASSERT_ALWAYS(image && "Image handle is empty");
263 BaseObject& handle = image.GetBaseObject();
265 return static_cast<Internal::ImageActor&>(handle);
268 inline const Internal::ImageActor& GetImplementation(const Dali::ImageActor& image)
270 DALI_ASSERT_ALWAYS(image && "Image handle is empty");
272 const BaseObject& handle = image.GetBaseObject();
274 return static_cast<const Internal::ImageActor&>(handle);
279 #endif // __DALI_INTERNAL_IMAGE_ACTOR_H__