QGIS API Documentation
2.18.21-Las Palmas (9fba24a)
|
A symbol layer class for displaying displacement arrows based on point layer attributes. More...
#include <qgsvectorfieldsymbollayer.h>
Public Types | |
enum | AngleOrientation { ClockwiseFromNorth = 0, CounterclockwiseFromEast } |
enum | AngleUnits { Degrees = 0, Radians } |
enum | VectorFieldType { Cartesian = 0, Polar, Height } |
![]() | |
enum | HorizontalAnchorPoint { Left, HCenter, Right } |
Symbol horizontal anchor points. More... | |
enum | VerticalAnchorPoint { Top, VCenter, Bottom } |
Symbol vertical anchor points. More... | |
Public Member Functions | |
QgsVectorFieldSymbolLayer () | |
~QgsVectorFieldSymbolLayer () | |
AngleOrientation | angleOrientation () const |
AngleUnits | angleUnits () const |
QgsVectorFieldSymbolLayer * | clone () const override |
Shall be reimplemented by subclasses to create a deep copy of the instance. More... | |
virtual QColor | color () const override |
The fill color. More... | |
const QgsMapUnitScale & | distanceMapUnitScale () const |
QgsSymbolV2::OutputUnit | distanceUnit () const |
void | drawPreviewIcon (QgsSymbolV2RenderContext &context, QSize size) override |
QString | layerType () const override |
Returns a string that represents this layer type. More... | |
QgsMapUnitScale | mapUnitScale () const override |
QgsSymbolV2::OutputUnit | outputUnit () const override |
QgsStringMap | properties () const override |
Should be reimplemented by subclasses to return a string map that contains the configuration information for the symbol layer. More... | |
void | renderPoint (QPointF point, QgsSymbolV2RenderContext &context) override |
Renders a marker at the specified point. More... | |
double | scale () const |
void | setAngleOrientation (AngleOrientation orientation) |
void | setAngleUnits (AngleUnits units) |
void | setColor (const QColor &color) override |
The fill color. More... | |
void | setDistanceMapUnitScale (const QgsMapUnitScale &scale) |
void | setDistanceUnit (QgsSymbolV2::OutputUnit unit) |
void | setMapUnitScale (const QgsMapUnitScale &scale) override |
void | setOutputUnit (QgsSymbolV2::OutputUnit unit) override |
void | setScale (double s) |
bool | setSubSymbol (QgsSymbolV2 *symbol) override |
set layer's subsymbol. takes ownership of the passed symbol More... | |
void | setVectorFieldType (VectorFieldType type) |
void | setXAttribute (const QString &attribute) |
void | setYAttribute (const QString &attribute) |
void | startRender (QgsSymbolV2RenderContext &context) override |
void | stopRender (QgsSymbolV2RenderContext &context) override |
QgsSymbolV2 * | subSymbol () override |
void | toSld (QDomDocument &doc, QDomElement &element, const QgsStringMap &props) const override |
Writes the SLD element following the SLD v1.1 specs. More... | |
QSet< QString > | usedAttributes () const override |
Returns the set of attributes referenced by the layer. More... | |
VectorFieldType | vectorFieldType () const |
QString | xAttribute () const |
QString | yAttribute () const |
![]() | |
double | angle () const |
Returns the rotation angle for the marker, in degrees clockwise from north. More... | |
virtual QRectF | bounds (QPointF point, QgsSymbolV2RenderContext &context) |
Returns the approximate bounding box of the marker symbol layer, taking into account any data defined overrides and offsets which are set for the marker layer. More... | |
HorizontalAnchorPoint | horizontalAnchorPoint () const |
Returns the horizontal anchor point for positioning the symbol. More... | |
QPointF | offset () const |
Returns the marker's offset, which is the horizontal and vertical displacement which the rendered marker will have from the original feature's geometry. More... | |
const QgsMapUnitScale & | offsetMapUnitScale () const |
Returns the map unit scale for the symbol's offset. More... | |
QgsSymbolV2::OutputUnit | offsetUnit () const |
Returns the units for the symbol's offset. More... | |
QgsSymbolV2::ScaleMethod | scaleMethod () const |
Returns the method to use for scaling the marker's size. More... | |
void | setAngle (double angle) |
Sets the rotation angle for the marker. More... | |
void | setHorizontalAnchorPoint (HorizontalAnchorPoint h) |
Sets the horizontal anchor point for positioning the symbol. More... | |
void | setLineAngle (double lineAngle) |
Sets the line angle modification for the symbol's angle. More... | |
void | setOffset (QPointF offset) |
Sets the marker's offset, which is the horizontal and vertical displacement which the rendered marker should have from the original feature's geometry. More... | |
void | setOffsetMapUnitScale (const QgsMapUnitScale &scale) |
Sets the map unit scale for the symbol's offset. More... | |
void | setOffsetUnit (QgsSymbolV2::OutputUnit unit) |
Sets the units for the symbol's offset. More... | |
void | setScaleMethod (QgsSymbolV2::ScaleMethod scaleMethod) |
Sets the method to use for scaling the marker's size. More... | |
void | setSize (double size) |
Sets the symbol size. More... | |
void | setSizeMapUnitScale (const QgsMapUnitScale &scale) |
Sets the map unit scale for the symbol's size. More... | |
void | setSizeUnit (QgsSymbolV2::OutputUnit unit) |
Sets the units for the symbol's size. More... | |
void | setVerticalAnchorPoint (VerticalAnchorPoint v) |
Sets the vertical anchor point for positioning the symbol. More... | |
double | size () const |
Returns the symbol size. More... | |
const QgsMapUnitScale & | sizeMapUnitScale () const |
Returns the map unit scale for the symbol's size. More... | |
QgsSymbolV2::OutputUnit | sizeUnit () const |
Returns the units for the symbol's size. More... | |
VerticalAnchorPoint | verticalAnchorPoint () const |
Returns the vertical anchor point for positioning the symbol. More... | |
virtual void | writeSldMarker (QDomDocument &doc, QDomElement &element, const QgsStringMap &props) const |
Writes the symbol layer definition as a SLD XML element. More... | |
![]() | |
virtual | ~QgsSymbolLayerV2 () |
virtual Q_DECL_DEPRECATED const QgsExpression * | dataDefinedProperty (const QString &property) const |
Returns a data defined expression for a property, if set. More... | |
virtual Q_DECL_DEPRECATED QString | dataDefinedPropertyString (const QString &property) const |
Returns a data defined expression for a property, if set. More... | |
virtual double | dxfAngle (QgsSymbolV2RenderContext &context) const |
get angle More... | |
virtual QColor | dxfBrushColor (QgsSymbolV2RenderContext &context) const |
get brush/fill color More... | |
virtual Qt::BrushStyle | dxfBrushStyle () const |
get brush/fill style More... | |
virtual QColor | dxfColor (QgsSymbolV2RenderContext &context) const |
get color More... | |
virtual QVector< qreal > | dxfCustomDashPattern (QgsSymbolV2::OutputUnit &unit) const |
get dash pattern More... | |
virtual double | dxfOffset (const QgsDxfExport &e, QgsSymbolV2RenderContext &context) const |
get offset More... | |
virtual Qt::PenStyle | dxfPenStyle () const |
get pen style More... | |
virtual double | dxfWidth (const QgsDxfExport &e, QgsSymbolV2RenderContext &context) const |
get line width More... | |
virtual double | estimateMaxBleed () const |
Returns the estimated maximum distance which the layer style will bleed outside the drawn shape. More... | |
virtual Q_DECL_DEPRECATED QVariant | evaluateDataDefinedProperty (const QString &property, const QgsFeature *feature, const QVariant &defaultVal=QVariant(), bool *ok=nullptr) const |
Evaluates the matching data defined property and returns the calculated value. More... | |
virtual QVariant | evaluateDataDefinedProperty (const QString &property, const QgsSymbolV2RenderContext &context, const QVariant &defaultVal=QVariant(), bool *ok=nullptr) const |
Evaluates the matching data defined property and returns the calculated value. More... | |
virtual QColor | fillColor () const |
Get fill color. More... | |
virtual QgsDataDefined * | getDataDefinedProperty (const QString &property) const |
Returns the data defined property corresponding to the specified property key. More... | |
virtual bool | hasDataDefinedProperties () const |
Checks whether the layer has any associated data defined properties. More... | |
virtual bool | hasDataDefinedProperty (const QString &property) const |
Checks whether the layer has a matching data defined property and if that property is currently actived. More... | |
virtual bool | isCompatibleWithSymbol (QgsSymbolV2 *symbol) const |
Returns if the layer can be used below the specified symbol. More... | |
bool | isLocked () const |
virtual QString | ogrFeatureStyle (double mmScaleFactor, double mapUnitScaleFactor) const |
virtual QColor | outlineColor () const |
Get outline color. More... | |
QgsPaintEffect * | paintEffect () const |
Returns the current paint effect for the layer. More... | |
virtual void | removeDataDefinedProperties () |
Removes all data defined properties from the layer and deletes associated objects. More... | |
virtual void | removeDataDefinedProperty (const QString &property) |
Removes a data defined property from the layer. More... | |
int | renderingPass () const |
virtual Q_DECL_DEPRECATED void | setDataDefinedProperty (const QString &property, const QString &expressionString) |
Sets a data defined expression for a property. More... | |
virtual void | setDataDefinedProperty (const QString &property, QgsDataDefined *dataDefined) |
Sets a data defined property for the layer. More... | |
virtual void | setFillColor (const QColor &color) |
Set fill color. More... | |
void | setLocked (bool locked) |
virtual void | setOutlineColor (const QColor &color) |
Set outline color. More... | |
void | setPaintEffect (QgsPaintEffect *effect) |
Sets the current paint effect for the layer. More... | |
void | setRenderingPass (int renderingPass) |
QgsSymbolV2::SymbolType | type () const |
virtual bool | writeDxf (QgsDxfExport &e, double mmMapUnitScaleFactor, const QString &layerName, QgsSymbolV2RenderContext &context, QPointF shift=QPointF(0.0, 0.0)) const |
write as DXF More... | |
Static Public Member Functions | |
static QgsSymbolLayerV2 * | create (const QgsStringMap &properties=QgsStringMap()) |
static QgsSymbolLayerV2 * | createFromSld (QDomElement &element) |
Additional Inherited Members | |
![]() | |
QgsMarkerSymbolLayerV2 (bool locked=false) | |
Constructor for QgsMarkerSymbolLayerV2. More... | |
void | markerOffset (QgsSymbolV2RenderContext &context, double &offsetX, double &offsetY) const |
Calculates the required marker offset, including both the symbol offset and any displacement required to align with the marker's anchor point. More... | |
void | markerOffset (QgsSymbolV2RenderContext &context, double width, double height, double &offsetX, double &offsetY) const |
Calculates the required marker offset, including both the symbol offset and any displacement required to align with the marker's anchor point. More... | |
void | markerOffset (QgsSymbolV2RenderContext &context, double width, double height, QgsSymbolV2::OutputUnit widthUnit, QgsSymbolV2::OutputUnit heightUnit, double &offsetX, double &offsetY, const QgsMapUnitScale &widthMapUnitScale, const QgsMapUnitScale &heightMapUnitScale) const |
![]() | |
QgsSymbolLayerV2 (QgsSymbolV2::SymbolType type, bool locked=false) | |
void | copyDataDefinedProperties (QgsSymbolLayerV2 *destLayer) const |
Copies all data defined properties of this layer to another symbol layer. More... | |
void | copyPaintEffect (QgsSymbolLayerV2 *destLayer) const |
Copies paint effect of this layer to another symbol layer. More... | |
virtual Q_DECL_DEPRECATED QgsExpression * | expression (const QString &property) const |
Returns the data defined expression associated with a property. More... | |
virtual Q_DECL_DEPRECATED void | prepareExpressions (const QgsFields *fields, double scale=-1.0) |
Prepares all data defined property expressions for evaluation. More... | |
virtual void | prepareExpressions (const QgsSymbolV2RenderContext &context) |
Prepares all data defined property expressions for evaluation. More... | |
void | restoreDataDefinedProperties (const QgsStringMap &stringMap) |
Restores all data defined properties from string map. More... | |
void | saveDataDefinedProperties (QgsStringMap &stringMap) const |
Saves all data defined properties to a string map. More... | |
![]() | |
static QPointF | _rotatedOffset (QPointF offset, double angle) |
Adjusts a marker offset to account for rotation. More... | |
![]() | |
double | mAngle |
Marker rotation angle, in degrees clockwise from north. More... | |
HorizontalAnchorPoint | mHorizontalAnchorPoint |
Horizontal anchor point. More... | |
double | mLineAngle |
Line rotation angle (see setLineAngle() for details) More... | |
QPointF | mOffset |
Marker offset. More... | |
QgsMapUnitScale | mOffsetMapUnitScale |
Offset map unit scale. More... | |
QgsSymbolV2::OutputUnit | mOffsetUnit |
Offset units. More... | |
QgsSymbolV2::ScaleMethod | mScaleMethod |
Marker size scaling method. More... | |
double | mSize |
Marker size. More... | |
QgsMapUnitScale | mSizeMapUnitScale |
Marker size map unit scale. More... | |
QgsSymbolV2::OutputUnit | mSizeUnit |
Marker size unit. More... | |
VerticalAnchorPoint | mVerticalAnchorPoint |
Vertical anchor point. More... | |
![]() | |
QColor | mColor |
QMap< QString, QgsDataDefined *> | mDataDefinedProperties |
QgsFields | mFields |
bool | mLocked |
QgsPaintEffect * | mPaintEffect |
int | mRenderingPass |
QgsSymbolV2::SymbolType | mType |
![]() | |
static const QString | EXPR_ALPHA |
static const QString | EXPR_ANGLE |
static const QString | EXPR_BLUR_RADIUS |
static const QString | EXPR_BORDER_COLOR |
static const QString | EXPR_BORDER_STYLE |
static const QString | EXPR_CAPSTYLE |
static const QString | EXPR_CHAR |
static const QString | EXPR_COLOR |
static const QString | EXPR_COLOR2 |
static const QString | EXPR_COLOR_BORDER |
static const QString | EXPR_COORDINATE_MODE |
static const QString | EXPR_CUSTOMDASH |
static const QString | EXPR_DISPLACEMENT_X |
static const QString | EXPR_DISPLACEMENT_Y |
static const QString | EXPR_DISTANCE |
static const QString | EXPR_DISTANCE_X |
static const QString | EXPR_DISTANCE_Y |
static const QString | EXPR_FILE |
static const QString | EXPR_FILL |
static const QString | EXPR_FILL_COLOR |
static const QString | EXPR_FILL_STYLE |
static const QString | EXPR_GRADIENT_TYPE |
static const QString | EXPR_HEIGHT |
static const QString | EXPR_HORIZONTAL_ANCHOR_POINT |
static const QString | EXPR_IGNORE_RINGS |
static const QString | EXPR_INTERVAL |
static const QString | EXPR_JOIN_STYLE |
static const QString | EXPR_JOINSTYLE |
static const QString | EXPR_LINE_STYLE |
static const QString | EXPR_LINEANGLE |
static const QString | EXPR_LINEWIDTH |
static const QString | EXPR_MAX_DISTANCE |
static const QString | EXPR_NAME |
static const QString | EXPR_OFFSET |
static const QString | EXPR_OFFSET_ALONG_LINE |
static const QString | EXPR_OUTLINE |
static const QString | EXPR_OUTLINE_COLOR |
static const QString | EXPR_OUTLINE_STYLE |
static const QString | EXPR_OUTLINE_WIDTH |
static const QString | EXPR_PLACEMENT |
static const QString | EXPR_REFERENCE1_ISCENTROID |
static const QString | EXPR_REFERENCE1_X |
static const QString | EXPR_REFERENCE1_Y |
static const QString | EXPR_REFERENCE2_ISCENTROID |
static const QString | EXPR_REFERENCE2_X |
static const QString | EXPR_REFERENCE2_Y |
static const QString | EXPR_ROTATION |
static const QString | EXPR_SIZE |
static const QString | EXPR_SPREAD |
static const QString | EXPR_SVG_FILE |
static const QString | EXPR_SVG_FILL_COLOR |
static const QString | EXPR_SVG_OUTLINE_COLOR |
static const QString | EXPR_SVG_OUTLINE_WIDTH |
static const QString | EXPR_SYMBOL_NAME |
static const QString | EXPR_USE_WHOLE_SHAPE |
static const QString | EXPR_VERTICAL_ANCHOR_POINT |
static const QString | EXPR_WIDTH |
static const QString | EXPR_WIDTH_BORDER |
static const bool | selectFillBorder = false |
static const bool | selectFillStyle = false |
static const bool | selectionIsOpaque = true |
A symbol layer class for displaying displacement arrows based on point layer attributes.
Definition at line 25 of file qgsvectorfieldsymbollayer.h.
Enumerator | |
---|---|
ClockwiseFromNorth | |
CounterclockwiseFromEast |
Definition at line 35 of file qgsvectorfieldsymbollayer.h.
Enumerator | |
---|---|
Degrees | |
Radians |
Definition at line 41 of file qgsvectorfieldsymbollayer.h.
Enumerator | |
---|---|
Cartesian | |
Polar | |
Height |
Definition at line 28 of file qgsvectorfieldsymbollayer.h.
QgsVectorFieldSymbolLayer::QgsVectorFieldSymbolLayer | ( | ) |
Definition at line 22 of file qgsvectorfieldsymbollayer.cpp.
QgsVectorFieldSymbolLayer::~QgsVectorFieldSymbolLayer | ( | ) |
Definition at line 37 of file qgsvectorfieldsymbollayer.cpp.
|
inline |
Definition at line 85 of file qgsvectorfieldsymbollayer.h.
|
inline |
Definition at line 87 of file qgsvectorfieldsymbollayer.h.
|
overridevirtual |
Shall be reimplemented by subclasses to create a deep copy of the instance.
Implements QgsSymbolLayerV2.
Definition at line 234 of file qgsvectorfieldsymbollayer.cpp.
|
overridevirtual |
The fill color.
Reimplemented from QgsSymbolLayerV2.
Definition at line 334 of file qgsvectorfieldsymbollayer.cpp.
|
static |
Definition at line 72 of file qgsvectorfieldsymbollayer.cpp.
|
static |
Definition at line 270 of file qgsvectorfieldsymbollayer.cpp.
|
inline |
Definition at line 99 of file qgsvectorfieldsymbollayer.h.
|
inline |
Definition at line 96 of file qgsvectorfieldsymbollayer.h.
|
overridevirtual |
Reimplemented from QgsMarkerSymbolLayerV2.
Definition at line 276 of file qgsvectorfieldsymbollayer.cpp.
|
inlineoverridevirtual |
Returns a string that represents this layer type.
Used for serialization. Should match with the string used to register this symbol layer in the registry.
Implements QgsSymbolLayerV2.
Definition at line 53 of file qgsvectorfieldsymbollayer.h.
|
overridevirtual |
Reimplemented from QgsMarkerSymbolLayerV2.
Definition at line 63 of file qgsvectorfieldsymbollayer.cpp.
|
overridevirtual |
Reimplemented from QgsMarkerSymbolLayerV2.
Definition at line 48 of file qgsvectorfieldsymbollayer.cpp.
|
overridevirtual |
Should be reimplemented by subclasses to return a string map that contains the configuration information for the symbol layer.
This is used to serialize a symbol layer perstistently.
Implements QgsSymbolLayerV2.
Definition at line 244 of file qgsvectorfieldsymbollayer.cpp.
|
overridevirtual |
Renders a marker at the specified point.
Derived classes must implement this to handle drawing the point.
point | position at which to render point, in painter units |
context | symbol render context |
Implements QgsMarkerSymbolLayerV2.
Definition at line 145 of file qgsvectorfieldsymbollayer.cpp.
|
inline |
Definition at line 81 of file qgsvectorfieldsymbollayer.h.
|
inline |
Definition at line 84 of file qgsvectorfieldsymbollayer.h.
|
inline |
Definition at line 86 of file qgsvectorfieldsymbollayer.h.
|
overridevirtual |
The fill color.
Reimplemented from QgsSymbolLayerV2.
Definition at line 326 of file qgsvectorfieldsymbollayer.cpp.
|
inline |
Definition at line 98 of file qgsvectorfieldsymbollayer.h.
|
inline |
Definition at line 95 of file qgsvectorfieldsymbollayer.h.
|
overridevirtual |
Reimplemented from QgsMarkerSymbolLayerV2.
Definition at line 57 of file qgsvectorfieldsymbollayer.cpp.
|
overridevirtual |
Reimplemented from QgsMarkerSymbolLayerV2.
Definition at line 42 of file qgsvectorfieldsymbollayer.cpp.
|
inline |
Definition at line 80 of file qgsvectorfieldsymbollayer.h.
|
overridevirtual |
set layer's subsymbol. takes ownership of the passed symbol
Reimplemented from QgsSymbolLayerV2.
Definition at line 134 of file qgsvectorfieldsymbollayer.cpp.
|
inline |
Definition at line 82 of file qgsvectorfieldsymbollayer.h.
|
inline |
Definition at line 76 of file qgsvectorfieldsymbollayer.h.
|
inline |
Definition at line 78 of file qgsvectorfieldsymbollayer.h.
|
overridevirtual |
Reimplemented from QgsMarkerSymbolLayerV2.
Definition at line 206 of file qgsvectorfieldsymbollayer.cpp.
|
overridevirtual |
Implements QgsSymbolLayerV2.
Definition at line 226 of file qgsvectorfieldsymbollayer.cpp.
|
inlineoverridevirtual |
Reimplemented from QgsSymbolLayerV2.
Definition at line 56 of file qgsvectorfieldsymbollayer.h.
|
overridevirtual |
Writes the SLD element following the SLD v1.1 specs.
Reimplemented from QgsMarkerSymbolLayerV2.
Definition at line 264 of file qgsvectorfieldsymbollayer.cpp.
Returns the set of attributes referenced by the layer.
This includes attributes required by any data defined properties associated with the layer.
Reimplemented from QgsSymbolLayerV2.
Definition at line 284 of file qgsvectorfieldsymbollayer.cpp.
|
inline |
Definition at line 83 of file qgsvectorfieldsymbollayer.h.
|
inline |
Definition at line 77 of file qgsvectorfieldsymbollayer.h.
|
inline |
Definition at line 79 of file qgsvectorfieldsymbollayer.h.