QGIS API Documentation  3.11.0-Master (68611307d7)
Public Member Functions | List of all members
QgsReferencedRectangle Class Reference

A QgsRectangle with associated coordinate reference system. More...

#include <qgsreferencedgeometry.h>

Inheritance diagram for QgsReferencedRectangle:
Inheritance graph
[legend]

Public Member Functions

 QgsReferencedRectangle (const QgsRectangle &rectangle, const QgsCoordinateReferenceSystem &crs)
 Constructor for QgsReferencedRectangle, with the specified initial rectangle and crs. More...
 
 QgsReferencedRectangle ()=default
 Constructor for QgsReferencedRectangle. More...
 
 operator QVariant () const
 Allows direct construction of QVariants from rectangle. More...
 
bool operator!= (const QgsReferencedRectangle &other)
 
bool operator== (const QgsReferencedRectangle &other)
 
- Public Member Functions inherited from QgsRectangle
 QgsRectangle ()=default
 Constructor for a null rectangle. More...
 
 QgsRectangle (double xMin, double yMin=0, double xMax=0, double yMax=0)
 Constructor. More...
 
 QgsRectangle (const QgsPointXY &p1, const QgsPointXY &p2)
 Construct a rectangle from two points. The rectangle is normalized after construction. More...
 
 QgsRectangle (const QRectF &qRectF)
 Construct a rectangle from a QRectF. The rectangle is normalized after construction. More...
 
 QgsRectangle (const QgsRectangle &other)
 Copy constructor. More...
 
 ~QgsRectangle ()=default
 
double area () const
 Returns the area of the rectangle. More...
 
QString asPolygon () const
 Returns the rectangle as a polygon. More...
 
QString asWktCoordinates () const
 Returns a string representation of the rectangle in WKT format. More...
 
QString asWktPolygon () const
 Returns a string representation of the rectangle as a WKT Polygon. More...
 
QgsRectangle buffered (double width) const
 Gets rectangle enlarged by buffer. More...
 
QgsPointXY center () const
 Returns the center point of the rectangle. More...
 
void combineExtentWith (const QgsRectangle &rect)
 Expands the rectangle so that it covers both the original rectangle and the given rectangle. More...
 
void combineExtentWith (double x, double y)
 Expands the rectangle so that it covers both the original rectangle and the given point. More...
 
void combineExtentWith (const QgsPointXY &point)
 Expands the rectangle so that it covers both the original rectangle and the given point. More...
 
bool contains (const QgsRectangle &rect) const
 Returns true when rectangle contains other rectangle. More...
 
bool contains (const QgsPointXY &p) const
 Returns true when rectangle contains a point. More...
 
void grow (double delta)
 Grows the rectangle in place by the specified amount. More...
 
double height () const
 Returns the height of the rectangle. More...
 
void include (const QgsPointXY &p)
 Updates the rectangle to include the specified point. More...
 
QgsRectangle intersect (const QgsRectangle &rect) const
 Returns the intersection with the given rectangle. More...
 
bool intersects (const QgsRectangle &rect) const
 Returns true when rectangle intersects with other rectangle. More...
 
void invert ()
 Swap x/y coordinates in the rectangle. More...
 
bool isEmpty () const
 Returns true if the rectangle is empty. More...
 
bool isFinite () const
 Returns true if the rectangle has finite boundaries. More...
 
bool isNull () const
 Test if the rectangle is null (all coordinates zero or after call to setMinimal()). More...
 
void normalize ()
 Normalize the rectangle so it has non-negative width/height. More...
 
 operator QVariant () const
 Allows direct construction of QVariants from rectangles. More...
 
bool operator!= (const QgsRectangle &r1) const
 Comparison operator. More...
 
QgsRectangle operator+ (QgsVector v) const
 Returns a rectangle offset from this one in the direction of the vector. More...
 
QgsRectangleoperator+= (QgsVector v)
 Moves this rectangle in the direction of the vector. More...
 
QgsRectangle operator- (QgsVector v) const
 Returns a rectangle offset from this one in the direction of the reversed vector. More...
 
QgsRectangleoperator-= (QgsVector v)
 Moves this rectangle in the direction of the reversed vector. More...
 
QgsRectangleoperator= (const QgsRectangle &r1)
 Assignment operator. More...
 
