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