dali-toolkit/internal/controls/renderers/gradient/linear-gradient.h

   1 #ifndef __DALI_TOOLKIT_INTERNAL_LINEAR_GRADIENT_H__
   2 #define __DALI_TOOLKIT_INTERNAL_LINEAR_GRADIENT_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
  21 #include <dali-toolkit/internal/controls/renderers/gradient/gradient.h>
  22
  23 #include <dali/public-api/math/vector2.h>
  24
  25 namespace Dali
  26 {
  27
  28 namespace Toolkit
  29 {
  30
  31 namespace Internal
  32 {
  33
  34 /**
  35  * Linear gradients change color evenly along a straight line.
  36  * The gradient is defined by an axis (the gradient line) at any specified angles.
  37  */
  38 class LinearGradient : public Gradient
  39 {
  40 public:
  41
  42   /**
  43    * Constructor.
  44    * @param[in] startPosition The starting point onto which the 0% gradient stops are mapped.
  45    * @param[in] endPosition The ending point r onto which the 100% gradient stops are mapped.
  46    */
  47   LinearGradient( const Vector2& startPosition, const Vector2& endPosition );
  48
  49   /**
  50    * Destructor.
  51    */
  52   virtual ~LinearGradient();
  53
  54   /**
  55    * Set the starting and ending points of the vector onto which the gradient stops are mapped.
  56    * @param[in] startPosition The starting point of the gradient vector.
  57    * @param[in] endPosition The ending point of the gradient vector.
  58    */
  59   void SetStartAndEndPosition( const Vector2& startPosition, const Vector2& endPosition );
  60
  61   /**
  62    * Get the stating point of the gradient vector.
  63    * @return The stating point of the gradient vector.
  64    */
  65   const Vector2& GetStartPosition() const;
  66
  67   /**
  68    * Get the ending point of the gradient vector.
  69    * @return The ending point of the gradient vector.
  70    */
  71   const Vector2& GetEndPosition() const;
  72
  73 private:
  74
  75   Vector2 mStartPosition;
  76   Vector2 mEndPosition;
  77 };
  78
  79 } // namespace Internal
  80
  81 } // namespace Toolkit
  82
  83 } // namespace Dali
  84
  85 #endif /* __DALI_TOOLKIT_INTERNAL_LINEAR_GRADIENT_H__ */