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::SetPixelArea()
84 void SetPixelArea( const PixelArea& pixelArea );
87 * @copydoc Dali::ImageActor::GetPixelArea()
89 const PixelArea& GetPixelArea() const;
92 * @copydoc Dali::ImageActor::IsPixelAreaSet()
94 bool IsPixelAreaSet() const;
97 * @copydoc Dali::ImageActor::ClearPixelArea()
99 void ClearPixelArea();
102 * @copydoc Dali::ImageActor::SetStyle()
104 void SetStyle( Style style );
107 * @copydoc Dali::ImageActor::GetStyle()
109 Style GetStyle() const;
112 * @copydoc Dali::ImageActor::SetNinePatchBorder
114 void SetNinePatchBorder( const Vector4& border, bool inPixels = false );
117 * @copydoc Dali::ImageActor::GetNinePatchBorder
119 Vector4 GetNinePatchBorder() const;
122 * Retrieve the attachment which renders the image.
123 * @return The attachment.
125 ImageAttachment& GetImageAttachment();
129 * @copydoc Dali::RenderableActor::SetSortModifier()
131 void SetSortModifier(float modifier);
134 * @copydoc Dali::RenderableActor::GetSortModifier()
136 float GetSortModifier() const;
139 * @copydoc Dali::RenderableActor::SetDepthIndex()
141 void SetDepthIndex( int depthIndex );
144 * @copydoc Dali::RenderableActor::GetDepthIndex()
146 int GetDepthIndex() const;
149 * @copydoc Dali::RenderableActor::SetCullFace()
151 void SetCullFace(CullFaceMode mode);
154 * @copydoc Dali::RenderableActor::GetCullFace()
156 CullFaceMode GetCullFace() const;
159 * @copydoc Dali::RenderableActor::SetBlendMode()
161 void SetBlendMode( BlendingMode::Type mode );
164 * @copydoc Dali::RenderableActor::GetBlendMode()
166 BlendingMode::Type GetBlendMode() const;
169 * @copydoc Dali::RenderableActor::SetBlendFunc()
171 void SetBlendFunc( BlendingFactor::Type srcFactorRgba, BlendingFactor::Type destFactorRgba );
174 * @copydoc Dali::RenderableActor::SetBlendFunc()
176 void SetBlendFunc( BlendingFactor::Type srcFactorRgb, BlendingFactor::Type destFactorRgb,
177 BlendingFactor::Type srcFactorAlpha, BlendingFactor::Type destFactorAlpha );
180 * @copydoc Dali::RenderableActor::GetBlendFunc()
182 void GetBlendFunc( BlendingFactor::Type& srcFactorRgb, BlendingFactor::Type& destFactorRgb,
183 BlendingFactor::Type& srcFactorAlpha, BlendingFactor::Type& destFactorAlpha ) const;
186 * @copydoc Dali::RenderableActor::SetBlendEquation()
188 void SetBlendEquation( BlendingEquation::Type equationRgba );
191 * @copydoc Dali::RenderableActor::SetBlendEquation()
193 void SetBlendEquation( BlendingEquation::Type equationRgb, BlendingEquation::Type equationAlpha );
196 * @copydoc Dali::RenderableActor::GetBlendEquation()
198 void GetBlendEquation( BlendingEquation::Type& equationRgb, BlendingEquation::Type& equationAlpha ) const;
201 * @copydoc Dali::RenderableActor::SetBlendColor()
203 void SetBlendColor( const Vector4& color );
206 * @copydoc Dali::RenderableActor::GetBlendColor()
208 const Vector4& GetBlendColor() const;
211 * @copydoc Dali::RenderableActor::SetFilterMode()
213 void SetFilterMode( FilterMode::Type minFilter, FilterMode::Type magFilter );
216 * @copydoc Dali::RenderableActor::GetFilterMode()
218 void GetFilterMode( FilterMode::Type& minFilter, FilterMode::Type& magFilter ) const;
222 * @copydoc Actor::SetShaderEffect
224 virtual void SetShaderEffect(ShaderEffect& effect);
227 * @copydoc Actor::GetShaderEffect
229 virtual ShaderEffectPtr GetShaderEffect() const;
232 * @copydoc Actor::RemoveShaderEffect
234 virtual void RemoveShaderEffect();
236 public: // Default property extensions from Object
239 * @copydoc Dali::Internal::Object::GetDefaultPropertyCount()
241 virtual unsigned int GetDefaultPropertyCount() const;
244 * @copydoc Dali::Internal::Object::GetDefaultPropertyIndices()
246 virtual void GetDefaultPropertyIndices( Property::IndexContainer& indices ) const;
249 * @copydoc Dali::Internal::Object::GetDefaultPropertyName()
251 virtual const char* GetDefaultPropertyName(Property::Index index) const;
254 * @copydoc Dali::Internal::Object::GetDefaultPropertyIndex()
256 virtual Property::Index GetDefaultPropertyIndex(const std::string& name) const;
259 * @copydoc Dali::Internal::Object::IsDefaultPropertyWritable()
261 virtual bool IsDefaultPropertyWritable(Property::Index index) const;
264 * @copydoc Dali::Internal::Object::IsDefaultPropertyAnimatable()
266 virtual bool IsDefaultPropertyAnimatable(Property::Index index) const;
269 * @copydoc Dali::Internal::Object::IsDefaultPropertyAConstraintInput()
271 virtual bool IsDefaultPropertyAConstraintInput( Property::Index index ) const;
274 * @copydoc Dali::Internal::Object::GetDefaultPropertyType()
276 virtual Property::Type GetDefaultPropertyType(Property::Index index) const;
279 * @copydoc Dali::Internal::Object::SetDefaultProperty()
281 virtual void SetDefaultProperty(Property::Index index, const Property::Value& propertyValue);
284 * @copydoc Dali::Internal::Object::GetDefaultProperty()
286 virtual Property::Value GetDefaultProperty( Property::Index index ) const;
288 public: // From Actor
291 * @copydoc Dali::Actor::GetNaturalSize()
293 virtual Vector3 GetNaturalSize() const;
295 private: // From RenderableActor
298 * @copydoc RenderableActor::GetRenderableAttachment
300 virtual RenderableAttachment& GetRenderableAttachment() const;
305 * Protected constructor; see also ImageActor::New()
310 * A reference counted object may only be deleted by calling Unreference()
312 virtual ~ImageActor();
317 * Calculate the natural size of this image actor
319 * @return Return the natural size as a Vector2
321 Vector2 CalculateNaturalSize() const;
324 * From Actor; used to trigger fade-in animations.
326 virtual void OnStageConnectionInternal();
329 * From Actor; used to notify Image.
331 virtual void OnStageDisconnectionInternal();
335 ImageAttachmentPtr mImageAttachment; ///< Used to display the image (holds a pointer to currently showed Image)
339 } // namespace Internal
341 // Helpers for public-api forwarding methods
343 inline Internal::ImageActor& GetImplementation(Dali::ImageActor& image)
345 DALI_ASSERT_ALWAYS(image && "Image handle is empty");
347 BaseObject& handle = image.GetBaseObject();
349 return static_cast<Internal::ImageActor&>(handle);
352 inline const Internal::ImageActor& GetImplementation(const Dali::ImageActor& image)
354 DALI_ASSERT_ALWAYS(image && "Image handle is empty");
356 const BaseObject& handle = image.GetBaseObject();
358 return static_cast<const Internal::ImageActor&>(handle);
363 #endif // __DALI_INTERNAL_IMAGE_ACTOR_H__