dali-toolkit/internal/visuals/image/image-visual.h

   1 #ifndef DALI_TOOLKIT_INTERNAL_IMAGE_VISUAL_H
   2 #define DALI_TOOLKIT_INTERNAL_IMAGE_VISUAL_H
   3
   4 /*
   5  * Copyright (c) 2016 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 // EXTERNAL INCLUDES
  22 #include <dali/public-api/common/intrusive-ptr.h>
  23 #include <dali/public-api/images/image.h>
  24 #include <dali/public-api/images/image-operations.h>
  25 #include <dali/public-api/images/resource-image.h>
  26 #include <dali/devel-api/object/weak-handle.h>
  27
  28 // INTERNAL INCLUDES
  29 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
  30 #include <dali-toolkit/devel-api/image-loader/atlas-upload-observer.h>
  31
  32 namespace Dali
  33 {
  34
  35 class NativeImage;
  36
  37 namespace Toolkit
  38 {
  39
  40 namespace Internal
  41 {
  42
  43 class ImageVisual;
  44 typedef IntrusivePtr< ImageVisual > ImageVisualPtr;
  45
  46 /**
  47  * The visual which renders an image to the control's quad
  48  *
  49  * The following properties are optional
  50  *
  51  * | %Property Name     | Type             |
  52  * |--------------------|------------------|
  53  * | url                | STRING           |
  54  * | fittingMode        | STRING           |
  55  * | samplingMode       | STRING           |
  56  * | desiredWidth       | INT              |
  57  * | desiredHeight      | INT              |
  58  * | synchronousLoading | BOOLEAN          |
  59  *
  60  * where imageFittingMode should be one of the following fitting modes:
  61  *   "SHRINK_TO_FIT"
  62  *   "SCALE_TO_FIT"
  63  *   "FIT_WIDTH"
  64  *   "FIT_HEIGHT"
  65  *   "DEFAULT"
  66  *
  67  * where imageSamplingMode should be one of the following sampling modes:
  68  *   "BOX"
  69  *   "NEAREST"
  70  *   "LINEAR"
  71  *   "BOX_THEN_NEAREST"
  72  *   "BOX_THEN_LINEAR"
  73  *   "NO_FILTER"
  74  *   "DONT_CARE"
  75  *   "DEFAULT"
  76  *
  77  */
  78 class ImageVisual: public Visual::Base, public ConnectionTracker, public AtlasUploadObserver
  79 {
  80 public:
  81
  82   /**
  83    * @brief Create a new image visual.
  84    *
  85    * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
  86    * @return A smart-pointer to the newly allocated visual.
  87    */
  88   static ImageVisualPtr New( VisualFactoryCache& factoryCache );
  89
  90   /**
  91    * @brief Create a new image visual with a URL.
  92    *
  93    * The visual will load the Image asynchronously when the associated actor is put on stage, and destroy the image when it is off stage
  94    *
  95    * @param[in] factoryCache The VisualFactoryCache object
  96    * @param[in] imageUrl The URL of the image resource to use
  97    * @param[in] size The width and height to fit the loaded image to.
  98    * @param[in] fittingMode The FittingMode of the resource to load
  99    * @param[in] samplingMode The SamplingMode of the resource to load
 100    */
 101   static ImageVisualPtr New( VisualFactoryCache& factoryCache,
 102                              const std::string& imageUrl,
 103                              ImageDimensions size = ImageDimensions(),
 104                              FittingMode::Type fittingMode = FittingMode::DEFAULT,
 105                              Dali::SamplingMode::Type samplingMode = SamplingMode::BOX_THEN_LINEAR );
 106
 107   /**
 108    * @brief Create a new image visual with an Image type.
 109    *
 110    * @param[in] factoryCache The VisualFactoryCache object
 111    * @param[in] image The image to use
 112    */
 113   static ImageVisualPtr New( VisualFactoryCache& factoryCache, const Image& image );
 114
 115 public:  // from Visual
 116
 117   /**
 118    * @copydoc Visual::Base::GetNaturalSize
 119    */
 120   virtual void GetNaturalSize( Vector2& naturalSize ) const;
 121
 122   /**
 123    * @copydoc Visual::Base::CreatePropertyMap
 124    */
 125   virtual void DoCreatePropertyMap( Property::Map& map ) const;
 126
 127   /**
 128    * @copydoc Visual::Base::DoSetProperty
 129    */
 130   virtual void DoSetProperty( Dali::Property::Index index, const Dali::Property::Value& propertyValue );
 131
 132   /**
 133    * @copydoc Visual::Base::DoGetProperty
 134    */
 135   virtual Dali::Property::Value DoGetProperty( Dali::Property::Index index );
 136
 137 protected:
 138
 139   /**
 140    * @brief Constructor.
 141    *
 142    * @param[in] factoryCache The VisualFactoryCache object
 143    */
 144   ImageVisual( VisualFactoryCache& factoryCache );
 145
 146   /**
 147    * @brief Constructor with a URL.
 148    *
 149    * The visual will load the Image asynchronously when the associated actor is put on stage, and destroy the image when it is off stage
 150    *
 151    * @param[in] factoryCache The VisualFactoryCache object
 152    * @param[in] imageUrl The URL of the image resource to use
 153    * @param[in] size The width and height to fit the loaded image to.
 154    * @param[in] fittingMode The FittingMode of the resource to load
 155    * @param[in] samplingMode The SamplingMode of the resource to load
 156    */
 157   ImageVisual( VisualFactoryCache& factoryCache,
 158                const std::string& imageUrl,
 159                ImageDimensions size,
 160                FittingMode::Type fittingMode,
 161                Dali::SamplingMode::Type samplingMode );
 162
 163   /**
 164    * @brief Constructor with an Image type.
 165    *
 166    * @param[in] factoryCache The VisualFactoryCache object
 167    * @param[in] image The image to use
 168    */
 169   ImageVisual( VisualFactoryCache& factoryCache, const Image& image );
 170
 171   /**
 172    * @brief A reference counted object may only be deleted by calling Unreference().
 173    */
 174   virtual ~ImageVisual();
 175
 176   /**
 177    * @copydoc Visual::Base::DoSetProperties
 178    */
 179   virtual void DoSetProperties( const Property::Map& propertyMap );
 180
 181   /**
 182    * @copydoc Visual::Base::DoSetOnStage
 183    */
 184   virtual void DoSetOnStage( Actor& actor );
 185
 186   /**
 187    * @copydoc Visual::Base::DoSetOffStage
 188    */
 189   virtual void DoSetOffStage( Actor& actor );
 190
 191   /**
 192    * @copydoc Visual::Base::OnSetTransform
 193    */
 194   virtual void OnSetTransform();
 195
 196 public:
 197
 198   /**
 199    * Get the standard image rendering shader.
 200    * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
 201    * @param[in] atlasing Whether texture atlasing is applied.
 202    * @param[in] defaultTextureWrapping Whether the default texture wrap mode is applied.
 203    */
 204   static Shader GetImageShader( VisualFactoryCache& factoryCache, bool atlasing, bool defaultTextureWrapping );
 205
 206   /**
 207    * @copydoc AtlasUploadObserver::UploadCompleted
 208    *
 209    * To avoid rendering garbage pixels, renderer should be added to actor after the resources are ready.
 210    * This callback is the place to add the renderer as it would be called once the loading is finished.
 211    */
 212   virtual void UploadCompleted();
 213
 214 private:
 215
 216   /**
 217    * @brief Applies the image to the texture set used for this renderer
 218    *
 219    * @param[in] image The Image to apply to the texture set used for this renderer
 220    */
 221   void ApplyImageToSampler( const Image& image );
 222
 223   /**
 224    * @brief Initializes the Dali::Renderer from an image url string
 225    *
 226    * @param[in] imageUrl The image url string to intialize this ImageVisual from
 227    */
 228   void InitializeRenderer( const std::string& imageUrl );
 229
 230   /**
 231    * @brief Initializes the Dali::Renderer from an image handle
 232    *
 233    * @param[in] image The image handle to intialize this ImageVisual from
 234    */
 235   void InitializeRenderer( const Image& image );
 236
 237   /**
 238    * @brief Creates the Dali::Renderer (potentially from the renderer cache), initializing it
 239    * @param[in] textures to use
 240    */
 241   void CreateRenderer( TextureSet& textures );
 242
 243   /**
 244    * @brief Creates the Dali::Renderer for NativeImage with custom sampler type and prefix, initializing it
 245    * @param NativeImageRenderer
 246    */
 247   void CreateNativeImageRenderer( NativeImage& nativeImage );
 248
 249   /**
 250    * @brief Query whether resources requires to be loaded synchronously.
 251    * @return Returns true if synchronous resource loading is required, false otherwise.
 252    */
 253   bool IsSynchronousResourceLoading() const;
 254
 255   /**
 256    * @brief Load the resource synchronously
 257    */
 258   void LoadResourceSynchronously();
 259
 260   /**
 261    * Creates the texture set and adds the texture to it
 262    * @param[out] textureRect The texture area of the texture in the atlas.
 263    * @param[in] url The URL of the image resource to use.
 264    * @param[in] synchronousLoading If true, the resource is loaded synchronously, otherwise asynchronously.
 265    * @param[in] attemptAtlasing If true will attempt atlasing, otherwise create unique texture
 266    * @return the texture set to use
 267    */
 268   TextureSet CreateTextureSet( Vector4& textureRect, const std::string& url, bool synchronousLoading, bool attemptAtlasing );
 269
 270   /**
 271    * Callback function of image resource loading succeed
 272    * @param[in] image The Image content that we attempted to load from mImageUrl
 273    */
 274   void OnImageLoaded( ResourceImage image );
 275
 276   /**
 277    * Set the value to the uTextureRect uniform
 278    * @param[in] textureRect The texture rectangular area.
 279    */
 280   void SetTextureRectUniform( const Vector4& textureRect  );
 281
 282   /**
 283    * Clean the renderer from cache, and remove the image from atlas if it is not used anymore
 284    */
 285   void CleanCache(const std::string& url);
 286
 287 private:
 288
 289   Image mImage;
 290   PixelData mPixels;
 291   Vector4 mPixelArea;
 292   WeakHandle<Actor> mPlacementActor;
 293   std::string mImageUrl;
 294
 295   Dali::ImageDimensions mDesiredSize;
 296   Dali::FittingMode::Type mFittingMode:3;
 297   Dali::SamplingMode::Type mSamplingMode:4;
 298   Dali::WrapMode::Type mWrapModeU:3;
 299   Dali::WrapMode::Type mWrapModeV:3;
 300
 301 };
 302
 303 } // namespace Internal
 304
 305 } // namespace Toolkit
 306
 307 } // namespace Dali
 308
 309 #endif /* DALI_TOOLKIT_INTERNAL_IMAGE_VISUAL_H */