Class for doing transforms between two map coordinate systems. More...

#include <qgscoordinatetransform.h>

Public Types
enum	TransformDirection { ForwardTransform, ReverseTransform }
	Enum used to indicate the direction (forward or inverse) of the transform. More...

Public Slots
void	initialise ()
	initialise is used to actually create the Transformer instance
bool	readXML (QDomNode &theNode)
bool	writeXML (QDomNode &theNode, QDomDocument &theDoc)

Signals
void	invalidTransformInput () const
	Signal when an invalid pj_transform() has occured.

Public Member Functions
	QgsCoordinateTransform ()
	QgsCoordinateTransform (const QgsCoordinateReferenceSystem &theSource, const QgsCoordinateReferenceSystem &theDest)
	Constructs a QgsCoordinateTransform using QgsCoordinateReferenceSystem objects.
	QgsCoordinateTransform (long theSourceSrsId, long theDestSrsId)
	Constructs a QgsCoordinateTransform using CRS ID of source and destination CRS.
	QgsCoordinateTransform (QString theSourceWkt, QString theDestWkt)
	QgsCoordinateTransform (long theSourceSrid, QString theDestWkt, QgsCoordinateReferenceSystem::CrsType theSourceCRSType=QgsCoordinateReferenceSystem::PostgisCrsId)
	~QgsCoordinateTransform ()
	destructor
QgsCoordinateTransform *	clone () const
const QgsCoordinateReferenceSystem &	destCRS () const
int	destinationDatumTransform () const
bool	isInitialised () const
bool	isShortCircuited ()
void	setDestCRS (const QgsCoordinateReferenceSystem &theCRS)
void	setDestCRSID (long theCRSID)
void	setDestinationDatumTransform (int dt)
void	setSourceCrs (const QgsCoordinateReferenceSystem &theCRS)
void	setSourceDatumTransform (int dt)
const QgsCoordinateReferenceSystem &	sourceCrs () const
int	sourceDatumTransform () const
QgsPoint	transform (const QgsPoint &p, TransformDirection direction=ForwardTransform) const
QgsPoint	transform (const double x, const double y, TransformDirection direction=ForwardTransform) const
QgsRectangle	transform (const QgsRectangle &theRect, TransformDirection direction=ForwardTransform) const
QgsRectangle	transformBoundingBox (const QgsRectangle &theRect, TransformDirection direction=ForwardTransform, const bool handle180Crossover=false) const
void	transformCoords (const int &numPoint, double x, double y, double *z, TransformDirection direction=ForwardTransform) const
void	transformInPlace (double &x, double &y, double &z, TransformDirection direction=ForwardTransform) const
void	transformInPlace (QVector< double > &x, QVector< double > &y, QVector< double > &z, TransformDirection direction=ForwardTransform) const
void	transformPolygon (QPolygonF &poly, TransformDirection direction=ForwardTransform) const

Static Public Member Functions
static QList< QList< int > >	datumTransformations (const QgsCoordinateReferenceSystem &srcCRS, const QgsCoordinateReferenceSystem &destCRS)
	Returns list of datum transformations for the given src and dest CRS.
static bool	datumTransformCrsInfo (int datumTransform, int &epsgNr, QString &srcProjection, QString &dstProjection, QString &remarks, QString &scope, bool &preferred, bool &deprecated)
	Gets name of source and dest geographical CRS (to show in a tooltip)
static QString	datumTransformString (int datumTransform)

Detailed Description

Class for doing transforms between two map coordinate systems.

This class can convert map coordinates to a different coordinate reference system. It is normally associated with a map layer and is used to transform between the layer's coordinate system and the coordinate system of the map canvas, although it can be used in a more general sense to transform coordinates.

All references to source and destination coordinate systems refer to layer and map canvas respectively. All operations are from the perspective of the layer. For example, a forward transformation transforms coordinates from the layers coordinate system to the map canvas.

Definition at line 52 of file qgscoordinatetransform.h.

Member Enumeration Documentation

enum QgsCoordinateTransform::TransformDirection

Enum used to indicate the direction (forward or inverse) of the transform.

Enumerator:

ForwardTransform	Transform from source to destination CRS.
ReverseTransform	Transform from destination to source CRS.

Definition at line 94 of file qgscoordinatetransform.h.

Constructor & Destructor Documentation

QgsCoordinateTransform::QgsCoordinateTransform ( )

Default constructor. Make sure you use initialised() manually if you use this one!

Definition at line 40 of file qgscoordinatetransform.cpp.

QgsCoordinateTransform::QgsCoordinateTransform	(	const QgsCoordinateReferenceSystem &	theSource,
		const QgsCoordinateReferenceSystem &	theDest
	)

Constructs a QgsCoordinateTransform using QgsCoordinateReferenceSystem objects.

Parameters

theSource	CRS, typically of the layer's coordinate system
theDest	CRS, typically of the map canvas coordinate system

Definition at line 52 of file qgscoordinatetransform.cpp.

