dali/internal/event/actors/image-actor-impl.h

   1 #ifndef __DALI_INTERNAL_IMAGE_ACTOR_H__
   2 #define __DALI_INTERNAL_IMAGE_ACTOR_H__
   3
   4 /*
   5  * Copyright (c) 2014 Samsung Electronics Co., Ltd.
   6  *
   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
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  *
  19  */
  20
  21 // INTERNAL INCLUDES
  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>
  29
  30 namespace Dali
  31 {
  32
  33 namespace Internal
  34 {
  35
  36 class Image;
  37
  38 /**
  39  * An actor which displays an Image object.
  40  *
  41  * This handles image fade-in if required, waiting for the image to load.
  42  *
  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.
  46  *
  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.
  50  */
  51 class ImageActor : public RenderableActor
  52 {
  53 public:
  54
  55   typedef Dali::ImageActor::Style Style;
  56   typedef Dali::ImageActor::PixelArea PixelArea;
  57
  58   /**
  59    * @brief Create an image actor instance.
  60    * @return A smart-pointer to a newly allocated image actor.
  61    */
  62   static ImageActorPtr New();
  63
  64   /**
  65    * @copydoc Dali::Internal::Actor::OnInitialize
  66    */
  67   void OnInitialize() ;
  68
  69   /**
  70    * @see Dali::ImageActor::SetImage()
  71    * @param[in] ImagePtr reference to the image object to display. Reference to avoid unnecessary increment/decrement reference.
  72    */
  73   void SetImage( ImagePtr& image );
  74
  75   /**
  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
  78    */
  79   ImagePtr GetImage();
  80
  81   /**
  82    * @copydoc Dali::ImageActor::SetPixelArea()
  83    */
  84   void SetPixelArea( const PixelArea& pixelArea );
  85
  86   /**
  87    * @copydoc Dali::ImageActor::GetPixelArea()
  88    */
  89   const PixelArea& GetPixelArea() const;
  90
  91   /**
  92    * @copydoc Dali::ImageActor::IsPixelAreaSet()
  93    */
  94   bool IsPixelAreaSet() const;
  95
  96   /**
  97    * @copydoc Dali::ImageActor::ClearPixelArea()
  98    */
  99   void ClearPixelArea();
 100
 101   /**
 102    * @copydoc Dali::ImageActor::SetStyle()
 103    */
 104   void SetStyle( Style style );
 105
 106   /**
 107    * @copydoc Dali::ImageActor::GetStyle()
 108    */
 109   Style GetStyle() const;
 110
 111   /**
 112    * @copydoc Dali::ImageActor::SetNinePatchBorder
 113    */
 114   void SetNinePatchBorder( const Vector4& border, bool inPixels = false );
 115
 116   /**
 117    * @copydoc Dali::ImageActor::GetNinePatchBorder
 118    */
 119   Vector4 GetNinePatchBorder() const;
 120
 121   /**
 122    * Retrieve the attachment which renders the image.
 123    * @return The attachment.
 124    */
 125   ImageAttachment& GetImageAttachment();
 126
 127
 128   /**
 129    * @copydoc Dali::RenderableActor::SetSortModifier()
 130    */
 131   void SetSortModifier(float modifier);
 132
 133   /**
 134    * @copydoc Dali::RenderableActor::GetSortModifier()
 135    */
 136   float GetSortModifier() const;
 137
 138   /**
 139    * @copydoc Dali::RenderableActor::SetCullFace()
 140    */
 141   void SetCullFace(CullFaceMode mode);
 142
 143   /**
 144    * @copydoc Dali::RenderableActor::GetCullFace()
 145    */
 146   CullFaceMode GetCullFace() const;
 147
 148   /**
 149    * @copydoc Dali::RenderableActor::SetBlendMode()
 150    */
 151   void SetBlendMode( BlendingMode::Type mode );
 152
 153   /**
 154    * @copydoc Dali::RenderableActor::GetBlendMode()
 155    */
 156   BlendingMode::Type GetBlendMode() const;
 157
 158   /**
 159    * @copydoc Dali::RenderableActor::SetBlendFunc()
 160    */
 161   void SetBlendFunc( BlendingFactor::Type srcFactorRgba,   BlendingFactor::Type destFactorRgba );
 162
 163   /**
 164    * @copydoc Dali::RenderableActor::SetBlendFunc()
 165    */
 166   void SetBlendFunc( BlendingFactor::Type srcFactorRgb,   BlendingFactor::Type destFactorRgb,
 167                      BlendingFactor::Type srcFactorAlpha, BlendingFactor::Type destFactorAlpha );
 168
 169   /**
 170    * @copydoc Dali::RenderableActor::GetBlendFunc()
 171    */
 172   void GetBlendFunc( BlendingFactor::Type& srcFactorRgb,   BlendingFactor::Type& destFactorRgb,
 173                      BlendingFactor::Type& srcFactorAlpha, BlendingFactor::Type& destFactorAlpha ) const;
 174
 175   /**
 176    * @copydoc Dali::RenderableActor::SetBlendEquation()
 177    */
 178   void SetBlendEquation( BlendingEquation::Type equationRgba );
 179
 180   /**
 181    * @copydoc Dali::RenderableActor::SetBlendEquation()
 182    */
 183   void SetBlendEquation( BlendingEquation::Type equationRgb, BlendingEquation::Type equationAlpha );
 184
 185   /**
 186    * @copydoc Dali::RenderableActor::GetBlendEquation()
 187    */
 188   void GetBlendEquation( BlendingEquation::Type& equationRgb, BlendingEquation::Type& equationAlpha ) const;
 189
 190   /**
 191    * @copydoc Dali::RenderableActor::SetBlendColor()
 192    */
 193   void SetBlendColor( const Vector4& color );
 194
 195   /**
 196    * @copydoc Dali::RenderableActor::GetBlendColor()
 197    */
 198   const Vector4& GetBlendColor() const;
 199
 200   /**
 201    * @copydoc Dali::RenderableActor::SetFilterMode()
 202    */
 203   void SetFilterMode( FilterMode::Type minFilter, FilterMode::Type magFilter );
 204
 205   /**
 206    * @copydoc Dali::RenderableActor::GetFilterMode()
 207    */
 208   void GetFilterMode( FilterMode::Type& minFilter, FilterMode::Type& magFilter ) const;
 209
 210 public:
 211   /**
 212    * @copydoc Actor::SetShaderEffect
 213    */
 214   virtual void SetShaderEffect(ShaderEffect& effect);
 215
 216   /**
 217    * @copydoc Actor::GetShaderEffect
 218    */
 219   virtual ShaderEffectPtr GetShaderEffect() const;
 220
 221   /**
 222    * @copydoc Actor::RemoveShaderEffect
 223    */
 224   virtual void RemoveShaderEffect();
 225
 226 public: // Default property extensions from Object
 227
 228   /**
 229    * @copydoc Dali::Internal::Object::GetDefaultPropertyCount()
 230    */
 231   virtual unsigned int GetDefaultPropertyCount() const;
 232
 233   /**
 234    * @copydoc Dali::Internal::Object::GetDefaultPropertyIndices()
 235    */
 236   virtual void GetDefaultPropertyIndices( Property::IndexContainer& indices ) const;
 237
 238   /**
 239    * @copydoc Dali::Internal::Object::GetDefaultPropertyName()
 240    */
 241   virtual const char* GetDefaultPropertyName(Property::Index index) const;
 242
 243   /**
 244    * @copydoc Dali::Internal::Object::GetDefaultPropertyIndex()
 245    */
 246   virtual Property::Index GetDefaultPropertyIndex(const std::string& name) const;
 247
 248   /**
 249    * @copydoc Dali::Internal::Object::IsDefaultPropertyWritable()
 250    */
 251   virtual bool IsDefaultPropertyWritable(Property::Index index) const;
 252
 253   /**
 254    * @copydoc Dali::Internal::Object::IsDefaultPropertyAnimatable()
 255    */
 256   virtual bool IsDefaultPropertyAnimatable(Property::Index index) const;
 257
 258   /**
 259    * @copydoc Dali::Internal::Object::IsDefaultPropertyAConstraintInput()
 260    */
 261   virtual bool IsDefaultPropertyAConstraintInput( Property::Index index ) const;
 262
 263   /**
 264    * @copydoc Dali::Internal::Object::GetDefaultPropertyType()
 265    */
 266   virtual Property::Type GetDefaultPropertyType(Property::Index index) const;
 267
 268   /**
 269    * @copydoc Dali::Internal::Object::SetDefaultProperty()
 270    */
 271   virtual void SetDefaultProperty(Property::Index index, const Property::Value& propertyValue);
 272
 273   /**
 274    * @copydoc Dali::Internal::Object::GetDefaultProperty()
 275    */
 276   virtual Property::Value GetDefaultProperty( Property::Index index ) const;
 277
 278 public: // From Actor
 279
 280   /**
 281    * @copydoc Dali::Actor::GetNaturalSize()
 282    */
 283   virtual Vector3 GetNaturalSize() const;
 284
 285 private: // From RenderableActor
 286
 287   /**
 288    * @copydoc RenderableActor::GetRenderableAttachment
 289    */
 290   virtual RenderableAttachment& GetRenderableAttachment() const;
 291
 292 protected:
 293
 294   /**
 295    * Protected constructor; see also ImageActor::New()
 296    */
 297   ImageActor();
 298
 299   /**
 300    * A reference counted object may only be deleted by calling Unreference()
 301    */
 302   virtual ~ImageActor();
 303
 304 private:
 305
 306   /**
 307    * Calculate the natural size of this image actor
 308    *
 309    * @return Return the natural size as a Vector2
 310    */
 311   Vector2 CalculateNaturalSize() const;
 312
 313   /**
 314    * From Actor; used to trigger fade-in animations.
 315    */
 316   virtual void OnStageConnectionInternal();
 317
 318   /**
 319    * From Actor; used to notify Image.
 320    */
 321   virtual void OnStageDisconnectionInternal();
 322
 323 private:
 324
 325   ImageAttachmentPtr mImageAttachment; ///< Used to display the image (holds a pointer to currently showed Image)
 326
 327 };
 328
 329 } // namespace Internal
 330
 331 // Helpers for public-api forwarding methods
 332
 333 inline Internal::ImageActor& GetImplementation(Dali::ImageActor& image)
 334 {
 335   DALI_ASSERT_ALWAYS(image && "Image handle is empty");
 336
 337   BaseObject& handle = image.GetBaseObject();
 338
 339   return static_cast<Internal::ImageActor&>(handle);
 340 }
 341
 342 inline const Internal::ImageActor& GetImplementation(const Dali::ImageActor& image)
 343 {
 344   DALI_ASSERT_ALWAYS(image && "Image handle is empty");
 345
 346   const BaseObject& handle = image.GetBaseObject();
 347
 348   return static_cast<const Internal::ImageActor&>(handle);
 349 }
 350
 351 } // namespace Dali
 352
 353 #endif // __DALI_INTERNAL_IMAGE_ACTOR_H__