Quantum GIS API Documentation
1.7.5-Wroclaw
|
Abstract base class for renderers. More...
#include <qgsrenderer.h>
Public Member Functions | |
QgsRenderer () | |
Default ctor sets up selection color from project properties. | |
virtual | ~QgsRenderer () |
Virtual destructor because we have virtual methods... | |
virtual bool | willRenderFeature (QgsFeature *f) |
Determines if a feature will be rendered or not. | |
void | renderFeature (QPainter *p, QgsFeature &f, QImage *img, bool selected, double widthScale=1.0, double rasterScaleFactor=1.0) |
A vector layer passes features to a renderer object to change the brush and pen of the qpainter. | |
void | renderFeature (QgsRenderContext &renderContext, QgsFeature &f, QImage *pic, bool selected) |
A vector layer passes features to a renderer object to change the brush and pen of the qpainter. | |
virtual void | renderFeature (QgsRenderContext &renderContext, QgsFeature &f, QImage *pic, bool selected, double opacity)=0 |
virtual int | readXML (const QDomNode &rnode, QgsVectorLayer &vl)=0 |
Reads the renderer configuration from an XML file. | |
virtual bool | writeXML (QDomNode &layer_node, QDomDocument &document, const QgsVectorLayer &vl) const =0 |
Writes the contents of the renderer to a configuration file. | |
virtual bool | needsAttributes () const =0 |
Returns true, if attribute values are used by the renderer and false otherwise. | |
virtual QgsAttributeList | classificationAttributes () const =0 |
Returns a list with indexes of classification attributes. | |
virtual QString | name () const =0 |
Returns the renderers name. | |
virtual const QList< QgsSymbol * > | symbols () const =0 |
Return symbology items. | |
virtual QgsRenderer * | clone () const =0 |
Returns a copy of the renderer (a deep copy on the heap) | |
virtual bool | containsPixmap () const |
Returns true if this renderer returns a pixmap in the render method (e.g. | |
virtual bool | usesTransparency () const |
Returns true if this renderer uses its own transparency settings, e.g. | |
virtual QgsSymbol * | symbolForFeature (const QgsFeature *f) |
Returns renderer symbol for a feature. |
Static Public Member Functions | |
static void | setSelectionColor (QColor color) |
Change selection color. | |
static QColor | selectionColor () |
Get selection color. | |
static void | scaleBrush (QBrush &b, double rasterScaleFactor) |
Scales a brush to a given raster scale factor (e.g. |
Protected Attributes | |
QGis::GeometryType | mGeometryType |
Layer type. |
Static Protected Attributes | |
static QColor | mSelectionColor = QColor( 0, 0, 0 ) |
Color to draw selected features - static so we can change it in proj props and automatically all renderers are updated. |
Abstract base class for renderers.
A renderer holds all the information necessary to draw the contents of a vector layer to a map canvas. The vector layer then passes each feature to paint to the renderer
Definition at line 40 of file qgsrenderer.h.
QgsRenderer::QgsRenderer | ( | ) |
Default ctor sets up selection color from project properties.
Definition at line 28 of file qgsrenderer.cpp.
|
virtual |
Virtual destructor because we have virtual methods...
Definition at line 33 of file qgsrenderer.cpp.
|
pure virtual |
Returns a list with indexes of classification attributes.
Implemented in QgsGraduatedSymbolRenderer, QgsContinuousColorRenderer, QgsSingleSymbolRenderer, and QgsUniqueValueRenderer.
Referenced by QgsLegendModel::addVectorLayerItems(), QgsVectorLayer::draw(), QgsVectorLayer::drawLabels(), and QgsVectorLayer::writeSymbology().
|
pure virtual |
Returns a copy of the renderer (a deep copy on the heap)
Implemented in QgsGraduatedSymbolRenderer, QgsContinuousColorRenderer, QgsUniqueValueRenderer, and QgsSingleSymbolRenderer.
Referenced by QgsVectorLayer::copySymbologySettings().
|
virtual |
Returns true if this renderer returns a pixmap in the render method (e.g.
for point data or diagrams)
Definition at line 47 of file qgsrenderer.cpp.
References mGeometryType, and QGis::Point.
|
pure virtual |
Returns the renderers name.
Implemented in QgsGraduatedSymbolRenderer, QgsContinuousColorRenderer, QgsSingleSymbolRenderer, and QgsUniqueValueRenderer.
Referenced by QgsSymbologyV2Conversion::rendererV1toV2().
|
pure virtual |
Returns true, if attribute values are used by the renderer and false otherwise.
Implemented in QgsGraduatedSymbolRenderer, QgsContinuousColorRenderer, QgsSingleSymbolRenderer, and QgsUniqueValueRenderer.
|
pure virtual |
Reads the renderer configuration from an XML file.
rnode | the Dom node to read |
vl | the vector layer which will be associated with the renderer |
Implemented in QgsGraduatedSymbolRenderer, QgsContinuousColorRenderer, QgsSingleSymbolRenderer, and QgsUniqueValueRenderer.
Referenced by QgsVectorLayer::readSymbology().
|
inline |
A vector layer passes features to a renderer object to change the brush and pen of the qpainter.
p | the painter storing brush and pen |
f | a pointer to the feature to be rendered |
img | a pointer to picture |
selected | feature is selected |
widthScale | scale |
rasterScaleFactor | raster scale |
Definition at line 66 of file qgsrenderer.h.
References QgsRenderContext::setPainter(), QgsRenderContext::setRasterScaleFactor(), and QgsRenderContext::setScaleFactor().
Referenced by QgsVectorLayer::draw().
|
inline |
A vector layer passes features to a renderer object to change the brush and pen of the qpainter.
Definition at line 77 of file qgsrenderer.h.
|
pure virtual |
Implemented in QgsGraduatedSymbolRenderer, QgsSingleSymbolRenderer, QgsContinuousColorRenderer, and QgsUniqueValueRenderer.
|
static |
Scales a brush to a given raster scale factor (e.g.
for printing)
Definition at line 59 of file qgsrenderer.cpp.
Referenced by QgsComposerLegend::drawPolygonSymbol(), QgsUniqueValueRenderer::renderFeature(), QgsSingleSymbolRenderer::renderFeature(), and QgsGraduatedSymbolRenderer::renderFeature().
|
static |
Get selection color.
Added in QGIS v1.4
Definition at line 42 of file qgsrenderer.cpp.
References mSelectionColor.
Referenced by QgsVectorLayer::drawRendererV2Levels().
|
static |
|
inlinevirtual |
Returns renderer symbol for a feature.
Reimplemented in QgsGraduatedSymbolRenderer, QgsUniqueValueRenderer, and QgsSingleSymbolRenderer.
Definition at line 117 of file qgsrenderer.h.
|
pure virtual |
Return symbology items.
Implemented in QgsGraduatedSymbolRenderer, QgsContinuousColorRenderer, QgsUniqueValueRenderer, and QgsSingleSymbolRenderer.
Referenced by QgsLegendModel::addVectorLayerItems(), QgsQuickPrint::printMap(), and QgsQuickPrint::scalePointSymbols().
|
inlinevirtual |
Returns true if this renderer uses its own transparency settings, e.g.
differentiated by classification. This is a hint for QgsVectorLayer to not use the transparency setting on layer level in this cases
Definition at line 113 of file qgsrenderer.h.
Referenced by QgsVectorLayer::draw(), QgsVectorLayer::drawLineString(), and QgsVectorLayer::drawPolygon().
|
inlinevirtual |
Determines if a feature will be rendered or not.
f | a pointer to the feature to determine if rendering will happen |
Reimplemented in QgsGraduatedSymbolRenderer, and QgsUniqueValueRenderer.
Definition at line 49 of file qgsrenderer.h.
Referenced by QgsVectorLayer::draw(), and QgsVectorLayer::drawLabels().
|
pure virtual |
Writes the contents of the renderer to a configuration file.
Writes the contents of the renderer to a configuration file @ return true in case of success
Implemented in QgsGraduatedSymbolRenderer, QgsContinuousColorRenderer, QgsSingleSymbolRenderer, and QgsUniqueValueRenderer.
Referenced by QgsVectorLayer::writeSymbology().
|
protected |
Layer type.
Definition at line 128 of file qgsrenderer.h.
Referenced by containsPixmap(), QgsUniqueValueRenderer::operator=(), QgsSingleSymbolRenderer::operator=(), QgsContinuousColorRenderer::operator=(), QgsGraduatedSymbolRenderer::operator=(), QgsContinuousColorRenderer::QgsContinuousColorRenderer(), QgsGraduatedSymbolRenderer::QgsGraduatedSymbolRenderer(), QgsSingleSymbolRenderer::QgsSingleSymbolRenderer(), QgsUniqueValueRenderer::QgsUniqueValueRenderer(), QgsUniqueValueRenderer::readXML(), QgsSingleSymbolRenderer::readXML(), QgsContinuousColorRenderer::readXML(), QgsGraduatedSymbolRenderer::readXML(), QgsUniqueValueRenderer::renderFeature(), QgsContinuousColorRenderer::renderFeature(), QgsSingleSymbolRenderer::renderFeature(), and QgsGraduatedSymbolRenderer::renderFeature().
|
staticprotected |
Color to draw selected features - static so we can change it in proj props and automatically all renderers are updated.
Definition at line 125 of file qgsrenderer.h.
Referenced by QgsUniqueValueRenderer::renderFeature(), QgsContinuousColorRenderer::renderFeature(), QgsSingleSymbolRenderer::renderFeature(), QgsGraduatedSymbolRenderer::renderFeature(), selectionColor(), and setSelectionColor().