QGIS API Documentation
3.0.2-Girona (307d082)
|
#include <qgssymbol.h>
Public Member Functions | |
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 (const QgsSymbolRenderContext &rh)=delete | |
QgsSymbolRenderContext cannot be copied. More... | |
QgsExpressionContextScope * | expressionContextScope () |
This scope is always available when a symbol of this type is being rendered. More... | |
const QgsFeature * | feature () const |
Current feature being rendered - may be null. 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... | |
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... | |
double | outputLineWidth (double width) const |
double | outputPixelSize (double size) const |
QgsUnitTypes::RenderUnit | outputUnit () const |
Returns the output unit for the context. 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 |
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... | |
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... | |
void | setOutputUnit (QgsUnitTypes::RenderUnit u) |
Sets the output unit for the context. More... | |
void | setRenderHints (QgsSymbol::RenderHints hints) |
Sets rendering hint flags for the symbol. More... | |
void | setSelected (bool selected) |
Definition at line 430 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 1041 of file qgssymbol.cpp.
|
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 1080 of file qgssymbol.cpp.
|
inline |
Current feature being rendered - may be null.
Definition at line 509 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 null)
Definition at line 534 of file qgssymbol.h.
|
inline |
|
inline |
|
inline |
Definition at line 475 of file qgssymbol.h.
|
inline |
Returns the opacity for the symbol.
Definition at line 483 of file qgssymbol.h.
QgsSymbolRenderContext & QgsSymbolRenderContext::operator= | ( | const QgsSymbolRenderContext & | ) |
Definition at line 1070 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 526 of file qgssymbol.h.
double QgsSymbolRenderContext::outputLineWidth | ( | double | width | ) | const |
Definition at line 1060 of file qgssymbol.cpp.
double QgsSymbolRenderContext::outputPixelSize | ( | double | size | ) | const |
Definition at line 1065 of file qgssymbol.cpp.
|
inline |
Returns the output unit for the context.
Definition at line 470 of file qgssymbol.h.
|
inline |
Returns a reference to the context's render context.
Definition at line 453 of file qgssymbol.h.
|
inline |
Returns a reference to the context's render context.
Definition at line 459 of file qgssymbol.h.
|
inline |
Returns the rendering hint flags for the symbol.
Definition at line 499 of file qgssymbol.h.
|
inline |
Definition at line 492 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 1085 of file qgssymbol.cpp.
|
inline |
Definition at line 507 of file qgssymbol.h.
|
inline |
|
inline |
Sets the part number of current geometry.
Definition at line 558 of file qgssymbol.h.
|
inline |
Definition at line 476 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 490 of file qgssymbol.h.
|
inline |
Sets the geometry type for the original feature geometry being rendered.
Definition at line 516 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 1055 of file qgssymbol.cpp.
|
inline |
Sets the output unit for the context.
Definition at line 473 of file qgssymbol.h.
|
inline |
Sets rendering hint flags for the symbol.
Definition at line 505 of file qgssymbol.h.
|
inline |
Definition at line 493 of file qgssymbol.h.