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/animation/animation-impl.h>
28 #include <dali/internal/event/effects/shader-effect-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::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
79 ImagePtr GetImage() const;
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::RenderableActor::SetSortModifier()
104 void SetSortModifier(float modifier);
107 * @copydoc Dali::RenderableActor::GetSortModifier()
109 float GetSortModifier() const;
112 * @copydoc Dali::RenderableActor::SetCullFace()
114 void SetCullFace(CullFaceMode mode);
117 * @copydoc Dali::RenderableActor::GetCullFace()
119 CullFaceMode GetCullFace() const;
122 * @copydoc Dali::RenderableActor::SetBlendMode()
124 void SetBlendMode( BlendingMode::Type mode );
127 * @copydoc Dali::RenderableActor::GetBlendMode()
129 BlendingMode::Type GetBlendMode() const;
132 * @copydoc Dali::RenderableActor::SetBlendFunc()
134 void SetBlendFunc( BlendingFactor::Type srcFactorRgba, BlendingFactor::Type destFactorRgba );
137 * @copydoc Dali::RenderableActor::SetBlendFunc()
139 void SetBlendFunc( BlendingFactor::Type srcFactorRgb, BlendingFactor::Type destFactorRgb,
140 BlendingFactor::Type srcFactorAlpha, BlendingFactor::Type destFactorAlpha );
143 * @copydoc Dali::RenderableActor::GetBlendFunc()
145 void GetBlendFunc( BlendingFactor::Type& srcFactorRgb, BlendingFactor::Type& destFactorRgb,
146 BlendingFactor::Type& srcFactorAlpha, BlendingFactor::Type& destFactorAlpha ) const;
149 * @copydoc Dali::RenderableActor::SetBlendEquation()
151 void SetBlendEquation( BlendingEquation::Type equationRgba );
154 * @copydoc Dali::RenderableActor::SetBlendEquation()
156 void SetBlendEquation( BlendingEquation::Type equationRgb, BlendingEquation::Type equationAlpha );
159 * @copydoc Dali::RenderableActor::GetBlendEquation()
161 void GetBlendEquation( BlendingEquation::Type& equationRgb, BlendingEquation::Type& equationAlpha ) const;
164 * @copydoc Dali::RenderableActor::SetBlendColor()
166 void SetBlendColor( const Vector4& color );
169 * @copydoc Dali::RenderableActor::GetBlendColor()
171 const Vector4& GetBlendColor() const;
174 * @copydoc Dali::RenderableActor::SetFilterMode()
176 void SetFilterMode( FilterMode::Type minFilter, FilterMode::Type magFilter );
179 * @copydoc Dali::RenderableActor::GetFilterMode()
181 void GetFilterMode( FilterMode::Type& minFilter, FilterMode::Type& magFilter ) const;
184 * @brief Allows this ImageActor to respond to the event that the a shader effect's uniform has updated
186 * @param[in] uniform The shader effect uniform that has been updated
188 void EffectUniformUpdated( const ShaderEffect::Uniform& uniform );
191 * @brief Allows this ImageActor to respond to the eventa that the shader effect's effect texture has been changed
193 void EffectImageUpdated();
197 * @copydoc Actor::SetShaderEffect
199 virtual void SetShaderEffect(ShaderEffect& effect);
202 * @copydoc Actor::GetShaderEffect
204 virtual ShaderEffectPtr GetShaderEffect() const;
207 * @copydoc Actor::RemoveShaderEffect
209 virtual void RemoveShaderEffect();
211 public: // Default property extensions from Object
214 * @copydoc Dali::Internal::Object::GetDefaultPropertyCount()
216 virtual unsigned int GetDefaultPropertyCount() const;
219 * @copydoc Dali::Internal::Object::GetDefaultPropertyIndices()
221 virtual void GetDefaultPropertyIndices( Property::IndexContainer& indices ) const;
224 * @copydoc Dali::Internal::Object::GetDefaultPropertyName()
226 virtual const char* GetDefaultPropertyName(Property::Index index) const;
229 * @copydoc Dali::Internal::Object::GetDefaultPropertyIndex()
231 virtual Property::Index GetDefaultPropertyIndex(const std::string& name) const;
234 * @copydoc Dali::Internal::Object::IsDefaultPropertyWritable()
236 virtual bool IsDefaultPropertyWritable(Property::Index index) const;
239 * @copydoc Dali::Internal::Object::IsDefaultPropertyAnimatable()
241 virtual bool IsDefaultPropertyAnimatable(Property::Index index) const;
244 * @copydoc Dali::Internal::Object::IsDefaultPropertyAConstraintInput()
246 virtual bool IsDefaultPropertyAConstraintInput( Property::Index index ) const;
249 * @copydoc Dali::Internal::Object::GetDefaultPropertyType()
251 virtual Property::Type GetDefaultPropertyType(Property::Index index) const;
254 * @copydoc Dali::Internal::Object::SetDefaultProperty()
256 virtual void SetDefaultProperty(Property::Index index, const Property::Value& propertyValue);
259 * @copydoc Dali::Internal::Object::GetDefaultProperty()
261 virtual Property::Value GetDefaultProperty( Property::Index index ) const;
263 public: // From Actor
266 * @copydoc Dali::Actor::GetNaturalSize()
268 virtual Vector3 GetNaturalSize() const;
273 * Protected constructor; see also ImageActor::New()
278 * A reference counted object may only be deleted by calling Unreference()
280 virtual ~ImageActor();
285 * Calculate the natural size of this image actor
287 * @return Return the natural size as a Vector2
289 Vector2 CalculateNaturalSize() const;
292 * @copydoc Dali::Actor::OnRelayout()
294 virtual void OnRelayout( const Vector2& size, RelayoutContainer& container );
298 ShaderEffectPtr mShaderEffect; ///< Optional referenced shader effect
299 RendererPtr mRenderer; ///< The renderer used to render the image
300 PixelArea mPixelArea; ///< The pixel area of the image to render
301 Vector4 mBlendColor; ///< The blend color for this ImageActor
302 int mRendererIndex; ///< The index location of mRenderer
303 size_t mTextureIndex; ///< The texture index for this ImageActor's texture
304 size_t mEffectTextureIndex; ///< The texture index for this ImageActor's effect texture
305 FilterMode::Type mMinFilter; ///< The minification filter currently set
306 FilterMode::Type mMagFilter; ///< The magnification filter currently set
307 bool mIsPixelAreaSet; ///< Flag indicating if the pixel area has been set
310 } // namespace Internal
312 // Helpers for public-api forwarding methods
314 inline Internal::ImageActor& GetImplementation(Dali::ImageActor& image)
316 DALI_ASSERT_ALWAYS(image && "Image handle is empty");
318 BaseObject& handle = image.GetBaseObject();
320 return static_cast<Internal::ImageActor&>(handle);
323 inline const Internal::ImageActor& GetImplementation(const Dali::ImageActor& image)
325 DALI_ASSERT_ALWAYS(image && "Image handle is empty");
327 const BaseObject& handle = image.GetBaseObject();
329 return static_cast<const Internal::ImageActor&>(handle);
334 #endif // __DALI_INTERNAL_IMAGE_ACTOR_H__