CanvasRenderer: Change name DrawableGroup::Clear() to RemoveAllDrawables()
[platform/core/uifw/dali-adaptor.git] / dali / internal / canvas-renderer / common / drawable-group-impl.h
1 #ifndef DALI_INTERNAL_DRAWABLE_GROUP_IMPL_H
2 #define DALI_INTERNAL_DRAWABLE_GROUP_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 #include <vector>
24
25 // INTERNAL INCLUDES
26 #include <dali/devel-api/adaptor-framework/canvas-renderer-drawable-group.h>
27 #include <dali/internal/canvas-renderer/common/drawable-impl.h>
28
29 namespace Dali
30 {
31 namespace Internal
32 {
33 namespace Adaptor
34 {
35 /**
36  * Dali internal DrawableGroup.
37  */
38 class DrawableGroup : public Internal::Adaptor::Drawable
39 {
40 public:
41   /**
42    * @brief List of drawables.
43    */
44   using DrawableVector = std::vector<Dali::CanvasRenderer::Drawable>;
45
46   /**
47    * @brief Constructor
48    */
49   DrawableGroup();
50
51   /**
52    * @brief Destructor.
53    */
54   ~DrawableGroup() override;
55
56   /**
57    * @copydoc Dali::CanvasRenderer::DrawableGroup::AddDrawable()
58    */
59   virtual bool AddDrawable(Dali::CanvasRenderer::Drawable& drawable);
60
61   /**
62    * @copydoc Dali::CanvasRenderer::DrawableGroup::RemoveAllDrawables()
63    */
64   virtual bool RemoveAllDrawables();
65
66   /**
67    * @brief Get list of drawables that added this group.
68    * @return Returns list of drawables.
69    */
70   virtual DrawableVector GetDrawables() const;
71
72   DrawableGroup(const DrawableGroup&) = delete;
73   DrawableGroup& operator=(DrawableGroup&) = delete;
74   DrawableGroup(DrawableGroup&&)           = delete;
75   DrawableGroup& operator=(DrawableGroup&&) = delete;
76 };
77
78 } // namespace Adaptor
79
80 } // namespace Internal
81
82 inline static Internal::Adaptor::DrawableGroup& GetImplementation(Dali::CanvasRenderer::DrawableGroup& drawablegroup)
83 {
84   DALI_ASSERT_ALWAYS(drawablegroup && "DrawableGroup handle is empty.");
85
86   BaseObject& handle = drawablegroup.GetBaseObject();
87
88   return static_cast<Internal::Adaptor::DrawableGroup&>(handle);
89 }
90
91 inline static const Internal::Adaptor::DrawableGroup& GetImplementation(const Dali::CanvasRenderer::DrawableGroup& drawablegroup)
92 {
93   DALI_ASSERT_ALWAYS(drawablegroup && "DrawableGroup handle is empty.");
94
95   const BaseObject& handle = drawablegroup.GetBaseObject();
96
97   return static_cast<const Internal::Adaptor::DrawableGroup&>(handle);
98 }
99
100 } // namespace Dali
101
102 #endif // DALI_INTERNAL_DRAWABLE_GROUP_IMPL_H