QGIS API Documentation  3.17.0-Master (8af46bc54f)
Public Member Functions | Static Public Member Functions | List of all members
QgsCircle Class Reference

Circle geometry type. More...

#include <qgscircle.h>

Inheritance diagram for QgsCircle:
Inheritance graph
[legend]

Public Member Functions

 QgsCircle ()
 
 QgsCircle (const QgsPoint &center, double radius, double azimuth=0) SIP_HOLDGIL
 Constructs a circle by defining all the members. More...
 
double area () const override SIP_HOLDGIL
 The area of the ellipse. More...
 
QgsRectangle boundingBox () const override
 Returns the minimal bounding box for the ellipse. More...
 
bool contains (const QgsPoint &point, double epsilon=1E-8) const
 Returns true if the circle contains the point. More...
 
int innerTangents (const QgsCircle &other, QgsPointXY &line1P1, QgsPointXY &line1P2, QgsPointXY &line2P1, QgsPointXY &line2P2) const
 Calculates the inner tangent points between this circle and an other circle. More...
 
int intersections (const QgsCircle &other, QgsPoint &intersection1, QgsPoint &intersection2, bool useZ=false) const
 Calculates the intersections points between this circle and an other circle. More...
 
QVector< QgsPointnorthQuadrant () const
 The four quadrants of the ellipse. More...
 
int outerTangents (const QgsCircle &other, QgsPointXY &line1P1, QgsPointXY &line1P2, QgsPointXY &line2P1, QgsPointXY &line2P2) const
 Calculates the outer tangent points between this circle and an other circle. More...
 
double perimeter () const override SIP_HOLDGIL
 The circumference of the ellipse using first approximation of Ramanujan. More...
 
double radius () const SIP_HOLDGIL
 Returns the radius of the circle. More...
 
void setRadius (double radius) SIP_HOLDGIL
 Sets the radius of the circle. More...
 
void setSemiMajorAxis (double semiMajorAxis) override SIP_HOLDGIL
 Inherited method. More...
 
void setSemiMinorAxis (double semiMinorAxis) override SIP_HOLDGIL
 Inherited method. More...
 
bool tangentToPoint (const QgsPointXY &p, QgsPointXY &pt1, QgsPointXY &pt2) const
 Calculates the tangent points between this circle and the point p. More...
 
QgsCircularStringtoCircularString (bool oriented=false) const
 Returns a circular string from the circle. More...
 
QString toString (int pointPrecision=17, int radiusPrecision=17, int azimuthPrecision=2) const override
 returns a string representation of the ellipse. More...
 
- Public Member Functions inherited from QgsEllipse
 QgsEllipse () SIP_HOLDGIL=default
 Constructor for QgsEllipse. More...
 
 QgsEllipse (const QgsPoint &center, double semiMajorAxis, double semiMinorAxis, double azimuth=90) SIP_HOLDGIL
 Constructs an ellipse by defining all the members. More...
 
virtual ~QgsEllipse ()=default
 
double azimuth () const SIP_HOLDGIL
 Returns the azimuth. More...
 
QgsPoint center () const SIP_HOLDGIL
 Returns the center point. More...
 
virtual double eccentricity () const SIP_HOLDGIL
 The eccentricity of the ellipse. More...
 
virtual QVector< QgsPointfoci () const
 Two foci of the ellipse. More...
 
virtual double focusDistance () const SIP_HOLDGIL
 The distance between the center and each foci. More...
 
virtual bool isEmpty () const SIP_HOLDGIL
 An ellipse is empty if axes are equal to 0. More...
 
virtual bool operator!= (const QgsEllipse &elp) const
 
virtual bool operator== (const QgsEllipse &elp) const
 
virtual QgsPolygonorientedBoundingBox () const
 Returns the oriented minimal bounding box for the ellipse. More...
 
virtual QgsPointSequence points (unsigned int segments=36) const
 Returns a list of points with segmentation from segments. More...
 
virtual QVector< QgsPointquadrant () const
 The four quadrants of the ellipse. More...
 
QgsPointrcenter ()
 Returns a reference to the center point of this ellipse. More...
 
double semiMajorAxis () const SIP_HOLDGIL
 Returns the semi-major axis. More...
 
double semiMinorAxis () const SIP_HOLDGIL
 Returns the semi-minor axis. More...
 
void setAzimuth (double azimuth) SIP_HOLDGIL
 Sets the azimuth (orientation). More...
 
