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/public-api/math/uint-16-pair.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>
  30
  31 namespace Dali
  32 {
  33
  34 namespace Internal
  35 {
  36
  37 class Image;
  38
  39 /**
  40  * An actor which displays an Image object.
  41  *
  42  * This handles image fade-in if required, waiting for the image to load.
  43  *
  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.
  47  *
  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.
  51  */
  52 class ImageActor : public Actor
  53 {
  54 public:
  55
  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() const;
  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( Dali::ImageActor::Style style );
 105
 106   /**
 107    * @copydoc Dali::ImageActor::GetStyle()
 108    */
 109   Dali::ImageActor::Style GetStyle() const;
 110
 111   /**
 112    * @copydoc Dali::ImageActor::SetNinePatchBorder()
 113    */
 114   void SetNinePatchBorder( const Vector4& border );
 115
 116   /**
 117    * @copydoc Dali::ImageActor::GetNinePatchBorder()
 118    */
 119   Vector4 GetNinePatchBorder() const;
 120
 121   /**
 122    * @copydoc Dali::RenderableActor::SetSortModifier()
 123    */
 124   void SetSortModifier(float modifier);
 125
 126   /**
 127    * @copydoc Dali::RenderableActor::GetSortModifier()
 128    */
 129   float GetSortModifier() const;
 130
 131   /**
 132    * @copydoc Dali::RenderableActor::SetBlendMode()
 133    */
 134   void SetBlendMode( BlendingMode::Type mode );
 135
 136   /**
 137    * @copydoc Dali::RenderableActor::GetBlendMode()
 138    */
 139   BlendingMode::Type GetBlendMode() const;
 140
 141   /**
 142    * @copydoc Dali::RenderableActor::SetBlendFunc()
 143    */
 144   void SetBlendFunc( BlendingFactor::Type srcFactorRgba,   BlendingFactor::Type destFactorRgba );
 145
 146   /**
 147    * @copydoc Dali::RenderableActor::SetBlendFunc()
 148    */
 149   void SetBlendFunc( BlendingFactor::Type srcFactorRgb,   BlendingFactor::Type destFactorRgb,
 150                      BlendingFactor::Type srcFactorAlpha, BlendingFactor::Type destFactorAlpha );
 151
 152   /**
 153    * @copydoc Dali::RenderableActor::GetBlendFunc()
 154    */
 155   void GetBlendFunc( BlendingFactor::Type& srcFactorRgb,   BlendingFactor::Type& destFactorRgb,
 156                      BlendingFactor::Type& srcFactorAlpha, BlendingFactor::Type& destFactorAlpha ) const;
 157
 158   /**
 159    * @copydoc Dali::RenderableActor::SetBlendEquation()
 160    */
 161   void SetBlendEquation( BlendingEquation::Type equationRgba );
 162
 163   /**
 164    * @copydoc Dali::RenderableActor::SetBlendEquation()
 165    */
 166   void SetBlendEquation( BlendingEquation::Type equationRgb, BlendingEquation::Type equationAlpha );
 167
 168   /**
 169    * @copydoc Dali::RenderableActor::GetBlendEquation()
 170    */
 171   void GetBlendEquation( BlendingEquation::Type& equationRgb, BlendingEquation::Type& equationAlpha ) const;
 172
 173   /**
 174    * @copydoc Dali::RenderableActor::SetBlendColor()
 175    */
 176   void SetBlendColor( const Vector4& color );
 177
 178   /**
 179    * @copydoc Dali::RenderableActor::GetBlendColor()
 180    */
 181   const Vector4& GetBlendColor() const;
 182
 183   /**
 184    * @copydoc Dali::RenderableActor::SetFilterMode()
 185    */
 186   void SetFilterMode( FilterMode::Type minFilter, FilterMode::Type magFilter );
 187
 188   /**
 189    * @copydoc Dali::RenderableActor::GetFilterMode()
 190    */
 191   void GetFilterMode( FilterMode::Type& minFilter, FilterMode::Type& magFilter ) const;
 192
 193   /**
 194    * @brief Allows this ImageActor to respond to the eventa that the shader effect's effect texture has been changed
 195    */
 196   void EffectImageUpdated();
 197
 198 public:
 199   /**
 200    * @copydoc Actor::SetShaderEffect
 201    */
 202   virtual void SetShaderEffect(ShaderEffect& effect);
 203
 204   /**
 205    * @copydoc Actor::GetShaderEffect
 206    */
 207   virtual ShaderEffectPtr GetShaderEffect() const;
 208
 209   /**
 210    * @copydoc Actor::RemoveShaderEffect
 211    */
 212   virtual void RemoveShaderEffect();
 213
 214 private:
 215
 216   /**
 217    * @copydoc Actor::OnRelayout
 218    */
 219   virtual void OnRelayout( const Vector2& size, RelayoutContainer& container );
 220
 221   /**
 222    * @copydoc Actor::OnSizeSet
 223    */
 224   virtual void OnSizeSet( const Vector3& targetSize );
 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 protected:
 286
 287   /**
 288    * Protected constructor; see also ImageActor::New()
 289    */
 290   ImageActor();
 291
 292   /**
 293    * A reference counted object may only be deleted by calling Unreference()
 294    */
 295   virtual ~ImageActor();
 296
 297 private:
 298
 299   /**
 300    * Calculate the natural size of this image actor
 301    *
 302    * @return Return the natural size as a Vector2
 303    */
 304   Vector2 CalculateNaturalSize() const;
 305
 306   /**
 307    * Update the grid geometry.
 308    */
 309   void UpdateGeometry();
 310
 311   /**
 312    * Update the texture rect uniform
 313    */
 314   void UpdateTexureRect();
 315
 316 private:
 317
 318   ShaderEffectPtr         mShaderEffect;            ///< Optional referenced shader effect
 319   RendererPtr             mRenderer;                ///< The renderer used to render the image
 320   PixelArea               mPixelArea;               ///< The pixel area of the image to render
 321   Vector4                 mBlendColor;              ///< The blend color for this ImageActor
 322   Vector4                 mNinePatchBorder;         ///< Nine-patch not supported, but this is used to store what is set so it can be returned for backwards compatibility.
 323   Vector2                 mActorSize;               ///< The actor size
 324   Uint16Pair              mGridSize;                ///< The geometry grid size
 325   int                     mRendererIndex;           ///< The index location of mRenderer
 326   size_t                  mTextureIndex;            ///< The texture index for this ImageActor's texture
 327   size_t                  mEffectTextureIndex;      ///< The texture index for this ImageActor's effect texture
 328   FilterMode::Type        mMinFilter;               ///< The minification filter currently set
 329   FilterMode::Type        mMagFilter;               ///< The magnification filter currently set
 330   Dali::ImageActor::Style mStyle;                   ///< The style set by SetStyle. Not used internally, only used to store what is set so it can be returned for backwards compatibility.
 331   bool                    mIsPixelAreaSet;          ///< Flag indicating if the pixel area has been set
 332 };
 333
 334 } // namespace Internal
 335
 336 // Helpers for public-api forwarding methods
 337
 338 inline Internal::ImageActor& GetImplementation(Dali::ImageActor& image)
 339 {
 340   DALI_ASSERT_ALWAYS(image && "Image handle is empty");
 341
 342   BaseObject& handle = image.GetBaseObject();
 343
 344   return static_cast<Internal::ImageActor&>(handle);
 345 }
 346
 347 inline const Internal::ImageActor& GetImplementation(const Dali::ImageActor& image)
 348 {
 349   DALI_ASSERT_ALWAYS(image && "Image handle is empty");
 350
 351   const BaseObject& handle = image.GetBaseObject();
 352
 353   return static_cast<const Internal::ImageActor&>(handle);
 354 }
 355
 356 } // namespace Dali
 357
 358 #endif // __DALI_INTERNAL_IMAGE_ACTOR_H__