File: qgsprofilepoint.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 (113 lines) | stat: -rw-r--r-- 3,130 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
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/elevation/qgsprofilepoint.h                                 *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/



class QgsProfilePoint
{
%Docstring(signature="appended")
Encapsulates a point on a distance-elevation profile.

.. versionadded:: 3.26
%End

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

    QgsProfilePoint();
%Docstring
Constructor for an empty point.
%End

    QgsProfilePoint( double distance, double elevation ) /HoldGIL/;
%Docstring
Create a point at the specified distance and elevation coordinates
%End

    void setDistance( double distance ) /HoldGIL/;
%Docstring
Sets the ``distance`` of the point.

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

    void setElevation( double elevation ) /HoldGIL/;
%Docstring
Sets the ``elevation`` of the point.

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

    double distance() const /HoldGIL/;
%Docstring
Returns the distance of the point.

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

    double elevation() const /HoldGIL/;
%Docstring
Returns the elevation of the point.

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

    bool isEmpty() const /HoldGIL/;
%Docstring
Returns ``True`` if the point is empty.

A QgsProfilePoint is considered empty when the coordinates have not been
explicitly filled in.
%End

    bool operator==( const QgsProfilePoint &other ) /HoldGIL/;

    bool operator!=( const QgsProfilePoint &other ) const /HoldGIL/;

    SIP_PYOBJECT __repr__();
%MethodCode
    const QString str = sipCpp->isEmpty()
                        ? QStringLiteral( "<QgsProfilePoint: EMPTY>" )
                        : QStringLiteral( "<QgsProfilePoint: %1, %2>" ).arg( sipCpp->distance() ).arg( sipCpp->elevation() );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
%End

    Py_ssize_t __len__();
%MethodCode
    sipRes = 2;
%End

    SIP_PYOBJECT __getitem__( int );
%MethodCode
    if ( a0 == 0 )
    {
      sipRes = Py_BuildValue( "d", sipCpp->distance() );
    }
    else if ( a0 == 1 )
    {
      sipRes = Py_BuildValue( "d", sipCpp->elevation() );
    }
    else
    {
      QString msg = QString( "Bad index: %1" ).arg( a0 );
      PyErr_SetString( PyExc_IndexError, msg.toLatin1().constData() );
    }
%End


};

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