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
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/labeling/qgslabelobstaclesettings.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsLabelObstacleSettings
{
%Docstring(signature="appended")
Contains settings related to how the label engine treats features as
obstacles
.. versionadded:: 3.10.2
%End
%TypeHeaderCode
#include "qgslabelobstaclesettings.h"
%End
public:
enum class ObstacleType /BaseType=IntEnum/
{
PolygonInterior,
PolygonBoundary,
PolygonWhole
};
bool isObstacle() const;
%Docstring
Returns ``True`` if the features are obstacles to labels of other
layers.
.. seealso:: :py:func:`setIsObstacle`
.. seealso:: :py:func:`factor`
.. seealso:: :py:func:`type`
%End
void setIsObstacle( bool isObstacle );
%Docstring
Sets whether features are obstacles to labels of other layers.
.. seealso:: :py:func:`isObstacle`
.. seealso:: :py:func:`factor`
.. seealso:: :py:func:`type`
%End
double factor() const;
%Docstring
Returns the obstacle factor, where 1.0 = default, < 1.0 more likely to
be covered by labels, > 1.0 less likely to be covered
.. seealso:: :py:func:`setFactor`
.. seealso:: :py:func:`isObstacle`
.. seealso:: :py:func:`type`
%End
void setFactor( double factor );
%Docstring
Sets the obstacle ``factor``, where 1.0 = default, < 1.0 more likely to
be covered by labels, > 1.0 less likely to be covered
.. seealso:: :py:func:`factor`
.. seealso:: :py:func:`isObstacle`
.. seealso:: :py:func:`type`
%End
ObstacleType type() const;
%Docstring
Returns how features act as obstacles for labels.
.. seealso:: :py:func:`setType`
.. seealso:: :py:func:`isObstacle`
.. seealso:: :py:func:`factor`
%End
void setType( ObstacleType type );
%Docstring
Controls how features act as obstacles for labels.
.. seealso:: :py:func:`type`
.. seealso:: :py:func:`isObstacle`
.. seealso:: :py:func:`factor`
%End
void setObstacleGeometry( const QgsGeometry &obstacleGeom );
%Docstring
Sets the label's obstacle geometry, if different to the feature
geometry. This can be used to override the shape of the feature for
obstacle detection, e.g., to buffer around a point geometry to prevent
labels being placed too close to the point itself. It not set, the
feature's geometry is used for obstacle detection.
.. seealso:: :py:func:`obstacleGeometry`
%End
QgsGeometry obstacleGeometry() const;
%Docstring
Returns the label's obstacle geometry, if different to the feature
geometry.
.. seealso:: :py:func:`setObstacleGeometry`
%End
void updateDataDefinedProperties( const QgsPropertyCollection &properties, QgsExpressionContext &context );
%Docstring
Updates the obstacle settings to respect any data defined properties set
within the specified ``properties`` collection.
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/labeling/qgslabelobstaclesettings.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
