QGIS API Documentation  master-6227475
Public Member Functions | Static Public Member Functions | Protected Attributes
QgsSingleSymbolRendererV2 Class Reference

#include <qgssinglesymbolrendererv2.h>

+ Inheritance diagram for QgsSingleSymbolRendererV2:
+ Collaboration diagram for QgsSingleSymbolRendererV2:

List of all members.

Public Member Functions

 QgsSingleSymbolRendererV2 (QgsSymbolV2 *symbol)
virtual ~QgsSingleSymbolRendererV2 ()
virtual int capabilities ()
 returns bitwise OR-ed capabilities of the renderer
virtual QgsFeatureRendererV2 * clone ()
virtual QString dump ()
 for debugging
virtual QgsLegendSymbolList legendSymbolItems ()
 return a list of item text / symbol
virtual QgsLegendSymbologyList legendSymbologyItems (QSize iconSize)
 return a list of symbology items for the legend
QString rotationField () const
virtual QDomElement save (QDomDocument &doc)
 store renderer info to XML element
QgsSymbolV2::ScaleMethod scaleMethod () const
void setRotationField (QString fieldName)
void setScaleMethod (QgsSymbolV2::ScaleMethod scaleMethod)
void setSizeScaleField (QString fieldName)
void setSymbol (QgsSymbolV2 *s)
QString sizeScaleField () const
virtual void startRender (QgsRenderContext &context, const QgsVectorLayer *vlayer)
virtual void stopRender (QgsRenderContext &context)
QgsSymbolV2 * symbol () const
virtual QgsSymbolV2 * symbolForFeature (QgsFeature &feature)
 to be overridden
virtual QgsSymbolV2List symbols ()
 for symbol levels
virtual void toSld (QDomDocument &doc, QDomElement &element) const
 used from subclasses to create SLD Rule elements following SLD v1.1 specs
virtual QList< QString > usedAttributes ()

Static Public Member Functions

static QgsFeatureRendererV2 * create (QDomElement &element)
 create renderer from XML element
static QgsFeatureRendererV2 * createFromSld (QDomElement &element, QGis::GeometryType geomType)

Protected Attributes

double mOrigSize
QString mRotationField
int mRotationFieldIdx
QgsSymbolV2::ScaleMethod mScaleMethod
QString mSizeScaleField
int mSizeScaleFieldIdx
QgsSymbolV2 * mSymbol
QgsSymbolV2 * mTempSymbol

Detailed Description

Definition at line 22 of file qgssinglesymbolrendererv2.h.

Constructor & Destructor Documentation

QgsSingleSymbolRendererV2::QgsSingleSymbolRendererV2 ( QgsSymbolV2 *  symbol)

Definition at line 29 of file qgssinglesymbolrendererv2.cpp.

References mSymbol, and symbol().

Referenced by clone(), create(), and createFromSld().

QgsSingleSymbolRendererV2::~QgsSingleSymbolRendererV2 ( ) [virtual]

Definition at line 37 of file qgssinglesymbolrendererv2.cpp.

References mSymbol.

Member Function Documentation

virtual int QgsSingleSymbolRendererV2::capabilities ( ) [inline, virtual]

returns bitwise OR-ed capabilities of the renderer

Note:
added in 2.0

Reimplemented from QgsFeatureRendererV2.

Definition at line 65 of file qgssinglesymbolrendererv2.h.

References QgsFeatureRendererV2::RotationField.

QgsFeatureRendererV2 * QgsSingleSymbolRendererV2::clone ( ) [virtual]

Implements QgsFeatureRendererV2.

Definition at line 188 of file qgssinglesymbolrendererv2.cpp.

References QgsSymbolV2::clone(), mSymbol, QgsSingleSymbolRendererV2(), rotationField(), scaleMethod(), setRotationField(), setScaleMethod(), setSizeScaleField(), QgsFeatureRendererV2::setUsingSymbolLevels(), sizeScaleField(), and QgsFeatureRendererV2::usingSymbolLevels().

QgsFeatureRendererV2 * QgsSingleSymbolRendererV2::create ( QDomElement &  element) [static]

create renderer from XML element

Definition at line 223 of file qgssinglesymbolrendererv2.cpp.

References QgsSymbolLayerV2Utils::clearSymbolMap(), QgsSymbolLayerV2Utils::decodeScaleMethod(), QgsSymbolLayerV2Utils::loadSymbols(), QgsSingleSymbolRendererV2(), setRotationField(), setScaleMethod(), and setSizeScaleField().

Referenced by QgsRendererV2Registry::QgsRendererV2Registry().

QgsFeatureRendererV2 * QgsSingleSymbolRendererV2::createFromSld ( QDomElement &  element,
QGis::GeometryType  geomType 
) [static]

Definition at line 254 of file qgssinglesymbolrendererv2.cpp.

