Class: Qgs25DRenderer

class qgis.core.Qgs25DRenderer

Bases: QgsFeatureRenderer

Methods

accept

param visitor:

clone

rtype:

QgsFeatureRenderer

convertFromRenderer

Try to convert from an existing renderer.

convertSymbolRotation

convertSymbolSizeScale

create

Create a new 2.5D renderer from XML

renderFeatureWithSymbol

Render the feature with the symbol using context.

renderVertexMarker

render editing vertex marker at specified point

renderVertexMarkerPolygon

render editing vertex marker for a polygon

renderVertexMarkerPolyline

render editing vertex marker for a polyline

roofColor

Gets the roof color

save

param doc:

saveRendererData

Saves generic renderer data into the specified element.

setRoofColor

Set the roof color

setShadowColor

Set the shadow's color

setShadowEnabled

Enable or disable the shadow

setShadowSpread

Set the shadow's spread distance in map units

setWallColor

Set the wall color

setWallShadingEnabled

Set wall shading enabled

shadowColor

Gets the shadow's color

shadowEnabled

Is the shadow enabled

shadowSpread

Gets the shadow's spread distance in map units

startRender

param context:

stopRender

param context:

symbolForFeature

param feature:

symbols

param context:

usedAttributes

param context:

wallColor

Gets the wall color

wallShadingEnabled

Gets wall shading enabled

accept(self, visitor: QgsStyleEntityVisitorInterface) bool
Parameters:

visitor (QgsStyleEntityVisitorInterface) –

Return type:

bool

clone(self) QgsFeatureRenderer
Return type:

QgsFeatureRenderer

convertFromRenderer(renderer: QgsFeatureRenderer) Qgs25DRenderer

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.

Parameters:

renderer (QgsFeatureRenderer) –

Return type:

Qgs25DRenderer

convertSymbolRotation(symbol: QgsSymbol, field: str)

Note

this function is used to convert old rotations expressions to symbol level DataDefined angle

convertSymbolSizeScale(symbol: QgsSymbol, method: Qgis.ScaleMethod, field: str)

Note

this function is used to convert old sizeScale expressions to symbol level DataDefined size

create(element: QDomElement, context: QgsReadWriteContext) QgsFeatureRenderer

Create a new 2.5D renderer from XML

Parameters:
Return type:

QgsFeatureRenderer

renderFeatureWithSymbol(self, feature: QgsFeature, symbol: QgsSymbol, context: QgsRenderContext, layer: int, selected: bool, drawVertexMarker: bool)

Render the feature with the symbol using context. Use layer to specify the symbol layer, selected to specify if it should be rendered as selected and drawVertexMarker to specify if vertex markers should be rendered.

renderVertexMarker(self, pt: QPointF | QPoint, context: QgsRenderContext)

render editing vertex marker at specified point

renderVertexMarkerPolygon(self, pts: QPolygonF, rings: Iterable[QPolygonF], context: QgsRenderContext)

render editing vertex marker for a polygon

renderVertexMarkerPolyline(self, pts: QPolygonF, context: QgsRenderContext)

render editing vertex marker for a polyline

roofColor(self) QColor

Gets the roof color

Return type:

QColor

save(self, doc: QDomDocument, context: QgsReadWriteContext) QDomElement
Parameters:
Return type:

QDomElement

saveRendererData(self, doc: QDomDocument, element: QDomElement, context: QgsReadWriteContext)

Saves generic renderer data into the specified element.

This method should be called in a subclass’ save() implementation in order to store all common base class properties in the DOM element.

New in version 3.22.

setRoofColor(self, roofColor: QColor | Qt.GlobalColor)

Set the roof color

Parameters:

roofColor (Union[QColor) –

setShadowColor(self, shadowColor: QColor | Qt.GlobalColor)

Set the shadow’s color

Parameters:

shadowColor (Union[QColor) –

setShadowEnabled(self, value: bool)

Enable or disable the shadow

Parameters:

value (bool) –

setShadowSpread(self, shadowSpread: float)

Set the shadow’s spread distance in map units

Parameters:

shadowSpread (float) –

setWallColor(self, wallColor: QColor | Qt.GlobalColor)

Set the wall color

Parameters:

wallColor (Union[QColor) –

setWallShadingEnabled(self, enabled: bool)

Set wall shading enabled

Parameters:

enabled (bool) –

shadowColor(self) QColor

Gets the shadow’s color

Return type:

QColor

shadowEnabled(self) bool

Is the shadow enabled

Return type:

bool

shadowSpread(self) float

Gets the shadow’s spread distance in map units

Return type:

float

startRender(self, context: QgsRenderContext, fields: QgsFields)
Parameters:
stopRender(self, context: QgsRenderContext)
Parameters:

context (QgsRenderContext) –

symbolForFeature(self, feature: QgsFeature, context: QgsRenderContext) QgsSymbol
Parameters:
Return type:

QgsSymbol

symbols(self, context: QgsRenderContext) List[QgsSymbol]
Parameters:

context (QgsRenderContext) –

Return type:

List[QgsSymbol]

usedAttributes(self, context: QgsRenderContext) Set[str]
Parameters:

context (QgsRenderContext) –

Return type:

Set[str]

wallColor(self) QColor

Gets the wall color

Return type:

QColor

wallShadingEnabled(self) bool

Gets wall shading enabled

Return type:

bool