dali-toolkit/internal/visuals/visual-factory-impl.h

   1 #ifndef DALI_TOOLKIT_VISUAL_FACTORY_IMPL_H
   2 #define DALI_TOOLKIT_VISUAL_FACTORY_IMPL_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 // EXTERNAL INCLUDES
  21 #include <dali/public-api/object/base-object.h>
  22
  23 // INTERNAL INCLUDES
  24 #include <dali-toolkit/devel-api/visual-factory/visual-factory.h>
  25 #include <dali-toolkit/devel-api/visual-factory/visual-base.h>
  26 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
  27
  28 namespace Dali
  29 {
  30
  31 namespace Toolkit
  32 {
  33
  34 namespace Internal
  35 {
  36
  37 class VisualFactoryCache;
  38 typedef IntrusivePtr<VisualFactoryCache> VisualFactoryCachePtr;
  39
  40 /**
  41  * @copydoc Toolkit::VisualFactory
  42  */
  43 class VisualFactory : public BaseObject
  44 {
  45 public:
  46
  47   /**
  48    * @brief Constructor
  49    *
  50    * @param[in] debugEnabled If true, use debug renderer to replace all the concrete renderer.
  51    */
  52   VisualFactory( bool debugEnabled );
  53
  54   /**
  55    * @copydoc Toolkit::RenderFactory::CreateVisual( const Property::Map& )
  56    */
  57   Toolkit::Visual::Base CreateVisual( const Property::Map& propertyMap );
  58
  59   /**
  60    * @copydoc Toolkit::RenderFactory::CreateVisual( const Image& )
  61    */
  62   Toolkit::Visual::Base CreateVisual( const Image& image );
  63
  64   /**
  65    * @copydoc Toolkit::RenderFactory::CreateVisual( const std::string&, ImageDimensions )
  66    */
  67   Toolkit::Visual::Base CreateVisual( const std::string& image, ImageDimensions size );
  68
  69 protected:
  70
  71   /**
  72    * A reference counted object may only be deleted by calling Unreference()
  73    */
  74   virtual ~VisualFactory();
  75
  76 private:
  77
  78   /**
  79    * Undefined copy constructor.
  80    */
  81   VisualFactory(const VisualFactory&);
  82
  83   /**
  84    * Undefined assignment operator.
  85    */
  86   VisualFactory& operator=(const VisualFactory& rhs);
  87
  88 private:
  89
  90   VisualFactoryCachePtr   mFactoryCache;
  91   bool                    mDebugEnabled;
  92 };
  93
  94 /**
  95  * @brief Template to allow discard old visual, get new one and set it on stage if possible
  96  *
  97  * @tparam ParameterType0 The type of first argument passed to the CreateVisual()
  98  * @tparam ParameterType1 The type of second argument passed to the CreateVisual()
  99  * @SINCE_1_0.39
 100  * @param[in] actor Actor for which the visual will be replaced
 101  * @param[in,out] visual The visual to be replaced
 102  * @param[in] param0 First template based argument passed to the visual factory
 103  * @param[in] param1 Second template based argument passed to the visual factory
 104  */
 105 template< class ParameterType0, class ParameterType1 >
 106 void InitializeVisual( Actor& actor, Toolkit::Visual::Base& visual, ParameterType0& param0, ParameterType1& param1 )
 107 {
 108   if( actor )
 109   {
 110     Toolkit::GetImplementation(visual).SetOffStage( actor );
 111   }
 112   visual = Toolkit::VisualFactory::Get().CreateVisual( param0, param1 );
 113   if( visual && actor && actor.OnStage() )
 114   {
 115     Toolkit::GetImplementation(visual).SetOnStage(actor);
 116   }
 117 }
 118
 119 /**
 120  * @brief Template to allow discard old visual, get new one and set it on stage if possible
 121  *
 122  * @tparam ParameterType The type of argument passed to the CreateVisual()
 123  * @SINCE_1_0.39
 124  * @param[in] actor Actor for which the visual will be replaced
 125  * @param[in,out] visual The visual to be replaced
 126  * @param[in] param Template based argument passed to the visual factory
 127  */
 128 template< class ParameterType >
 129 void InitializeVisual( Actor& actor, Toolkit::Visual::Base& visual, ParameterType& param )
 130 {
 131   if( actor && visual )
 132   {
 133     Toolkit::GetImplementation(visual).SetOffStage( actor );
 134   }
 135   visual =  Toolkit::VisualFactory::Get().CreateVisual( param );
 136   if( visual && actor && actor.OnStage() )
 137   {
 138     Toolkit::GetImplementation(visual).SetOnStage(actor);
 139   }
 140 }
 141
 142 } // namespace Internal
 143
 144 inline const Internal::VisualFactory& GetImplementation(const Toolkit::VisualFactory& factory)
 145 {
 146   DALI_ASSERT_ALWAYS( factory && "VisualFactory handle is empty" );
 147
 148   const BaseObject& handle = factory.GetBaseObject();
 149
 150   return static_cast<const Internal::VisualFactory&>(handle);
 151 }
 152
 153 inline Internal::VisualFactory& GetImplementation(Toolkit::VisualFactory& factory)
 154 {
 155   DALI_ASSERT_ALWAYS( factory && "VisualFactory handle is empty" );
 156
 157   BaseObject& handle = factory.GetBaseObject();
 158
 159   return static_cast<Internal::VisualFactory&>(handle);
 160 }
 161
 162 } // namespace Toolkit
 163
 164 } // namespace Dali
 165
 166 #endif /* DALI_TOOLKIT_VISUAL_FACTORY_IMPL_H */