QGIS API Documentation  2.99.0-Master (a18066b)
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 ()
 
QgsFeatureRendererclone () const override
 Create a deep copy of this renderer. More...
 
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 QgsSymbolsymbolForFeature (QgsFeature &feature, QgsRenderContext &context) override
 To be overridden. More...
 
virtual QgsSymbolList symbols (QgsRenderContext &context) override
 Returns list of symbols used by the renderer. More...
 
QSet< QString > usedAttributes (const QgsRenderContext &context) const override
 Return a list of attributes required by this renderer. More...
 
QColor wallColor () const
 Get the wall color. More...
 
bool wallShadingEnabled () const
 Get wall shading enabled. More...
 
- Public Member Functions inherited from QgsFeatureRenderer
virtual ~QgsFeatureRenderer ()
 
virtual Capabilities capabilities ()
 Returns details about internals of this renderer. More...
 
virtual void checkLegendSymbolItem (const QString &key, bool state=true)
 item in symbology was checked More...
 
virtual QString dump () const
 Returns debug information about this renderer. More...
 
virtual const QgsFeatureRendererembeddedRenderer () 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< QString > legendKeysForFeature (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 QgsSymboloriginalSymbolForFeature (QgsFeature &feature, QgsRenderContext &context)
 Return symbol for feature. More...
 
virtual QgsSymbolList 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 void setEmbeddedRenderer (QgsFeatureRenderer *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, QgsSymbol *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...
 
void setUsingSymbolLevels (bool usingSymbolLevels)
 
void setVertexMarkerAppearance (int type, int size)
 set type and size of editing vertex markers for subsequent rendering More...
 
virtual QgsSymbolList symbolsForFeature (QgsFeature &feat, QgsRenderContext &context)
 Returns list of symbols used for rendering the feature. More...
 
virtual void toSld (QDomDocument &doc, QDomElement &element, const QgsStringMap &props=QgsStringMap()) const
 used from subclasses to create SLD Rule elements following SLD v1.1 specs More...
 
QString type () const
 
bool usingSymbolLevels () const
 
virtual bool willRenderFeature (QgsFeature &feat, QgsRenderContext &context)
 Returns whether the renderer will render a feature or not. More...
 
virtual QDomElement writeSld (QDomDocument &doc, const QString &styleName, const QgsStringMap &props=QgsStringMap()) const
 create the SLD UserStyle element following the SLD v1.1 specs with the given name More...
 

Static Public Member Functions

static Qgs25DRendererconvertFromRenderer (QgsFeatureRenderer *renderer)
 Try to convert from an existing renderer. More...
 
static QgsFeatureRenderercreate (QDomElement &element)
 Create a new 2.5D renderer from XML. More...
 
- Static Public Member Functions inherited from QgsFeatureRenderer
static QgsFeatureRendererdefaultRenderer (QgsWkbTypes::GeometryType geomType)
 return a new renderer - used by default in vector layers More...
 
static QgsFeatureRendererload (QDomElement &symbologyElem)
 create a renderer from XML element More...
 
static QgsFeatureRendererloadSld (const QDomNode &node, QgsWkbTypes::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 QgsFeatureRenderer
enum  Capability { SymbolLevels = 1, MoreSymbolsPerFeature = 1 << 2, Filter = 1 << 3, ScaleDependent = 1 << 4 }
 Used to specify details about a renderer. More...
 
- Protected Member Functions inherited from QgsFeatureRenderer
 QgsFeatureRenderer (const QString &type)
 
void copyRendererData (QgsFeatureRenderer *destRenderer) const
 Clones generic renderer data to another renderer. More...
 
void renderFeatureWithSymbol (QgsFeature &feature, QgsSymbol *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...
 
- Static Protected Member Functions inherited from QgsFeatureRenderer
static QPointF _getPoint (QgsRenderContext &context, const QgsPointV2 &point)
 Creates a point in screen coordinates from a wkb string in map coordinates. More...
 
static void convertSymbolRotation (QgsSymbol *symbol, const QString &field)
 
static void convertSymbolSizeScale (QgsSymbol *symbol, QgsSymbol::ScaleMethod method, const QString &field)
 
- Protected Attributes inherited from QgsFeatureRenderer
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 = nullptr
 
QString mType
 
bool mUsingSymbolLevels
 

Detailed Description

Definition at line 27 of file qgs25drenderer.h.

Constructor & Destructor Documentation

◆ Qgs25DRenderer()

Qgs25DRenderer::Qgs25DRenderer ( )

Definition at line 62 of file qgs25drenderer.cpp.

Member Function Documentation

◆ clone()

QgsFeatureRenderer * Qgs25DRenderer::clone ( ) const
overridevirtual

Create a deep copy of this renderer.

Should be implemented by all subclasses and generate a proper subclass.

Returns
A copy of this renderer

Implements QgsFeatureRenderer.

Definition at line 154 of file qgs25drenderer.cpp.

◆ convertFromRenderer()

Qgs25DRenderer * Qgs25DRenderer::convertFromRenderer ( QgsFeatureRenderer 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 254 of file qgs25drenderer.cpp.

◆ create()

QgsFeatureRenderer * Qgs25DRenderer::create ( QDomElement &  element)
static

Create a new 2.5D renderer from XML.

Parameters
elementXML information

Definition at line 126 of file qgs25drenderer.cpp.

◆ roofColor()

QColor Qgs25DRenderer::roofColor ( ) const

Get the roof color.

Definition at line 243 of file qgs25drenderer.cpp.

◆ save()

QDomElement Qgs25DRenderer::save ( QDomDocument &  doc)
overridevirtual

store renderer info to XML element

Reimplemented from QgsFeatureRenderer.

Definition at line 113 of file qgs25drenderer.cpp.

◆ setRoofColor()

void Qgs25DRenderer::setRoofColor ( const QColor &  roofColor)

Set the roof color.

Definition at line 248 of file qgs25drenderer.cpp.

◆ setShadowColor()

void Qgs25DRenderer::setShadowColor ( const QColor &  shadowColor)

Set the shadow's color.

Definition at line 207 of file qgs25drenderer.cpp.

◆ setShadowEnabled()

void Qgs25DRenderer::setShadowEnabled ( bool  value)

Enable or disable the shadow.

Definition at line 197 of file qgs25drenderer.cpp.

◆ setShadowSpread()

void Qgs25DRenderer::setShadowSpread ( double  shadowSpread)

Set the shadow's spread distance in map units.

Definition at line 217 of file qgs25drenderer.cpp.

◆ setWallColor()

void Qgs25DRenderer::setWallColor ( const QColor &  wallColor)

Set the wall color.

Definition at line 227 of file qgs25drenderer.cpp.

◆ setWallShadingEnabled()

void Qgs25DRenderer::setWallShadingEnabled ( bool  enabled)

Set wall shading enabled.

Definition at line 233 of file qgs25drenderer.cpp.

◆ shadowColor()

QColor Qgs25DRenderer::shadowColor ( ) const

Get the shadow's color.

Definition at line 202 of file qgs25drenderer.cpp.

◆ shadowEnabled()

bool Qgs25DRenderer::shadowEnabled ( ) const

Is the shadow enabled.

Definition at line 192 of file qgs25drenderer.cpp.

◆ shadowSpread()

double Qgs25DRenderer::shadowSpread ( ) const

Get the shadow's spread distance in map units.

Definition at line 212 of file qgs25drenderer.cpp.

◆ startRender()

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 QgsFeatureRenderer.

Definition at line 139 of file qgs25drenderer.cpp.

◆ stopRender()

void Qgs25DRenderer::stopRender ( QgsRenderContext context)
overridevirtual

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

Implements QgsFeatureRenderer.

Definition at line 144 of file qgs25drenderer.cpp.

◆ symbolForFeature()

QgsSymbol * 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

Implements QgsFeatureRenderer.

Definition at line 161 of file qgs25drenderer.cpp.

◆ symbols()

QgsSymbolList Qgs25DRenderer::symbols ( QgsRenderContext context)
overridevirtual

Returns list of symbols used by the renderer.

Parameters
contextrender context
Note
added in QGIS 2.12

Reimplemented from QgsFeatureRenderer.

Definition at line 168 of file qgs25drenderer.cpp.

◆ usedAttributes()

QSet< QString > Qgs25DRenderer::usedAttributes ( const QgsRenderContext context) const
overridevirtual

Return a list of attributes required by this renderer.

Attributes not listed in here may not have been requested from the provider at rendering time.

Returns
A set of attributes

Implements QgsFeatureRenderer.

Definition at line 149 of file qgs25drenderer.cpp.

◆ wallColor()

QColor Qgs25DRenderer::wallColor ( ) const

Get the wall color.

Definition at line 222 of file qgs25drenderer.cpp.

◆ wallShadingEnabled()

bool Qgs25DRenderer::wallShadingEnabled ( ) const

Get wall shading enabled.

Definition at line 238 of file qgs25drenderer.cpp.


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