References QgsSymbolLayerV2Utils::createSymbolLayerV2ListFromSld(), QGis::Line, QGis::Point, QGis::Polygon, QgsDebugMsg, QgsSingleSymbolRendererV2(), and symbol().

Referenced by QgsRendererV2Registry::QgsRendererV2Registry().

QString QgsSingleSymbolRendererV2::dump ( ) [virtual]

for debugging

Reimplemented from QgsFeatureRendererV2.

Definition at line 176 of file qgssinglesymbolrendererv2.cpp.

References QgsSymbolV2::dump(), and mSymbol.

QgsLegendSymbolList QgsSingleSymbolRendererV2::legendSymbolItems ( ) [virtual]

return a list of item text / symbol

Note:
: this method was added in version 1.5
not available in python bindings

Reimplemented from QgsFeatureRendererV2.

Definition at line 376 of file qgssinglesymbolrendererv2.cpp.

References mSymbol.

QgsLegendSymbologyList QgsSingleSymbolRendererV2::legendSymbologyItems ( QSize  iconSize) [virtual]

return a list of symbology items for the legend

Reimplemented from QgsFeatureRendererV2.

Definition at line 365 of file qgssinglesymbolrendererv2.cpp.

References mSymbol, and QgsSymbolLayerV2Utils::symbolPreviewPixmap().

QString QgsSingleSymbolRendererV2::rotationField ( ) const [inline, virtual]
Note:
added in 1.5

Reimplemented from QgsFeatureRendererV2.

Definition at line 44 of file qgssinglesymbolrendererv2.h.

Referenced by clone(), and QgsSingleSymbolRendererV2Widget::QgsSingleSymbolRendererV2Widget().

QDomElement QgsSingleSymbolRendererV2::save ( QDomDocument &  doc) [virtual]

store renderer info to XML element

Reimplemented from QgsFeatureRendererV2.

Definition at line 342 of file qgssinglesymbolrendererv2.cpp.

References QgsSymbolLayerV2Utils::encodeScaleMethod(), mRotationField, mScaleMethod, mSizeScaleField, mSymbol, QgsFeatureRendererV2::mUsingSymbolLevels, RENDERER_TAG_NAME, QgsSymbolLayerV2Utils::saveSymbols(), and symbols().

QgsSymbolV2::ScaleMethod QgsSingleSymbolRendererV2::scaleMethod ( ) const [inline]
Note:
added in 2.0

Definition at line 54 of file qgssinglesymbolrendererv2.h.

Referenced by clone(), QgsSingleSymbolRendererV2Widget::QgsSingleSymbolRendererV2Widget(), and setScaleMethod().

void QgsSingleSymbolRendererV2::setRotationField ( QString  fieldName) [inline, virtual]
Note:
added in 1.5

Reimplemented from QgsFeatureRendererV2.

Definition at line 42 of file qgssinglesymbolrendererv2.h.

Referenced by clone(), create(), and QgsSingleSymbolRendererV2Widget::rotationFieldChanged().

void QgsSingleSymbolRendererV2::setScaleMethod ( QgsSymbolV2::ScaleMethod  scaleMethod)
Note:
added in 2.0

Definition at line 170 of file qgssinglesymbolrendererv2.cpp.

References mScaleMethod, mSymbol, scaleMethod(), and QgsFeatureRendererV2::setScaleMethodToSymbol().

Referenced by clone(), create(), and QgsSingleSymbolRendererV2Widget::scaleMethodChanged().

void QgsSingleSymbolRendererV2::setSizeScaleField ( QString  fieldName) [inline]
Note:
added in 1.5

Definition at line 47 of file qgssinglesymbolrendererv2.h.

Referenced by clone(), create(), and QgsSingleSymbolRendererV2Widget::sizeScaleFieldChanged().

void QgsSingleSymbolRendererV2::setSymbol ( QgsSymbolV2 *  s)

Definition at line 163 of file qgssinglesymbolrendererv2.cpp.

References mSymbol.

Referenced by QgsSingleSymbolRendererV2Widget::changeSingleSymbol().

QString QgsSingleSymbolRendererV2::sizeScaleField ( ) const [inline]
Note:
added in 1.5

Definition at line 49 of file qgssinglesymbolrendererv2.h.

Referenced by clone(), and QgsSingleSymbolRendererV2Widget::QgsSingleSymbolRendererV2Widget().

void QgsSingleSymbolRendererV2::startRender ( QgsRenderContext &  context,
const QgsVectorLayer *  vlayer 
) [virtual]

Implements QgsFeatureRendererV2.

Definition at line 83 of file qgssinglesymbolrendererv2.cpp.

References QgsSymbolV2::clone(), QgsSymbolV2::DataDefinedRotation, QgsSymbolV2::DataDefinedSizeScale, QgsVectorLayer::fieldNameIndex(), QgsSymbolV2::Line, QgsSymbolV2::Marker, mOrigSize, mRotationField, mRotationFieldIdx, mSizeScaleField, mSizeScaleFieldIdx, mSymbol, mTempSymbol, QgsSymbolV2::setRenderHints(), size, QgsSymbolV2::startRender(), and QgsSymbolV2::type().

