dali/internal/canvas-renderer/common/gradient-impl.h

   1 #ifndef DALI_INTERNAL_GRADIENT_IMPL_H
   2 #define DALI_INTERNAL_GRADIENT_IMPL_H
   3
   4 /*
   5  * Copyright (c) 2022 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/object/base-object.h>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali/devel-api/adaptor-framework/canvas-renderer/canvas-renderer-gradient.h>
  26 #include <dali/devel-api/adaptor-framework/canvas-renderer/canvas-renderer.h>
  27
  28 namespace Dali
  29 {
  30 namespace Internal
  31 {
  32 namespace Adaptor
  33 {
  34 /**
  35  * Dali internal Gradient.
  36  */
  37 class Gradient : public Dali::BaseObject
  38 {
  39 public:
  40   /**
  41    * @brief Constructor
  42    */
  43   Gradient();
  44
  45   /**
  46    * @brief Destructor.
  47    */
  48   virtual ~Gradient() override;
  49
  50   /**
  51    * @brief Create factory item(implementation) object.
  52    */
  53   void Create();
  54
  55   /**
  56    * @copydoc Dali::CanvasRenderer::Gradient::SetColorStops()
  57    */
  58   virtual bool SetColorStops(Dali::CanvasRenderer::Gradient::ColorStops& colorStops);
  59
  60   /**
  61    * @copydoc Dali::CanvasRenderer::Gradient::GetColorStops()
  62    */
  63   virtual Dali::CanvasRenderer::Gradient::ColorStops GetColorStops() const;
  64
  65   /**
  66    * @copydoc Dali::CanvasRenderer::Gradient::SetSpread()
  67    */
  68   virtual bool SetSpread(Dali::CanvasRenderer::Gradient::Spread spread);
  69
  70   /**
  71    * @copydoc Dali::CanvasRenderer::Gradient::GetSpread()
  72    */
  73   virtual Dali::CanvasRenderer::Gradient::Spread GetSpread() const;
  74
  75   /**
  76    * @brief Set a gradient object
  77    * @param[in] object gradient object
  78    */
  79   virtual void SetObject(const void* object);
  80
  81   /**
  82    * @brief Returns a gradient object pointer.
  83    * @return Returns a gradient object pointer.
  84    */
  85   virtual void* GetObject() const;
  86
  87   /**
  88    * @brief Set a changed state.
  89    * @param[in] changed The state of changed.
  90    */
  91   virtual void SetChanged(bool changed);
  92
  93   /**
  94    * @brief Get a changed state.
  95    * @return Returns state of changed.
  96    */
  97   virtual bool GetChanged() const;
  98
  99   /**
 100    * @brief Returns a gradient's implements object pointer.
 101    * @return Returns a gradient's implements object pointer.
 102    */
 103   Dali::Internal::Adaptor::Gradient* GetImplementation();
 104
 105   Gradient(const Gradient&) = delete;
 106   Gradient& operator=(Gradient&) = delete;
 107   Gradient(Gradient&&)           = delete;
 108   Gradient& operator=(Gradient&&) = delete;
 109
 110 private:
 111   Dali::Internal::Adaptor::Gradient* mImpl = nullptr;
 112 };
 113
 114 } // namespace Adaptor
 115
 116 } // namespace Internal
 117
 118 inline static Internal::Adaptor::Gradient& GetImplementation(Dali::CanvasRenderer::Gradient& gradient)
 119 {
 120   DALI_ASSERT_ALWAYS(gradient && "Gradient handle is empty.");
 121
 122   BaseObject& handle = gradient.GetBaseObject();
 123
 124   return static_cast<Internal::Adaptor::Gradient&>(handle);
 125 }
 126
 127 inline static const Internal::Adaptor::Gradient& GetImplementation(const Dali::CanvasRenderer::Gradient& gradient)
 128 {
 129   DALI_ASSERT_ALWAYS(gradient && "Gradient handle is empty.");
 130
 131   const BaseObject& handle = gradient.GetBaseObject();
 132
 133   return static_cast<const Internal::Adaptor::Gradient&>(handle);
 134 }
 135
 136 } // namespace Dali
 137
 138 #endif // DALI_INTERNAL_GRADIENT_IMPL_H