summaryrefslogtreecommitdiff
path: root/include/mbgl/style/layers/symbol_layer.hpp
blob: ee0c91fd1409ef33e9c4a3147ac18cd12b426a78 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
// This file is generated. Do not edit.

#pragma once

#include <mbgl/style/layer.hpp>
#include <mbgl/style/filter.hpp>
#include <mbgl/style/property_value.hpp>
#include <mbgl/style/expression/formatted.hpp>
#include <mbgl/util/color.hpp>

#include <vector>

namespace mbgl {
namespace style {

class TransitionOptions;

class SymbolLayer : public Layer {
public:
    SymbolLayer(const std::string& layerID, const std::string& sourceID);
    ~SymbolLayer() final;

    // Dynamic properties
    optional<conversion::Error> setLayoutProperty(const std::string& name, const conversion::Convertible& value) final;
    optional<conversion::Error> setPaintProperty(const std::string& name, const conversion::Convertible& value) final;

    // Layout properties

    static PropertyValue<bool> getDefaultIconAllowOverlap();
    const PropertyValue<bool>& getIconAllowOverlap() const;
    void setIconAllowOverlap(const PropertyValue<bool>&);

    static PropertyValue<SymbolAnchorType> getDefaultIconAnchor();
    const PropertyValue<SymbolAnchorType>& getIconAnchor() const;
    void setIconAnchor(const PropertyValue<SymbolAnchorType>&);

    static PropertyValue<bool> getDefaultIconIgnorePlacement();
    const PropertyValue<bool>& getIconIgnorePlacement() const;
    void setIconIgnorePlacement(const PropertyValue<bool>&);

    static PropertyValue<std::string> getDefaultIconImage();
    const PropertyValue<std::string>& getIconImage() const;
    void setIconImage(const PropertyValue<std::string>&);

    static PropertyValue<bool> getDefaultIconKeepUpright();
    const PropertyValue<bool>& getIconKeepUpright() const;
    void setIconKeepUpright(const PropertyValue<bool>&);

    static PropertyValue<std::array<float, 2>> getDefaultIconOffset();
    const PropertyValue<std::array<float, 2>>& getIconOffset() const;
    void setIconOffset(const PropertyValue<std::array<float, 2>>&);

    static PropertyValue<bool> getDefaultIconOptional();
    const PropertyValue<bool>& getIconOptional() const;
    void setIconOptional(const PropertyValue<bool>&);

    static PropertyValue<float> getDefaultIconPadding();
    const PropertyValue<float>& getIconPadding() const;
    void setIconPadding(const PropertyValue<float>&);

    static PropertyValue<AlignmentType> getDefaultIconPitchAlignment();
    const PropertyValue<AlignmentType>& getIconPitchAlignment() const;
    void setIconPitchAlignment(const PropertyValue<AlignmentType>&);

    static PropertyValue<float> getDefaultIconRotate();
    const PropertyValue<float>& getIconRotate() const;
    void setIconRotate(const PropertyValue<float>&);

    static PropertyValue<AlignmentType> getDefaultIconRotationAlignment();
    const PropertyValue<AlignmentType>& getIconRotationAlignment() const;
    void setIconRotationAlignment(const PropertyValue<AlignmentType>&);

    static PropertyValue<float> getDefaultIconSize();
    const PropertyValue<float>& getIconSize() const;
    void setIconSize(const PropertyValue<float>&);

    static PropertyValue<IconTextFitType> getDefaultIconTextFit();
    const PropertyValue<IconTextFitType>& getIconTextFit() const;
    void setIconTextFit(const PropertyValue<IconTextFitType>&);

    static PropertyValue<std::array<float, 4>> getDefaultIconTextFitPadding();
    const PropertyValue<std::array<float, 4>>& getIconTextFitPadding() const;
    void setIconTextFitPadding(const PropertyValue<std::array<float, 4>>&);

    static PropertyValue<bool> getDefaultSymbolAvoidEdges();
    const PropertyValue<bool>& getSymbolAvoidEdges() const;
    void setSymbolAvoidEdges(const PropertyValue<bool>&);

    static PropertyValue<SymbolPlacementType> getDefaultSymbolPlacement();
    const PropertyValue<SymbolPlacementType>& getSymbolPlacement() const;
    void setSymbolPlacement(const PropertyValue<SymbolPlacementType>&);

    static PropertyValue<float> getDefaultSymbolSortKey();
    const PropertyValue<float>& getSymbolSortKey() const;
    void setSymbolSortKey(const PropertyValue<float>&);

    static PropertyValue<float> getDefaultSymbolSpacing();
    const PropertyValue<float>& getSymbolSpacing() const;
    void setSymbolSpacing(const PropertyValue<float>&);

