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

#include <qgsrendererv2.h>

Inheritance diagram for QgsFeatureRendererV2:
Inheritance graph
[legend]

Public Types

enum  Capabilities {
  SymbolLevels = 1, RotationField = 1 << 1, MoreSymbolsPerFeature = 1 << 2, Filter = 1 << 3,
  ScaleDependent = 1 << 4
}

Public Member Functions

QString type () const
virtual QgsSymbolV2 * symbolForFeature (QgsFeature &feature)=0
 to be overridden
virtual QgsSymbolV2 * originalSymbolForFeature (QgsFeature &feature)
 Return symbol for feature.
virtual void startRender (QgsRenderContext &context, const QgsFields &fields)=0
virtual Q_DECL_DEPRECATED void startRender (QgsRenderContext &context, const QgsVectorLayer *vlayer)
virtual void stopRender (QgsRenderContext &context)=0
virtual QList< QString > usedAttributes ()=0
virtual ~QgsFeatureRendererV2 ()
virtual QgsFeatureRendererV2 * clone () const =0
virtual bool renderFeature (QgsFeature &feature, QgsRenderContext &context, int layer=-1, bool selected=false, bool drawVertexMarker=false)
virtual QString dump () const
 for debugging
virtual int capabilities ()
 returns bitwise OR-ed capabilities of the renderer
virtual QgsSymbolV2List symbols ()=0
 for symbol levels
bool usingSymbolLevels () const
void setUsingSymbolLevels (bool usingSymbolLevels)
virtual QDomElement save (QDomDocument &doc)
 store renderer info to XML element
virtual QDomElement writeSld (QDomDocument &doc, const QgsVectorLayer &layer) const
 create the SLD UserStyle element following the SLD v1.1 specs
virtual void toSld (QDomDocument &doc, QDomElement &element) const
 used from subclasses to create SLD Rule elements following SLD v1.1 specs
virtual QgsLegendSymbologyList legendSymbologyItems (QSize iconSize)
 return a list of symbology items for the legend
virtual bool legendSymbolItemsCheckable () const
 items of symbology items in legend should be checkable
virtual bool legendSymbolItemChecked (QString key)
 items of symbology items in legend is checked
virtual void checkLegendSymbolItem (QString key, bool state=true)
 item in symbology was checked
virtual QgsLegendSymbolList legendSymbolItems (double scaleDenominator=-1, QString rule="")
 return a list of item text / symbol
virtual QgsLegendSymbolListV2 legendSymbolItemsV2 () const
 Return a list of symbology items for the legend.
virtual QString legendClassificationAttribute () const
 If supported by the renderer, return classification attribute for the use in legend.
void setVertexMarkerAppearance (int type, int size)
 set type and size of editing vertex markers for subsequent rendering
virtual QString rotationField () const
 return rotation field name (or empty string if not set or not supported by renderer)
virtual void setRotationField (QString fieldName)
 sets rotation field of renderer (if supported by the renderer)
virtual bool willRenderFeature (QgsFeature &feat)
 return whether the renderer will render a feature or not.
virtual QgsSymbolV2List symbolsForFeature (QgsFeature &feat)
 return list of symbols used for rendering the feature.
virtual QgsSymbolV2List originalSymbolsForFeature (QgsFeature &feat)
 Equivalent of originalSymbolsForFeature() call extended to support renderers that may use more symbols per feature - similar to symbolsForFeature()

Static Public Member Functions

static QgsFeatureRendererV2 * defaultRenderer (QGis::GeometryType geomType)
 return a new renderer - used by default in vector layers
static QgsFeatureRendererV2 * load (QDomElement &symbologyElem)
 create a renderer from XML element
static QgsFeatureRendererV2 * loadSld (const QDomNode &node, QGis::GeometryType geomType, QString &errorMessage)
 create a new renderer according to the information contained in the UserStyle element of a SLD style document

Protected Member Functions

 QgsFeatureRendererV2 (QString type)
void renderFeatureWithSymbol (QgsFeature &feature, QgsSymbolV2 *symbol, QgsRenderContext &context, int layer, bool selected, bool drawVertexMarker)
void renderVertexMarker (QPointF &pt, QgsRenderContext &context)
 render editing vertex marker at specified point
void renderVertexMarkerPolyline (QPolygonF &pts, QgsRenderContext &context)
 render editing vertex marker for a polyline
void renderVertexMarkerPolygon (QPolygonF &pts, QList< QPolygonF > *rings, QgsRenderContext &context)
 render editing vertex marker for a polygon
void setScaleMethodToSymbol (QgsSymbolV2 *symbol, int scaleMethod)

