QGIS API Documentation 3.28.0-Firenze (ed3ad0430f)
|
Perform transforms between map coordinates and device coordinates. More...
#include <qgsmaptopixel.h>
Public Member Functions | |
QgsMapToPixel () | |
Constructor for an invalid QgsMapToPixel. More... | |
QgsMapToPixel (double mapUnitsPerPixel) | |
Constructor. More... | |
QgsMapToPixel (double mapUnitsPerPixel, double centerX, double centerY, int widthPixels, int heightPixels, double rotation) | |
Constructor. More... | |
bool | isValid () const |
Returns true if the object is valid (i.e. More... | |
int | mapHeight () const |
Returns current map height in pixels. More... | |
double | mapRotation () const |
Returns the current map rotation in degrees (clockwise). More... | |
double | mapUnitsPerPixel () const |
Returns the current map units per pixel. More... | |
int | mapWidth () const |
Returns the current map width in pixels. More... | |
bool | operator!= (const QgsMapToPixel &other) const |
bool | operator== (const QgsMapToPixel &other) const |
void | setMapRotation (double degrees, double cx, double cy) |
Sets map rotation in degrees (clockwise). More... | |
void | setMapUnitsPerPixel (double mapUnitsPerPixel) |
Sets the map units per pixel. More... | |
void | setParameters (double mapUnitsPerPixel, double centerX, double centerY, int widthPixels, int heightPixels, double rotation) |
Sets parameters for use in transforming coordinates. More... | |
void | setParameters (double mapUnitsPerPixel, double centerX, double centerY, int widthPixels, int heightPixels, double rotation, bool *ok) |
Sets parameters for use in transforming coordinates. More... | |
QString | showParameters () const |
Returns a string representation of the parameters used in the transform. More... | |
QgsPointXY | toMapCoordinates (double x, double y) const |
Transforms device coordinates to map (world) coordinates. More... | |
QgsPointXY | toMapCoordinates (int x, int y) const |
Transforms device coordinates to map (world) coordinates. More... | |
QgsPointXY | toMapCoordinates (QPoint p) const |
Transforms device coordinates to map (world) coordinates. More... | |
Q_DECL_DEPRECATED QgsPointXY | toMapPoint (double x, double y) const |
Transforms device coordinates to map (world) coordinates. More... | |
QTransform | transform () const |
Returns a QTransform encapsulating the map to pixel conversion. More... | |
QgsPointXY | transform (const QgsPointXY &p) const |
Transforms a point p from map (world) coordinates to device coordinates. More... | |
void | transform (QgsPointXY *p) const |
Transforms a point p from map (world) coordinates to device coordinates in place. More... | |
QgsPointXY | transform (qreal x, qreal y) const |
Transforms the point specified by x,y from map (world) coordinates to device coordinates. More... | |
void | transformInPlace (double &x, double &y) const |
Transforms device coordinates to map coordinates. More... | |
void | transformInPlace (float &x, float &y) const |
Transforms device coordinates to map coordinates. More... | |
template<class T > | |
void | transformInPlace (QVector< T > &x, QVector< T > &y) const |
Transforms device coordinates to map coordinates. More... | |
double | xCenter () const |
Returns the center x-coordinate for the transform. More... | |
double | yCenter () const |
Returns the center y-coordinate for the transform. More... | |
Static Public Member Functions | |
static QgsMapToPixel | fromScale (double scale, QgsUnitTypes::DistanceUnit mapUnits, double dpi=96) |
Returns a new QgsMapToPixel created using a specified scale and distance unit. More... | |
Perform transforms between map coordinates and device coordinates.
This class can convert device coordinates to map coordinates and vice versa.
Definition at line 38 of file qgsmaptopixel.h.
QgsMapToPixel::QgsMapToPixel | ( | ) |
Constructor for an invalid QgsMapToPixel.
A manual call to setParameters() is required to initialize the object.
Definition at line 66 of file qgsmaptopixel.cpp.
QgsMapToPixel::QgsMapToPixel | ( | double | mapUnitsPerPixel, |
double | centerX, | ||
double | centerY, | ||
int | widthPixels, | ||
int | heightPixels, | ||
double | rotation | ||
) |
Constructor.
mapUnitsPerPixel | Map units per pixel |
centerX | X coordinate of map center, in geographical units |
centerY | Y coordinate of map center, in geographical units |
widthPixels | Output width, in pixels |
heightPixels | Output height, in pixels |
rotation | clockwise rotation in degrees |
Definition at line 28 of file qgsmaptopixel.cpp.
QgsMapToPixel::QgsMapToPixel | ( | double | mapUnitsPerPixel | ) |
Constructor.
mapUnitsPerPixel | Map units per pixel |
Definition at line 48 of file qgsmaptopixel.cpp.
|
static |
Returns a new QgsMapToPixel created using a specified scale and distance unit.
scale | map scale denominator, e.g. 1000.0 for a 1:1000 map. |
dpi | screen DPI |
mapUnits | map units |
Definition at line 59 of file qgsmaptopixel.cpp.
|
inline |
Returns true
if the object is valid (i.e.
it has parameters set), or false
if the object is default constructed with no parameters set.
Definition at line 83 of file qgsmaptopixel.h.
|
inline |
Returns current map height in pixels.
Definition at line 247 of file qgsmaptopixel.h.
|
inline |
Returns the current map rotation in degrees (clockwise).
Definition at line 269 of file qgsmaptopixel.h.
|
inline |
Returns the current map units per pixel.
Definition at line 229 of file qgsmaptopixel.h.
|
inline |
Returns the current map width in pixels.
The information is only known if setRotation was used.
Definition at line 239 of file qgsmaptopixel.h.
|
inline |
Definition at line 342 of file qgsmaptopixel.h.
|
inline |
Definition at line 329 of file qgsmaptopixel.h.
void QgsMapToPixel::setMapRotation | ( | double | degrees, |
double | cx, | ||
double | cy | ||
) |
Sets map rotation in degrees (clockwise).
Calling this method will automatically set the object as valid.
degrees | clockwise rotation in degrees |
cx | X ordinate of map center in geographical units |
cy | Y ordinate of map center in geographical units |
Definition at line 95 of file qgsmaptopixel.cpp.
void QgsMapToPixel::setMapUnitsPerPixel | ( | double | mapUnitsPerPixel | ) |
Sets the map units per pixel.
Calling this method will automatically set the object as valid.
mapUnitsPerPixel | Map units per pixel |
Definition at line 83 of file qgsmaptopixel.cpp.
void QgsMapToPixel::setParameters | ( | double | mapUnitsPerPixel, |
double | centerX, | ||
double | centerY, | ||
int | widthPixels, | ||
int | heightPixels, | ||
double | rotation | ||
) |
Sets parameters for use in transforming coordinates.
Calling this method will automatically set the object as valid.
mapUnitsPerPixel | Map units per pixel |
centerX | X coordinate of map center, in geographical units |
centerY | Y coordinate of map center, in geographical units |
widthPixels | Output width, in pixels |
heightPixels | Output height, in pixels |
rotation | clockwise rotation in degrees |
Definition at line 168 of file qgsmaptopixel.cpp.
void QgsMapToPixel::setParameters | ( | double | mapUnitsPerPixel, |
double | centerX, | ||
double | centerY, | ||
int | widthPixels, | ||
int | heightPixels, | ||
double | rotation, | ||
bool * | ok | ||
) |
Sets parameters for use in transforming coordinates.
Calling this method will automatically set the object as valid.
mapUnitsPerPixel | Map units per pixel |
centerX | X coordinate of map center, in geographical units |
centerY | Y coordinate of map center, in geographical units |
widthPixels | Output width, in pixels |
heightPixels | Output height, in pixels |
rotation | clockwise rotation in degrees |
ok | will be set to true if the specified parameters result in a valid transform, otherwise the changes are ignored and ok will be set to false . |
Definition at line 122 of file qgsmaptopixel.cpp.
QString QgsMapToPixel::showParameters | ( | ) | const |
Returns a string representation of the parameters used in the transform.
Definition at line 180 of file qgsmaptopixel.cpp.
|
inline |
Transforms device coordinates to map (world) coordinates.
Definition at line 181 of file qgsmaptopixel.h.
|
inline |
Transforms device coordinates to map (world) coordinates.
Definition at line 173 of file qgsmaptopixel.h.
|
inline |
Transforms device coordinates to map (world) coordinates.
p | Point to be converted to map cooordinates |
Definition at line 197 of file qgsmaptopixel.h.
|
inline |
Transforms device coordinates to map (world) coordinates.
Definition at line 208 of file qgsmaptopixel.h.
QTransform QgsMapToPixel::transform | ( | ) | const |
Returns a QTransform encapsulating the map to pixel conversion.
Definition at line 190 of file qgsmaptopixel.cpp.
|
inline |
Transforms a point p from map (world) coordinates to device coordinates.
p | Point to transform |
Definition at line 90 of file qgsmaptopixel.h.
|
inline |
Transforms a point p from map (world) coordinates to device coordinates in place.
Definition at line 101 of file qgsmaptopixel.h.
|
inline |
Transforms the point specified by x,y from map (world) coordinates to device coordinates.
x | x coordinate of point to transform |
y | y coordinate of point to transform |
Definition at line 116 of file qgsmaptopixel.h.
|
inline |
Transforms device coordinates to map coordinates.
This method modifies the given coordinates in place. It is intended as a fast way to do the transform.
Definition at line 128 of file qgsmaptopixel.h.
|
inline |
Transforms device coordinates to map coordinates.
This method modifies the given coordinates in place. It is intended as a fast way to do the transform.
Definition at line 144 of file qgsmaptopixel.h.
|
inline |
Transforms device coordinates to map coordinates.
This method modifies the given coordinates in place. It is intended as a fast way to do the transform.
Definition at line 162 of file qgsmaptopixel.h.
|
inline |
Returns the center x-coordinate for the transform.
Definition at line 320 of file qgsmaptopixel.h.
|
inline |
Returns the center y-coordinate for the transform.
Definition at line 327 of file qgsmaptopixel.h.