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 public: // Default property extensions from Object
 128
 129   /**
 130    * @copydoc Dali::Internal::Object::GetDefaultPropertyCount()
 131    */
 132   virtual unsigned int GetDefaultPropertyCount() const;
 133
 134   /**
 135    * @copydoc Dali::Internal::Object::GetDefaultPropertyIndices()
 136    */
 137   virtual void GetDefaultPropertyIndices( Property::IndexContainer& indices ) const;
 138
 139   /**
 140    * @copydoc Dali::Internal::Object::GetDefaultPropertyName()
 141    */
 142   virtual const char* GetDefaultPropertyName(Property::Index index) const;
 143
 144   /**
 145    * @copydoc Dali::Internal::Object::GetDefaultPropertyIndex()
 146    */
 147   virtual Property::Index GetDefaultPropertyIndex(const std::string& name) const;
 148
 149   /**
 150    * @copydoc Dali::Internal::Object::IsDefaultPropertyWritable()
 151    */
 152   virtual bool IsDefaultPropertyWritable(Property::Index index) const;
 153
 154   /**
 155    * @copydoc Dali::Internal::Object::IsDefaultPropertyAnimatable()
 156    */
 157   virtual bool IsDefaultPropertyAnimatable(Property::Index index) const;
 158
 159   /**
 160    * @copydoc Dali::Internal::Object::IsDefaultPropertyAConstraintInput()
 161    */
 162   virtual bool IsDefaultPropertyAConstraintInput( Property::Index index ) const;
 163
 164   /**
 165    * @copydoc Dali::Internal::Object::GetDefaultPropertyType()
 166    */
 167   virtual Property::Type GetDefaultPropertyType(Property::Index index) const;
 168
 169   /**
 170    * @copydoc Dali::Internal::Object::SetDefaultProperty()
 171    */
 172   virtual void SetDefaultProperty(Property::Index index, const Property::Value& propertyValue);
 173
 174   /**
 175    * @copydoc Dali::Internal::Object::GetDefaultProperty()
 176    */
 177   virtual Property::Value GetDefaultProperty( Property::Index index ) const;
 178
 179 public: // From Actor
 180
 181   /**
 182    * @copydoc Dali::Actor::GetNaturalSize()
 183    */
 184   virtual Vector3 GetNaturalSize() const;
 185
 186 private: // From RenderableActor
 187
 188   /**
 189    * @copydoc RenderableActor::GetRenderableAttachment
 190    */
 191   virtual RenderableAttachment& GetRenderableAttachment() const;
 192
 193 protected:
 194
 195   /**
 196    * Protected constructor; see also ImageActor::New()
 197    */
 198   ImageActor();
 199
 200   /**
 201    * A reference counted object may only be deleted by calling Unreference()
 202    */
 203   virtual ~ImageActor();
 204
 205 private:
 206
 207   /**
 208    * Calculate the natural size of this image actor
 209    *
 210    * @return Return the natural size as a Vector2
 211    */
 212   Vector2 CalculateNaturalSize() const;
 213
 214   /**
 215    * From Actor; used to trigger fade-in animations.
 216    */
 217   virtual void OnStageConnectionInternal();
 218
 219   /**
 220    * From Actor; used to notify Image.
 221    */
 222   virtual void OnStageDisconnectionInternal();
 223
 224 private:
 225
 226   ImageAttachmentPtr mImageAttachment; ///< Used to display the image (holds a pointer to currently showed Image)
 227
 228 };
 229
 230 } // namespace Internal
 231
 232 // Helpers for public-api forwarding methods
 233
 234 inline Internal::ImageActor& GetImplementation(Dali::ImageActor& image)
 235 {
 236   DALI_ASSERT_ALWAYS(image && "Image handle is empty");
 237
 238   BaseObject& handle = image.GetBaseObject();
 239
 240   return static_cast<Internal::ImageActor&>(handle);
 241 }
 242
 243 inline const Internal::ImageActor& GetImplementation(const Dali::ImageActor& image)
 244 {
 245   DALI_ASSERT_ALWAYS(image && "Image handle is empty");
 246
 247   const BaseObject& handle = image.GetBaseObject();
 248
 249   return static_cast<const Internal::ImageActor&>(handle);
 250 }
 251
 252 } // namespace Dali
 253
 254 #endif // __DALI_INTERNAL_IMAGE_ACTOR_H__