Static Protected Member Functions

static const unsigned char * _getPoint (QPointF &pt, QgsRenderContext &context, const unsigned char *wkb)
static const unsigned char * _getLineString (QPolygonF &pts, QgsRenderContext &context, const unsigned char *wkb)
static const unsigned char * _getPolygon (QPolygonF &pts, QList< QPolygonF > &holes, QgsRenderContext &context, const unsigned char *wkb)

Protected Attributes

QString mType
bool mUsingSymbolLevels
int mCurrentVertexMarkerType
 The current type of editing marker.
int mCurrentVertexMarkerSize
 The current size of editing marker.

Member Enumeration Documentation

enum QgsFeatureRendererV2::Capabilities
Enumerator:
SymbolLevels 
RotationField 
MoreSymbolsPerFeature 
Filter 
ScaleDependent 

Constructor & Destructor Documentation

virtual QgsFeatureRendererV2::~QgsFeatureRendererV2 ( )
inlinevirtual
QgsFeatureRendererV2::QgsFeatureRendererV2 ( QString  type)
protected

Member Function Documentation

const unsigned char * QgsFeatureRendererV2::_getLineString ( QPolygonF &  pts,
QgsRenderContext &  context,
const unsigned char *  wkb 
)
staticprotected
const unsigned char * QgsFeatureRendererV2::_getPoint ( QPointF &  pt,
QgsRenderContext &  context,
const unsigned char *  wkb 
)
staticprotected
const unsigned char * QgsFeatureRendererV2::_getPolygon ( QPolygonF &  pts,
QList< QPolygonF > &  holes,
QgsRenderContext &  context,
const unsigned char *  wkb 
)
staticprotected
virtual int QgsFeatureRendererV2::capabilities ( )
inlinevirtual

returns bitwise OR-ed capabilities of the renderer

Reimplemented in QgsRuleBasedRendererV2, QgsGraduatedSymbolRendererV2, QgsCategorizedSymbolRendererV2, QgsInvertedPolygonRenderer, and QgsSingleSymbolRendererV2.

void QgsFeatureRendererV2::checkLegendSymbolItem ( QString  key,
bool  state = true 
)
virtual

item in symbology was checked

Note
added in 2.5

Reimplemented in QgsGraduatedSymbolRendererV2, QgsRuleBasedRendererV2, and QgsCategorizedSymbolRendererV2.

virtual QgsFeatureRendererV2* QgsFeatureRendererV2::clone ( ) const
pure virtual

Implemented in QgsRuleBasedRendererV2, QgsGraduatedSymbolRendererV2, QgsCategorizedSymbolRendererV2, QgsSingleSymbolRendererV2, QgsInvertedPolygonRenderer, and QgsPointDisplacementRenderer.

QgsFeatureRendererV2 * QgsFeatureRendererV2::defaultRenderer ( QGis::GeometryType  geomType)
static

return a new renderer - used by default in vector layers

QString QgsFeatureRendererV2::dump ( ) const
virtual

for debugging

Reimplemented in QgsRuleBasedRendererV2, QgsGraduatedSymbolRendererV2, QgsCategorizedSymbolRendererV2, QgsInvertedPolygonRenderer, and QgsSingleSymbolRendererV2.

virtual QString QgsFeatureRendererV2::legendClassificationAttribute ( ) const
inlinevirtual

If supported by the renderer, return classification attribute for the use in legend.

Note
added in 2.6

Reimplemented in QgsGraduatedSymbolRendererV2, and QgsCategorizedSymbolRendererV2.

bool QgsFeatureRendererV2::legendSymbolItemChecked ( QString  key)
virtual

items of symbology items in legend is checked

Note
added in 2.5

Reimplemented in QgsGraduatedSymbolRendererV2, QgsRuleBasedRendererV2, and QgsCategorizedSymbolRendererV2.

QgsLegendSymbolList QgsFeatureRendererV2::legendSymbolItems ( double  scaleDenominator = -1,
QString  rule = "" 
)
virtual

return a list of item text / symbol

Note
not available in python bindings

Reimplemented in QgsRuleBasedRendererV2, QgsGraduatedSymbolRendererV2, QgsCategorizedSymbolRendererV2, QgsInvertedPolygonRenderer, QgsSingleSymbolRendererV2, and QgsPointDisplacementRenderer.

bool QgsFeatureRendererV2::legendSymbolItemsCheckable ( ) const
virtual

items of symbology items in legend should be checkable

Note
added in 2.5

Reimplemented in QgsGraduatedSymbolRendererV2, QgsRuleBasedRendererV2, and QgsCategorizedSymbolRendererV2.