    static PropertyValue<SymbolZOrderType> getDefaultSymbolZOrder();
    const PropertyValue<SymbolZOrderType>& getSymbolZOrder() const;
    void setSymbolZOrder(const PropertyValue<SymbolZOrderType>&);

    static PropertyValue<bool> getDefaultTextAllowOverlap();
    const PropertyValue<bool>& getTextAllowOverlap() const;
    void setTextAllowOverlap(const PropertyValue<bool>&);

    static PropertyValue<SymbolAnchorType> getDefaultTextAnchor();
    const PropertyValue<SymbolAnchorType>& getTextAnchor() const;
    void setTextAnchor(const PropertyValue<SymbolAnchorType>&);

    static PropertyValue<expression::Formatted> getDefaultTextField();
    const PropertyValue<expression::Formatted>& getTextField() const;
    void setTextField(const PropertyValue<expression::Formatted>&);

    static PropertyValue<std::vector<std::string>> getDefaultTextFont();
    const PropertyValue<std::vector<std::string>>& getTextFont() const;
    void setTextFont(const PropertyValue<std::vector<std::string>>&);

    static PropertyValue<bool> getDefaultTextIgnorePlacement();
    const PropertyValue<bool>& getTextIgnorePlacement() const;
    void setTextIgnorePlacement(const PropertyValue<bool>&);

    static PropertyValue<TextJustifyType> getDefaultTextJustify();
    const PropertyValue<TextJustifyType>& getTextJustify() const;
    void setTextJustify(const PropertyValue<TextJustifyType>&);

    static PropertyValue<bool> getDefaultTextKeepUpright();
    const PropertyValue<bool>& getTextKeepUpright() const;
    void setTextKeepUpright(const PropertyValue<bool>&);

    static PropertyValue<float> getDefaultTextLetterSpacing();
    const PropertyValue<float>& getTextLetterSpacing() const;
    void setTextLetterSpacing(const PropertyValue<float>&);

    static PropertyValue<float> getDefaultTextLineHeight();
    const PropertyValue<float>& getTextLineHeight() const;
    void setTextLineHeight(const PropertyValue<float>&);

    static PropertyValue<float> getDefaultTextMaxAngle();
    const PropertyValue<float>& getTextMaxAngle() const;
    void setTextMaxAngle(const PropertyValue<float>&);

    static PropertyValue<float> getDefaultTextMaxWidth();
    const PropertyValue<float>& getTextMaxWidth() const;
    void setTextMaxWidth(const PropertyValue<float>&);

    static PropertyValue<std::array<float, 2>> getDefaultTextOffset();
    const PropertyValue<std::array<float, 2>>& getTextOffset() const;
    void setTextOffset(const PropertyValue<std::array<float, 2>>&);

    static PropertyValue<bool> getDefaultTextOptional();
    const PropertyValue<bool>& getTextOptional() const;
    void setTextOptional(const PropertyValue<bool>&);

    static PropertyValue<float> getDefaultTextPadding();
    const PropertyValue<float>& getTextPadding() const;
    void setTextPadding(const PropertyValue<float>&);

    static PropertyValue<AlignmentType> getDefaultTextPitchAlignment();
    const PropertyValue<AlignmentType>& getTextPitchAlignment() const;
    void setTextPitchAlignment(const PropertyValue<AlignmentType>&);

    static PropertyValue<RadialOffsetType> getDefaultTextRadialOffset();
    const PropertyValue<RadialOffsetType>& getTextRadialOffset() const;
    void setTextRadialOffset(const PropertyValue<RadialOffsetType>&);

    static PropertyValue<float> getDefaultTextRotate();
    const PropertyValue<float>& getTextRotate() const;
    void setTextRotate(const PropertyValue<float>&);

    static PropertyValue<AlignmentType> getDefaultTextRotationAlignment();
    const PropertyValue<AlignmentType>& getTextRotationAlignment() const;
    void setTextRotationAlignment(const PropertyValue<AlignmentType>&);

    static PropertyValue<float> getDefaultTextSize();
    const PropertyValue<float>& getTextSize() const;
    void setTextSize(const PropertyValue<float>&);

    static PropertyValue<TextTransformType> getDefaultTextTransform();
    const PropertyValue<TextTransformType>& getTextTransform() const;
    void setTextTransform(const PropertyValue<TextTransformType>&);

    static PropertyValue<std::vector<TextVariableAnchorType>> getDefaultTextVariableAnchor();
    const PropertyValue<std::vector<TextVariableAnchorType>>& getTextVariableAnchor() const;
    void setTextVariableAnchor(const PropertyValue<std::vector<TextVariableAnchorType>>&);

    // Paint properties

    static PropertyValue<Color> getDefaultIconColor();
    const PropertyValue<Color>& getIconColor() const;
    void setIconColor(const PropertyValue<Color>&);
    void setIconColorTransition(const TransitionOptions&);
    TransitionOptions getIconColorTransition() const;

