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

   1 #ifndef DALI_TOOLKIT_INTERNAL_GRADIENT_VISUAL_H
   2 #define DALI_TOOLKIT_INTERNAL_GRADIENT_VISUAL_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
  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 #include <dali-toolkit/internal/visuals/gradient/gradient.h>
  27
  28 namespace Dali
  29 {
  30 class Vector2;
  31
  32 namespace Toolkit
  33 {
  34
  35 namespace Internal
  36 {
  37
  38 class Gradient;
  39 class GradientVisual;
  40 typedef IntrusivePtr< GradientVisual > GradientVisualPtr;
  41
  42 /**
  43  * The visual which renders smooth transition of colors to the control's quad.
  44  * It supports two types of gradients: linear and radial.
  45  *
  46  * The following properties are essential for create a LINEAR GradientRender
  47  *
  48  * | %Property Name          | Type             |
  49  * |-------------------------|------------------|
  50  * | startPosition           | VECTOR2          |
  51  * | endPosition             | VECTOR2          |
  52  * | stopColor               | ARRAY of VECTOR4 |
  53  *
  54  * The following properties are essential for create a RADIAL GradientRender
  55  *
  56  * | %Property Name          | Type             |
  57  * |-------------------------|------------------|
  58  * | center                  | VECTOR2          |
  59  * | radius                  | FLOAT            |
  60  * | stopColor               | ARRAY of VECTOR4 |
  61  *
  62  * The following properties are optional for both LINEAR and RADIAL GradientRender.
  63  *
  64  * | %Property Name          | Type             |
  65  * |-------------------------|------------------|
  66  * | stopOffset              | ARRAY of FLOAT   |
  67  * | units                   | STRING           |
  68  * | spreadMethod            | STRING           |
  69  *
  70  * Valid values for units are 'userSpace' and 'objectBoundingBox'.
  71  * Valid values for spreadMethod are 'pad', 'repeat' and 'reflect.'
  72  * If not provided, 'objectBoundingBox' is used as default gradient units, and 'pad' is used as default spread method.
  73  */
  74 class GradientVisual: public Visual::Base
  75 {
  76 public:
  77
  78   /**
  79    * Types of the gradient
  80    */
  81   enum Type
  82   {
  83     LINEAR,
  84     RADIAL
  85   };
  86
  87   /**
  88    * @brief Create a new gradient visual.
  89    *
  90    * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
  91    * @return A smart-pointer to the newly allocated visual.
  92    */
  93   static GradientVisualPtr New( VisualFactoryCache& factoryCache );
  94
  95 public:  // from Visual
  96
  97   /**
  98    * @copydoc Visual::Base::SetSize
  99    */
 100   virtual void SetSize( const Vector2& size );
 101
 102   /**
 103    * @copydoc Visual::Base::CreatePropertyMap
 104    */
 105   virtual void DoCreatePropertyMap( Property::Map& map ) const;
 106
 107   /**
 108    * @copydoc Visual::Base::DoSetProperty
 109    */
 110   virtual void DoSetProperty( Dali::Property::Index index, const Dali::Property::Value& propertyValue );
 111
 112   /**
 113    * @copydoc Visual::Base::DoGetProperty
 114    */
 115   virtual Dali::Property::Value DoGetProperty( Dali::Property::Index index );
 116
 117 protected:
 118
 119   /**
 120    * @brief Constructor.
 121    *
 122    * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
 123    */
 124   GradientVisual( VisualFactoryCache& factoryCache );
 125
 126   /**
 127    * @brief A reference counted object may only be deleted by calling Unreference().
 128    */
 129   virtual ~GradientVisual();
 130
 131   /**
 132    * @copydoc Visual::Base::DoSetProperties
 133    */
 134   virtual void DoSetProperties( const Property::Map& propertyMap );
 135
 136   /**
 137    * @copydoc Visual::Base::DoSetOnStage
 138    */
 139   virtual void DoSetOnStage( Actor& actor );
 140
 141 private:
 142
 143   /**
 144    * @brief Initialize the renderer with the geometry and shader from the cache, if not available, create and save to the cache for sharing.
 145    */
 146   void InitializeRenderer();
 147
 148   /**
 149    * New a gradient object with the given property map.
 150    *
 151    * @return True if the property map provides valid properties to create a gradient. Otherwise, returns false.
 152    */
 153   bool NewGradient(Type gradientType, const Property::Map& propertyMap);
 154
 155   /**
 156    * Get the stop-offsets from the property.
 157    * The valid property type are ARRAY, VECTOR2, VECTOR3, VECTOR4.
 158    *
 159    * @param[in] value The property value of stop-offsets
 160    * @param[out] stopOffsets The vector contains the stop offset values.
 161    */
 162   static void GetStopOffsets(const Property::Value* value, Vector<float>& stopOffsets);
 163
 164   // Undefined
 165   GradientVisual( const GradientVisual& gradientVisual );
 166
 167   // Undefined
 168   GradientVisual& operator=( const GradientVisual& gradientVisual );
 169
 170 private:
 171
 172   Matrix3 mGradientTransform;
 173   IntrusivePtr<Gradient> mGradient;
 174   Type mGradientType;
 175 };
 176
 177 } // namespace Internal
 178
 179 } // namespace Toolkit
 180
 181 } // namespace Dali
 182
 183 #endif /* DALI_TOOLKIT_INTERNAL_GRADIENT_VISUAL_H */