dali-toolkit/internal/controls/renderers/renderer-factory-impl.h

   1 #ifndef __DALI_TOOLKIT_RENDERER_FACTORY_IMPL_H__
   2 #define __DALI_TOOLKIT_RENDERER_FACTORY_IMPL_H__
   3
   4 /*
   5  * Copyright (c) 2015 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 // EXTERNAL INCLUDES
  21 #include <dali/public-api/object/base-object.h>
  22
  23 // INTERNAL INCLUDES
  24 #include <dali-toolkit/devel-api/controls/renderer-factory/renderer-factory.h>
  25 #include <dali-toolkit/devel-api/controls/renderer-factory/control-renderer.h>
  26
  27 namespace Dali
  28 {
  29
  30 namespace Toolkit
  31 {
  32
  33 namespace Internal
  34 {
  35
  36 class RendererFactoryCache;
  37 typedef IntrusivePtr<RendererFactoryCache> RendererFactoryCachePtr;
  38
  39 class ImageAtlasManager;
  40 typedef IntrusivePtr<ImageAtlasManager> ImageAtlasManagerPtr;
  41
  42 /**
  43  * @copydoc Toolkit::RendererFactory
  44  */
  45 class RendererFactory : public BaseObject
  46 {
  47 public:
  48
  49   enum RendererType
  50   {
  51     COLOR,
  52     BORDER,
  53     GRADIENT,
  54     IMAGE,
  55     N_PATCH,
  56     SVG,
  57     MESH,
  58     UNDEFINED
  59   };
  60
  61   /**
  62    * @brief Constructor
  63    *
  64    * @param[in] debugEnabled If true, use debug renderer to replace all the concrete renderer.
  65    */
  66   RendererFactory( bool debugEnabled );
  67
  68   /**
  69    * @copydoc Toolkit::RenderFactory::GetControlRenderer( const Property::Map& )
  70    */
  71   Toolkit::ControlRenderer GetControlRenderer( const Property::Map& propertyMap );
  72
  73   /**
  74    * @copydoc Toolkit::RenderFactory::ResetRenderer( Toolkit::ControlRenderer& renderer, Actor& actor, const Property::Map& propertyMap )
  75    */
  76   void ResetRenderer( Toolkit::ControlRenderer& renderer, Actor& actor, const Property::Map& propertyMap );
  77
  78   /**
  79    * @copydoc Toolkit::RenderFactory::GetControlRenderer( const Vector4& )
  80    */
  81   Toolkit::ControlRenderer GetControlRenderer( const Vector4& color );
  82
  83   /**
  84    * @copydoc Toolkit::RendererFactory::ResetRenderer( Toolkit::ControlRenderer&, Actor& actor, const Vector4& )
  85    */
  86   void ResetRenderer( Toolkit::ControlRenderer& renderer, Actor& actor, const Vector4& color );
  87
  88   /**
  89    * @copydoc Toolkit::RenderFactory::GetControlRenderer( float, const Vector4&, bool )
  90    */
  91   Toolkit::ControlRenderer GetControlRenderer( float borderSize, const Vector4& borderColor, bool antiAliasing );
  92
  93   /**
  94    * @copydoc Toolkit::RenderFactory::GetControlRenderer( const Image& )
  95    */
  96   Toolkit::ControlRenderer GetControlRenderer( const Image& image );
  97
  98   /**
  99    * @copydoc Toolkit::RendererFactory::ResetRenderer( Toolkit::ControlRenderer&, Actor& actor, const Image& )
 100    */
 101   void ResetRenderer( Toolkit::ControlRenderer& renderer, Actor& actor, const Image& image );
 102
 103   /**
 104    * @copydoc Toolkit::RenderFactory::GetControlRenderer( const std::string&, ImageDimensions )
 105    */
 106   Toolkit::ControlRenderer GetControlRenderer( const std::string& image, ImageDimensions size );
 107
 108   /**
 109    * @copydoc Toolkit::RendererFactory::ResetRenderer( Toolkit::ControlRenderer&, Actor& actor, const std::string&, ImageDimensions )
 110    */
 111   void ResetRenderer( Toolkit::ControlRenderer& renderer, Actor& actor, const std::string& image, ImageDimensions size );
 112
 113 public:
 114   /**
 115    * @brief Returns an image to be used when a renderer has failed to correctly render
 116    */
 117   static Image GetBrokenRendererImage();
 118
 119 protected:
 120
 121   /**
 122    * A reference counted object may only be deleted by calling Unreference()
 123    */
 124   virtual ~RendererFactory();
 125
 126 private:
 127
 128   /**
 129    * Get the renderer type from the property map.
 130    *
 131    * @param[in] propertyMap The map contains the properties of the control renderer
 132    * @return The rendererType
 133    */
 134   RendererType GetRendererType( const Property::Map& propertyMap );
 135
 136   /**
 137    * Prepare the atlas manager
 138    */
 139   void CreateAtlasManager();
 140
 141   /**
 142    * Undefined copy constructor.
 143    */
 144   RendererFactory(const RendererFactory&);
 145
 146   /**
 147    * Undefined assignment operator.
 148    */
 149   RendererFactory& operator=(const RendererFactory& rhs);
 150
 151 private:
 152
 153   RendererFactoryCachePtr mFactoryCache;
 154   ImageAtlasManagerPtr    mAtlasManager;
 155   bool                    mDebugEnabled;
 156 };
 157
 158 } // namespace Internal
 159
 160 inline const Internal::RendererFactory& GetImplementation(const Toolkit::RendererFactory& factory)
 161 {
 162   DALI_ASSERT_ALWAYS( factory && "RendererFactory handle is empty" );
 163
 164   const BaseObject& handle = factory.GetBaseObject();
 165
 166   return static_cast<const Internal::RendererFactory&>(handle);
 167 }
 168
 169 inline Internal::RendererFactory& GetImplementation(Toolkit::RendererFactory& factory)
 170 {
 171   DALI_ASSERT_ALWAYS( factory && "RendererFactory handle is empty" );
 172
 173   BaseObject& handle = factory.GetBaseObject();
 174
 175   return static_cast<Internal::RendererFactory&>(handle);
 176 }
 177
 178 } // namespace Toolkit
 179
 180 } // namespace Dali
 181
 182 #endif /* __DALI_TOOLKIT_RENDERER_FACTORY_IMPL_H__ */