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::SetToNaturalSize()
  83    */
  84   void SetToNaturalSize();
  85
  86   /**
  87    * @copydoc Dali::ImageActor::SetPixelArea()
  88    */
  89   void SetPixelArea( const PixelArea& pixelArea );
  90
  91   /**
  92    * @copydoc Dali::ImageActor::GetPixelArea()
  93    */
  94   const PixelArea& GetPixelArea() const;
  95
  96   /**
  97    * @copydoc Dali::ImageActor::IsPixelAreaSet()
  98    */
  99   bool IsPixelAreaSet() const;
 100
 101   /**
 102    * @copydoc Dali::ImageActor::ClearPixelArea()
 103    */
 104   void ClearPixelArea();
 105
 106   /**
 107    * @copydoc Dali::ImageActor::SetStyle()
 108    */
 109   void SetStyle( Style style );
 110
 111   /**
 112    * @copydoc Dali::ImageActor::GetStyle()
 113    */
 114   Style GetStyle() const;
 115
 116   /**
 117    * @copydoc Dali::ImageActor::SetNinePatchBorder
 118    */
 119   void SetNinePatchBorder( const Vector4& border, bool inPixels = false );
 120
 121   /**
 122    * @copydoc Dali::ImageActor::GetNinePatchBorder
 123    */
 124   Vector4 GetNinePatchBorder() const;
 125
 126   /**
 127    * Retrieve the attachment which renders the image.
 128    * @return The attachment.
 129    */
 130   ImageAttachment& GetImageAttachment();
 131
 132
 133   /**
 134    * @copydoc Dali::RenderableActor::SetSortModifier()
 135    */
 136   void SetSortModifier(float modifier);
 137
 138   /**
 139    * @copydoc Dali::RenderableActor::GetSortModifier()
 140    */
 141   float GetSortModifier() const;
 142
 143   /**
 144    * @copydoc Dali::RenderableActor::SetCullFace()
 145    */
 146   void SetCullFace(CullFaceMode mode);
 147
 148   /**
 149    * @copydoc Dali::RenderableActor::GetCullFace()
 150    */
 151   CullFaceMode GetCullFace() const;
 152
 153   /**
 154    * @copydoc Dali::RenderableActor::SetBlendMode()
 155    */
 156   void SetBlendMode( BlendingMode::Type mode );
 157
 158   /**
 159    * @copydoc Dali::RenderableActor::GetBlendMode()
 160    */
 161   BlendingMode::Type GetBlendMode() const;
 162
 163   /**
 164    * @copydoc Dali::RenderableActor::SetBlendFunc()
 165    */
 166   void SetBlendFunc( BlendingFactor::Type srcFactorRgba,   BlendingFactor::Type destFactorRgba );
 167
 168   /**
 169    * @copydoc Dali::RenderableActor::SetBlendFunc()
 170    */
 171   void SetBlendFunc( BlendingFactor::Type srcFactorRgb,   BlendingFactor::Type destFactorRgb,
 172                      BlendingFactor::Type srcFactorAlpha, BlendingFactor::Type destFactorAlpha );
 173
 174   /**
 175    * @copydoc Dali::RenderableActor::GetBlendFunc()
 176    */
 177   void GetBlendFunc( BlendingFactor::Type& srcFactorRgb,   BlendingFactor::Type& destFactorRgb,
 178                      BlendingFactor::Type& srcFactorAlpha, BlendingFactor::Type& destFactorAlpha ) const;
 179
 180   /**
 181    * @copydoc Dali::RenderableActor::SetBlendEquation()
 182    */
 183   void SetBlendEquation( BlendingEquation::Type equationRgba );
 184
 185   /**
 186    * @copydoc Dali::RenderableActor::SetBlendEquation()
 187    */
 188   void SetBlendEquation( BlendingEquation::Type equationRgb, BlendingEquation::Type equationAlpha );
 189
 190   /**
 191    * @copydoc Dali::RenderableActor::GetBlendEquation()
 192    */
 193   void GetBlendEquation( BlendingEquation::Type& equationRgb, BlendingEquation::Type& equationAlpha ) const;
 194
 195   /**
 196    * @copydoc Dali::RenderableActor::SetBlendColor()
 197    */
 198   void SetBlendColor( const Vector4& color );
 199
 200   /**
 201    * @copydoc Dali::RenderableActor::GetBlendColor()
 202    */
 203   const Vector4& GetBlendColor() const;
 204
 205   /**
 206    * @copydoc Dali::RenderableActor::SetFilterMode()
 207    */
 208   void SetFilterMode( FilterMode::Type minFilter, FilterMode::Type magFilter );
 209
 210   /**
 211    * @copydoc Dali::RenderableActor::GetFilterMode()
 212    */
 213   void GetFilterMode( FilterMode::Type& minFilter, FilterMode::Type& magFilter ) const;
 214
 215 public:
 216   /**
 217    * @copydoc Actor::SetShaderEffect
 218    */
 219   virtual void SetShaderEffect(ShaderEffect& effect);
 220
 221   /**
 222    * @copydoc Actor::GetShaderEffect
 223    */
 224   virtual ShaderEffectPtr GetShaderEffect() const;
 225
 226   /**
 227    * @copydoc Actor::RemoveShaderEffect
 228    */
 229   virtual void RemoveShaderEffect();
 230
 231 public: // Default property extensions from Object
 232
 233   /**
 234    * @copydoc Dali::Internal::Object::GetDefaultPropertyCount()
 235    */
 236   virtual unsigned int GetDefaultPropertyCount() const;
 237
 238   /**
 239    * @copydoc Dali::Internal::Object::GetDefaultPropertyIndices()
 240    */
 241   virtual void GetDefaultPropertyIndices( Property::IndexContainer& indices ) const;
 242
 243   /**
 244    * @copydoc Dali::Internal::Object::GetDefaultPropertyName()
 245    */
 246   virtual const char* GetDefaultPropertyName(Property::Index index) const;
 247
 248   /**
 249    * @copydoc Dali::Internal::Object::GetDefaultPropertyIndex()
 250    */
 251   virtual Property::Index GetDefaultPropertyIndex(const std::string& name) const;
 252
 253   /**
 254    * @copydoc Dali::Internal::Object::IsDefaultPropertyWritable()
 255    */
 256   virtual bool IsDefaultPropertyWritable(Property::Index index) const;
 257
 258   /**
 259    * @copydoc Dali::Internal::Object::IsDefaultPropertyAnimatable()
 260    */
 261   virtual bool IsDefaultPropertyAnimatable(Property::Index index) const;
 262
 263   /**
 264    * @copydoc Dali::Internal::Object::IsDefaultPropertyAConstraintInput()
 265    */
 266   virtual bool IsDefaultPropertyAConstraintInput( Property::Index index ) const;
 267
 268   /**
 269    * @copydoc Dali::Internal::Object::GetDefaultPropertyType()
 270    */
 271   virtual Property::Type GetDefaultPropertyType(Property::Index index) const;
 272
 273   /**
 274    * @copydoc Dali::Internal::Object::SetDefaultProperty()
 275    */
 276   virtual void SetDefaultProperty(Property::Index index, const Property::Value& propertyValue);
 277
 278   /**
 279    * @copydoc Dali::Internal::Object::GetDefaultProperty()
 280    */
 281   virtual Property::Value GetDefaultProperty( Property::Index index ) const;
 282
 283 public: // From Actor
 284
 285   /**
 286    * @copydoc Dali::Actor::GetNaturalSize()
 287    */
 288   virtual Vector3 GetNaturalSize() const;
 289
 290 private: // From RenderableActor
 291
 292   /**
 293    * @copydoc RenderableActor::GetRenderableAttachment
 294    */
 295   virtual RenderableAttachment& GetRenderableAttachment() const;
 296
 297 protected:
 298
 299   /**
 300    * Protected constructor; see also ImageActor::New()
 301    */
 302   ImageActor();
 303
 304   /**
 305    * A reference counted object may only be deleted by calling Unreference()
 306    */
 307   virtual ~ImageActor();
 308
 309 private:
 310
 311   /**
 312    * Helper to set the actor to the image's natural size
 313    */
 314   void SetNaturalSize();
 315
 316   /**
 317    * Calculate the natural size of this image actor
 318    *
 319    * @return Return the natural size as a Vector2
 320    */
 321   Vector2 CalculateNaturalSize() const;
 322
 323   /**
 324    * From Actor.
 325    * This is called after SizeSet() has been called.
 326    */
 327   virtual void OnSizeSet( const Vector3& targetSize );
 328
 329   /**
 330    * @copydoc Actor::OnSizeAnimation( Animation& animation, const Vector3& targetSize )
 331    */
 332   virtual void OnSizeAnimation(Animation& animation, const Vector3& targetSize);
 333
 334   /**
 335    * From Actor; used to trigger fade-in animations.
 336    */
 337   virtual void OnStageConnectionInternal();
 338
 339   /**
 340    * From Actor; used to notify Image.
 341    */
 342   virtual void OnStageDisconnectionInternal();
 343
 344 private:
 345
 346   ImageAttachmentPtr mImageAttachment; ///< Used to display the image (holds a pointer to currently showed Image)
 347
 348   // flags, compressed to bitfield (uses only 1 byte)
 349   bool mUsingNaturalSize:1;      ///< True only when the actor is using
 350   bool mInternalSetSize:1;       ///< True whilst setting size internally, false at all other times
 351
 352 };
 353
 354 } // namespace Internal
 355
 356 // Helpers for public-api forwarding methods
 357
 358 inline Internal::ImageActor& GetImplementation(Dali::ImageActor& image)
 359 {
 360   DALI_ASSERT_ALWAYS(image && "Image handle is empty");
 361
 362   BaseObject& handle = image.GetBaseObject();
 363
 364   return static_cast<Internal::ImageActor&>(handle);
 365 }
 366
 367 inline const Internal::ImageActor& GetImplementation(const Dali::ImageActor& image)
 368 {
 369   DALI_ASSERT_ALWAYS(image && "Image handle is empty");
 370
 371   const BaseObject& handle = image.GetBaseObject();
 372
 373   return static_cast<const Internal::ImageActor&>(handle);
 374 }
 375
 376 } // namespace Dali
 377
 378 #endif // __DALI_INTERNAL_IMAGE_ACTOR_H__