CanvasRenderer: Add RemoveAllDrawables() API
[platform/core/uifw/dali-adaptor.git] / dali / internal / canvas-renderer / common / canvas-renderer-impl.h
1 #ifndef DALI_INTERNAL_CANVAS_RENDERER_IMPL_H
2 #define DALI_INTERNAL_CANVAS_RENDERER_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 #include <dali/devel-api/adaptor-framework/pixel-buffer.h>
28
29 namespace Dali
30 {
31 namespace Internal
32 {
33 namespace Adaptor
34 {
35 /**
36  * Dali internal CanvasRenderer.
37  */
38 class CanvasRenderer : public Dali::BaseObject
39 {
40 public:
41   /**
42    * @brief Constructor
43    */
44   CanvasRenderer();
45
46   /**
47    * @brief Destructor.
48    */
49   ~CanvasRenderer() override;
50
51   /**
52    * @copydoc Dali::CanvasRenderer::Commit()
53    */
54   virtual bool Commit();
55
56   /**
57    * @copydoc Dali::CanvasRenderer::GetPixelBuffer()
58    */
59   virtual Devel::PixelBuffer GetPixelBuffer();
60
61   /**
62    * @copydoc Dali::CanvasRenderer::AddDrawable()
63    */
64   virtual bool AddDrawable(Dali::CanvasRenderer::Drawable& drawable);
65
66   /**
67    * @copydoc Dali::CanvasRenderer::IsCanvasChanged()
68    */
69   virtual bool IsCanvasChanged() const;
70
71   /**
72    * @copydoc Dali::CanvasRenderer::Rasterize()
73    */
74   virtual bool Rasterize();
75
76   /**
77    * @copydoc Dali::CanvasRenderer::RemoveDrawable()
78    */
79   virtual bool RemoveDrawable(Dali::CanvasRenderer::Drawable& drawable);
80
81   /**
82    * @copydoc Dali::CanvasRenderer::RemoveAllDrawables()
83    */
84   virtual bool RemoveAllDrawables();
85
86   /**
87    * @copydoc Dali::CanvasRenderer::SetSize()
88    */
89   virtual bool SetSize(const Vector2& size);
90
91   /**
92    * @copydoc Dali::CanvasRenderer::GetSize()
93    */
94   virtual const Vector2& GetSize();
95
96   /**
97    * @copydoc Dali::CanvasRenderer::SetViewBox()
98    */
99   virtual bool SetViewBox(const Vector2& viewBox);
100
101   /**
102    * @copydoc Dali::CanvasRenderer::GetViewBox()
103    */
104   virtual const Vector2& GetViewBox();
105
106   CanvasRenderer(const CanvasRenderer&) = delete;
107   CanvasRenderer& operator=(CanvasRenderer&) = delete;
108   CanvasRenderer(CanvasRenderer&&)           = delete;
109   CanvasRenderer& operator=(CanvasRenderer&&) = delete;
110 };
111
112 } // namespace Adaptor
113
114 } // namespace Internal
115
116 inline static Internal::Adaptor::CanvasRenderer& GetImplementation(Dali::CanvasRenderer& renderer)
117 {
118   DALI_ASSERT_ALWAYS(renderer && "CanvasRenderer handle is empty.");
119
120   BaseObject& handle = renderer.GetBaseObject();
121
122   return static_cast<Internal::Adaptor::CanvasRenderer&>(handle);
123 }
124
125 inline static const Internal::Adaptor::CanvasRenderer& GetImplementation(const Dali::CanvasRenderer& renderer)
126 {
127   DALI_ASSERT_ALWAYS(renderer && "CanvasRenderer handle is empty.");
128
129   const BaseObject& handle = renderer.GetBaseObject();
130
131   return static_cast<const Internal::Adaptor::CanvasRenderer&>(handle);
132 }
133
134 } // namespace Dali
135
136 #endif // DALI_INTERNAL_CANVAS_RENDERER_IMPL_H