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