QGIS API Documentation  2.5.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
QgsMapSettings Class Reference

The QgsMapSettings class contains configuration for rendering of the map. More...

#include <qgsmapsettings.h>

Collaboration diagram for QgsMapSettings:
Collaboration graph
[legend]

Public Types

enum  Flag {
  Antialiasing = 0x01, DrawEditingInfo = 0x02, ForceVectorOutput = 0x04, UseAdvancedEffects = 0x08,
  DrawLabeling = 0x10, UseRenderingOptimization = 0x20, DrawSelection = 0x40
}
 Enumeration of flags that adjust the way how map is rendered. More...
 

Public Member Functions

 QgsMapSettings ()
 
QgsRectangle extent () const
 Return geographical coordinates of the rectangle that should be rendered. More...
 
void setExtent (const QgsRectangle &rect)
 Set coordinates of the rectangle which should be rendered. More...
 
QSize outputSize () const
 Return the size of the resulting map image. More...
 
void setOutputSize (const QSize &size)
 Set the size of the resulting map image. More...
 
int outputDpi () const
 Return DPI used for conversion between real world units (e.g. More...
 
void setOutputDpi (int dpi)
 Set DPI used for conversion between real world units (e.g. mm) and pixels. More...
 
QStringList layers () const
 Get list of layer IDs for map rendering The layers are stored in the reverse order of how they are rendered (layer with index 0 will be on top) More...
 
void setLayers (const QStringList &layers)
 Set list of layer IDs for map rendering. More...
 
void setCrsTransformEnabled (bool enabled)
 sets whether to use projections for this layer set More...
 
bool hasCrsTransformEnabled () const
 returns true if projections are enabled for this layer set More...
 
void setDestinationCrs (const QgsCoordinateReferenceSystem &crs)
 sets destination coordinate reference system More...
 
const
QgsCoordinateReferenceSystem
destinationCrs () const
 returns CRS of destination coordinate reference system More...
 
QGis::UnitType mapUnits () const
 Get units of map's geographical coordinates - used for scale calculation. More...
 
void setMapUnits (QGis::UnitType u)
 Set units of map's geographical coordinates - used for scale calculation. More...
 
void setBackgroundColor (const QColor &color)
 Set the background color of the map. More...
 
QColor backgroundColor () const
 Get the background color of the map. More...
 
void setSelectionColor (const QColor &color)
 Set color that is used for drawing of selected vector features. More...
 
QColor selectionColor () const
 Get color that is used for drawing of selected vector features. More...
 
void setFlags (Flags flags)
 Set combination of flags that will be used for rendering. More...
 
void setFlag (Flag flag, bool on=true)
 Enable or disable a particular flag (other flags are not affected) More...
 
Flags flags () const
 Return combination of flags used for rendering. More...
 
bool testFlag (Flag flag) const
 Check whether a particular flag is enabled. More...
 
void setOutputImageFormat (QImage::Format format)
 sets format of internal QImage More...
 
QImage::Format outputImageFormat () const
 format of internal QImage, default QImage::Format_ARGB32_Premultiplied More...
 
bool hasValidSettings () const
 Check whether the map settings are valid and can be used for rendering. More...
 
QgsRectangle visibleExtent () const
 Return the actual extent derived from requested extent that takes takes output image size into account. More...
 
double mapUnitsPerPixel () const
 Return the distance in geographical coordinates that equals to one pixel in the map. More...
 
double scale () const
 Return the calculated scale of the map. More...
 
const QgsDatumTransformStoredatumTransformStore () const
 
QgsDatumTransformStoredatumTransformStore ()
 
const QgsMapToPixelmapToPixel () const
 
QgsRectangle layerExtentToOutputExtent (QgsMapLayer *theLayer, QgsRectangle extent) const
 transform bounding box from layer's CRS to output CRS More...
 
QgsRectangle outputExtentToLayerExtent (QgsMapLayer *theLayer, QgsRectangle extent) const
 transform bounding box from output CRS to layer's CRS More...
 
QgsPoint layerToMapCoordinates (QgsMapLayer *theLayer, QgsPoint point) const
 transform point coordinates from layer's CRS to output CRS More...
 
QgsRectangle layerToMapCoordinates (QgsMapLayer *theLayer, QgsRectangle rect) const
 transform rectangle from layer's CRS to output CRS More...
 
QgsPoint mapToLayerCoordinates (QgsMapLayer *theLayer, QgsPoint point) const
 transform point coordinates from output CRS to layer's CRS More...
 
QgsRectangle mapToLayerCoordinates (QgsMapLayer *theLayer, QgsRectangle rect) const
 transform rectangle from output CRS to layer's CRS More...
 
const QgsCoordinateTransformlayerTransfrom (QgsMapLayer *layer) const
 Return coordinate transform from layer's CRS to destination CRS. More...
 
QgsRectangle fullExtent () const
 returns current extent of layer set More...
 
void readXML (QDomNode &theNode)
 
void writeXML (QDomNode &theNode, QDomDocument &theDoc)
 

Protected Member Functions

void updateDerived ()
 

Protected Attributes

int mDpi
 
QSize mSize
 
QgsRectangle mExtent
 
QStringList mLayers
 
bool mProjectionsEnabled
 
QgsCoordinateReferenceSystem mDestCRS
 
QgsDatumTransformStore mDatumTransformStore
 
QColor mBackgroundColor
 
QColor mSelectionColor
 
Flags mFlags
 
QImage::Format mImageFormat
 
bool mValid
 whether the actual settings are valid (set in updateDerived()) More...
 
QgsRectangle mVisibleExtent
 extent with some additional white space that matches the output aspect ratio More...
 
double mMapUnitsPerPixel
 
double mScale
 
QgsScaleCalculator mScaleCalculator
 
QgsMapToPixel mMapToPixel
 

Detailed Description

The QgsMapSettings class contains configuration for rendering of the map.

The rendering itself is done by QgsMapRendererJob subclasses.

In order to set up QgsMapSettings instance, it is necessary to set at least few members: extent, output size and layers.

QgsMapSettings and QgsMapRendererJob (+subclasses) are intended to replace QgsMapRenderer class that existed before QGIS 2.4. The advantage of the new classes is that they separate the settings from the rendering and provide asynchronous API for map rendering.

Note
added in 2.4

Definition at line 52 of file qgsmapsettings.h.

Member Enumeration Documentation

Enumeration of flags that adjust the way how map is rendered.

Enumerator
Antialiasing 

Enable anti-aliasin for map rendering.

DrawEditingInfo 

Enable drawing of vertex markers for layers in editing mode.

ForceVectorOutput 

Vector graphics should not be cached and drawn as raster images.

UseAdvancedEffects 

Enable layer transparency and blending effects.

DrawLabeling 

Enable drawing of labels on top of the map.

UseRenderingOptimization 

Enable vector simplification and other rendering optimizations.

DrawSelection 

Whether vector selections should be shown in the rendered map.

Definition at line 112 of file qgsmapsettings.h.

Constructor & Destructor Documentation

QgsMapSettings::QgsMapSettings ( )

Definition at line 33 of file qgsmapsettings.cpp.

References QGis::Degrees, setMapUnits(), and updateDerived().

Member Function Documentation

QColor QgsMapSettings::backgroundColor ( ) const
inline

Get the background color of the map.

Definition at line 104 of file qgsmapsettings.h.

Referenced by QgsMapRendererJob::composeImage(), and QgsMapRendererCustomPainterJob::start().

const QgsDatumTransformStore& QgsMapSettings::datumTransformStore ( ) const
inline
QgsDatumTransformStore& QgsMapSettings::datumTransformStore ( )
inline

Definition at line 152 of file qgsmapsettings.h.

const QgsCoordinateReferenceSystem & QgsMapSettings::destinationCrs ( ) const
QgsRectangle QgsMapSettings::extent ( ) const

Return geographical coordinates of the rectangle that should be rendered.

The actual visible extent used for rendering could be slightly different since the given extent may be expanded in order to fit the aspect ratio of output size. Use visibleExtent() to get the resulting extent.

Definition at line 52 of file qgsmapsettings.cpp.

References mExtent.

Referenced by fullExtent(), layerExtentToOutputExtent(), QgsMapCanvasRendererSync::onExtentC2R(), outputExtentToLayerExtent(), QgsMapCanvas::readProject(), QgsMapRenderer::readXML(), QgsRenderChecker::runTest(), setExtent(), updateDerived(), and writeXML().

QgsMapSettings::Flags QgsMapSettings::flags ( ) const

Return combination of flags used for rendering.

Definition at line 237 of file qgsmapsettings.cpp.

References mFlags.

Referenced by QgsComposerMap::draw(), and setFlags().

QgsRectangle QgsMapSettings::fullExtent ( ) const
bool QgsMapSettings::hasCrsTransformEnabled ( ) const
bool QgsMapSettings::hasValidSettings ( ) const

Check whether the map settings are valid and can be used for rendering.

Definition at line 253 of file qgsmapsettings.cpp.

References mValid.

Referenced by QgsMapOverviewCanvas::refresh(), QgsMapCanvas::refresh(), and QgsMapOverviewCanvas::updateFullExtent().

QgsRectangle QgsMapSettings::layerExtentToOutputExtent ( QgsMapLayer theLayer,
QgsRectangle  extent 
) const

transform bounding box from layer's CRS to output CRS

See also
layerToMapCoordinates( QgsMapLayer* theLayer, QgsRectangle rect ) if you want to transform a rectangle
Returns
a bounding box (aligned rectangle) containing the transformed extent

Definition at line 284 of file qgsmapsettings.cpp.

References extent(), hasCrsTransformEnabled(), layerTransfrom(), QgsMessageLog::logMessage(), QgsDebugMsg, QgsRectangle::toString(), and QgsException::what().

Referenced by fullExtent(), QgsMapCanvas::panToSelected(), QgsLayerTreeViewDefaultActions::zoomToLayers(), and QgsMapCanvas::zoomToSelected().

QStringList QgsMapSettings::layers ( ) const
QgsPoint QgsMapSettings::layerToMapCoordinates ( QgsMapLayer theLayer,
QgsPoint  point 
) const
QgsRectangle QgsMapSettings::layerToMapCoordinates ( QgsMapLayer theLayer,
QgsRectangle  rect 
) const

transform rectangle from layer's CRS to output CRS

See also
layerExtentToOutputExtent() if you want to transform a bounding box
Returns
the transformed rectangle

Definition at line 358 of file qgsmapsettings.cpp.

References QgsCoordinateTransform::ForwardTransform, hasCrsTransformEnabled(), layerTransfrom(), QgsMessageLog::logMessage(), and QgsException::what().

const QgsCoordinateTransform * QgsMapSettings::layerTransfrom ( QgsMapLayer layer) const

Return coordinate transform from layer's CRS to destination CRS.

Parameters
layer
Returns
transform - may be null if the transform is not needed

Definition at line 277 of file qgsmapsettings.cpp.

References mDatumTransformStore, and QgsDatumTransformStore::transformation().

Referenced by QgsMapRendererJob::drawOldLabeling(), QgsHighlight::init(), layerExtentToOutputExtent(), layerToMapCoordinates(), mapToLayerCoordinates(), outputExtentToLayerExtent(), and QgsMapRendererJob::prepareJobs().

QgsPoint QgsMapSettings::mapToLayerCoordinates ( QgsMapLayer theLayer,
QgsPoint  point 
) const
QgsRectangle QgsMapSettings::mapToLayerCoordinates ( QgsMapLayer theLayer,
QgsRectangle  rect 
) const

transform rectangle from output CRS to layer's CRS

See also
outputExtentToLayerExtent() if you want to transform a bounding box
Returns
the transformed rectangle

Definition at line 402 of file qgsmapsettings.cpp.

References hasCrsTransformEnabled(), layerTransfrom(), QgsMessageLog::logMessage(), QgsCoordinateTransform::ReverseTransform, and QgsException::what().

const QgsMapToPixel& QgsMapSettings::mapToPixel ( ) const
inline
QGis::UnitType QgsMapSettings::mapUnits ( ) const
double QgsMapSettings::mapUnitsPerPixel ( ) const

Return the distance in geographical coordinates that equals to one pixel in the map.

Definition at line 263 of file qgsmapsettings.cpp.

References mMapUnitsPerPixel.

Referenced by QgsTolerance::computeMapUnitPerPixel(), QgsMapCanvas::mapUnitsPerPixel(), QgsRenderChecker::runTest(), and updateDerived().

int QgsMapSettings::outputDpi ( ) const

Return DPI used for conversion between real world units (e.g.

mm) and pixels Default value is 96

Definition at line 170 of file qgsmapsettings.cpp.

References mDpi.

Referenced by QgsRenderContext::fromMapSettings(), QgsMapCanvas::QgsMapCanvas(), QgsMapCanvas::resizeEvent(), QgsMapCanvasItem::setRenderContextVariables(), and QgsMapRendererCustomPainterJob::start().

QgsRectangle QgsMapSettings::outputExtentToLayerExtent ( QgsMapLayer theLayer,
QgsRectangle  extent 
) const

transform bounding box from output CRS to layer's CRS

See also
mapToLayerCoordinates( QgsMapLayer* theLayer,QgsRectangle rect ) if you want to transform a rectangle
Returns
a bounding box (aligned rectangle) containing the transformed extent

Definition at line 310 of file qgsmapsettings.cpp.

References extent(), hasCrsTransformEnabled(), layerTransfrom(), QgsMessageLog::logMessage(), QgsDebugMsg, QgsCoordinateTransform::ReverseTransform, QgsRectangle::toString(), and QgsException::what().

QImage::Format QgsMapSettings::outputImageFormat ( ) const
inline

format of internal QImage, default QImage::Format_ARGB32_Premultiplied

Definition at line 137 of file qgsmapsettings.h.

Referenced by QgsMapRendererJob::composeImage(), QgsComposerMap::draw(), QgsMapRendererJob::prepareJobs(), and QgsMapRendererSequentialJob::QgsMapRendererSequentialJob().

QSize QgsMapSettings::outputSize ( ) const
void QgsMapSettings::readXML ( QDomNode &  theNode)
double QgsMapSettings::scale ( ) const
QColor QgsMapSettings::selectionColor ( ) const
inline

Get color that is used for drawing of selected vector features.

Definition at line 109 of file qgsmapsettings.h.

Referenced by QgsRenderContext::fromMapSettings().

void QgsMapSettings::setBackgroundColor ( const QColor &  color)
inline

Set the background color of the map.

Definition at line 102 of file qgsmapsettings.h.

Referenced by QgsComposerMap::draw(), QgsRenderChecker::runTest(), QgsMapOverviewCanvas::setBackgroundColor(), and QgsMapCanvas::setCanvasColor().

void QgsMapSettings::setCrsTransformEnabled ( bool  enabled)
void QgsMapSettings::setDestinationCrs ( const QgsCoordinateReferenceSystem crs)
void QgsMapSettings::setExtent ( const QgsRectangle rect)

Set coordinates of the rectangle which should be rendered.

The actual visible extent used for rendering could be slightly different since the given extent may be expanded in order to fit the aspect ratio of output size. Use visibleExtent() to get the resulting extent.

Definition at line 57 of file qgsmapsettings.cpp.

References extent(), mExtent, and updateDerived().

Referenced by QgsComposerMap::draw(), QgsComposerMapGrid::drawGrid(), QgsComposerMapOverview::drawOverview(), QgsMapRenderer::mapSettings(), QgsDxfPalLabeling::QgsDxfPalLabeling(), readXML(), QgsMapCanvas::setExtent(), QgsMapOverviewCanvas::updateFullExtent(), QgsMapRenderer::writeXML(), QgsMapCanvas::zoomToNextExtent(), and QgsMapCanvas::zoomToPreviousExtent().

void QgsMapSettings::setFlag ( QgsMapSettings::Flag  flag,
bool  on = true 
)

Enable or disable a particular flag (other flags are not affected)

Definition at line 229 of file qgsmapsettings.cpp.

References mFlags.

Referenced by QgsComposerMap::draw(), QgsMapCanvas::enableAntiAliasing(), QgsMapCanvas::QgsMapCanvas(), QgsMapOverviewCanvas::QgsMapOverviewCanvas(), and QgsRenderChecker::runTest().

void QgsMapSettings::setFlags ( Flags  flags)

Set combination of flags that will be used for rendering.

Definition at line 224 of file qgsmapsettings.cpp.

References flags(), and mFlags.

Referenced by QgsComposerMap::draw().

void QgsMapSettings::setLayers ( const QStringList &  layers)

Set list of layer IDs for map rendering.

The layers must be registered in QgsMapLayerRegistry. The layers are stored in the reverse order of how they are rendered (layer with index 0 will be on top)

Definition at line 188 of file qgsmapsettings.cpp.

References layers(), and mLayers.

Referenced by QgsComposerMap::draw(), QgsMapRenderer::mapSettings(), QgsMapOverviewCanvas::setLayerSet(), and QgsMapCanvas::setLayerSet().

void QgsMapSettings::setMapUnits ( QGis::UnitType  u)
void QgsMapSettings::setOutputDpi ( int  dpi)
void QgsMapSettings::setOutputImageFormat ( QImage::Format  format)
inline

sets format of internal QImage

Definition at line 135 of file qgsmapsettings.h.

Referenced by QgsComposerMap::draw().

void QgsMapSettings::setOutputSize ( const QSize &  size)
void QgsMapSettings::setSelectionColor ( const QColor &  color)
inline

Set color that is used for drawing of selected vector features.

Definition at line 107 of file qgsmapsettings.h.

Referenced by QgsMapCanvas::setSelectionColor().

bool QgsMapSettings::testFlag ( QgsMapSettings::Flag  flag) const
void QgsMapSettings::updateDerived ( )
protected
QgsRectangle QgsMapSettings::visibleExtent ( ) const
void QgsMapSettings::writeXML ( QDomNode &  theNode,
QDomDocument &  theDoc 
)

Member Data Documentation

QColor QgsMapSettings::mBackgroundColor
protected

Definition at line 226 of file qgsmapsettings.h.

QgsDatumTransformStore QgsMapSettings::mDatumTransformStore
protected

Definition at line 224 of file qgsmapsettings.h.

Referenced by layerTransfrom(), readXML(), setDestinationCrs(), and writeXML().

QgsCoordinateReferenceSystem QgsMapSettings::mDestCRS
protected

Definition at line 223 of file qgsmapsettings.h.

Referenced by destinationCrs(), and setDestinationCrs().

int QgsMapSettings::mDpi
protected

Definition at line 214 of file qgsmapsettings.h.

Referenced by outputDpi(), setOutputDpi(), and updateDerived().

QgsRectangle QgsMapSettings::mExtent
protected

Definition at line 218 of file qgsmapsettings.h.

Referenced by extent(), setExtent(), and updateDerived().

Flags QgsMapSettings::mFlags
protected

Definition at line 229 of file qgsmapsettings.h.

Referenced by flags(), setFlag(), setFlags(), and testFlag().

QImage::Format QgsMapSettings::mImageFormat
protected

Definition at line 231 of file qgsmapsettings.h.

QStringList QgsMapSettings::mLayers
protected

Definition at line 220 of file qgsmapsettings.h.

Referenced by fullExtent(), layers(), and setLayers().

QgsMapToPixel QgsMapSettings::mMapToPixel
protected

Definition at line 242 of file qgsmapsettings.h.

Referenced by updateDerived().

double QgsMapSettings::mMapUnitsPerPixel
protected

Definition at line 236 of file qgsmapsettings.h.

Referenced by mapUnitsPerPixel(), and updateDerived().

bool QgsMapSettings::mProjectionsEnabled
protected

Definition at line 222 of file qgsmapsettings.h.

Referenced by hasCrsTransformEnabled(), and setCrsTransformEnabled().

double QgsMapSettings::mScale
protected

Definition at line 237 of file qgsmapsettings.h.

Referenced by scale(), and updateDerived().

QgsScaleCalculator QgsMapSettings::mScaleCalculator
protected

Definition at line 241 of file qgsmapsettings.h.

Referenced by mapUnits(), setMapUnits(), and updateDerived().

QColor QgsMapSettings::mSelectionColor
protected

Definition at line 227 of file qgsmapsettings.h.

QSize QgsMapSettings::mSize
protected

Definition at line 216 of file qgsmapsettings.h.

Referenced by outputSize(), setOutputSize(), and updateDerived().

bool QgsMapSettings::mValid
protected

whether the actual settings are valid (set in updateDerived())

Definition at line 234 of file qgsmapsettings.h.

Referenced by hasValidSettings(), and updateDerived().

QgsRectangle QgsMapSettings::mVisibleExtent
protected

extent with some additional white space that matches the output aspect ratio

Definition at line 235 of file qgsmapsettings.h.

Referenced by updateDerived(), and visibleExtent().


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