    static PropertyValue<float> getDefaultIconHaloBlur();
    const PropertyValue<float>& getIconHaloBlur() const;
    void setIconHaloBlur(const PropertyValue<float>&);
    void setIconHaloBlurTransition(const TransitionOptions&);
    TransitionOptions getIconHaloBlurTransition() const;

    static PropertyValue<Color> getDefaultIconHaloColor();
    const PropertyValue<Color>& getIconHaloColor() const;
    void setIconHaloColor(const PropertyValue<Color>&);
    void setIconHaloColorTransition(const TransitionOptions&);
    TransitionOptions getIconHaloColorTransition() const;

    static PropertyValue<float> getDefaultIconHaloWidth();
    const PropertyValue<float>& getIconHaloWidth() const;
    void setIconHaloWidth(const PropertyValue<float>&);
    void setIconHaloWidthTransition(const TransitionOptions&);
    TransitionOptions getIconHaloWidthTransition() const;

    static PropertyValue<float> getDefaultIconOpacity();
    const PropertyValue<float>& getIconOpacity() const;
    void setIconOpacity(const PropertyValue<float>&);
    void setIconOpacityTransition(const TransitionOptions&);
    TransitionOptions getIconOpacityTransition() const;

    static PropertyValue<std::array<float, 2>> getDefaultIconTranslate();
    const PropertyValue<std::array<float, 2>>& getIconTranslate() const;
    void setIconTranslate(const PropertyValue<std::array<float, 2>>&);
    void setIconTranslateTransition(const TransitionOptions&);
    TransitionOptions getIconTranslateTransition() const;

    static PropertyValue<TranslateAnchorType> getDefaultIconTranslateAnchor();
    const PropertyValue<TranslateAnchorType>& getIconTranslateAnchor() const;
    void setIconTranslateAnchor(const PropertyValue<TranslateAnchorType>&);
    void setIconTranslateAnchorTransition(const TransitionOptions&);
    TransitionOptions getIconTranslateAnchorTransition() const;

    static PropertyValue<Color> getDefaultTextColor();
    const PropertyValue<Color>& getTextColor() const;
    void setTextColor(const PropertyValue<Color>&);
    void setTextColorTransition(const TransitionOptions&);
    TransitionOptions getTextColorTransition() const;

    static PropertyValue<float> getDefaultTextHaloBlur();
    const PropertyValue<float>& getTextHaloBlur() const;
    void setTextHaloBlur(const PropertyValue<float>&);
    void setTextHaloBlurTransition(const TransitionOptions&);
    TransitionOptions getTextHaloBlurTransition() const;

    static PropertyValue<Color> getDefaultTextHaloColor();
    const PropertyValue<Color>& getTextHaloColor() const;
    void setTextHaloColor(const PropertyValue<Color>&);
    void setTextHaloColorTransition(const TransitionOptions&);
    TransitionOptions getTextHaloColorTransition() const;

    static PropertyValue<float> getDefaultTextHaloWidth();
    const PropertyValue<float>& getTextHaloWidth() const;
    void setTextHaloWidth(const PropertyValue<float>&);
    void setTextHaloWidthTransition(const TransitionOptions&);
    TransitionOptions getTextHaloWidthTransition() const;

    static PropertyValue<float> getDefaultTextOpacity();
    const PropertyValue<float>& getTextOpacity() const;
    void setTextOpacity(const PropertyValue<float>&);
    void setTextOpacityTransition(const TransitionOptions&);
    TransitionOptions getTextOpacityTransition() const;

    static PropertyValue<std::array<float, 2>> getDefaultTextTranslate();
    const PropertyValue<std::array<float, 2>>& getTextTranslate() const;
    void setTextTranslate(const PropertyValue<std::array<float, 2>>&);
    void setTextTranslateTransition(const TransitionOptions&);
    TransitionOptions getTextTranslateTransition() const;

    static PropertyValue<TranslateAnchorType> getDefaultTextTranslateAnchor();
    const PropertyValue<TranslateAnchorType>& getTextTranslateAnchor() const;
    void setTextTranslateAnchor(const PropertyValue<TranslateAnchorType>&);
    void setTextTranslateAnchorTransition(const TransitionOptions&);
    TransitionOptions getTextTranslateAnchorTransition() const;

    // Private implementation

    class Impl;
    const Impl& impl() const;

    Mutable<Impl> mutableImpl() const;
    SymbolLayer(Immutable<Impl>);
    std::unique_ptr<Layer> cloneRef(const std::string& id) const final;

protected:
    Mutable<Layer::Impl> mutableBaseImpl() const final;
};

} // namespace style
} // namespace mbgl