dali-toolkit/internal/controls/renderers/border/border-renderer.h

   1 #ifndef __DALI_TOOLKIT_INTERNAL_BORDER_RENDERER_H__
   2 #define __DALI_TOOLKIT_INTERNAL_BORDER_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 // EXTERNAL INCLUDES
  21 #include <dali/devel-api/rendering/geometry.h>
  22
  23 // INTERNAL INCLUDES
  24 #include <dali-toolkit/internal/controls/renderers/control-renderer-impl.h>
  25
  26 namespace Dali
  27 {
  28
  29 namespace Toolkit
  30 {
  31
  32 namespace Internal
  33 {
  34
  35 /**
  36  * The renderer which renders a solid color to the control's quad border fixed to a specified size.
  37  *
  38  * The following properties are required for create a BorderRender
  39  *
  40  * | %Property Name   | Type        |
  41  * |------------------|-------------|
  42  * | border-color     | VECTOR4     |
  43  * | border-size      | FLOAT       |
  44  */
  45
  46 class BorderRenderer : public ControlRenderer
  47 {
  48 public:
  49
  50   /**
  51    * @brief Constructor.
  52    */
  53   BorderRenderer();
  54
  55   /**
  56    * @brief A reference counted object may only be deleted by calling Unreference().
  57    */
  58   virtual ~BorderRenderer();
  59
  60 public:  // from ControlRenderer
  61
  62   /**
  63    * @copydoc ControlRenderer::Initialize
  64    */
  65   virtual void Initialize( RendererFactoryCache& factoryCache, const Property::Map& propertyMap );
  66
  67   /**
  68    * @copydoc ControlRenderer::SetClipRect
  69    */
  70   virtual void SetClipRect( const Rect<int>& clipRect );
  71
  72 protected:
  73   /**
  74    * @copydoc ControlRenderer::DoSetOnStage
  75    */
  76   virtual void DoSetOnStage( Actor& actor );
  77
  78   /**
  79    * @copydoc ControlRenderer::CreatePropertyMap
  80    */
  81   virtual void CreatePropertyMap( Property::Map& map ) const;
  82
  83 public:
  84
  85   /**
  86    * Request the geometry and shader from the cache, if not available, create and save to the cache for sharing.
  87    *
  88    * @param[in] factoryCache A pointer pointing to the RendererFactoryCache object
  89    */
  90   void Initialize( RendererFactoryCache& factoryCache );
  91
  92   /**
  93    * Set the color of the border.
  94    * @param[in] color The border color.
  95    */
  96   void SetBorderColor( const Vector4& color);
  97
  98   /**
  99    * Set the size of the border.
 100    * @param[in] size The border size.
 101    */
 102   void SetBorderSize( float size );
 103
 104 private:
 105
 106   /**
 107    * Create the geometry which presents the border.
 108    * @return The border geometry
 109    */
 110   Geometry CreateBorderGeometry();
 111
 112   // Undefined
 113   BorderRenderer( const BorderRenderer& borderRenderer );
 114
 115   // Undefined
 116   BorderRenderer& operator=( const BorderRenderer& borderRenderer );
 117
 118 private:
 119
 120   Vector4 mBorderColor;
 121   float   mBorderSize;
 122
 123   Property::Index mBorderColorIndex;
 124   Property::Index mBorderSizeIndex;
 125 };
 126
 127 } // namespace Internal
 128
 129 } // namespace Toolkit
 130
 131 } // namespace Dali
 132
 133 #endif /* __DALI_TOOLKIT_INTERNAL_BORDER_RENDERER_H__ */