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/devel-api/rendering/cull-face.h>
25 #include <dali/internal/event/actors/actor-declarations.h>
26 #include <dali/internal/event/actors/actor-impl.h>
27 #include <dali/internal/event/actor-attachments/image-attachment-impl.h>
28 #include <dali/internal/event/animation/animation-impl.h>
29 #include <dali/internal/event/images/nine-patch-image-impl.h>
40 * An actor which displays an Image object.
42 * This handles image fade-in if required, waiting for the image to load.
44 * If a new image is set on the actor, then this ensures that the old image
45 * is displayed until the new image is ready to render to prevent flashing
46 * to the actor color. This will also happen if the image is reloaded.
48 * This is achieved by using two connector objects to Image: mImageNext and
49 * mImageAttachment's member object. The first one points to the Image object that is going to
50 * be displayed next, the second one to the Image that is currently being displayed.
52 class ImageActor : public Actor
56 typedef Dali::ImageActor::Style Style;
57 typedef Dali::ImageActor::PixelArea PixelArea;
60 * @brief Create an image actor instance.
61 * @return A smart-pointer to a newly allocated image actor.
63 static ImageActorPtr New();
66 * @copydoc Dali::Internal::Actor::OnInitialize
71 * @see Dali::ImageActor::SetImage()
72 * @param[in] ImagePtr reference to the image object to display. Reference to avoid unnecessary increment/decrement reference.
74 void SetImage( ImagePtr& image );
77 * Retrieve the image rendered by the actor's attachment.
78 * @return smart pointer to the image or an empty one if no image is assigned
83 * @copydoc Dali::ImageActor::SetPixelArea()
85 void SetPixelArea( const PixelArea& pixelArea );
88 * @copydoc Dali::ImageActor::GetPixelArea()
90 const PixelArea& GetPixelArea() const;
93 * @copydoc Dali::ImageActor::IsPixelAreaSet()
95 bool IsPixelAreaSet() const;
98 * @copydoc Dali::ImageActor::ClearPixelArea()
100 void ClearPixelArea();
103 * @copydoc Dali::ImageActor::SetStyle()
105 void SetStyle( Style style );
108 * @copydoc Dali::ImageActor::GetStyle()
110 Style GetStyle() const;
113 * @copydoc Dali::ImageActor::SetNinePatchBorder
115 void SetNinePatchBorder( const Vector4& border, bool inPixels = false );
118 * @copydoc Dali::ImageActor::GetNinePatchBorder
120 Vector4 GetNinePatchBorder() const;
123 * Retrieve the attachment which renders the image.
124 * @return The attachment.
126 ImageAttachment& GetImageAttachment();
130 * @copydoc Dali::RenderableActor::SetSortModifier()
132 void SetSortModifier(float modifier);
135 * @copydoc Dali::RenderableActor::GetSortModifier()
137 float GetSortModifier() const;
140 * @copydoc Dali::RenderableActor::SetDepthIndex()
142 void SetDepthIndex( int depthIndex );
145 * @copydoc Dali::RenderableActor::GetDepthIndex()
147 int GetDepthIndex() const;
150 * @copydoc Dali::RenderableActor::SetCullFace()
152 void SetCullFace(CullFaceMode mode);
155 * @copydoc Dali::RenderableActor::GetCullFace()
157 CullFaceMode GetCullFace() const;
160 * @copydoc Dali::RenderableActor::SetBlendMode()
162 void SetBlendMode( BlendingMode::Type mode );
165 * @copydoc Dali::RenderableActor::GetBlendMode()
167 BlendingMode::Type GetBlendMode() const;
170 * @copydoc Dali::RenderableActor::SetBlendFunc()
172 void SetBlendFunc( BlendingFactor::Type srcFactorRgba, BlendingFactor::Type destFactorRgba );
175 * @copydoc Dali::RenderableActor::SetBlendFunc()
177 void SetBlendFunc( BlendingFactor::Type srcFactorRgb, BlendingFactor::Type destFactorRgb,
178 BlendingFactor::Type srcFactorAlpha, BlendingFactor::Type destFactorAlpha );
181 * @copydoc Dali::RenderableActor::GetBlendFunc()
183 void GetBlendFunc( BlendingFactor::Type& srcFactorRgb, BlendingFactor::Type& destFactorRgb,
184 BlendingFactor::Type& srcFactorAlpha, BlendingFactor::Type& destFactorAlpha ) const;
187 * @copydoc Dali::RenderableActor::SetBlendEquation()
189 void SetBlendEquation( BlendingEquation::Type equationRgba );
192 * @copydoc Dali::RenderableActor::SetBlendEquation()
194 void SetBlendEquation( BlendingEquation::Type equationRgb, BlendingEquation::Type equationAlpha );
197 * @copydoc Dali::RenderableActor::GetBlendEquation()
199 void GetBlendEquation( BlendingEquation::Type& equationRgb, BlendingEquation::Type& equationAlpha ) const;
202 * @copydoc Dali::RenderableActor::SetBlendColor()
204 void SetBlendColor( const Vector4& color );
207 * @copydoc Dali::RenderableActor::GetBlendColor()
209 const Vector4& GetBlendColor() const;
212 * @copydoc Dali::RenderableActor::SetFilterMode()
214 void SetFilterMode( FilterMode::Type minFilter, FilterMode::Type magFilter );
217 * @copydoc Dali::RenderableActor::GetFilterMode()
219 void GetFilterMode( FilterMode::Type& minFilter, FilterMode::Type& magFilter ) const;
223 * @copydoc Actor::SetShaderEffect
225 virtual void SetShaderEffect(ShaderEffect& effect);
228 * @copydoc Actor::GetShaderEffect
230 virtual ShaderEffectPtr GetShaderEffect() const;
233 * @copydoc Actor::RemoveShaderEffect
235 virtual void RemoveShaderEffect();
237 public: // Default property extensions from Object
240 * @copydoc Dali::Internal::Object::GetDefaultPropertyCount()
242 virtual unsigned int GetDefaultPropertyCount() const;
245 * @copydoc Dali::Internal::Object::GetDefaultPropertyIndices()
247 virtual void GetDefaultPropertyIndices( Property::IndexContainer& indices ) const;
250 * @copydoc Dali::Internal::Object::GetDefaultPropertyName()
252 virtual const char* GetDefaultPropertyName(Property::Index index) const;
255 * @copydoc Dali::Internal::Object::GetDefaultPropertyIndex()
257 virtual Property::Index GetDefaultPropertyIndex(const std::string& name) const;
260 * @copydoc Dali::Internal::Object::IsDefaultPropertyWritable()
262 virtual bool IsDefaultPropertyWritable(Property::Index index) const;
265 * @copydoc Dali::Internal::Object::IsDefaultPropertyAnimatable()
267 virtual bool IsDefaultPropertyAnimatable(Property::Index index) const;
270 * @copydoc Dali::Internal::Object::IsDefaultPropertyAConstraintInput()
272 virtual bool IsDefaultPropertyAConstraintInput( Property::Index index ) const;
275 * @copydoc Dali::Internal::Object::GetDefaultPropertyType()
277 virtual Property::Type GetDefaultPropertyType(Property::Index index) const;
280 * @copydoc Dali::Internal::Object::SetDefaultProperty()
282 virtual void SetDefaultProperty(Property::Index index, const Property::Value& propertyValue);
285 * @copydoc Dali::Internal::Object::GetDefaultProperty()
287 virtual Property::Value GetDefaultProperty( Property::Index index ) const;
289 public: // From Actor
292 * @copydoc Dali::Actor::GetNaturalSize()
294 virtual Vector3 GetNaturalSize() const;
296 private: // From RenderableActor
299 * @copydoc RenderableActor::GetRenderableAttachment
301 virtual RenderableAttachment& GetRenderableAttachment() const;
306 * Protected constructor; see also ImageActor::New()
311 * A reference counted object may only be deleted by calling Unreference()
313 virtual ~ImageActor();
318 * Calculate the natural size of this image actor
320 * @return Return the natural size as a Vector2
322 Vector2 CalculateNaturalSize() const;
325 * From Actor; used to trigger fade-in animations.
327 virtual void OnStageConnectionInternal();
330 * From Actor; used to notify Image.
332 virtual void OnStageDisconnectionInternal();
336 ImageAttachmentPtr mImageAttachment; ///< Used to display the image (holds a pointer to currently showed Image)
340 } // namespace Internal
342 // Helpers for public-api forwarding methods
344 inline Internal::ImageActor& GetImplementation(Dali::ImageActor& image)
346 DALI_ASSERT_ALWAYS(image && "Image handle is empty");
348 BaseObject& handle = image.GetBaseObject();
350 return static_cast<Internal::ImageActor&>(handle);
353 inline const Internal::ImageActor& GetImplementation(const Dali::ImageActor& image)
355 DALI_ASSERT_ALWAYS(image && "Image handle is empty");
357 const BaseObject& handle = image.GetBaseObject();
359 return static_cast<const Internal::ImageActor&>(handle);
364 #endif // __DALI_INTERNAL_IMAGE_ACTOR_H__