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

   1 #ifndef __DALI_TOOLKIT_INTERNAL_CONTROL_RENDERER_H__
   2 #define __DALI_TOOLKIT_INTERNAL_CONTROL_RENDERER_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
  21
  22 // EXTERNAL INCLUDES
  23 #include <dali/public-api/object/base-object.h>
  24
  25 #include <dali-toolkit/devel-api/controls/renderer-factory/renderer-factory.h>
  26 #include <dali-toolkit/devel-api/controls/renderer-factory/control-renderer.h>
  27
  28 namespace Dali
  29 {
  30
  31 namespace Toolkit
  32 {
  33
  34 namespace Internal
  35 {
  36
  37 class RendererFactoryCache;
  38
  39 /**
  40  * Base class for all Control rendering logic. A control may have multiple control renderers.
  41  *
  42  * Note: The control renderer responds to the the Actor::COLOR by blending it with the 'Multiply' operator.
  43  */
  44 class ControlRenderer : public BaseObject
  45 {
  46 public:
  47
  48   /**
  49    * Initialisation of the renderer, this API should only called by the RendererFactory:
  50    *  request the geometry and shader from the cache, if not available, create and save to the cache for sharing;
  51    *  record the property values.
  52    *
  53    * @param[in] factoryCache A pointer pointing to the RendererFactoryCache object
  54    * @param[in] propertyMap The properties for the requested ControlRenderer object.
  55    */
  56   virtual void Initialize( RendererFactoryCache& factoryCache, const Property::Map& propertyMap ) = 0;
  57
  58   /**
  59    * @copydoc Toolkit::ControlRenderer::SetSize
  60    */
  61   virtual void SetSize( const Vector2& size );
  62
  63   /**
  64    * ToDo: Add this function to Toolkit::ControlRenderer when it is fully implemented.
  65    *
  66    * Set the clip rectangular of this renderer.
  67    * The contents of the renderer will not be visible outside this rectangular.
  68    *
  69    * @param [in] clipRect The clipping rectangular.
  70    */
  71   virtual void SetClipRect( const Rect<int>& clipRect );
  72
  73   /**
  74    *ToDo: Add this function to Toolkit::ControlRenderer when it is fully implemented.
  75    *
  76    * Reposition this renderer with a 2D offset.
  77    *
  78    * @param[in] offset The offset to reposition the renderer.
  79    */
  80   virtual void SetOffset( const Vector2& offset );
  81
  82   /**
  83    * @copydoc Toolkit::ControlRenderer::SetDepthIndex
  84    */
  85   void SetDepthIndex( float index );
  86
  87   /**
  88    * @copydoc Toolkit::ControlRenderer::SetOnStage
  89    * @pre Impl->mGeometry must be created before this method is called
  90    */
  91   void SetOnStage( Actor& actor );
  92
  93   /**
  94    * @copydoc Toolkit::ControlRenderer::SetOffStage
  95    */
  96   void SetOffStage( Actor& actor );
  97
  98   /**
  99    * @copydoc Toolkit::ControlRenderer::CreatePropertyMap
 100    */
 101   virtual void CreatePropertyMap( Property::Map& map ) const = 0;
 102
 103 protected:
 104
 105   /**
 106    * @brief Constructor.
 107    */
 108   ControlRenderer();
 109
 110   /**
 111    * @brief A reference counted object may only be deleted by calling Unreference().
 112    */
 113   virtual ~ControlRenderer();
 114
 115 protected:
 116
 117   /**
 118    * Called by SetOnStage() allowing sub classes to respond to the SetOnStage event
 119    *
 120    * @param[in] actor The actor applying this renderer.
 121    */
 122   virtual void DoSetOnStage( Actor& actor );
 123
 124   /**
 125    * Called by SetOffStage() allowing sub classes to respond to the SetOffStage event
 126    *
 127    * @param[in] actor The actor applying this renderer.
 128    */
 129   virtual void DoSetOffStage( Actor& actor );
 130
 131 private:
 132
 133   // Undefined
 134   ControlRenderer( const ControlRenderer& renderer );
 135
 136   // Undefined
 137   ControlRenderer& operator=( const ControlRenderer& renderer );
 138
 139 protected:
 140
 141   struct Impl;
 142   Impl* mImpl;
 143 };
 144
 145 } // namespace Internal
 146
 147 inline const Internal::ControlRenderer& GetImplementation(const Toolkit::ControlRenderer& renderer)
 148 {
 149   DALI_ASSERT_ALWAYS( renderer && "ControlRenderer handle is empty" );
 150
 151   const BaseObject& handle = renderer.GetBaseObject();
 152
 153   return static_cast<const Internal::ControlRenderer&>(handle);
 154 }
 155
 156 inline Internal::ControlRenderer& GetImplementation(Toolkit::ControlRenderer& renderer)
 157 {
 158   DALI_ASSERT_ALWAYS( renderer && "ControlRenderer handle is empty" );
 159
 160   BaseObject& handle = renderer.GetBaseObject();
 161
 162   return static_cast<Internal::ControlRenderer&>(handle);
 163 }
 164
 165 } // namespace Toolkit
 166
 167 } // namespace Dali
 168
 169 #endif /* __DALI_TOOLKIT_INTERNAL_CONTROL_RENDERER_H___ */