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

   1 #ifndef DALI_INTERNAL_DRAWABLE_IMPL_H
   2 #define DALI_INTERNAL_DRAWABLE_IMPL_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/object/base-object.h>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali/devel-api/adaptor-framework/canvas-renderer-drawable.h>
  26 #include <dali/devel-api/adaptor-framework/canvas-renderer.h>
  27
  28 namespace Dali
  29 {
  30 namespace Internal
  31 {
  32 namespace Adaptor
  33 {
  34 /**
  35  * Dali internal Drawable.
  36  */
  37 class Drawable : public Dali::BaseObject
  38 {
  39 public:
  40   /**
  41    * @brief Enumeration for type of drawable.
  42    */
  43   enum class Types
  44   {
  45     NONE = 0,      ///< Means that type is not defined.
  46     SHAPE,         ///< Meaning of Shape class that inherits Drawable.
  47     DRAWABLE_GROUP ///< Meaning of DrawableGorup class that inherits Drawable.
  48   };
  49
  50 public:
  51   /**
  52    * @brief Constructor
  53    */
  54   Drawable();
  55
  56   /**
  57    * @brief Destructor.
  58    */
  59   virtual ~Drawable() override;
  60
  61   /**
  62    * @brief Create factory item(implementation) object.
  63    */
  64   void Create();
  65
  66   /**
  67    * @copydoc Dali::CanvasRenderer::Drawable::SetOpacity()
  68    */
  69   virtual bool SetOpacity(float opacity);
  70
  71   /**
  72    * @copydoc Dali::CanvasRenderer::Drawable::GetOpacity()
  73    */
  74   virtual float GetOpacity() const;
  75
  76   /**
  77    * @copydoc Dali::CanvasRenderer::Drawable::Rotate()
  78    */
  79   virtual bool Rotate(Degree degree);
  80
  81   /**
  82    * @copydoc Dali::CanvasRenderer::Drawable::Scale()
  83    */
  84   virtual bool Scale(float factor);
  85
  86   /**
  87    * @copydoc Dali::CanvasRenderer::Drawable::Translate()
  88    */
  89   virtual bool Translate(Vector2 translate);
  90
  91   /**
  92    * @copydoc Dali::CanvasRenderer::Drawable::Transform()
  93    */
  94   virtual bool Transform(const Dali::Matrix3& matrix);
  95
  96   /**
  97    * @copydoc Dali::CanvasRenderer::Drawable::GetBoundingBox
  98    */
  99   virtual Rect<float> GetBoundingBox() const;
 100
 101   /**
 102    * @brief Set whether this drawable object was added to other object(CanvasRenderer or DrawableGroup) or not.
 103    * @param[in] added Ture if added, false otherwise.
 104    */
 105   virtual void SetAdded(bool added);
 106
 107   /**
 108    * @brief Returns whether this drawable object was added to another object(CanvasRenderer or DrawableGroup).
 109    * @return Returns Ture if added, false otherwise.
 110    */
 111   virtual bool IsAdded() const;
 112
 113   /**
 114    * @brief Returns a drawable object pointer.
 115    * @return Returns a drawable object pointer.
 116    */
 117   virtual void* GetObject() const;
 118
 119   /**
 120    * @brief Set a drawable object
 121    * @param[in] object drawable object
 122    */
 123   virtual void SetObject(const void* object);
 124
 125   /**
 126    * @brief Set a changed state.
 127    * @param[in] changed The state of changed.
 128    */
 129   virtual void SetChanged(bool changed);
 130
 131   /**
 132    * @brief Get a changed state.
 133    * @return Returns state of changed.
 134    */
 135   virtual bool GetChanged() const;
 136
 137   /**
 138    * @brief Set drawable's type.
 139    * @param[in] type Type of drawable.
 140    */
 141   virtual void SetType(Types type);
 142
 143   /**
 144    * @brief Get drawable's type.
 145    * @return Returns type of drawable.
 146    */
 147   virtual Types GetType() const;
 148
 149   /**
 150    * @brief Returns a drawable's implements object pointer.
 151    * @return Returns a drawable's implements object pointer.
 152    */
 153   Dali::Internal::Adaptor::Drawable* GetImplementation();
 154
 155   Drawable(const Drawable&) = delete;
 156   Drawable& operator=(Drawable&) = delete;
 157   Drawable(Drawable&&)           = delete;
 158   Drawable& operator=(Drawable&&) = delete;
 159
 160 private:
 161   Dali::Internal::Adaptor::Drawable* mImpl = nullptr;
 162 };
 163
 164 } // namespace Adaptor
 165
 166 } // namespace Internal
 167
 168 inline static Internal::Adaptor::Drawable& GetImplementation(Dali::CanvasRenderer::Drawable& drawable)
 169 {
 170   DALI_ASSERT_ALWAYS(drawable && "Drawable handle is empty.");
 171
 172   BaseObject& handle = drawable.GetBaseObject();
 173
 174   return static_cast<Internal::Adaptor::Drawable&>(handle);
 175 }
 176
 177 inline static const Internal::Adaptor::Drawable& GetImplementation(const Dali::CanvasRenderer::Drawable& drawable)
 178 {
 179   DALI_ASSERT_ALWAYS(drawable && "Drawable handle is empty.");
 180
 181   const BaseObject& handle = drawable.GetBaseObject();
 182
 183   return static_cast<const Internal::Adaptor::Drawable&>(handle);
 184 }
 185
 186 } // namespace Dali
 187
 188 #endif // DALI_INTERNAL_DRAWABLE_IMPL_H