QGIS API Documentation  3.24.2-Tisler (13c1a02865)
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 ()
 
bool accept (QgsStyleEntityVisitorInterface *visitor) const override
 Accepts the specified symbology visitor, causing it to visit all symbols associated with the renderer. More...
 
QgsFeatureRendererclone () const override
 Create a deep copy of this renderer. More...
 
QColor roofColor () const
 Gets the roof color. More...
 
QDomElement save (QDomDocument &doc, const QgsReadWriteContext &context) override
 Stores renderer properties to an 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
 Gets the shadow's color. More...
 
bool shadowEnabled () const
 Is the shadow enabled. More...
 
double shadowSpread () const
 Gets the shadow's spread distance in map units. More...
 
void startRender (QgsRenderContext &context, const QgsFields &fields) override
 Must be called when a new render cycle is started. More...
 
void stopRender (QgsRenderContext &context) override
 Must be called when a render cycle has finished, to allow the renderer to clean up. More...
 
QgsSymbolsymbolForFeature (const QgsFeature &feature, QgsRenderContext &context) const override
 To be overridden. More...
 
QgsSymbolList symbols (QgsRenderContext &context) const override
 Returns list of symbols used by the renderer. More...
 
QSet< QString > usedAttributes (const QgsRenderContext &context) const override
 Returns a list of attributes required by this renderer. More...
 
QColor wallColor () const
 Gets the wall color. More...
 
bool wallShadingEnabled () const
 Gets wall shading enabled. More...
 
- Public Member Functions inherited from QgsFeatureRenderer
virtual ~QgsFeatureRenderer ()
 
virtual QgsFeatureRenderer::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...
 
void copyRendererData (QgsFeatureRenderer *destRenderer) const
 Clones generic renderer data to another renderer. 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 (const QgsFeature &feature, QgsRenderContext &context) const
 Returns 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 () const
 Returns a list of symbology items for the legend. More...
 
virtual bool legendSymbolItemsCheckable () const
 items of symbology items in legend should be checkable 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
 Gets 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 (const QgsFeature &feature, QgsRenderContext &context) const
 Returns symbol for feature. More...
 
virtual QgsSymbolList originalSymbolsForFeature (const QgsFeature &feature, QgsRenderContext &context) const
 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...
 
double referenceScale () const
 Returns the symbology reference scale. More...
 
virtual bool renderFeature (const QgsFeature &feature, QgsRenderContext &context, int layer=-1, bool selected=false, bool drawVertexMarker=false) SIP_THROW(QgsCsException)
 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 setReferenceScale (double scale)
 Sets the symbology reference scale. More...
 
void setUsingSymbolLevels (bool usingSymbolLevels)
 
void setVertexMarkerAppearance (Qgis::VertexMarkerType type, double size)
 Sets type and size of editing vertex markers for subsequent rendering. More...
 
virtual QgsSymbolList symbolsForFeature (const QgsFeature &feature, QgsRenderContext &context) const
 Returns list of symbols used for rendering the feature. More...
 
virtual void toSld (QDomDocument &doc, QDomElement &element, const QVariantMap &props=QVariantMap()) const
 used from subclasses to create SLD Rule elements following SLD v1.1 specs More...
 
QString type () const
 
virtual bool usesEmbeddedSymbols () const
 Returns true if the renderer uses embedded symbols for features. More...
 
bool usingSymbolLevels () const
 
virtual bool willRenderFeature (const QgsFeature &feature, QgsRenderContext &context) const
 Returns whether the renderer will render a feature or not. More...
 
virtual QDomElement writeSld (QDomDocument &doc, const QString &styleName, const QVariantMap &props=QVariantMap()) 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, const QgsReadWriteContext &context)
 Create a new 2.5D renderer from XML. More...
 
- Static Public Member Functions inherited from QgsFeatureRenderer
static QgsFeatureRendererdefaultRenderer (QgsWkbTypes::GeometryType geomType)
 Returns a new renderer - used by default in vector layers. More...
 
static QgsFeatureRendererload (QDomElement &symbologyElem, const QgsReadWriteContext &context)
 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 renderFeatureWithSymbol (const QgsFeature &feature, QgsSymbol *symbol, QgsRenderContext &context, int layer, bool selected, bool drawVertexMarker) SIP_THROW(QgsCsException)
 Render the feature with the symbol using context. More...
 
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 saveRendererData (QDomDocument &doc, QDomElement &element, const QgsReadWriteContext &context)
 Saves generic renderer data into the specified element. More...
 
- Static Protected Member Functions inherited from QgsFeatureRenderer
static QPointF _getPoint (QgsRenderContext &context, const QgsPoint &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, Qgis::ScaleMethod method, const QString &field)
 
- Protected Attributes inherited from QgsFeatureRenderer
double mCurrentVertexMarkerSize = 2
 The current size of editing marker. More...
 
Qgis::VertexMarkerType mCurrentVertexMarkerType = Qgis::VertexMarkerType::Cross
 The current type of editing marker. More...
 
bool mForceRaster = false
 
QgsFeatureRequest::OrderBy mOrderBy
 
bool mOrderByEnabled = false
 
QgsPaintEffectmPaintEffect = nullptr
 
double mReferenceScale = -1.0
 
QString mType
 
bool mUsingSymbolLevels = false
 

Detailed Description

Definition at line 29 of file qgs25drenderer.h.

Constructor & Destructor Documentation