QgsLegendSymbolListV2 QgsFeatureRendererV2::legendSymbolItemsV2 ( ) const
virtual

Return a list of symbology items for the legend.

Better choice than legendSymbolItems(). Default fallback implementation just uses legendSymbolItems() implementation

Note
added in 2.6

Reimplemented in QgsRuleBasedRendererV2, and QgsSingleSymbolRendererV2.

QgsLegendSymbologyList QgsFeatureRendererV2::legendSymbologyItems ( QSize  iconSize)
virtual

return a list of symbology items for the legend

Reimplemented in QgsRuleBasedRendererV2, QgsGraduatedSymbolRendererV2, QgsCategorizedSymbolRendererV2, QgsInvertedPolygonRenderer, QgsSingleSymbolRendererV2, and QgsPointDisplacementRenderer.

QgsFeatureRendererV2 * QgsFeatureRendererV2::load ( QDomElement &  symbologyElem)
static

create a renderer from XML element

QgsFeatureRendererV2 * QgsFeatureRendererV2::loadSld ( const QDomNode &  node,
QGis::GeometryType  geomType,
QString &  errorMessage 
)
static

create a new renderer according to the information contained in the UserStyle element of a SLD style document

Parameters
nodethe node in the SLD document whose the UserStyle element is a child
geomTypethe geometry type of the features, used to convert Symbolizer elements
errorMessageit will contain the error message if something went wrong
Returns
the renderer
virtual QgsSymbolV2* QgsFeatureRendererV2::originalSymbolForFeature ( QgsFeature &  feature)
inlinevirtual

Return symbol for feature.

The difference compared to symbolForFeature() is that it returns original symbol which can be used as an identifier for renderer's rule - the former may return a temporary replacement of a symbol for use in rendering.

Note
added in 2.6

Reimplemented in QgsGraduatedSymbolRendererV2, QgsInvertedPolygonRenderer, QgsCategorizedSymbolRendererV2, and QgsSingleSymbolRendererV2.

QgsSymbolV2List QgsFeatureRendererV2::originalSymbolsForFeature ( QgsFeature &  feat)
virtual

Equivalent of originalSymbolsForFeature() call extended to support renderers that may use more symbols per feature - similar to symbolsForFeature()

Note
added in 2.6

Reimplemented in QgsRuleBasedRendererV2, and QgsInvertedPolygonRenderer.

bool QgsFeatureRendererV2::renderFeature ( QgsFeature &  feature,
QgsRenderContext &  context,
int  layer = -1,
bool  selected = false,
bool  drawVertexMarker = false 
)
virtual

Reimplemented in QgsRuleBasedRendererV2, QgsInvertedPolygonRenderer, and QgsPointDisplacementRenderer.

void QgsFeatureRendererV2::renderFeatureWithSymbol ( QgsFeature &  feature,
QgsSymbolV2 *  symbol,
QgsRenderContext &  context,
int  layer,
bool  selected,
bool  drawVertexMarker 
)
protected
void QgsFeatureRendererV2::renderVertexMarker ( QPointF &  pt,
QgsRenderContext &  context 
)
protected

render editing vertex marker at specified point

void QgsFeatureRendererV2::renderVertexMarkerPolygon ( QPolygonF &  pts,
QList< QPolygonF > *  rings,
QgsRenderContext &  context 
)
protected

render editing vertex marker for a polygon

void QgsFeatureRendererV2::renderVertexMarkerPolyline ( QPolygonF &  pts,
QgsRenderContext &  context 
)
protected

render editing vertex marker for a polyline

virtual QString QgsFeatureRendererV2::rotationField ( ) const
inlinevirtual

return rotation field name (or empty string if not set or not supported by renderer)

Reimplemented in QgsGraduatedSymbolRendererV2, QgsCategorizedSymbolRendererV2, and QgsSingleSymbolRendererV2.

QDomElement QgsFeatureRendererV2::save ( QDomDocument &  doc)
virtual

store renderer info to XML element

Reimplemented in QgsRuleBasedRendererV2, QgsGraduatedSymbolRendererV2, QgsCategorizedSymbolRendererV2, QgsInvertedPolygonRenderer, QgsSingleSymbolRendererV2, and QgsPointDisplacementRenderer.

virtual void QgsFeatureRendererV2::setRotationField ( QString  fieldName)
inlinevirtual

sets rotation field of renderer (if supported by the renderer)

Reimplemented in QgsGraduatedSymbolRendererV2, QgsCategorizedSymbolRendererV2, and QgsSingleSymbolRendererV2.