Referenced by QgsVectorLayer::drawRendererV2Levels().

void QgsSingleSymbolRendererV2::stopRender ( QgsRenderContext &  context) [virtual]

Implements QgsFeatureRendererV2.

Definition at line 123 of file qgssinglesymbolrendererv2.cpp.

References mRotationFieldIdx, mSizeScaleFieldIdx, mSymbol, mTempSymbol, and QgsSymbolV2::stopRender().

Referenced by QgsVectorLayer::stopRendererV2().

QgsSymbolV2 * QgsSingleSymbolRendererV2::symbol ( ) const

Definition at line 158 of file qgssinglesymbolrendererv2.cpp.

References mSymbol.

Referenced by createFromSld(), QgsVectorLayer::drawRendererV2Levels(), QgsSingleSymbolRendererV2(), and QgsSingleSymbolRendererV2Widget::QgsSingleSymbolRendererV2Widget().

QgsSymbolV2 * QgsSingleSymbolRendererV2::symbolForFeature ( QgsFeature &  feature) [virtual]

to be overridden

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

Implements QgsFeatureRendererV2.

Definition at line 42 of file qgssinglesymbolrendererv2.cpp.

References QgsFeature::attribute(), QgsSymbolV2::Fill, QgsSymbolV2::Line, QgsSymbolV2::Marker, mOrigSize, mRotationFieldIdx, mScaleMethod, mSizeScaleFieldIdx, mSymbol, mTempSymbol, QgsMarkerSymbolV2::setAngle(), QgsFillSymbolV2::setAngle(), QgsMarkerSymbolV2::setScaleMethod(), QgsMarkerSymbolV2::setSize(), QgsLineSymbolV2::setWidth(), and QgsSymbolV2::type().

QgsSymbolV2List QgsSingleSymbolRendererV2::symbols ( ) [virtual]

for symbol levels

Implements QgsFeatureRendererV2.

Definition at line 216 of file qgssinglesymbolrendererv2.cpp.

References mSymbol.

Referenced by save().

void QgsSingleSymbolRendererV2::toSld ( QDomDocument &  doc,
QDomElement &  element 
) const [virtual]

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

Note:
added in 1.9

Reimplemented from QgsFeatureRendererV2.

Definition at line 198 of file qgssinglesymbolrendererv2.cpp.

References mRotationField, mSizeScaleField, mSymbol, and QgsSymbolV2::toSld().

QList< QString > QgsSingleSymbolRendererV2::usedAttributes ( ) [virtual]

Implements QgsFeatureRendererV2.

Definition at line 140 of file qgssinglesymbolrendererv2.cpp.

References mRotationField, mSizeScaleField, mSymbol, and QgsSymbolV2::usedAttributes().

Member Data Documentation

double QgsSingleSymbolRendererV2::mOrigSize [protected]

Definition at line 92 of file qgssinglesymbolrendererv2.h.

Referenced by startRender(), and symbolForFeature().

QString QgsSingleSymbolRendererV2::mRotationField [protected]

Definition at line 85 of file qgssinglesymbolrendererv2.h.

Referenced by save(), startRender(), toSld(), and usedAttributes().

int QgsSingleSymbolRendererV2::mRotationFieldIdx [protected]

Definition at line 90 of file qgssinglesymbolrendererv2.h.

Referenced by startRender(), stopRender(), and symbolForFeature().

QgsSymbolV2::ScaleMethod QgsSingleSymbolRendererV2::mScaleMethod [protected]

Definition at line 87 of file qgssinglesymbolrendererv2.h.

Referenced by save(), setScaleMethod(), and symbolForFeature().

QString QgsSingleSymbolRendererV2::mSizeScaleField [protected]

Definition at line 86 of file qgssinglesymbolrendererv2.h.

Referenced by save(), startRender(), toSld(), and usedAttributes().

int QgsSingleSymbolRendererV2::mSizeScaleFieldIdx [protected]

Definition at line 90 of file qgssinglesymbolrendererv2.h.

Referenced by startRender(), stopRender(), and symbolForFeature().

QgsSymbolV2* QgsSingleSymbolRendererV2::mSymbol [protected]

Definition at line 84 of file qgssinglesymbolrendererv2.h.

Referenced by clone(), dump(), legendSymbolItems(), legendSymbologyItems(), QgsSingleSymbolRendererV2(), save(), setScaleMethod(), setSymbol(), startRender(), stopRender(), symbol(), symbolForFeature(), symbols(), toSld(), usedAttributes(), and ~QgsSingleSymbolRendererV2().

QgsSymbolV2* QgsSingleSymbolRendererV2::mTempSymbol [protected]

Definition at line 91 of file qgssinglesymbolrendererv2.h.

Referenced by startRender(), stopRender(), and symbolForFeature().

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines