1 /*
2  * Copyright (c) 2022 Huawei Device Co., Ltd.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 
16 #ifndef FOUNDATION_ACE_FRAMEWORKS_CORE_COMPONENTS_NG_PATTERN_SHAPE_PAINT_PROPERTY_H
17 #define FOUNDATION_ACE_FRAMEWORKS_CORE_COMPONENTS_NG_PATTERN_SHAPE_PAINT_PROPERTY_H
18 
19 #include <array>
20 #include <string>
21 #include "base/geometry/dimension.h"
22 #include "core/components/common/properties/color.h"
23 #include "core/components/common/properties/paint_state.h"
24 #include "core/components_ng/base/inspector_filter.h"
25 #include "core/components_ng/layout/layout_property.h"
26 #include "core/components_ng/property/property.h"
27 #include "core/components_ng/render/paint_property.h"
28 
29 namespace OHOS::Ace::NG {
30 
31 class ACE_EXPORT ShapePaintProperty : public PaintProperty {
32     DECLARE_ACE_TYPE(ShapePaintProperty, PaintProperty);
33 
34 public:
35     static constexpr double FILL_OPACITY_DEFAULT = 1.0f;
36     static constexpr double STROKE_MITERLIMIT_DEFAULT = 4.0f;
37     static constexpr double STROKE_MITERLIMIT_MIN = 1.0f;
38     static constexpr double STROKE_OPACITY_DEFAULT = 1.0f;
39     static constexpr Dimension STROKE_WIDTH_DEFAULT = 1.0_vp;
40     static constexpr bool ANTIALIAS_DEFAULT = true;
41     static constexpr int SQUARE_CAP = 2;
42     static constexpr int DEFAULT_LINE_JOIN=0;
43 
44     ShapePaintProperty() = default;
45     ~ShapePaintProperty() override = default;
Clone()46     RefPtr<PaintProperty> Clone() const override
47     {
48         auto value = MakeRefPtr<ShapePaintProperty>();
49         value->PaintProperty::UpdatePaintProperty(DynamicCast<PaintProperty>(this));
50         value->propFill_ = CloneFill();
51         value->propFillOpacity_ = CloneFillOpacity();
52         value->propStroke_ = CloneStroke();
53         value->propStrokeWidth_ = CloneStrokeWidth();
54         value->propStrokeOpacity_ = CloneStrokeOpacity();
55         value->propStrokeDashArray_ = CloneStrokeDashArray();
56         value->propStrokeDashOffset_ = CloneStrokeDashOffset();
57         value->propStrokeLineCap_ = CloneStrokeLineCap();
58         value->propStrokeLineJoin_ = CloneStrokeLineJoin();
59         value->propStrokeMiterLimit_ = CloneStrokeMiterLimit();
60         value->propAntiAlias_ = CloneAntiAlias();
61         return value;
62     }
63 
Reset()64     void Reset() override
65     {
66         PaintProperty::Reset();
67         ResetAntiAlias();
68         ResetFill();
69         ResetFillOpacity();
70         ResetStroke();
71         ResetStrokeWidth();
72         ResetStrokeDashArray();
73         ResetStrokeDashOffset();
74         ResetStrokeLineCap();
75         ResetStrokeLineJoin();
76         ResetStrokeMiterLimit();
77         ResetStrokeOpacity();
78     }
79 
ToJsonValue(std::unique_ptr<JsonValue> & json,const InspectorFilter & filter)80     void ToJsonValue(std::unique_ptr<JsonValue>& json, const InspectorFilter& filter) const override
81     {
82         PaintProperty::ToJsonValue(json, filter);
83         /* no fixed attr below, just return */
84         if (filter.IsFastFilter()) {
85             return;
86         }
87         json->PutExtAttr("stroke", propStroke_.value_or(Color::BLACK).ColorToString().c_str(), filter);
88         json->PutExtAttr("strokeWidth", propStrokeWidth_.value_or(Dimension()).ConvertToPx(), filter);
89         json->PutExtAttr("strokeOpacity",
90             std::to_string(propStrokeOpacity_.value_or(STROKE_OPACITY_DEFAULT)).c_str(), filter);
91         json->PutExtAttr("strokeDashOffset",
92             propStrokeDashOffset_.value_or(Dimension()).ToString().c_str(), filter);
93 
94         auto jsonDashArray = JsonUtil::CreateArray(true);
95         std::vector<Dimension> array = propStrokeDashArray_.value_or(std::vector<Dimension>());
96         for (size_t i = 0; i < array.size(); i++) {
97             auto index = std::to_string(i);
98             auto value = array[i].ToString();
99             jsonDashArray->Put(index.c_str(), value.c_str());
100         }
101         json->PutExtAttr("strokeDashArray", jsonDashArray, filter);
102 
103         std::array<std::string, 3> lineCap = { "LineCapStyle.Butt", "LineCapStyle.Round", "LineCapStyle.Square" };
104         json->PutExtAttr("strokeLineCap", lineCap.at(propStrokeLineCap_.value_or(0) % 3).c_str(), filter);
105         std::array<std::string, 3> lineJoin = { "LineJoinStyle.Miter", "LineJoinStyle.Round", "LineJoinStyle.Bevel" };
106         json->PutExtAttr("strokeLineJoin", lineJoin.at(propStrokeLineJoin_.value_or(0) % 3).c_str(), filter);
107         json->PutExtAttr("strokeMiterLimit",
108             std::to_string(propStrokeMiterLimit_.value_or(STROKE_MITERLIMIT_DEFAULT)).c_str(), filter);
109         json->PutExtAttr("fill", propFill_.value_or(Color::BLACK).ColorToString().c_str(), filter);
110         json->PutExtAttr("fillOpacity",
111             std::to_string(propFillOpacity_.value_or(FILL_OPACITY_DEFAULT)).c_str(), filter);
112         json->PutExtAttr("antiAlias", propAntiAlias_.value_or(ANTIALIAS_DEFAULT) ? "true" : "false", filter);
113     }
114 
115     void UpdateShapeProperty(const RefPtr<ShapePaintProperty>& target);
116 
117     ACE_DEFINE_PROPERTY_ITEM_WITHOUT_GROUP(Fill, Color, PROPERTY_UPDATE_RENDER);
118     ACE_DEFINE_PROPERTY_ITEM_WITHOUT_GROUP(FillOpacity, double, PROPERTY_UPDATE_RENDER);
119     ACE_DEFINE_PROPERTY_ITEM_WITHOUT_GROUP(Stroke, Color, PROPERTY_UPDATE_RENDER);
120     ACE_DEFINE_PROPERTY_ITEM_WITHOUT_GROUP(StrokeDashArray, std::vector<Ace::Dimension>, PROPERTY_UPDATE_RENDER);
121     ACE_DEFINE_PROPERTY_ITEM_WITHOUT_GROUP(StrokeDashOffset, Dimension, PROPERTY_UPDATE_RENDER);
122     ACE_DEFINE_PROPERTY_ITEM_WITHOUT_GROUP(StrokeLineCap, int, PROPERTY_UPDATE_RENDER);
123     ACE_DEFINE_PROPERTY_ITEM_WITHOUT_GROUP(StrokeLineJoin, int, PROPERTY_UPDATE_RENDER);
124     ACE_DEFINE_PROPERTY_ITEM_WITHOUT_GROUP(StrokeMiterLimit, double, PROPERTY_UPDATE_RENDER);
125     ACE_DEFINE_PROPERTY_ITEM_WITHOUT_GROUP(StrokeOpacity, double, PROPERTY_UPDATE_RENDER);
126     ACE_DEFINE_PROPERTY_ITEM_WITHOUT_GROUP(StrokeWidth, Ace::Dimension, PROPERTY_UPDATE_RENDER);
127     ACE_DEFINE_PROPERTY_ITEM_WITHOUT_GROUP(AntiAlias, bool, PROPERTY_UPDATE_RENDER);
128 
129 private:
130     ACE_DISALLOW_COPY_AND_MOVE(ShapePaintProperty);
131 };
132 } // namespace OHOS::Ace::NG
133 #endif // FOUNDATION_ACE_FRAMEWORKS_CORE_COMPONENTS_NG_PATTERN_SHAPE_PAINT_PROPERTY_H
134