void setCenter (const QgsPoint &center) SIP_HOLDGIL
 Sets the center point. More...
 
virtual QgsLineStringtoLineString (unsigned int segments=36) const
 Returns a segmented linestring. More...
 
virtual QgsPolygontoPolygon (unsigned int segments=36) const
 Returns a segmented polygon. More...
 

Static Public Member Functions

static QgsCircle from2Points (const QgsPoint &pt1, const QgsPoint &pt2) SIP_HOLDGIL
 Constructs a circle by 2 points on the circle. More...
 
static QgsCircle from3Points (const QgsPoint &pt1, const QgsPoint &pt2, const QgsPoint &pt3, double epsilon=1E-8) SIP_HOLDGIL
 Constructs a circle by 3 points on the circle. More...
 
static QgsCircle from3Tangents (const QgsPoint &pt1_tg1, const QgsPoint &pt2_tg1, const QgsPoint &pt1_tg2, const QgsPoint &pt2_tg2, const QgsPoint &pt1_tg3, const QgsPoint &pt2_tg3, double epsilon=1E-8) SIP_HOLDGIL
 Constructs a circle by 3 tangents on the circle (aka inscribed circle of a triangle). More...
 
static QgsCircle fromCenterDiameter (const QgsPoint &center, double diameter, double azimuth=0) SIP_HOLDGIL
 Constructs a circle by a center point and a diameter. More...
 
static QgsCircle fromCenterPoint (const QgsPoint &center, const QgsPoint &pt1) SIP_HOLDGIL
 Constructs a circle by a center point and another point. More...
 
static QgsCircle fromExtent (const QgsPoint &pt1, const QgsPoint &pt2) SIP_HOLDGIL
 Constructs a circle by an extent (aka bounding box / QgsRectangle). More...
 
static QgsCircle minimalCircleFrom3Points (const QgsPoint &pt1, const QgsPoint &pt2, const QgsPoint &pt3, double epsilon=1E-8) SIP_HOLDGIL
 Constructs the smallest circle from 3 points. More...
 
- Static Public Member Functions inherited from QgsEllipse
static QgsEllipse fromCenter2Points (const QgsPoint &ptc, const QgsPoint &pt1, const QgsPoint &pt2) SIP_HOLDGIL
 Constructs an ellipse by a central point and two other points. More...
 
static QgsEllipse fromCenterPoint (const QgsPoint &ptc, const QgsPoint &pt1) SIP_HOLDGIL
 Constructs an ellipse by a center point and a another point. More...
 
static QgsEllipse fromExtent (const QgsPoint &pt1, const QgsPoint &pt2) SIP_HOLDGIL
 Constructs an ellipse by an extent (aka bounding box / QgsRectangle). More...
 
static QgsEllipse fromFoci (const QgsPoint &pt1, const QgsPoint &pt2, const QgsPoint &pt3) SIP_HOLDGIL
 Constructs an ellipse by foci (pt1 and pt2) and a point pt3. More...
 

Additional Inherited Members

- Protected Attributes inherited from QgsEllipse
double mAzimuth = 90.0
 
QgsPoint mCenter
 
double mSemiMajorAxis = 0.0
 
double mSemiMinorAxis = 0.0
 

Detailed Description

Circle geometry type.

A circle is defined by a center point with a radius and an azimuth. The azimuth is the north angle to the semi-major axis, in degrees. By default, the semi-major axis is oriented to the north (0 degrees).

Since
QGIS 3.0

Definition at line 43 of file qgscircle.h.

Constructor & Destructor Documentation

◆ QgsCircle() [1/2]

QgsCircle::QgsCircle ( )

Definition at line 25 of file qgscircle.cpp.

◆ QgsCircle() [2/2]

QgsCircle::QgsCircle ( const QgsPoint center,
double  radius,
double  azimuth = 0 
)

Constructs a circle by defining all the members.

Parameters
centerThe center of the circle.
radiusThe radius of the circle.
azimuthAngle in degrees started from the North to the first quadrant.

Definition at line 31 of file qgscircle.cpp.

Member Function Documentation

◆ area()

double QgsCircle::area ( ) const
overridevirtual

The area of the ellipse.

Reimplemented from QgsEllipse.

Definition at line 294 of file qgscircle.cpp.

◆ boundingBox()

