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

   1 #ifndef DALI_TOOLKIT_INTERNAL_BATCH_IMAGE_VISUAL_H
   2 #define DALI_TOOLKIT_INTERNAL_BATCH_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 // INTERNAL HEADER
  22 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
  23 #include <dali-toolkit/internal/visuals/image-atlas-manager.h>
  24
  25 // EXTERNAL INCLUDES
  26 #include <dali/public-api/images/resource-image.h>
  27
  28 namespace Dali
  29 {
  30 namespace Toolkit
  31 {
  32 namespace Internal
  33 {
  34
  35 class BatchImageVisual: public Visual::Base, public ConnectionTracker
  36 {
  37 public:
  38
  39   /**
  40    * @brief Constructor.
  41    *
  42    * @param[in] factoryCache The VisualFactoryCache object
  43    * @param[in] atlasManager The atlasManager object
  44    */
  45   BatchImageVisual( VisualFactoryCache& factoryCache, ImageAtlasManager& atlasManager );
  46
  47   /**
  48    * @brief A reference counted object may only be deleted by calling Unreference().
  49    */
  50   ~BatchImageVisual();
  51
  52 public:  // from Visual
  53
  54   /**
  55    * @copydoc Visual::Base::SetSize
  56    */
  57   virtual void SetSize( const Vector2& size );
  58
  59   /**
  60    * @copydoc Visual::Base::GetNaturalSize
  61    */
  62   virtual void GetNaturalSize( Vector2& naturalSize ) const;
  63
  64   /**
  65    * @copydoc Visual::Base::SetClipRect
  66    */
  67   virtual void SetClipRect( const Rect<int>& clipRect );
  68
  69   /**
  70    * @copydoc Visual::Base::CreatePropertyMap
  71    */
  72   virtual void DoCreatePropertyMap( Property::Map& map ) const;
  73
  74 protected:
  75
  76   /**
  77    * @copydoc Visua::Base::DoInitialize
  78    */
  79   virtual void DoInitialize( Actor& actor, const Property::Map& propertyMap );
  80
  81   /**
  82    * @copydoc Visual::Base::DoSetOnStage
  83    */
  84   virtual void DoSetOnStage( Actor& actor );
  85
  86   /**
  87    * @copydoc Visual::Base::DoSetOffStage
  88    */
  89   virtual void DoSetOffStage( Actor& actor );
  90
  91 private:
  92
  93   /**
  94    * Get the batch image rendering shader.
  95    * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
  96    */
  97   static Shader GetBatchShader( VisualFactoryCache& factoryCache );
  98
  99   /**
 100    * @brief Initializes the Dali::Renderer from an image url string
 101    *
 102    * @param[in] imageUrl The image url string to intialize this ImageVisual from
 103    */
 104   void InitializeRenderer( const std::string& imageUrl );
 105
 106   /**
 107    * Clean the Visual from cache, and remove the image from atlas if it is not used anymore
 108    */
 109   void CleanCache( const std::string& url );
 110
 111 private:
 112
 113   ImageAtlasManager&      mAtlasManager;
 114   Vector4                 mAtlasRect;
 115   std::string             mImageUrl;
 116   Dali::ImageDimensions   mDesiredSize;
 117 };
 118
 119 } // namespace Internal
 120
 121 } // namespace Toolkit
 122
 123 } // namespace Dali
 124
 125 #endif // DALI_TOOLKIT_INTERNAL_BATCH_IMAGE_VISUAL_H