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