QGIS API Documentation  2.18.3-Las Palmas (77b8c3d)
Public Member Functions | Static Public Member Functions | List of all members
Qgs25DRenderer Class Reference

#include <qgs25drenderer.h>

Inheritance diagram for Qgs25DRenderer:
Inheritance graph
[legend]

Public Member Functions

 Qgs25DRenderer ()
 
QgsFeatureRendererV2clone () const override
 
QColor roofColor () const
 Get the roof color. More...
 
QDomElement save (QDomDocument &doc) override
 store renderer info to XML element More...
 
void setRoofColor (const QColor &roofColor)
 Set the roof color. More...
 
void setShadowColor (const QColor &shadowColor)
 Set the shadow's color. More...
 
void setShadowEnabled (bool value)
 Enable or disable the shadow. More...
 
void setShadowSpread (double shadowSpread)
 Set the shadow's spread distance in map units. More...
 
void setWallColor (const QColor &wallColor)
 Set the wall color. More...
 
void setWallShadingEnabled (bool enabled)
 Set wall shading enabled. More...
 
QColor shadowColor () const
 Get the shadow's color. More...
 
bool shadowEnabled () const
 Is the shadow enabled. More...
 
double shadowSpread () const
 Get the shadow's spread distance in map units. More...
 
void startRender (QgsRenderContext &context, const QgsFields &fields) override
 Needs to be called when a new render cycle is started. More...
 
void stopRender (QgsRenderContext &context) override
 Needs to be called when a render cycle has finished to clean up. More...
 
virtual QgsSymbolV2symbolForFeature (QgsFeature &feature, QgsRenderContext &context) override
 To be overridden. More...
 
virtual QgsSymbolV2List symbols (QgsRenderContext &context) override
 Returns list of symbols used by the renderer. More...
 
QList< QStringusedAttributes () override
 Returns a set of attributes required for this renderer. More...
 
QColor wallColor () const
 Get the wall color. More...
 
bool wallShadingEnabled ()
 Get wall shading enabled. More...
 
- Public Member Functions inherited from QgsFeatureRendererV2
virtual ~QgsFeatureRendererV2 ()
 
virtual int capabilities ()
 returns bitwise OR-ed capabilities of the renderer More...
 
virtual void checkLegendSymbolItem (const QString &key, bool state=true)
 item in symbology was checked More...
 
virtual QString dump () const
 for debugging More...
 
virtual const QgsFeatureRendererV2embeddedRenderer () const
 Returns the current embedded renderer (subrenderer) for this feature renderer. More...
 
virtual QString filter (const QgsFields &fields=QgsFields())
 If a renderer does not require all the features this method may be overridden and return an expression used as where clause. More...
 
virtual bool filterNeedsGeometry () const
 Returns true if this renderer requires the geometry to apply the filter. More...
 
bool forceRasterRender () const
 Returns whether the renderer must render as a raster. More...
 
virtual QString legendClassificationAttribute () const
 If supported by the renderer, return classification attribute for the use in legend. More...
 
virtual QSet< QStringlegendKeysForFeature (QgsFeature &feature, QgsRenderContext &context)
 Return legend keys matching a specified feature. More...
 
virtual bool legendSymbolItemChecked (const QString &key)
 items of symbology items in legend is checked More...
 
virtual QgsLegendSymbolList legendSymbolItems (double scaleDenominator=-1, const QString &rule="")
 return a list of item text / symbol More...
 
virtual bool legendSymbolItemsCheckable () const
 items of symbology items in legend should be checkable More...
 
virtual QgsLegendSymbolListV2 legendSymbolItemsV2 () const
 Return a list of symbology items for the legend. More...
 
virtual QgsLegendSymbologyList legendSymbologyItems (QSize iconSize)
 return a list of symbology items for the legend More...
 
virtual void modifyRequestExtent (QgsRectangle &extent, QgsRenderContext &context)
 Allows for a renderer to modify the extent of a feature request prior to rendering. More...
 
QgsFeatureRequest::OrderBy orderBy () const
 Get the order in which features shall be processed by this renderer. More...
 
bool orderByEnabled () const
 Returns whether custom ordering will be applied before features are processed by this renderer. More...
 
virtual Q_DECL_DEPRECATED QgsSymbolV2originalSymbolForFeature (QgsFeature &feature)
 Return symbol for feature. More...
 
virtual QgsSymbolV2originalSymbolForFeature (QgsFeature &feature, QgsRenderContext &context)
 Return symbol for feature. More...
 
virtual Q_DECL_DEPRECATED QgsSymbolV2List originalSymbolsForFeature (QgsFeature &feat)
 Equivalent of originalSymbolsForFeature() call extended to support renderers that may use more symbols per feature - similar to symbolsForFeature() More...
 
virtual QgsSymbolV2List originalSymbolsForFeature (QgsFeature &feat, QgsRenderContext &context)
 Equivalent of originalSymbolsForFeature() call extended to support renderers that may use more symbols per feature - similar to symbolsForFeature() More...
 
QgsPaintEffectpaintEffect () const
 Returns the current paint effect for the renderer. More...
 
virtual bool renderFeature (QgsFeature &feature, QgsRenderContext &context, int layer=-1, bool selected=false, bool drawVertexMarker=false)
 Render a feature using this renderer in the given context. More...
 
virtual Q_DECL_DEPRECATED QString rotationField () const
 return rotation field name (or empty string if not set or not supported by renderer) More...
 
virtual void setEmbeddedRenderer (QgsFeatureRendererV2 *subRenderer)
 Sets an embedded renderer (subrenderer) for this feature renderer. More...
 
void setForceRasterRender (bool forceRaster)
 Sets whether the renderer should be rendered to a raster destination. More...
 
virtual void setLegendSymbolItem (const QString &key, QgsSymbolV2 *symbol)
 Sets the symbol to be used for a legend symbol item. More...
 
void setOrderBy (const QgsFeatureRequest::OrderBy &orderBy)
 Define the order in which features shall be processed by this renderer. More...
 
void setOrderByEnabled (bool enabled)
 Sets whether custom ordering should be applied before features are processed by this renderer. More...
 
void setPaintEffect (QgsPaintEffect *effect)
 Sets the current paint effect for the renderer. More...
 
virtual Q_DECL_DEPRECATED void setRotationField (const QString &fieldName)
 sets rotation field of renderer (if supported by the renderer) More...
 
void setUsingSymbolLevels (bool usingSymbolLevels)
 
void setVertexMarkerAppearance (int type, int size)
 set type and size of editing vertex markers for subsequent rendering More...
 
virtual Q_DECL_DEPRECATED void startRender (QgsRenderContext &context, const QgsVectorLayer *vlayer)
 
virtual Q_DECL_DEPRECATED QgsSymbolV2symbolForFeature (QgsFeature &feature)
 To be overridden. More...
 
virtual Q_DECL_DEPRECATED QgsSymbolV2List symbols ()
 For symbol levels. More...
 
virtual Q_DECL_DEPRECATED QgsSymbolV2List symbolsForFeature (QgsFeature &feat)
 Returns list of symbols used for rendering the feature. More...
 
virtual QgsSymbolV2List symbolsForFeature (QgsFeature &feat, QgsRenderContext &context)
 Returns list of symbols used for rendering the feature. More...
 
virtual void toSld (QDomDocument &doc, QDomElement &element) const
 used from subclasses to create SLD Rule elements following SLD v1.1 specs More...
 
virtual void toSld (QDomDocument &doc, QDomElement &element, const QgsStringMap &props) const
 used from subclasses to create SLD Rule elements following SLD v1.1 specs More...
 
QString type () const
 
bool usingSymbolLevels () const
 
virtual Q_DECL_DEPRECATED bool willRenderFeature (QgsFeature &feat)
 Returns whether the renderer will render a feature or not. More...
 
virtual bool willRenderFeature (QgsFeature &feat, QgsRenderContext &context)
 Returns whether the renderer will render a feature or not. More...
 
virtual Q_DECL_DEPRECATED QDomElement writeSld (QDomDocument &doc, const QgsVectorLayer &layer) const
 create the SLD UserStyle element following the SLD v1.1 specs More...
 
virtual QDomElement writeSld (QDomDocument &doc, const QString &styleName) const
 create the SLD UserStyle element following the SLD v1.1 specs with the given name More...
 
