mirror of
https://github.com/qgis/QGIS.git
synced 2025-10-15 00:02:52 -04:00
270 lines
7.9 KiB
Plaintext
270 lines
7.9 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/geometry/qgsellipse.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.py again *
|
|
************************************************************************/
|
|
|
|
|
|
|
|
|
|
|
|
class QgsEllipse
|
|
{
|
|
%Docstring(signature="appended")
|
|
Ellipse geometry type.
|
|
|
|
An ellipse is defined by a center point with a semi-major axis, a
|
|
semi-minor axis and an azimuth. The azimuth is the north angle to the
|
|
first quadrant (always oriented on the semi-major axis), in degrees. By
|
|
default, the semi-major axis is oriented to the east (90 degrees). The
|
|
semi-minor axis is always smaller than the semi-major axis. If it is set
|
|
larger, it will be swapped and the azimuth will increase by 90 degrees.
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsellipse.h"
|
|
%End
|
|
public:
|
|
|
|
QgsEllipse() /HoldGIL/;
|
|
%Docstring
|
|
Constructor for QgsEllipse.
|
|
%End
|
|
|
|
virtual ~QgsEllipse();
|
|
|
|
QgsEllipse( const QgsPoint ¢er, double semiMajorAxis, double semiMinorAxis, double azimuth = 90 ) /HoldGIL/;
|
|
%Docstring
|
|
Constructs an ellipse by defining all the members.
|
|
|
|
:param center: The center of the ellipse.
|
|
:param semiMajorAxis: Semi-major axis of the ellipse.
|
|
:param semiMinorAxis: Semi-minor axis of the ellipse.
|
|
:param azimuth: Angle in degrees started from the North to the first
|
|
quadrant.
|
|
%End
|
|
|
|
static QgsEllipse fromFoci( const QgsPoint &pt1, const QgsPoint &pt2, const QgsPoint &pt3 ) /HoldGIL/;
|
|
%Docstring
|
|
Constructs an ellipse by foci (``pt1`` and ``pt2``) and a point ``pt3``.
|
|
The center point can have m value which is the result from the midpoint
|
|
operation between ``pt1`` and ``pt2``. Z dimension is also supported and
|
|
is retrieved from the first 3D point amongst ``pt1`` and ``pt2``. Axes
|
|
are calculated from the 2D distance with the third point ``pt3``. The
|
|
azimuth is the angle between ``pt1`` and ``pt2``.
|
|
|
|
:param pt1: First focus.
|
|
:param pt2: Second focus.
|
|
:param pt3: A point to calculate the axes.
|
|
%End
|
|
|
|
static QgsEllipse fromExtent( const QgsPoint &pt1, const QgsPoint &pt2 ) /HoldGIL/;
|
|
%Docstring
|
|
Constructs an ellipse by an extent (aka bounding box /
|
|
:py:class:`QgsRectangle`). The center point can have m value which is
|
|
the result from the midpoint operation between ``pt1`` and ``pt2``. Z
|
|
dimension is also supported and is retrieved from the first 3D point
|
|
amongst ``pt1`` and ``pt2``. Axes are calculated from the 2D distance
|
|
between ``pt1`` and ``pt2``. The azimuth always takes the default value.
|
|
|
|
:param pt1: First corner.
|
|
:param pt2: Second corner.
|
|
%End
|
|
|
|
static QgsEllipse fromCenterPoint( const QgsPoint &ptc, const QgsPoint &pt1 ) /HoldGIL/;
|
|
%Docstring
|
|
Constructs an ellipse by a center point and a another point. The center
|
|
point keeps m value from ``ptc``. Z dimension is also supported and is
|
|
retrieved from the first 3D point amongst ``ptc`` and ``pt1``. Axes are
|
|
calculated from the 2D distance between ``ptc`` and ``pt1``. The azimuth
|
|
always takes the default value.
|
|
|
|
:param ptc: Center point.
|
|
:param pt1: First point.
|
|
%End
|
|
|
|
static QgsEllipse fromCenter2Points( const QgsPoint &ptc, const QgsPoint &pt1, const QgsPoint &pt2 ) /HoldGIL/;
|
|
%Docstring
|
|
Constructs an ellipse by a central point and two other points. The
|
|
center point keeps m value from ``ptc``. Z dimension is also supported
|
|
and is retrieved from the first 3D point amongst ``ptc``, ``pt1`` and
|
|
``pt2``. Axes are calculated from the 2D distance between ``ptc`` and
|
|
``pt1`` and ``pt2``. The azimuth is the angle between ``ptc`` and
|
|
``pt1``.
|
|
|
|
:param ptc: Center point.
|
|
:param pt1: First point.
|
|
:param pt2: Second point.
|
|
%End
|
|
|
|
virtual bool operator ==( const QgsEllipse &elp ) const;
|
|
virtual bool operator !=( const QgsEllipse &elp ) const;
|
|
|
|
virtual bool isEmpty() const /HoldGIL/;
|
|
%Docstring
|
|
An ellipse is empty if axes are equal to 0
|
|
%End
|
|
|
|
QgsPoint center() const /HoldGIL/;
|
|
%Docstring
|
|
Returns the center point.
|
|
|
|
.. seealso:: :py:func:`setCenter`
|
|
|
|
.. seealso:: :py:func:`rcenter`
|
|
%End
|
|
|
|
double semiMajorAxis() const /HoldGIL/;
|
|
%Docstring
|
|
Returns the semi-major axis.
|
|
|
|
.. seealso:: :py:func:`setSemiMajorAxis`
|
|
%End
|
|
|
|
double semiMinorAxis() const /HoldGIL/;
|
|
%Docstring
|
|
Returns the semi-minor axis.
|
|
|
|
.. seealso:: :py:func:`setSemiMinorAxis`
|
|
%End
|
|
|
|
double azimuth() const /HoldGIL/;
|
|
%Docstring
|
|
Returns the azimuth.
|
|
|
|
.. seealso:: :py:func:`setAzimuth`
|
|
%End
|
|
|
|
|
|
void setCenter( const QgsPoint ¢er ) /HoldGIL/;
|
|
%Docstring
|
|
Sets the center point.
|
|
|
|
.. seealso:: :py:func:`center`
|
|
|
|
.. seealso:: :py:func:`rcenter`
|
|
%End
|
|
|
|
virtual void setSemiMajorAxis( double semiMajorAxis ) /HoldGIL/;
|
|
%Docstring
|
|
Sets the semi-major axis.
|
|
|
|
.. seealso:: :py:func:`semiMajorAxis`
|
|
%End
|
|
|
|
virtual void setSemiMinorAxis( double semiMinorAxis ) /HoldGIL/;
|
|
%Docstring
|
|
Sets the semi-minor axis.
|
|
|
|
.. seealso:: :py:func:`semiMinorAxis`
|
|
%End
|
|
|
|
void setAzimuth( double azimuth ) /HoldGIL/;
|
|
%Docstring
|
|
Sets the azimuth (orientation).
|
|
|
|
.. seealso:: :py:func:`azimuth`
|
|
%End
|
|
|
|
virtual double focusDistance() const /HoldGIL/;
|
|
%Docstring
|
|
The distance between the center and each foci.
|
|
|
|
.. seealso:: :py:func:`fromFoci`
|
|
|
|
.. seealso:: :py:func:`foci`
|
|
|
|
:return: The distance between the center and each foci.
|
|
%End
|
|
|
|
virtual QVector<QgsPoint> foci() const;
|
|
%Docstring
|
|
Two foci of the ellipse. The axes are oriented by the azimuth and are on
|
|
the semi-major axis.
|
|
|
|
.. seealso:: :py:func:`fromFoci`
|
|
|
|
.. seealso:: :py:func:`focusDistance`
|
|
|
|
:return: the two foci.
|
|
%End
|
|
|
|
virtual double eccentricity() const /HoldGIL/;
|
|
%Docstring
|
|
The eccentricity of the ellipse. nan is returned if the ellipse is
|
|
empty.
|
|
%End
|
|
virtual double area() const /HoldGIL/;
|
|
%Docstring
|
|
The area of the ellipse.
|
|
%End
|
|
virtual double perimeter() const /HoldGIL/;
|
|
%Docstring
|
|
The circumference of the ellipse using first approximation of Ramanujan.
|
|
%End
|
|
|
|
virtual QVector<QgsPoint> quadrant() const;
|
|
%Docstring
|
|
The four quadrants of the ellipse. They are oriented and started always
|
|
from semi-major axis.
|
|
|
|
:return: quadrants defined by four points.
|
|
%End
|
|
|
|
virtual QgsPointSequence points( unsigned int segments = 36 ) const;
|
|
%Docstring
|
|
Returns a list of points with segmentation from ``segments``.
|
|
|
|
:param segments: Number of segments used to segment geometry.
|
|
%End
|
|
|
|
virtual QgsPolygon *toPolygon( unsigned int segments = 36 ) const /Factory/;
|
|
%Docstring
|
|
Returns a segmented polygon.
|
|
|
|
:param segments: Number of segments used to segment geometry.
|
|
%End
|
|
|
|
virtual QgsLineString *toLineString( unsigned int segments = 36 ) const /Factory/;
|
|
%Docstring
|
|
Returns a segmented linestring.
|
|
|
|
:param segments: Number of segments used to segment geometry.
|
|
%End
|
|
|
|
virtual QgsPolygon *orientedBoundingBox() const /Factory/;
|
|
%Docstring
|
|
Returns the oriented minimal bounding box for the ellipse.
|
|
%End
|
|
|
|
virtual QgsRectangle boundingBox() const;
|
|
%Docstring
|
|
Returns the minimal bounding box for the ellipse.
|
|
%End
|
|
|
|
virtual QString toString( int pointPrecision = 17, int axisPrecision = 17, int azimuthPrecision = 2 ) const;
|
|
%Docstring
|
|
returns a string representation of the ellipse. Members will be
|
|
truncated to the specified precision.
|
|
%End
|
|
|
|
SIP_PYOBJECT __repr__();
|
|
%MethodCode
|
|
QString str = QStringLiteral( "<QgsEllipse: %1>" ).arg( sipCpp->toString() );
|
|
sipRes = PyUnicode_FromString( str.toUtf8().constData() );
|
|
%End
|
|
|
|
protected:
|
|
|
|
};
|
|
|
|
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/geometry/qgsellipse.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.py again *
|
|
************************************************************************/
|