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