QgsCoordinateTransform::QgsCoordinateTransform	(	long	theSourceSrsId,
		long	theDestSrsId
	)

Constructs a QgsCoordinateTransform using CRS ID of source and destination CRS.

Definition at line 67 of file qgscoordinatetransform.cpp.

QgsCoordinateTransform::QgsCoordinateTransform	(	QString	theSourceWkt,
		QString	theDestWkt
	)

Constructs a QgsCoordinateTransform using the Well Known Text representation of the layer and map canvas coordinate systems

Parameters

theSourceWkt	Wkt, typically of the layer's coordinate system
theDestWkt	Wkt, typically of the map canvas coordinate system

Definition at line 80 of file qgscoordinatetransform.cpp.

QgsCoordinateTransform::QgsCoordinateTransform	(	long	theSourceSrid,
		QString	theDestWkt,
		QgsCoordinateReferenceSystem::CrsType	theSourceCRSType = `QgsCoordinateReferenceSystem::PostgisCrsId`
	)

Constructs a QgsCoordinateTransform using a Spatial Reference Id of the layer and map canvas coordinate system as Wkt

Parameters

theSourceSrid	Spatial Ref Id of the layer's coordinate system
theDestWkt	Wkt of the map canvas coordinate system
theSourceCRSType	On of the enum members defined in QgsCoordinateReferenceSystem::CrsType

Definition at line 98 of file qgscoordinatetransform.cpp.

QgsCoordinateTransform::~QgsCoordinateTransform ( )

destructor

Definition at line 119 of file qgscoordinatetransform.cpp.

Member Function Documentation

QgsCoordinateTransform * QgsCoordinateTransform::clone ( ) const

Definition at line 132 of file qgscoordinatetransform.cpp.

QList< QList< int > > QgsCoordinateTransform::datumTransformations	(	const QgsCoordinateReferenceSystem &	srcCRS,
		const QgsCoordinateReferenceSystem &	destCRS
	)

static

Returns list of datum transformations for the given src and dest CRS.

Note: not available in python bindings

Definition at line 811 of file qgscoordinatetransform.cpp.

bool QgsCoordinateTransform::datumTransformCrsInfo	(	int	datumTransform,
		int &	epsgNr,
		QString &	srcProjection,
		QString &	dstProjection,
		QString &	remarks,
		QString &	scope,
		bool &	preferred,
		bool &	deprecated
	)

static

Gets name of source and dest geographical CRS (to show in a tooltip)

Returns: epsgNr epsg code of the transformation (or 0 if not in epsg db)

Definition at line 980 of file qgscoordinatetransform.cpp.

QString QgsCoordinateTransform::datumTransformString ( int datumTransform )

static

Definition at line 926 of file qgscoordinatetransform.cpp.

const QgsCoordinateReferenceSystem& QgsCoordinateTransform::destCRS ( ) const

inline

Get the QgsCoordinateReferenceSystem representation of the map canvas coordinate system

Returns: QgsCoordinateReferenceSystem of the map canvas coordinate system

Definition at line 122 of file qgscoordinatetransform.h.

int QgsCoordinateTransform::destinationDatumTransform ( ) const

inline

Definition at line 232 of file qgscoordinatetransform.h.

void QgsCoordinateTransform::initialise ( )

slot

initialise is used to actually create the Transformer instance

Definition at line 161 of file qgscoordinatetransform.cpp.

void QgsCoordinateTransform::invalidTransformInput ( ) const

signal

Signal when an invalid pj_transform() has occured.

bool QgsCoordinateTransform::isInitialised ( ) const

inline

Flag to indicate whether the coordinate systems have been initialised

Returns: true if initialised, otherwise false

Definition at line 203 of file qgscoordinatetransform.h.

bool QgsCoordinateTransform::isShortCircuited ( )

inline

See if the transform short circuits because src and dest are equivalent

Returns: bool True if it short circuits

Definition at line 208 of file qgscoordinatetransform.h.

bool QgsCoordinateTransform::readXML ( QDomNode & theNode )

slot

Restores state from the given Dom node.

Parameters

theNode The node from which state will be restored

Returns: bool True on success, False on failure

Definition at line 744 of file qgscoordinatetransform.cpp.

void QgsCoordinateTransform::setDestCRS ( const QgsCoordinateReferenceSystem & theCRS )

Mutator for dest QgsCoordinateReferenceSystem

Parameters

theCRS of the destination coordinate system

Definition at line 146 of file qgscoordinatetransform.cpp.

void QgsCoordinateTransform::setDestCRSID ( long theCRSID )

Change the destination coordinate system by passing it a qgis srsid A QGIS srsid is a unique key value to an entry on the tbl_srs in the srs.db sqlite database.

Note: This slot will usually be called if the project properties change and a different coordinate system is selected.; This coord transform will be reinitialised when this slot is called to check if short circuiting is needed or not etc.

Parameters

theCRSID - A long representing the srsid of the srs to be used

todo Add some logic here to determine if the srsid is a system or user one