QgsRectangle QgsCircle::boundingBox ( ) const
overridevirtual

Returns the minimal bounding box for the ellipse.

Reimplemented from QgsEllipse.

Definition at line 355 of file qgscircle.cpp.

◆ contains()

bool QgsCircle::contains ( const QgsPoint point,
double  epsilon = 1E-8 
) const

Returns true if the circle contains the point.

Definition at line 350 of file qgscircle.cpp.

◆ from2Points()

QgsCircle QgsCircle::from2Points ( const QgsPoint pt1,
const QgsPoint pt2 
)
static

Constructs a circle by 2 points on the circle.

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. The radius is calculated from the 2D distance between pt1 and pt2. The azimuth is the angle between pt1 and pt2.

Parameters
pt1First point.
pt2Second point.

Definition at line 37 of file qgscircle.cpp.

◆ from3Points()

QgsCircle QgsCircle::from3Points ( const QgsPoint pt1,
const QgsPoint pt2,
const QgsPoint pt3,
double  epsilon = 1E-8 
)
static

Constructs a circle by 3 points on the circle.

M value is dropped for the center point. Z dimension is supported and is retrieved from the first 3D point amongst pt1, pt2 and pt3. The azimuth always takes the default value. If the points are colinear an empty circle is returned.

Parameters
pt1First point.
pt2Second point.
pt3Third point.
epsilonValue used to compare point.

Definition at line 83 of file qgscircle.cpp.

◆ from3Tangents()

QgsCircle QgsCircle::from3Tangents ( const QgsPoint pt1_tg1,
const QgsPoint pt2_tg1,
const QgsPoint pt1_tg2,
const QgsPoint pt2_tg2,
const QgsPoint pt1_tg3,
const QgsPoint pt2_tg3,
double  epsilon = 1E-8 
)
static

Constructs a circle by 3 tangents on the circle (aka inscribed circle of a triangle).

Z and m values are dropped for the center point. The azimuth always takes the default value.

Parameters
pt1_tg1First point of the first tangent.
pt2_tg1Second point of the first tangent.
pt1_tg2First point of the second tangent.
pt2_tg2Second point of the second tangent.
pt1_tg3First point of the third tangent.
pt2_tg3Second point of the third tangent.
epsilonValue used to compare point.

Definition at line 191 of file qgscircle.cpp.

◆ fromCenterDiameter()

QgsCircle QgsCircle::fromCenterDiameter ( const QgsPoint center,
double  diameter,
double  azimuth = 0 
)
static

Constructs a circle by a center point and a diameter.

The center point keeps z and m values from center.

Parameters
centerCenter point.
diameterDiameter of the circle.
azimuthAzimuth of the circle.

Definition at line 176 of file qgscircle.cpp.

◆ fromCenterPoint()

QgsCircle QgsCircle::fromCenterPoint ( const QgsPoint center,
const QgsPoint pt1 
)
static

Constructs a circle by a center point and another point.

The center point keeps z and m values from center. Axes are calculated from the 2D distance between center and pt1. The azimuth is the angle between center and pt1.

Parameters
centerCenter point.
pt1A point on the circle.

Definition at line 181 of file qgscircle.cpp.

◆ fromExtent()

QgsCircle QgsCircle::fromExtent ( const QgsPoint pt1,
const QgsPoint pt2 
)
static