◆ Qgs25DRenderer()

Qgs25DRenderer::Qgs25DRenderer ( )

Definition at line 66 of file qgs25drenderer.cpp.

Member Function Documentation

◆ accept()

bool Qgs25DRenderer::accept ( QgsStyleEntityVisitorInterface visitor) const
overridevirtual

Accepts the specified symbology visitor, causing it to visit all symbols associated with the renderer.

Returns true if the visitor should continue visiting other objects, or false if visiting should be canceled.

Since
QGIS 3.10

Reimplemented from QgsFeatureRenderer.

Definition at line 186 of file qgs25drenderer.cpp.

◆ 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 164 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 274 of file qgs25drenderer.cpp.

◆ create()

QgsFeatureRenderer * Qgs25DRenderer::create ( QDomElement &  element,
const QgsReadWriteContext context 
)
static

Create a new 2.5D renderer from XML.

Parameters
elementXML information
contextreading context

Definition at line 132 of file qgs25drenderer.cpp.

◆ roofColor()

QColor Qgs25DRenderer::roofColor ( ) const

Gets the roof color.

Definition at line 263 of file qgs25drenderer.cpp.

◆ save()

QDomElement Qgs25DRenderer::save ( QDomDocument &  doc,
const QgsReadWriteContext context 
)
overridevirtual

Stores renderer properties to an XML element.

Subclasses which override this method should call saveRendererData() as part of their implementation in order to store all common base class properties in the returned DOM element.

Reimplemented from QgsFeatureRenderer.

Definition at line 117 of file qgs25drenderer.cpp.

◆ setRoofColor()

void Qgs25DRenderer::setRoofColor ( const QColor &  roofColor)

Set the roof color.

Definition at line 268 of file qgs25drenderer.cpp.

◆ setShadowColor()

void Qgs25DRenderer::setShadowColor ( const QColor &  shadowColor)

Set the shadow's color.

Definition at line 227 of file qgs25drenderer.cpp.

◆ setShadowEnabled()

void Qgs25DRenderer::setShadowEnabled ( bool  value)

Enable or disable the shadow.

Definition at line 217 of file qgs25drenderer.cpp.

◆ setShadowSpread()

void Qgs25DRenderer::setShadowSpread ( double  shadowSpread)

Set the shadow's spread distance in map units.

Definition at line 237 of file qgs25drenderer.cpp.

◆ setWallColor()

void Qgs25DRenderer::setWallColor ( const QColor &  wallColor)

Set the wall color.

Definition at line 247 of file qgs25drenderer.cpp.

◆ setWallShadingEnabled()

void Qgs25DRenderer::setWallShadingEnabled ( bool  enabled)

Set wall shading enabled.

Definition at line 253 of file qgs25drenderer.cpp.

◆ shadowColor()

QColor Qgs25DRenderer::shadowColor ( ) const

Gets the shadow's color.

Definition at line 222 of file qgs25drenderer.cpp.

◆ shadowEnabled()

bool Qgs25DRenderer::shadowEnabled ( ) const

Is the shadow enabled.

Definition at line 212 of file qgs25drenderer.cpp.

◆ shadowSpread()

double Qgs25DRenderer::shadowSpread ( ) const

Gets the shadow's spread distance in map units.

Definition at line 232 of file qgs25drenderer.cpp.

◆ startRender()

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

Must be called when a new render cycle is started.

A call to startRender() must always be followed by a corresponding call to stopRender() after all features have been rendered.

Parameters
contextAdditional information passed to the renderer about the job which will be rendered
fieldsThe fields available for rendering
See also
stopRender()
Warning
This method is not thread safe. Before calling startRender() in a non-main thread, the renderer should instead be cloned and startRender()/stopRender() called on the clone.

Reimplemented from QgsFeatureRenderer.

Definition at line 145 of file qgs25drenderer.cpp.

◆ stopRender()

void Qgs25DRenderer::stopRender ( QgsRenderContext context)
overridevirtual

Must be called when a render cycle has finished, to allow the renderer to clean up.

Calls to stopRender() must always be preceded by a call to startRender().

Warning
This method is not thread safe. Before calling startRender() in a non-main thread, the renderer should instead be cloned and startRender()/stopRender() called on the clone.
See also
startRender()

Reimplemented from QgsFeatureRenderer.

Definition at line 152 of file qgs25drenderer.cpp.

◆ symbolForFeature()

QgsSymbol * Qgs25DRenderer::symbolForFeature ( const QgsFeature feature,
QgsRenderContext context 
) const
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
Since
QGIS 2.12

Implements QgsFeatureRenderer.

Definition at line 171 of file qgs25drenderer.cpp.

◆ symbols()

QgsSymbolList Qgs25DRenderer::symbols ( QgsRenderContext context) const
overridevirtual

Returns list of symbols used by the renderer.

Parameters
contextrender context
Since
QGIS 2.12

Reimplemented from QgsFeatureRenderer.

Definition at line 178 of file qgs25drenderer.cpp.

◆ usedAttributes()

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

Returns 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 159 of file qgs25drenderer.cpp.

◆ wallColor()

QColor Qgs25DRenderer::wallColor ( ) const

Gets the wall color.

Definition at line 242 of file qgs25drenderer.cpp.

◆ wallShadingEnabled()

bool Qgs25DRenderer::wallShadingEnabled ( ) const

Gets wall shading enabled.

Definition at line 258 of file qgs25drenderer.cpp.


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