Revert "CanvasRenderer: Add missing parentheses for @copydoc"
[platform/core/uifw/dali-adaptor.git] / dali / internal / canvas-renderer / common / shape-impl.h
1 #ifndef DALI_INTERNAL_SHAPE_IMPL_H
2 #define DALI_INTERNAL_SHAPE_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 #ifdef THORVG_SUPPORT
23 #include <thorvg.h>
24 #endif
25 #include <dali/public-api/object/base-object.h>
26 #include <dali/public-api/signals/connection-tracker.h>
27
28 // INTERNAL INCLUDES
29 #include <dali/devel-api/adaptor-framework/canvas-renderer-shape.h>
30 #include <dali/internal/canvas-renderer/common/drawable-impl.h>
31
32 namespace Dali
33 {
34 namespace Internal
35 {
36 namespace Adaptor
37 {
38 /**
39  * Dali internal Shape.
40  */
41 class Shape : public Internal::Adaptor::Drawable
42 {
43 public:
44   /**
45    * @brief Constructor
46    */
47   Shape();
48
49   /**
50    * @brief Destructor.
51    */
52   ~Shape() override;
53
54   /**
55    * @copydoc Dali::CanvasRenderer::Shape::AddRect
56    */
57   virtual bool AddRect(Rect<float> rect, Vector2 roundedCorner);
58
59   /**
60    * @copydoc Dali::CanvasRenderer::Shape::AddCircle
61    */
62   virtual bool AddCircle(Vector2 center, Vector2 radius);
63
64   /**
65    * @copydoc Dali::CanvasRenderer::Shape::AddArc
66    */
67   virtual bool AddArc(Vector2 center, float radius, float startAngle, float sweep, bool pie);
68
69   /**
70    * @copydoc Dali::CanvasRenderer::Shape::AddMoveTo
71    */
72   virtual bool AddMoveTo(Vector2 point);
73
74   /**
75    * @copydoc Dali::CanvasRenderer::Shape::AddLineTo
76    */
77   virtual bool AddLineTo(Vector2 line);
78
79   /**
80    * @copydoc Dali::CanvasRenderer::Shape::AddCubicTo
81    */
82   virtual bool AddCubicTo(Vector2 controlPoint1, Vector2 controlPoint2, Vector2 endPoint);
83
84   /**
85    * @copydoc Dali::CanvasRenderer::Shape::Close
86    */
87   virtual bool Close();
88
89   /**
90    * @copydoc Dali::CanvasRenderer::Shape::ResetPath
91    */
92   virtual bool ResetPath();
93
94   /**
95    * @copydoc Dali::CanvasRenderer::Shape::SetFillColor
96    */
97   virtual bool SetFillColor(Vector4 color);
98
99   /**
100    * @copydoc Dali::CanvasRenderer::Shape::GetFillColor
101    */
102   virtual Vector4 GetFillColor() const;
103
104   /**
105    * @copydoc Dali::CanvasRenderer::Shape::SetFillRule
106    */
107   virtual bool SetFillRule(Dali::CanvasRenderer::Shape::FillRule rule);
108
109   /**
110    * @copydoc Dali::CanvasRenderer::Shape::GetFillRule
111    */
112   virtual Dali::CanvasRenderer::Shape::FillRule GetFillRule() const;
113
114   /**
115    * @copydoc Dali::CanvasRenderer::Shape::SetStrokeWidth
116    */
117   virtual bool SetStrokeWidth(float width);
118
119   /**
120    * @copydoc Dali::CanvasRenderer::Shape::GetStrokeWidth
121    */
122   virtual float GetStrokeWidth() const;
123
124   /**
125    * @copydoc Dali::CanvasRenderer::Shape::SetStrokeColor
126    */
127   virtual bool SetStrokeColor(Vector4 color);
128
129   /**
130    * @copydoc Dali::CanvasRenderer::Shape::GetStrokeColor
131    */
132   virtual Vector4 GetStrokeColor() const;
133
134   /**
135    * @copydoc Dali::CanvasRenderer::Shape::SetStrokeDash
136    */
137   virtual bool SetStrokeDash(const Dali::Vector<float> dashPattern);
138
139   /**
140    * @copydoc Dali::CanvasRenderer::Shape::GetStrokeDash
141    */
142   virtual Dali::Vector<float> GetStrokeDash() const;
143
144   /**
145    * @copydoc Dali::CanvasRenderer::Shape::SetStrokeCap
146    */
147   virtual bool SetStrokeCap(Dali::CanvasRenderer::Shape::StrokeCap cap);
148
149   /**
150    * @copydoc Dali::CanvasRenderer::Shape::GetStrokeCap
151    */
152   virtual Dali::CanvasRenderer::Shape::StrokeCap GetStrokeCap() const;
153
154   /**
155    * @copydoc Dali::CanvasRenderer::Shape::SetStrokeJoin
156    */
157   virtual bool SetStrokeJoin(Dali::CanvasRenderer::Shape::StrokeJoin join);
158
159   /**
160    * @copydoc Dali::CanvasRenderer::Shape::GetStrokeJoin
161    */
162   virtual Dali::CanvasRenderer::Shape::StrokeJoin GetStrokeJoin() const;
163
164   Shape(const Shape&) = delete;
165   Shape& operator=(Shape&) = delete;
166   Shape(Shape&&)           = delete;
167   Shape& operator=(Shape&&) = delete;
168 };
169
170 } // namespace Adaptor
171
172 } // namespace Internal
173
174 inline static Internal::Adaptor::Shape& GetImplementation(Dali::CanvasRenderer::Shape& shape)
175 {
176   DALI_ASSERT_ALWAYS(shape && "Shape handle is empty.");
177
178   BaseObject& handle = shape.GetBaseObject();
179
180   return static_cast<Internal::Adaptor::Shape&>(handle);
181 }
182
183 inline static const Internal::Adaptor::Shape& GetImplementation(const Dali::CanvasRenderer::Shape& shape)
184 {
185   DALI_ASSERT_ALWAYS(shape && "Shape handle is empty.");
186
187   const BaseObject& handle = shape.GetBaseObject();
188
189   return static_cast<const Internal::Adaptor::Shape&>(handle);
190 }
191
192 } // namespace Dali
193
194 #endif // DALI_INTERNAL_SHAPE_IMPL_H