virtual QDomElement writeSld (QDomDocument &doc, const QString &styleName, const QgsStringMap &props) const
 create the SLD UserStyle element following the SLD v1.1 specs with the given name More...
 

Static Public Member Functions

static Qgs25DRendererconvertFromRenderer (QgsFeatureRendererV2 *renderer)
 Try to convert from an existing renderer. More...
 
static QgsFeatureRendererV2create (QDomElement &element)
 Create a new 2.5D renderer from XML. More...
 
- Static Public Member Functions inherited from QgsFeatureRendererV2
static QgsFeatureRendererV2defaultRenderer (QGis::GeometryType geomType)
 return a new renderer - used by default in vector layers More...
 
static QgsFeatureRendererV2load (QDomElement &symbologyElem)
 create a renderer from XML element More...
 
static QgsFeatureRendererV2loadSld (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. More...
 

Additional Inherited Members

- Public Types inherited from QgsFeatureRendererV2
enum  Capabilities {
  SymbolLevels = 1, RotationField = 1 << 1, MoreSymbolsPerFeature = 1 << 2, Filter = 1 << 3,
  ScaleDependent = 1 << 4
}
 
- Protected Member Functions inherited from QgsFeatureRendererV2
 QgsFeatureRendererV2 (const QString &type)
 
Q_DECL_DEPRECATED void copyPaintEffect (QgsFeatureRendererV2 *destRenderer) const
 Copies paint effect of this renderer to another renderer. More...
 
void copyRendererData (QgsFeatureRendererV2 *destRenderer) const
 Clones generic renderer data to another renderer. More...
 
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 More...
 
void renderVertexMarkerPolygon (QPolygonF &pts, QList< QPolygonF > *rings, QgsRenderContext &context)
 render editing vertex marker for a polygon More...
 
void renderVertexMarkerPolyline (QPolygonF &pts, QgsRenderContext &context)
 render editing vertex marker for a polyline More...
 
void setScaleMethodToSymbol (QgsSymbolV2 *symbol, int scaleMethod)
 
- Static Protected Member Functions inherited from QgsFeatureRendererV2
static QgsConstWkbPtr _getLineString (QPolygonF &pts, QgsRenderContext &context, QgsConstWkbPtr &wkb, bool clipToExtent=true)
 Creates a line string in screen coordinates from a wkb string in map coordinates. More...
 
static QgsConstWkbPtr _getPoint (QPointF &pt, QgsRenderContext &context, QgsConstWkbPtr &wkb)
 Creates a point in screen coordinates from a wkb string in map coordinates. More...
 
static QgsConstWkbPtr _getPolygon (QPolygonF &pts, QList< QPolygonF > &holes, QgsRenderContext &context, QgsConstWkbPtr &wkb, bool clipToExtent=true)
 Creates a polygon in screen coordinates from a wkb string in map coordinates. More...
 
static void convertSymbolRotation (QgsSymbolV2 *symbol, const QString &field)
 
static void convertSymbolSizeScale (QgsSymbolV2 *symbol, QgsSymbolV2::ScaleMethod method, const QString &field)
 
- Protected Attributes inherited from QgsFeatureRendererV2
int mCurrentVertexMarkerSize
 The current size of editing marker. More...
 
int mCurrentVertexMarkerType
 The current type of editing marker. More...
 
bool mForceRaster
 
QgsFeatureRequest::OrderBy mOrderBy
 
bool mOrderByEnabled
 
QgsPaintEffectmPaintEffect
 
QString mType
 
bool mUsingSymbolLevels
 

Detailed Description

Definition at line 27 of file qgs25drenderer.h.

Constructor & Destructor Documentation

Qgs25DRenderer::Qgs25DRenderer ( )

Definition at line 61 of file qgs25drenderer.cpp.

Member Function Documentation

QgsFeatureRendererV2 * Qgs25DRenderer::clone ( ) const
overridevirtual

Implements QgsFeatureRendererV2.

Definition at line 153 of file qgs25drenderer.cpp.

Qgs25DRenderer * Qgs25DRenderer::convertFromRenderer ( QgsFeatureRendererV2 renderer)
static

Try to convert from an existing renderer.

If it is not of the same type we assume that the internals are not compatible and create a new default 2.5D renderer.

Definition at line 253 of file qgs25drenderer.cpp.

QgsFeatureRendererV2 * Qgs25DRenderer::create ( QDomElement element)
static

Create a new 2.5D renderer from XML.

Parameters
elementXML information

Definition at line 125 of file qgs25drenderer.cpp.

QColor Qgs25DRenderer::roofColor ( ) const

Get the roof color.

Definition at line 242 of file qgs25drenderer.cpp.

QDomElement Qgs25DRenderer::save ( QDomDocument doc)
overridevirtual

store renderer info to XML element

Reimplemented from QgsFeatureRendererV2.

Definition at line 112 of file qgs25drenderer.cpp.

void Qgs25DRenderer::setRoofColor ( const QColor roofColor)

Set the roof color.

Definition at line 247 of file qgs25drenderer.cpp.

void Qgs25DRenderer::setShadowColor ( const QColor shadowColor)

Set the shadow's color.

Definition at line 206 of file qgs25drenderer.cpp.

void Qgs25DRenderer::setShadowEnabled ( bool  value)

Enable or disable the shadow.

Definition at line 196 of file qgs25drenderer.cpp.

void Qgs25DRenderer::setShadowSpread ( double  shadowSpread)

Set the shadow's spread distance in map units.

Definition at line 216 of file qgs25drenderer.cpp.

void Qgs25DRenderer::setWallColor ( const QColor wallColor)

Set the wall color.

Definition at line 226 of file qgs25drenderer.cpp.

void Qgs25DRenderer::setWallShadingEnabled ( bool  enabled)

Set wall shading enabled.

Definition at line 232 of file qgs25drenderer.cpp.

QColor Qgs25DRenderer::shadowColor ( ) const

Get the shadow's color.

Definition at line 201 of file qgs25drenderer.cpp.

bool Qgs25DRenderer::shadowEnabled ( ) const

Is the shadow enabled.

Definition at line 191 of file qgs25drenderer.cpp.

double Qgs25DRenderer::shadowSpread ( ) const

Get the shadow's spread distance in map units.

Definition at line 211 of file qgs25drenderer.cpp.

void Qgs25DRenderer::startRender ( QgsRenderContext context,
const QgsFields fields 
)
overridevirtual

Needs to be called when a new render cycle is started.

Parameters
contextAdditional information passed to the renderer about the job which will be rendered
fieldsThe fields available for rendering
Returns
Information passed back from the renderer that can e.g. be used to reduce the amount of requested features

Implements QgsFeatureRendererV2.

Definition at line 138 of file qgs25drenderer.cpp.

void Qgs25DRenderer::stopRender ( QgsRenderContext context)
overridevirtual

Needs to be called when a render cycle has finished to clean up.

Implements QgsFeatureRendererV2.

Definition at line 143 of file qgs25drenderer.cpp.

QgsSymbolV2 * Qgs25DRenderer::symbolForFeature ( QgsFeature feature,
QgsRenderContext context 
)
overridevirtual

To be overridden.

Must be called between startRender() and stopRender() calls.

Parameters
featurefeature
contextrender context
Returns
returns pointer to symbol or 0 if symbol was not found
Note
added in QGIS 2.12
available in Python bindings as symbolForFeature2

Reimplemented from QgsFeatureRendererV2.

Definition at line 160 of file qgs25drenderer.cpp.

QgsSymbolV2List Qgs25DRenderer::symbols ( QgsRenderContext context)
overridevirtual

Returns list of symbols used by the renderer.

Parameters
contextrender context
Note
added in QGIS 2.12
available in Python bindings as symbols2

Reimplemented from QgsFeatureRendererV2.

Definition at line 167 of file qgs25drenderer.cpp.

QList< QString > Qgs25DRenderer::usedAttributes ( )
overridevirtual

Returns a set of attributes required for this renderer.

TODO QGIS3: Change QList to QSet

Implements QgsFeatureRendererV2.

Definition at line 148 of file qgs25drenderer.cpp.

QColor Qgs25DRenderer::wallColor ( ) const

Get the wall color.

Definition at line 221 of file qgs25drenderer.cpp.

bool Qgs25DRenderer::wallShadingEnabled ( )

Get wall shading enabled.

Definition at line 237 of file qgs25drenderer.cpp.


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