File: qgspointdisplacementrenderer.sip.in

package info (click to toggle)
qgis 3.40.11%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,183,800 kB
  • sloc: cpp: 1,595,841; python: 372,637; xml: 23,474; sh: 3,761; perl: 3,664; ansic: 2,257; sql: 2,137; yacc: 1,068; lex: 577; javascript: 540; lisp: 411; makefile: 154
file content (189 lines) | stat: -rw-r--r-- 5,329 bytes parent folder | download | duplicates (6)
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
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/symbology/qgspointdisplacementrenderer.h                    *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/




class QgsPointDisplacementRenderer: QgsPointDistanceRenderer
{
%Docstring(signature="appended")
A renderer that automatically displaces points with the same geographic
location.
%End

%TypeHeaderCode
#include "qgspointdisplacementrenderer.h"
%End
  public:

    enum Placement /BaseType=IntEnum/
    {
      Ring,
      ConcentricRings,
      Grid
    };

    QgsPointDisplacementRenderer( const QString &labelAttributeName = QString() );
%Docstring
Constructor for QgsPointDisplacementRenderer.

:param labelAttributeName: optional attribute name for labeling points
%End

    virtual Qgis::FeatureRendererFlags flags() const;

    virtual QgsPointDisplacementRenderer *clone() const /Factory/;

    virtual void startRender( QgsRenderContext &context, const QgsFields &fields );

    virtual void stopRender( QgsRenderContext &context );

    virtual QDomElement save( QDomDocument &doc, const QgsReadWriteContext &context );

    virtual QSet<QString> usedAttributes( const QgsRenderContext &context ) const;

    virtual bool accept( QgsStyleEntityVisitorInterface *visitor ) const;


    static QgsFeatureRenderer *create( QDomElement &symbologyElem, const QgsReadWriteContext &context ) /Factory/;
%Docstring
Create a renderer from XML element
%End

    void setCircleWidth( double width );
%Docstring
Sets the line width for the displacement group circle.

:param width: line width in mm

.. seealso:: :py:func:`circleWidth`

.. seealso:: :py:func:`setCircleColor`
%End

    double circleWidth() const;
%Docstring
Returns the line width for the displacement group circle in mm.

.. seealso:: :py:func:`setCircleWidth`

.. seealso:: :py:func:`circleColor`
%End

    void setCircleColor( const QColor &color );
%Docstring
Sets the color used for drawing the displacement group circle.

:param color: circle color

.. seealso:: :py:func:`circleColor`

.. seealso:: :py:func:`setCircleWidth`
%End

    QColor circleColor() const;
%Docstring
Returns the color used for drawing the displacement group circle.

.. seealso:: :py:func:`setCircleColor`

.. seealso:: :py:func:`circleWidth`
%End

    void setCircleRadiusAddition( double distance );
%Docstring
Sets a factor for increasing the ring size of displacement groups.

:param distance: addition factor

.. seealso:: :py:func:`circleRadiusAddition`
%End

    double circleRadiusAddition() const;
%Docstring
Returns the factor for increasing the ring size of displacement groups.

.. seealso:: :py:func:`setCircleRadiusAddition`
%End

    void setLabelDistanceFactor( double factor );
%Docstring
Sets a factor for increasing the label distances from the symbol.

:param factor: addition factor

.. seealso:: :py:func:`labelDistanceFactor`

.. versionadded:: 3.8
%End

    double labelDistanceFactor() const;
%Docstring
Returns the factor for label distance from the symbol.

.. seealso:: :py:func:`setLabelDistanceFactor`

.. versionadded:: 3.8
%End

    Placement placement() const;
%Docstring
Returns the placement method used for dispersing the points.

.. seealso:: :py:func:`setPlacement`
%End

    void setPlacement( Placement placement );
%Docstring
Sets the placement method used for dispersing the points.

:param placement: placement method

.. seealso:: :py:func:`placement`
%End

    QgsMarkerSymbol *centerSymbol();
%Docstring
Returns the symbol for the center of a displacement group (but not
ownership of the symbol).

.. seealso:: :py:func:`setCenterSymbol`
%End

    void setCenterSymbol( QgsMarkerSymbol *symbol /Transfer/ );
%Docstring
Sets the center symbol for a displacement group.

:param symbol: new center symbol. Ownership is transferred to the
               renderer.

.. seealso:: :py:func:`centerSymbol`
%End

    static QgsPointDisplacementRenderer *convertFromRenderer( const QgsFeatureRenderer *renderer ) /Factory/;
%Docstring
Creates a QgsPointDisplacementRenderer from an existing renderer.

:return: a new renderer if the conversion was possible, otherwise
         ``None``.
%End

  private:
    QgsPointDisplacementRenderer( const QgsPointDisplacementRenderer & );
    QgsPointDisplacementRenderer &operator=( const QgsPointDisplacementRenderer & );
    virtual void drawGroup( QPointF centerPoint, QgsRenderContext &context, const QgsPointDistanceRenderer::ClusteredGroup &group ) const;

};

/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/symbology/qgspointdisplacementrenderer.h                    *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/