void QgsFeatureRendererV2::setScaleMethodToSymbol ( QgsSymbolV2 *  symbol,
int  scaleMethod 
)
protected
void QgsFeatureRendererV2::setUsingSymbolLevels ( bool  usingSymbolLevels)
inline
void QgsFeatureRendererV2::setVertexMarkerAppearance ( int  type,
int  size 
)

set type and size of editing vertex markers for subsequent rendering

virtual void QgsFeatureRendererV2::startRender ( QgsRenderContext &  context,
const QgsFields &  fields 
)
pure virtual

Implemented in QgsRuleBasedRendererV2, QgsGraduatedSymbolRendererV2, QgsCategorizedSymbolRendererV2, QgsInvertedPolygonRenderer, QgsPointDisplacementRenderer, and QgsSingleSymbolRendererV2.

void QgsFeatureRendererV2::startRender ( QgsRenderContext &  context,
const QgsVectorLayer *  vlayer 
)
virtual
Deprecated:
since 2.4 - not using QgsVectorLayer directly anymore
virtual void QgsFeatureRendererV2::stopRender ( QgsRenderContext &  context)
pure virtual

Implemented in QgsRuleBasedRendererV2, QgsGraduatedSymbolRendererV2, QgsCategorizedSymbolRendererV2, QgsInvertedPolygonRenderer, QgsPointDisplacementRenderer, and QgsSingleSymbolRendererV2.

virtual QgsSymbolV2* QgsFeatureRendererV2::symbolForFeature ( QgsFeature &  feature)
pure virtual

to be overridden

Parameters
featurefeature
Returns
returns pointer to symbol or 0 if symbol was not found

Implemented in QgsRuleBasedRendererV2, QgsGraduatedSymbolRendererV2, QgsInvertedPolygonRenderer, QgsCategorizedSymbolRendererV2, QgsPointDisplacementRenderer, and QgsSingleSymbolRendererV2.

virtual QgsSymbolV2List QgsFeatureRendererV2::symbols ( )
pure virtual

for symbol levels

Implemented in QgsRuleBasedRendererV2, QgsGraduatedSymbolRendererV2, QgsCategorizedSymbolRendererV2, QgsInvertedPolygonRenderer, QgsSingleSymbolRendererV2, and QgsPointDisplacementRenderer.

QgsSymbolV2List QgsFeatureRendererV2::symbolsForFeature ( QgsFeature &  feat)
virtual

return list of symbols used for rendering the feature.

For renderers that do not support MoreSymbolsPerFeature it is more efficient to use symbolForFeature()

Reimplemented in QgsRuleBasedRendererV2, and QgsInvertedPolygonRenderer.

virtual void QgsFeatureRendererV2::toSld ( QDomDocument &  doc,
QDomElement &  element 
) const
inlinevirtual

used from subclasses to create SLD Rule elements following SLD v1.1 specs

Reimplemented in QgsRuleBasedRendererV2, QgsGraduatedSymbolRendererV2, QgsCategorizedSymbolRendererV2, QgsSingleSymbolRendererV2, and QgsPointDisplacementRenderer.

QString QgsFeatureRendererV2::type ( ) const
inline
virtual QList<QString> QgsFeatureRendererV2::usedAttributes ( )
pure virtual

Implemented in QgsRuleBasedRendererV2, QgsGraduatedSymbolRendererV2, QgsCategorizedSymbolRendererV2, QgsInvertedPolygonRenderer, QgsPointDisplacementRenderer, and QgsSingleSymbolRendererV2.

bool QgsFeatureRendererV2::usingSymbolLevels ( ) const
inline
virtual bool QgsFeatureRendererV2::willRenderFeature ( QgsFeature &  feat)
inlinevirtual

return whether the renderer will render a feature or not.

Must be called between startRender() and stopRender() calls. Default implementation uses symbolForFeature().

Reimplemented in QgsRuleBasedRendererV2, and QgsInvertedPolygonRenderer.

QDomElement QgsFeatureRendererV2::writeSld ( QDomDocument &  doc,
const QgsVectorLayer &  layer 
) const
virtual

create the SLD UserStyle element following the SLD v1.1 specs

Member Data Documentation

int QgsFeatureRendererV2::mCurrentVertexMarkerSize
protected

The current size of editing marker.

int QgsFeatureRendererV2::mCurrentVertexMarkerType
protected

The current type of editing marker.

QString QgsFeatureRendererV2::mType
protected
bool QgsFeatureRendererV2::mUsingSymbolLevels
protected
The documentation for this class was generated from the following files:
Generated on Fri Oct 31 2014 15:49:48 for QGIS API Documentation by   doxygen 1.8.1.2