bool operator== (const QgsRectangle &r1) const
 Comparison operator. More...
 
double perimeter () const
 Returns the perimeter of the rectangle. More...
 
void scale (double scaleFactor, const QgsPointXY *c=nullptr)
 Scale the rectangle around its center point. More...
 
void scale (double scaleFactor, double centerX, double centerY)
 Scale the rectangle around its center point. More...
 
QgsRectangle scaled (double scaleFactor, const QgsPointXY *center=nullptr) const
 Scale the rectangle around its center point. More...
 
void set (const QgsPointXY &p1, const QgsPointXY &p2)
 Sets the rectangle from two QgsPoints. More...
 
void set (double xMin, double yMin, double xMax, double yMax)
 Sets the rectangle from four points. More...
 
void setMinimal ()
 Set a rectangle so that min corner is at max and max corner is at min. More...
 
void setXMaximum (double x)
 Set the maximum x value. More...
 
void setXMinimum (double x)
 Set the minimum x value. More...
 
void setYMaximum (double y)
 Set the maximum y value. More...
 
void setYMinimum (double y)
 Set the minimum y value. More...
 
QgsRectangle snappedToGrid (double spacing) const
 Returns a copy of this rectangle that is snapped to a grid with the specified spacing between the grid lines. More...
 
QgsBox3d toBox3d (double zMin, double zMax) const
 Converts the rectangle to a 3D box, with the specified zMin and zMax z values. More...
 
QRectF toRectF () const
 Returns a QRectF with same coordinates as the rectangle. More...
 
QString toString (int precision=16) const
 Returns a string representation of form xmin,ymin : xmax,ymax Coordinates will be truncated to the specified precision. More...
 
double width () const
 Returns the width of the rectangle. More...
 
double xMaximum () const
 Returns the x maximum value (right side of rectangle). More...
 
double xMinimum () const
 Returns the x minimum value (left side of rectangle). More...
 
double yMaximum () const
 Returns the y maximum value (top side of rectangle). More...
 
double yMinimum () const
 Returns the y minimum value (bottom side of rectangle). More...
 
- Public Member Functions inherited from QgsReferencedGeometryBase
 QgsReferencedGeometryBase (const QgsCoordinateReferenceSystem &crs=QgsCoordinateReferenceSystem())
 Constructor for QgsReferencedGeometryBase, with the specified crs. More...
 
QgsCoordinateReferenceSystem crs () const
 Returns the associated coordinate reference system, or an invalid CRS if no reference system is set. More...
 
void setCrs (const QgsCoordinateReferenceSystem &crs)
 Sets the associated crs. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from QgsRectangle
static QgsRectangle fromCenterAndSize (QgsPointXY center, double width, double height)
 Creates a new rectangle, given the specified center point and width and height. More...
 
static QgsRectangle fromWkt (const QString &wkt)
 Creates a new rectangle from a wkt string. More...
 

Detailed Description

A QgsRectangle with associated coordinate reference system.

Since
QGIS 3.0

Definition at line 72 of file qgsreferencedgeometry.h.

Constructor & Destructor Documentation

◆ QgsReferencedRectangle() [1/2]

QgsReferencedRectangle::QgsReferencedRectangle ( const QgsRectangle rectangle,
const QgsCoordinateReferenceSystem crs 
)

Constructor for QgsReferencedRectangle, with the specified initial rectangle and crs.

Definition at line 24 of file qgsreferencedgeometry.cpp.

◆ QgsReferencedRectangle() [2/2]

QgsReferencedRectangle::QgsReferencedRectangle ( )
default

Constructor for QgsReferencedRectangle.

Member Function Documentation

◆ operator QVariant()

QgsReferencedRectangle::operator QVariant ( ) const
inline

Allows direct construction of QVariants from rectangle.

Definition at line 88 of file qgsreferencedgeometry.h.

◆ operator!=()

bool QgsReferencedRectangle::operator!= ( const QgsReferencedRectangle other)

Definition at line 34 of file qgsreferencedgeometry.cpp.

◆ operator==()

bool QgsReferencedRectangle::operator== ( const QgsReferencedRectangle other)

Definition at line 29 of file qgsreferencedgeometry.cpp.


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