QGIS API Documentation
3.14.0-Pi (9f7028fd23)
|
#include <qgssymbol.h>
Public Member Functions | |
QgsSymbolRenderContext (const QgsSymbolRenderContext &rh)=delete | |
QgsSymbolRenderContext cannot be copied. More... | |
QgsSymbolRenderContext (QgsRenderContext &c, QgsUnitTypes::RenderUnit u, qreal opacity=1.0, bool selected=false, QgsSymbol::RenderHints renderHints=nullptr, const QgsFeature *f=nullptr, const QgsFields &fields=QgsFields(), const QgsMapUnitScale &mapUnitScale=QgsMapUnitScale()) | |
Constructor for QgsSymbolRenderContext. More... | |
~QgsSymbolRenderContext () | |
QgsExpressionContextScope * | expressionContextScope () |
This scope is always available when a symbol of this type is being rendered. More... | |
const QgsFeature * | feature () const |
Returns the current feature being rendered. More... | |
QgsFields | fields () const |
Fields of the layer. More... | |
int | geometryPartCount () const |
Part count of current geometry. More... | |
int | geometryPartNum () const |
Part number of current geometry. More... | |
Q_DECL_DEPRECATED QgsMapUnitScale | mapUnitScale () const |
qreal | opacity () const |
Returns the opacity for the symbol. More... | |
QgsSymbolRenderContext & | operator= (const QgsSymbolRenderContext &) |
QgsWkbTypes::GeometryType | originalGeometryType () const |
Returns the geometry type for the original feature geometry being rendered. More... | |
Q_DECL_DEPRECATED double | outputLineWidth (double width) const |
Q_DECL_DEPRECATED double | outputPixelSize (double size) const |
Q_DECL_DEPRECATED QgsUnitTypes::RenderUnit | outputUnit () const |
Returns the output unit for the context. More... | |
const QgsLegendPatchShape * | patchShape () const |
Returns the symbol patch shape, to use if rendering symbol preview icons. More... | |
QgsRenderContext & | renderContext () |
Returns a reference to the context's render context. More... | |
const QgsRenderContext & | renderContext () const |
Returns a reference to the context's render context. More... | |
QgsSymbol::RenderHints | renderHints () const |
Returns the rendering hint flags for the symbol. More... | |
bool | selected () const |
Returns true if symbols should be rendered using the selected symbol coloring and style. More... | |
void | setExpressionContextScope (QgsExpressionContextScope *contextScope) |
Set an expression scope for this symbol. More... | |
void | setFeature (const QgsFeature *f) |
void | setGeometryPartCount (int count) |
Sets the part count of current geometry. More... | |
void | setGeometryPartNum (int num) |
Sets the part number of current geometry. More... | |
Q_DECL_DEPRECATED void | setMapUnitScale (const QgsMapUnitScale &scale) |
void | setOpacity (qreal opacity) |
Sets the opacity for the symbol. More... | |
void | setOriginalGeometryType (QgsWkbTypes::GeometryType type) |
Sets the geometry type for the original feature geometry being rendered. More... | |
void | setOriginalValueVariable (const QVariant &value) |
Sets the original value variable value for data defined symbology. More... | |
Q_DECL_DEPRECATED void | setOutputUnit (QgsUnitTypes::RenderUnit u) |
Sets the output unit for the context. More... | |
void | setPatchShape (const QgsLegendPatchShape &shape) |
Sets the symbol patch shape, to use if rendering symbol preview icons. More... | |
void | setRenderHints (QgsSymbol::RenderHints hints) |
Sets rendering hint flags for the symbol. More... | |
void | setSelected (bool selected) |
Sets whether symbols should be rendered using the selected symbol coloring and style. More... | |
Definition at line 681 of file qgssymbol.h.
QgsSymbolRenderContext::QgsSymbolRenderContext | ( | QgsRenderContext & | c, |
QgsUnitTypes::RenderUnit | u, | ||
qreal | opacity = 1.0 , |
||
bool | selected = false , |
||
QgsSymbol::RenderHints | renderHints = nullptr , |
||
const QgsFeature * | f = nullptr , |
||
const QgsFields & | fields = QgsFields() , |
||
const QgsMapUnitScale & | mapUnitScale = QgsMapUnitScale() |
||
) |
Constructor for QgsSymbolRenderContext.
c | |
u | |
opacity | value between 0 (fully transparent) and 1 (fully opaque) |
selected | set to true if symbol should be drawn in a "selected" state |
renderHints | flags controlling rendering behavior |
f | |
fields | |
mapUnitScale |
Definition at line 1354 of file qgssymbol.cpp.
|
default |
|
delete |
QgsSymbolRenderContext cannot be copied.
QgsExpressionContextScope * QgsSymbolRenderContext::expressionContextScope | ( | ) |
This scope is always available when a symbol of this type is being rendered.
Definition at line 1396 of file qgssymbol.cpp.
|
inline |
Returns the current feature being rendered.
This may be nullptr
.
Definition at line 789 of file qgssymbol.h.
|
inline |
Fields of the layer.
Currently only available in startRender() calls to allow symbols with data-defined properties prepare the expressions (other times fields() returns an empty QgsFields object).
Definition at line 814 of file qgssymbol.h.
|
inline |
|
inline |
|
inline |
Definition at line 739 of file qgssymbol.h.
|
inline |
Returns the opacity for the symbol.
Definition at line 751 of file qgssymbol.h.
QgsSymbolRenderContext & QgsSymbolRenderContext::operator= | ( | const QgsSymbolRenderContext & | ) |
Definition at line 1386 of file qgssymbol.cpp.
|
inline |
Returns the geometry type for the original feature geometry being rendered.
This can be useful if symbol layers alter their appearance based on geometry type - eg offsetting a simple line style will look different if the simple line is rendering a polygon feature (a closed buffer) vs a line feature (an unclosed offset line).
Definition at line 806 of file qgssymbol.h.
double QgsSymbolRenderContext::outputLineWidth | ( | double | width | ) | const |
Definition at line 1375 of file qgssymbol.cpp.
double QgsSymbolRenderContext::outputPixelSize | ( | double | size | ) | const |
Definition at line 1380 of file qgssymbol.cpp.
|
inline |
Returns the output unit for the context.
Definition at line 728 of file qgssymbol.h.
const QgsLegendPatchShape * QgsSymbolRenderContext::patchShape | ( | ) | const |
Returns the symbol patch shape, to use if rendering symbol preview icons.
Definition at line 1406 of file qgssymbol.cpp.
|
inline |
Returns a reference to the context's render context.
Definition at line 708 of file qgssymbol.h.
|
inline |
Returns a reference to the context's render context.
Definition at line 714 of file qgssymbol.h.
|
inline |
Returns the rendering hint flags for the symbol.
Definition at line 776 of file qgssymbol.h.
|
inline |
Returns true
if symbols should be rendered using the selected symbol coloring and style.
Definition at line 764 of file qgssymbol.h.
void QgsSymbolRenderContext::setExpressionContextScope | ( | QgsExpressionContextScope * | contextScope | ) |
Set an expression scope for this symbol.
Will take ownership.
contextScope | An expression scope for details about this symbol |
Definition at line 1401 of file qgssymbol.cpp.
|
inline |
Definition at line 784 of file qgssymbol.h.
|
inline |
|
inline |
Sets the part number of current geometry.
Definition at line 838 of file qgssymbol.h.
|
inline |
Definition at line 744 of file qgssymbol.h.
|
inline |
Sets the opacity for the symbol.
opacity | opacity value between 0 (fully transparent) and 1 (fully opaque) |
Definition at line 758 of file qgssymbol.h.
|
inline |
Sets the geometry type for the original feature geometry being rendered.
Definition at line 796 of file qgssymbol.h.
void QgsSymbolRenderContext::setOriginalValueVariable | ( | const QVariant & | value | ) |
Sets the original value variable value for data defined symbology.
value | value for original value variable. This usually represents the symbol property value before any data defined overrides have been applied. |
Definition at line 1370 of file qgssymbol.cpp.
|
inline |
Sets the output unit for the context.
Definition at line 734 of file qgssymbol.h.
void QgsSymbolRenderContext::setPatchShape | ( | const QgsLegendPatchShape & | shape | ) |
Sets the symbol patch shape, to use if rendering symbol preview icons.
Definition at line 1411 of file qgssymbol.cpp.
|
inline |
Sets rendering hint flags for the symbol.
Definition at line 782 of file qgssymbol.h.
|
inline |
Sets whether symbols should be rendered using the selected symbol coloring and style.
Definition at line 770 of file qgssymbol.h.