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     UNDEFINED
  58   };
  59
  60   /**
  61    * @brief Constructor
  62    *
  63    * @param[in] debugEnabled If true, use debug renderer to replace all the concrete renderer.
  64    */
  65   RendererFactory( bool debugEnabled );
  66
  67   /**
  68    * @copydoc Toolkit::RenderFactory::GetControlRenderer( const Property::Map& )
  69    */
  70   Toolkit::ControlRenderer GetControlRenderer( const Property::Map& propertyMap );
  71
  72   /**
  73    * @copydoc Toolkit::RenderFactory::ResetRenderer( Toolkit::ControlRenderer& renderer, Actor& actor, const Property::Map& propertyMap )
  74    */
  75   void ResetRenderer( Toolkit::ControlRenderer& renderer, Actor& actor, const Property::Map& propertyMap );
  76
  77   /**
  78    * @copydoc Toolkit::RenderFactory::GetControlRenderer( const Vector4& )
  79    */
  80   Toolkit::ControlRenderer GetControlRenderer( const Vector4& color );
  81
  82   /**
  83    * @copydoc Toolkit::RendererFactory::ResetRenderer( Toolkit::ControlRenderer&, Actor& actor, const Vector4& )
  84    */
  85   void ResetRenderer( Toolkit::ControlRenderer& renderer, Actor& actor, const Vector4& color );
  86
  87   /**
  88    * @copydoc Toolkit::RenderFactory::GetControlRenderer( float, const Vector4&, bool )
  89    */
  90   Toolkit::ControlRenderer GetControlRenderer( float borderSize, const Vector4& borderColor, bool antiAliasing );
  91
  92   /**
  93    * @copydoc Toolkit::RenderFactory::GetControlRenderer( const Image& )
  94    */
  95   Toolkit::ControlRenderer GetControlRenderer( const Image& image );
  96
  97   /**
  98    * @copydoc Toolkit::RendererFactory::ResetRenderer( Toolkit::ControlRenderer&, Actor& actor, const Image& )
  99    */
 100   void ResetRenderer( Toolkit::ControlRenderer& renderer, Actor& actor, const Image& image );
 101
 102   /**
 103    * @copydoc Toolkit::RenderFactory::GetControlRenderer( const std::string&, ImageDimensions )
 104    */
 105   Toolkit::ControlRenderer GetControlRenderer( const std::string& image, ImageDimensions size );
 106
 107   /**
 108    * @copydoc Toolkit::RendererFactory::ResetRenderer( Toolkit::ControlRenderer&, Actor& actor, const std::string&, ImageDimensions )
 109    */
 110   void ResetRenderer( Toolkit::ControlRenderer& renderer, Actor& actor, const std::string& image, ImageDimensions size );
 111
 112 public:
 113   /**
 114    * @brief Returns an image to be used when a renderer has failed to correctly render
 115    */
 116   static Image GetBrokenRendererImage();
 117
 118 protected:
 119
 120   /**
 121    * A reference counted object may only be deleted by calling Unreference()
 122    */
 123   virtual ~RendererFactory();
 124
 125 private:
 126
 127   /**
 128    * Get the renderer type from the property map.
 129    *
 130    * @param[in] propertyMap The map contains the properties of the control renderer
 131    * @return The rendererType
 132    */
 133   RendererType GetRendererType( const Property::Map& propertyMap );
 134
 135   /**
 136    * Prepare the atlas manager
 137    */
 138   void CreateAtlasManager();
 139
 140   /**
 141    * Undefined copy constructor.
 142    */
 143   RendererFactory(const RendererFactory&);
 144
 145   /**
 146    * Undefined assignment operator.
 147    */
 148   RendererFactory& operator=(const RendererFactory& rhs);
 149
 150 private:
 151
 152   RendererFactoryCachePtr mFactoryCache;
 153   ImageAtlasManagerPtr    mAtlasManager;
 154   bool                    mDebugEnabled;
 155 };
 156
 157 } // namespace Internal
 158
 159 inline const Internal::RendererFactory& GetImplementation(const Toolkit::RendererFactory& factory)
 160 {
 161   DALI_ASSERT_ALWAYS( factory && "RendererFactory handle is empty" );
 162
 163   const BaseObject& handle = factory.GetBaseObject();
 164
 165   return static_cast<const Internal::RendererFactory&>(handle);
 166 }
 167
 168 inline Internal::RendererFactory& GetImplementation(Toolkit::RendererFactory& factory)
 169 {
 170   DALI_ASSERT_ALWAYS( factory && "RendererFactory handle is empty" );
 171
 172   BaseObject& handle = factory.GetBaseObject();
 173
 174   return static_cast<Internal::RendererFactory&>(handle);
 175 }
 176
 177 } // namespace Toolkit
 178
 179 } // namespace Dali
 180
 181 #endif /* __DALI_TOOLKIT_RENDERER_FACTORY_IMPL_H__ */