dali-toolkit/internal/visuals/color/color-visual.h

   1 #ifndef DALI_TOOLKIT_INTERNAL_COLOR_VISUAL_H
   2 #define DALI_TOOLKIT_INTERNAL_COLOR_VISUAL_H
   3
   4 /*
   5  * Copyright (c) 2017 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 // EXTERNAL INCLUDES
  22 #include <dali/public-api/common/intrusive-ptr.h>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
  26
  27 namespace Dali
  28 {
  29
  30 namespace Toolkit
  31 {
  32
  33 namespace Internal
  34 {
  35
  36 class ColorVisual;
  37 typedef IntrusivePtr< ColorVisual > ColorVisualPtr;
  38
  39 /**
  40  * The visual which renders a solid color to the control's quad
  41  *
  42  * The following properties are required for create a ColorRender
  43  *
  44  * | %Property Name  | Type        |
  45  * |-----------------|-------------|
  46  * | mixColor        | VECTOR4     |
  47  */
  48 class ColorVisual: public Visual::Base
  49 {
  50 public:
  51
  52   /**
  53    * @brief Create a new color visual.
  54    *
  55    * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
  56    * @param[in] properties A Property::Map containing settings for this visual
  57    * @return A smart-pointer to the newly allocated visual.
  58    */
  59   static ColorVisualPtr New( VisualFactoryCache& factoryCache, const Property::Map& properties );
  60
  61 public:  // from Visual
  62
  63   /**
  64    * @copydoc Visual::Base::CreatePropertyMap
  65    */
  66   virtual void DoCreatePropertyMap( Property::Map& map ) const;
  67
  68   /**
  69    * @copydoc Visual::Base::CreateInstancePropertyMap
  70    */
  71   virtual void DoCreateInstancePropertyMap( Property::Map& map ) const;
  72
  73 protected:
  74
  75   /**
  76    * @brief Constructor.
  77    *
  78    * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
  79    */
  80   ColorVisual( VisualFactoryCache& factoryCache );
  81
  82   /**
  83    * @brief A reference counted object may only be deleted by calling Unreference().
  84    */
  85   virtual ~ColorVisual();
  86
  87   /**
  88    * @copydoc Visual::Base::DoSetProperties
  89    */
  90   virtual void DoSetProperties( const Property::Map& propertyMap );
  91
  92   /**
  93    * @copydoc Visual::Base::DoSetOnStage
  94    */
  95   virtual void DoSetOnStage( Actor& actor );
  96
  97   /**
  98    * @copydoc Visual::Base::OnSetTransform
  99    */
 100   virtual void OnSetTransform();
 101
 102 private:
 103   /**
 104    * @brief Initialize the renderer with the geometry and shader from the cache, if not available, create and save to the cache for sharing.
 105    */
 106   void InitializeRenderer();
 107
 108 private:
 109
 110   // Undefined
 111   ColorVisual( const ColorVisual& colorRenderer );
 112
 113   // Undefined
 114   ColorVisual& operator=( const ColorVisual& colorRenderer );
 115
 116 private:
 117
 118   bool mRenderIfTransparent; ///< Whether we should render even if the mix-color is transparent.
 119 };
 120
 121 } // namespace Internal
 122
 123 } // namespace Toolkit
 124
 125 } // namespace Dali
 126
 127 #endif /* DALI_TOOLKIT_INTERNAL_COLOR_VISUAL_H */