QGIS API Documentation 3.28.0-Firenze (ed3ad0430f)
Public Types | Public Member Functions | List of all members
QgsGcpPoint Class Reference

Contains properties of a ground control point (GCP). More...

#include <qgsgcppoint.h>

Public Types

enum class  PointType { Source , Destination }
 Coordinate point types. More...
 

Public Member Functions

 QgsGcpPoint (const QgsPointXY &sourcePoint, const QgsPointXY &destinationPoint, const QgsCoordinateReferenceSystem &destinationPointCrs, bool enabled=true)
 Constructor for QgsGcpPoint. More...
 
QgsPointXY destinationPoint () const
 Returns the destination coordinates. More...
 
QgsCoordinateReferenceSystem destinationPointCrs () const
 Returns the CRS of the destination point. More...
 
bool isEnabled () const
 Returns true if the point is currently enabled. More...
 
bool operator!= (const QgsGcpPoint &other) const
 
bool operator== (const QgsGcpPoint &other) const
 
void setDestinationPoint (QgsPointXY point)
 Sets the destination coordinates. More...
 
void setDestinationPointCrs (const QgsCoordinateReferenceSystem &crs)
 Sets the crs of the destination point. More...
 
void setEnabled (bool enabled)
 Sets whether the point is currently enabled. More...
 
void setSourcePoint (QgsPointXY point)
 Sets the source coordinates. More...
 
QgsPointXY sourcePoint () const
 Returns the source coordinates. More...
 
QgsPointXY transformedDestinationPoint (const QgsCoordinateReferenceSystem &targetCrs, const QgsCoordinateTransformContext &context) const
 Returns the destionationPoint() transformed to the given target CRS. More...
 

Detailed Description

Contains properties of a ground control point (GCP).

Since
QGIS 3.26

Definition at line 30 of file qgsgcppoint.h.

Member Enumeration Documentation

◆ PointType

enum class QgsGcpPoint::PointType
strong

Coordinate point types.

Enumerator
Source 

Source point.

Destination 

Destination point.

Definition at line 35 of file qgsgcppoint.h.

Constructor & Destructor Documentation

◆ QgsGcpPoint()

QgsGcpPoint::QgsGcpPoint ( const QgsPointXY sourcePoint,
const QgsPointXY destinationPoint,
const QgsCoordinateReferenceSystem destinationPointCrs,
bool  enabled = true 
)

Constructor for QgsGcpPoint.

Parameters
sourcePointsource coordinates. This may either be in pixels (for completely non-referenced images) OR in the source layer CRS.
destinationPointdestination coordinates
destinationPointCrsCRS of destination point
enabledwhether the point is currently enabled

Definition at line 21 of file qgsgcppoint.cpp.

Member Function Documentation

◆ destinationPoint()

QgsPointXY QgsGcpPoint::destinationPoint ( ) const
inline

Returns the destination coordinates.

See also
setDestinationPoint()

Definition at line 75 of file qgsgcppoint.h.

◆ destinationPointCrs()

QgsCoordinateReferenceSystem QgsGcpPoint::destinationPointCrs ( ) const

Returns the CRS of the destination point.

See also
setDestinationPointCrs()

Definition at line 30 of file qgsgcppoint.cpp.

◆ isEnabled()

bool QgsGcpPoint::isEnabled ( ) const
inline

Returns true if the point is currently enabled.

See also
setEnabled()

Definition at line 108 of file qgsgcppoint.h.

◆ operator!=()

bool QgsGcpPoint::operator!= ( const QgsGcpPoint other) const
inline

Definition at line 126 of file qgsgcppoint.h.

◆ operator==()

bool QgsGcpPoint::operator== ( const QgsGcpPoint other) const
inline

Definition at line 118 of file qgsgcppoint.h.

◆ setDestinationPoint()

void QgsGcpPoint::setDestinationPoint ( QgsPointXY  point)
inline

Sets the destination coordinates.

See also
destinationPoint()

Definition at line 82 of file qgsgcppoint.h.

◆ setDestinationPointCrs()

void QgsGcpPoint::setDestinationPointCrs ( const QgsCoordinateReferenceSystem crs)

Sets the crs of the destination point.

See also
destinationPointCrs()

Definition at line 35 of file qgsgcppoint.cpp.

◆ setEnabled()

void QgsGcpPoint::setEnabled ( bool  enabled)
inline

Sets whether the point is currently enabled.

See also
isEnabled()

Definition at line 115 of file qgsgcppoint.h.

◆ setSourcePoint()

void QgsGcpPoint::setSourcePoint ( QgsPointXY  point)
inline

Sets the source coordinates.

This may either be in pixels (for completely non-referenced images) OR in the source layer CRS.

See also
sourcePoint()

Definition at line 68 of file qgsgcppoint.h.

◆ sourcePoint()

QgsPointXY QgsGcpPoint::sourcePoint ( ) const
inline

Returns the source coordinates.

This may either be in pixels (for completely non-referenced images) OR in the source layer CRS.

See also
setSourcePoint()

Definition at line 59 of file qgsgcppoint.h.

◆ transformedDestinationPoint()

QgsPointXY QgsGcpPoint::transformedDestinationPoint ( const QgsCoordinateReferenceSystem targetCrs,
const QgsCoordinateTransformContext context 
) const

Returns the destionationPoint() transformed to the given target CRS.

Definition at line 40 of file qgsgcppoint.cpp.


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