Constructs a circle by an extent (aka bounding box / 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.

Parameters
pt1First corner.
pt2Second corner.

Definition at line 279 of file qgscircle.cpp.

◆ innerTangents()

int QgsCircle::innerTangents ( const QgsCircle other,
QgsPointXY line1P1,
QgsPointXY line1P2,
QgsPointXY line2P1,
QgsPointXY line2P2 
) const

Calculates the inner tangent points between this circle and an other circle.

The inner tangent points correspond to the points at which the two lines which are drawn so that they are tangential to both circles but on different sides, touching the circles and crossing each other.

The first tangent line is described by the points stored in line1P1 and line1P2, and the second line is described by the points stored in line2P1 and line2P2.

Returns the number of tangents (either 0 or 2).

Note that this method is 2D only and does not consider the z-value of the circle.

See also
tangentToPoint() and outerTangents()
Since
QGIS 3.6

Definition at line 273 of file qgscircle.cpp.

◆ intersections()

int QgsCircle::intersections ( const QgsCircle other,
QgsPoint intersection1,
QgsPoint intersection2,
bool  useZ = false 
) const

Calculates the intersections points between this circle and an other circle.

If found, the intersection points will be stored in intersection1 and intersection2.

By default this method does not consider any z values and instead treats the circles as 2-dimensional. If useZ is set to true, then an intersection will only occur if the z values of both circles are equal. In this case the points returned for intersection1 and intersection2 will contain the z value of the circle intersections.

Returns
number of intersection points found.
Since
QGIS 3.2

Definition at line 239 of file qgscircle.cpp.

◆ minimalCircleFrom3Points()

QgsCircle QgsCircle::minimalCircleFrom3Points ( const QgsPoint pt1,
const QgsPoint pt2,
const QgsPoint pt3,
double  epsilon = 1E-8 
)
static

Constructs the smallest circle from 3 points.

Z and m values are dropped for the center point. The azimuth always takes the default value. If the points are colinear an empty circle is returned.

Parameters
pt1First point.
pt2Second point.
pt3Third point.
epsilonValue used to compare point.

Definition at line 223 of file qgscircle.cpp.

◆ northQuadrant()

QVector< QgsPoint > QgsCircle::northQuadrant ( ) const

The four quadrants of the ellipse.

They are oriented and started from North.

Returns
quadrants defined by four points.
See also
quadrant()

Definition at line 316 of file qgscircle.cpp.

◆ outerTangents()

int QgsCircle::outerTangents ( const QgsCircle other,
QgsPointXY line1P1,
QgsPointXY line1P2,
QgsPointXY line2P1,
QgsPointXY line2P2 
) const

Calculates the outer tangent points between this circle and an other circle.

The outer tangent points correspond to the points at which the two lines which are drawn so that they are tangential to both circles touch the circles.

The first tangent line is described by the points stored in line1P1 and line1P2, and the second line is described by the points stored in line2P1 and line2P2.

Returns the number of tangents (either 0 or 2).

Note that this method is 2D only and does not consider the z-value of the circle.

See also
tangentToPoint() and innerTangents()
Since
QGIS 3.2

Definition at line 267 of file qgscircle.cpp.

◆ perimeter()

double QgsCircle::perimeter ( ) const
overridevirtual

The circumference of the ellipse using first approximation of Ramanujan.

Reimplemented from QgsEllipse.

Definition at line 299 of file qgscircle.cpp.

◆ radius()

double QgsCircle::radius ( ) const
inline

Returns the radius of the circle.

Definition at line 247 of file qgscircle.h.

◆ setRadius()

void QgsCircle::setRadius ( double  radius)
inline

Sets the radius of the circle.

Definition at line 249 of file qgscircle.h.

◆ setSemiMajorAxis()

void QgsCircle::setSemiMajorAxis ( double  semiMajorAxis)
overridevirtual

Inherited method.

Use setRadius instead.

See also
radius()
setRadius()

Reimplemented from QgsEllipse.

Definition at line 304 of file qgscircle.cpp.

◆ setSemiMinorAxis()

void QgsCircle::setSemiMinorAxis ( double  semiMinorAxis)
overridevirtual

Inherited method.

Use setRadius instead.

See also
radius()
setRadius()

Reimplemented from QgsEllipse.

Definition at line 310 of file qgscircle.cpp.

◆ tangentToPoint()

bool QgsCircle::tangentToPoint ( const QgsPointXY p,
QgsPointXY pt1,
QgsPointXY pt2 
) const

Calculates the tangent points between this circle and the point p.

If found, the tangent points will be stored in pt1 and pt2.

Note that this method is 2D only and does not consider the z-value of the circle.

Returns
true if tangent was found.
See also
outerTangents() and innerTangents()
Since
QGIS 3.2

Definition at line 262 of file qgscircle.cpp.

◆ toCircularString()

QgsCircularString * QgsCircle::toCircularString ( bool  oriented = false) const

Returns a circular string from the circle.

Parameters
orientedIf oriented is true the start point is from azimuth instead from north.

Definition at line 327 of file qgscircle.cpp.

◆ toString()

QString QgsCircle::toString ( int  pointPrecision = 17,
int  axisPrecision = 17,
int  azimuthPrecision = 2 
) const
overridevirtual

returns a string representation of the ellipse.

Members will be truncated to the specified precision.

Reimplemented from QgsEllipse.

Definition at line 360 of file qgscircle.cpp.


The documentation for this class was generated from the following files: