Class: QgsInvertedPolygonRenderer¶
-
class
qgis.core.
QgsInvertedPolygonRenderer
(embeddedRenderer: QgsFeatureRenderer = None)¶ Bases:
QgsFeatureRenderer
Constructor
- Parameters
embeddedRenderer (
QgsFeatureRenderer
= None) – optional embeddedRenderer. IfNone
, a default one will be assigned. Ownership will be transferred.
QgsInvertedPolygonRenderer
is a polygon-only feature renderer used to display features inverted, where the exterior is turned to an interior and where the exterior theoretically spans the entire plane, allowing to mask the surroundings of some features.It is designed on top of another feature renderer, which is called “embedded” Most of the methods are then only proxies to the embedded renderer.
Features are collected to form one “inverted” polygon during renderFeature() and rendered on stopRender().
Methods
- param visitor
- rtype
QgsFeatureRenderer.Capabilities
- param key
Direct copies are forbidden.
Creates a
QgsInvertedPolygonRenderer
by a conversion from an existing renderer.Clones generic renderer data to another renderer.
Creates a renderer out of an XML, for loading
- rtype
str
- rtype
QgsFeatureRenderer
- rtype
bool
- param feature
- param key
- rtype
List[QgsLegendSymbolItem]
- rtype
bool
- param feature
- param feature
- rtype
bool
Renders a given feature.
Render the
feature
with thesymbol
usingcontext
.render editing vertex marker at specified point
render editing vertex marker for a polygon
render editing vertex marker for a polyline
- param doc
- param subRenderer
- param key
- type enabled
bool
- param context
The actual rendering will take place here.
- param feature
- param context
- param feature
- param context
- param feature
-
accept
(self, visitor: QgsStyleEntityVisitorInterface) → bool¶ - Parameters
visitor (QgsStyleEntityVisitorInterface) –
- Return type
bool
-
capabilities
(self) → QgsFeatureRenderer.Capabilities¶ - Return type
-
checkLegendSymbolItem
(self, key: str, state: bool = True)¶ - Parameters
key (str) –
state (bool = True) –
-
clone
(self) → QgsInvertedPolygonRenderer¶ Direct copies are forbidden. Use clone() instead.
- Return type
-
convertFromRenderer
(renderer: QgsFeatureRenderer) → QgsInvertedPolygonRenderer¶ Creates a
QgsInvertedPolygonRenderer
by a conversion from an existing renderer.- Return type
- Returns
a new renderer if the conversion was possible, otherwise 0.
New in version 2.5.
- Parameters
renderer (QgsFeatureRenderer) –
-
convertSymbolRotation
(symbol: QgsSymbol, field: str)¶ Note
this function is used to convert old rotations expressions to symbol level DataDefined angle
-
convertSymbolSizeScale
(symbol: QgsSymbol, method: QgsSymbol.ScaleMethod, field: str)¶ Note
this function is used to convert old sizeScale expressions to symbol level DataDefined size
-
copyRendererData
(self, destRenderer: QgsFeatureRenderer)¶ Clones generic renderer data to another renderer. Currently clones * Order By * Paint Effect
- Parameters
destRenderer – destination renderer for copied effect
-
create
(element: QDomElement, context: QgsReadWriteContext) → QgsFeatureRenderer¶ Creates a renderer out of an XML, for loading
- Parameters
element (QDomElement) –
context (QgsReadWriteContext) –
- Return type
-
dump
(self) → str¶ - Return type
str
-
embeddedRenderer
(self) → QgsFeatureRenderer¶ - Return type
-
filterNeedsGeometry
(self) → bool¶ - Return type
bool
-
legendKeysForFeature
(self, feature: QgsFeature, context: QgsRenderContext) → Set[str]¶ - Parameters
feature (QgsFeature) –
context (QgsRenderContext) –
- Return type
Set[str]
-
legendSymbolItemChecked
(self, key: str) → bool¶ - Parameters
key (str) –
- Return type
bool
-
legendSymbolItems
(self) → List[QgsLegendSymbolItem]¶ - Return type
List[QgsLegendSymbolItem]
-
legendSymbolItemsCheckable
(self) → bool¶ - Return type
bool
-
originalSymbolForFeature
(self, feature: QgsFeature, context: QgsRenderContext) → QgsSymbol¶ - Parameters
feature (QgsFeature) –
context (QgsRenderContext) –
- Return type
-
originalSymbolsForFeature
(self, feature: QgsFeature, context: QgsRenderContext) → List[QgsSymbol]¶ - Parameters
feature (QgsFeature) –
context (QgsRenderContext) –
- Return type
List[QgsSymbol]
-
preprocessingEnabled
(self) → bool¶ - Return type
bool
- Returns
True
if the geometries are to be preprocessed (merged with an union) before rendering.
-
renderFeature
(self, feature: QgsFeature, context: QgsRenderContext, layer: int = - 1, selected: bool = False, drawVertexMarker: bool = False) → bool¶ Renders a given feature. This will here collect features. The actual rendering will be postponed to stopRender()
- Parameters
feature (QgsFeature) – the feature to render
context (QgsRenderContext) – the rendering context
layer (int = -1) – the symbol layer to render, if that makes sense
selected (bool = False) – whether this feature has been selected (this will add decorations)
drawVertexMarker (bool = False) – whether this feature has vertex markers (in edit mode usually)
- Return type
bool
- Returns
True
if the rendering was OK
-
renderFeatureWithSymbol
(self, feature: QgsFeature, symbol: QgsSymbol, context: QgsRenderContext, layer: int, selected: bool, drawVertexMarker: bool)¶ Render the
feature
with thesymbol
usingcontext
. Uselayer
to specify the symbol layer,selected
to specify if it should be rendered as selected anddrawVertexMarker
to specify if vertex markers should be rendered.
-
renderVertexMarker
(self, pt: Union[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
-
save
(self, doc: QDomDocument, context: QgsReadWriteContext) → QDomElement¶ - Parameters
doc (QDomDocument) –
context (QgsReadWriteContext) –
- Return type
QDomElement
-
setEmbeddedRenderer
(self, subRenderer: QgsFeatureRenderer)¶ - Parameters
subRenderer (QgsFeatureRenderer) –
-
setPreprocessingEnabled
(self, enabled: bool)¶ - Parameters
enabled (bool) – enables or disables the preprocessing. When enabled, geometries will be merged with an union before being rendered. It allows fixing some rendering artifacts (when rendering overlapping polygons for instance). This will involve some CPU-demanding computations and is thus disabled by default.
-
startRender
(self, context: QgsRenderContext, fields: QgsFields)¶ - Parameters
context (QgsRenderContext) –
fields (QgsFields) –
-
stopRender
(self, context: QgsRenderContext)¶ The actual rendering will take place here. Features collected during renderFeature() are rendered using the embedded feature renderer
- Parameters
context (QgsRenderContext) –
-
symbolForFeature
(self, feature: QgsFeature, context: QgsRenderContext) → QgsSymbol¶ - Parameters
feature (QgsFeature) –
context (QgsRenderContext) –
- Return type
-
symbols
(self, context: QgsRenderContext) → List[QgsSymbol]¶ - Parameters
context (QgsRenderContext) –
- Return type
List[QgsSymbol]
-
symbolsForFeature
(self, feature: QgsFeature, context: QgsRenderContext) → List[QgsSymbol]¶ - Parameters
feature (QgsFeature) –
context (QgsRenderContext) –
- Return type
List[QgsSymbol]
-
usedAttributes
(self, context: QgsRenderContext) → Set[str]¶ - Parameters
context (QgsRenderContext) –
- Return type
Set[str]
-
willRenderFeature
(self, feature: QgsFeature, context: QgsRenderContext) → bool¶ - Parameters
feature (QgsFeature) –
context (QgsRenderContext) –
- Return type
bool