Definition at line 152 of file qgscoordinatetransform.cpp.

void QgsCoordinateTransform::setDestinationDatumTransform ( int dt )

inline

Definition at line 233 of file qgscoordinatetransform.h.

void QgsCoordinateTransform::setSourceCrs ( const QgsCoordinateReferenceSystem & theCRS )

Set the source (layer) QgsCoordinateReferenceSystem

Parameters

theCRS QgsCoordinateReferenceSystem representation of the layer's coordinate system

Definition at line 141 of file qgscoordinatetransform.cpp.

void QgsCoordinateTransform::setSourceDatumTransform ( int dt )

inline

Definition at line 231 of file qgscoordinatetransform.h.

const QgsCoordinateReferenceSystem& QgsCoordinateTransform::sourceCrs ( ) const

inline

Get the QgsCoordinateReferenceSystem representation of the layer's coordinate system

Returns: QgsCoordinateReferenceSystem of the layer's coordinate system

Definition at line 116 of file qgscoordinatetransform.h.

int QgsCoordinateTransform::sourceDatumTransform ( ) const

inline

Definition at line 230 of file qgscoordinatetransform.h.

QgsPoint QgsCoordinateTransform::transform	(	const QgsPoint &	p,
		TransformDirection	direction = `ForwardTransform`
	)		const

Transform the point from Source Coordinate System to Destination Coordinate System If the direction is ForwardTransform then coordinates are transformed from layer CS –> map canvas CS, otherwise points are transformed from map canvas CS to layerCS.

Parameters

p	Point to transform
direction	TransformDirection (defaults to ForwardTransform)

Returns: QgsPoint in Destination Coordinate System

Definition at line 278 of file qgscoordinatetransform.cpp.

QgsPoint QgsCoordinateTransform::transform	(	const double	x,
		const double	y = `0.0`,
		TransformDirection	direction = `ForwardTransform`
	)		const

Transform the point specified by x,y from Source Coordinate System to Destination Coordinate System If the direction is ForwardTransform then coordinates are transformed from layer CS –> map canvas CS, otherwise points are transformed from map canvas CS to layerCS.

Parameters

x	x cordinate of point to transform
y	y coordinate of point to transform
direction	TransformDirection (defaults to ForwardTransform)

Returns: QgsPoint in Destination Coordinate System

Definition at line 301 of file qgscoordinatetransform.cpp.

QgsRectangle QgsCoordinateTransform::transform	(	const QgsRectangle &	theRect,
		TransformDirection	direction = `ForwardTransform`
	)		const

Transform a QgsRectangle to the dest Coordinate system If the direction is ForwardTransform then coordinates are transformed from layer CS –> map canvas CS, otherwise points are transformed from map canvas CS to layerCS.

Parameters

theRect	rect to transform
direction	TransformDirection (defaults to ForwardTransform)

Returns: QgsRectangle in Destination Coordinate System

Definition at line 315 of file qgscoordinatetransform.cpp.

QgsRectangle QgsCoordinateTransform::transformBoundingBox	(	const QgsRectangle &	theRect,
		TransformDirection	direction = `ForwardTransform`,
		const bool	handle180Crossover = `false`
	)		const

Transform a QgsRectangle to the dest Coordinate system If the direction is ForwardTransform then coordinates are transformed from layer CS –> map canvas CS, otherwise points are transformed from map canvas CS to layerCS. It assumes that rect is a bounding box, and creates a bounding box in the proejcted CS, so that all points in source rectangle is within returned rectangle.

Parameters

theRect	rect to transform
direction	TransformDirection (defaults to ForwardTransform)
handle180Crossover	set to true if destination crs is geographic and handling of extents crossing the 180 degree longitude line is required

Returns: QgsRectangle in Destination Coordinate System

Definition at line 525 of file qgscoordinatetransform.cpp.

void QgsCoordinateTransform::transformCoords	(	const int &	numPoint,
		double *	x,
		double *	y,
		double *	z,
		TransformDirection	direction = `ForwardTransform`
	)		const

Transform an array of coordinates to a different Coordinate System If the direction is ForwardTransform then coordinates are transformed from layer CS –> map canvas CS, otherwise points are transformed from map canvas CS to layerCS.

Parameters

numPoint	number of coordinates in arrays
x	array of x coordinates to transform
y	array of y coordinates to transform
z	array of z coordinates to transform
direction	TransformDirection (defaults to ForwardTransform)

Returns: QgsRectangle in Destination Coordinate System

Definition at line 632 of file qgscoordinatetransform.cpp.

void QgsCoordinateTransform::transformInPlace	(	double &	x,
		double &	y,
		double &	z,
		TransformDirection	direction = `ForwardTransform`
	)		const

Definition at line 351 of file qgscoordinatetransform.cpp.

void QgsCoordinateTransform::transformInPlace	(	QVector< double > &	x,
		QVector< double > &	y,
		QVector< double > &	z,
		TransformDirection	direction = `ForwardTransform`
	)		const