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

   1 #ifndef DALI_TOOLKIT_INTERNAL_GRADIENT_H
   2 #define DALI_TOOLKIT_INTERNAL_GRADIENT_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/dali-vector.h>
  23 #include <dali/public-api/images/buffer-image.h>
  24 #include <dali/public-api/math/matrix3.h>
  25 #include <dali/public-api/object/ref-object.h>
  26 #include <dali/public-api/rendering/texture.h>
  27
  28 // INTERNAL INCLUDES
  29 #include <dali-toolkit/public-api/visuals/gradient-visual-properties.h>
  30
  31 namespace Dali
  32 {
  33
  34 class Vector4;
  35
  36 namespace Toolkit
  37 {
  38
  39 namespace Internal
  40 {
  41
  42 /**
  43  * Gradients consist of continuously smooth color transitions along a vector from one color to another,
  44  * possibly followed by additional transitions along the same vector to other colors.
  45  */
  46 class Gradient : public RefObject
  47 {
  48 public:
  49
  50   /**
  51    * The stop node tells the gradient what color it should be at certain position.
  52    */
  53   struct GradientStop
  54   {
  55     GradientStop( float offset, const Vector4& color )
  56     : mOffset( offset ), mStopColor( color )
  57     {}
  58
  59     bool operator<(const GradientStop& rhs) const
  60     {
  61       return mOffset < rhs.mOffset;
  62     }
  63
  64     float   mOffset;     // A value ranging from 0 to 1 to indicate where the gradient stop is placed.
  65     Vector4 mStopColor;  // The color to use at this gradient stop
  66   };
  67
  68 public:
  69
  70   /**
  71    * Add a gradient stop.
  72    *
  73    * @param[in] offset The position to place the stop.
  74    * @param[in] color  The color to use at this stop.
  75    */
  76   void AddStop(float offset, const Vector4& color);
  77
  78   /**
  79    * Get the gradient stops.
  80    * @return The vector of gradient stops.
  81    */
  82   const Vector<GradientStop>& GetStops();
  83
  84   /**
  85    * Set the coordinate system used by the gradient attributes.
  86    * @param[in] gradientUnits The the attributes are defined using the current user coordinate system or the bounding box of the shape.
  87    */
  88   void SetGradientUnits( Toolkit::GradientVisual::Units::Type gradientUnits );
  89
  90   /**
  91    * Get the coordinate system used by the gradient attributes.
  92    * @return USER_SPACE_ON_USE or OBJECT_BOUNDING_BOX
  93    */
  94   Toolkit::GradientVisual::Units::Type GetGradientUnits() const;
  95
  96   /**
  97    * Indicates what happens if the gradient starts or ends inside the bounds of the target rectangle.
  98    * If not specified, the effect is as if a value of 'pad' were specified
  99    *
 100    * @param[in] spread The method to fill the remainder of target region which is outside the gradient bounds
 101    */
 102   void SetSpreadMethod( Toolkit::GradientVisual::SpreadMethod::Type spread );
 103
 104   /**
 105    * Get the filling method for the the remainder of target region which is outside the gradient boun.
 106    * @return PAD, REFLECT or REPEAT
 107    */
 108   Toolkit::GradientVisual::SpreadMethod::Type GetSpreadMethod() const;
 109
 110   /**
 111    * Get the transformation matrix to align the vertices with the gradient line/circle
 112    * @ return the aligning transformation matrix
 113    */
 114   const Matrix3& GetAlignmentTransform() const;
 115
 116   /**
 117    * Generate the lookup texture with the gradient stops.
 118    * @return The lookup texture which transit smoothly between stops.
 119    */
 120   Dali::Texture GenerateLookupTexture();
 121
 122 private:
 123
 124   /**
 125    * Estimate the resolution of the lookup texture.
 126    * Note: Only call this function after the gradient stops are sorted in order.
 127    */
 128   unsigned int EstimateTextureResolution();
 129
 130 protected:
 131
 132   /**
 133    * Construct a new Gradient object
 134    * Called in the constructor of subclasses
 135    */
 136   Gradient();
 137
 138   /**
 139    * @brief A reference counted object may only be deleted by calling Unreference().
 140    */
 141   virtual ~Gradient();
 142
 143   // Undefined
 144   Gradient( const Gradient& gradient );
 145
 146   // Undefined
 147   Gradient& operator=( const Gradient& handle );
 148
 149 protected:
 150
 151   Vector<GradientStop>                        mGradientStops;
 152   Matrix3                                     mAlignmentTransform;
 153   Toolkit::GradientVisual::Units::Type        mGradientUnits;
 154   Toolkit::GradientVisual::SpreadMethod::Type mSpreadMethod;
 155
 156 };
 157
 158 } // namespace Internal
 159
 160 } // namespace Toolkit
 161
 162 } // namespace Dali
 163
 164 #endif // DALI_TOOLKIT_INTERNAL_GRADIENT_RENDERER_H