QGIS API Documentation
3.0.2-Girona (307d082)
|
Abstract base class for marker symbol layers. More...
#include <qgssymbollayer.h>
Public Member Functions | |
double | angle () const |
Returns the rotation angle for the marker, in degrees clockwise from north. More... | |
virtual QRectF | bounds (QPointF point, QgsSymbolRenderContext &context)=0 |
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... | |
void | drawPreviewIcon (QgsSymbolRenderContext &context, QSize size) override |
HorizontalAnchorPoint | horizontalAnchorPoint () const |
Returns the horizontal anchor point for positioning the symbol. More... | |
QgsMapUnitScale | mapUnitScale () const override |
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... | |
QgsUnitTypes::RenderUnit | offsetUnit () const |
Returns the units for the symbol's offset. More... | |
QgsUnitTypes::RenderUnit | outputUnit () const override |
Returns the units to use for sizes and widths within the symbol layer. More... | |
virtual void | renderPoint (QPointF point, QgsSymbolRenderContext &context)=0 |
Renders a marker at the specified point. More... | |
QgsSymbol::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 | setMapUnitScale (const QgsMapUnitScale &scale) override |
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 (QgsUnitTypes::RenderUnit unit) |
Sets the units for the symbol's offset. More... | |
void | setOutputUnit (QgsUnitTypes::RenderUnit unit) override |
Sets the units to use for sizes and widths within the symbol layer. More... | |
void | setScaleMethod (QgsSymbol::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 (QgsUnitTypes::RenderUnit 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... | |
QgsUnitTypes::RenderUnit | sizeUnit () const |
Returns the units for the symbol's size. More... | |
void | startRender (QgsSymbolRenderContext &context) override |
void | toSld (QDomDocument &doc, QDomElement &element, const QgsStringMap &props) const override |
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... | |
Public Member Functions inherited from QgsSymbolLayer | |
virtual | ~QgsSymbolLayer () |
virtual QgsSymbolLayer * | clone () const =0 |
Shall be reimplemented by subclasses to create a deep copy of the instance. More... | |
virtual QColor | color () const |
The fill color. More... | |
QgsPropertyCollection & | dataDefinedProperties () |
Returns a reference to the symbol layer's property collection, used for data defined overrides. More... | |
const QgsPropertyCollection & | dataDefinedProperties () const |
Returns a reference to the symbol layer's property collection, used for data defined overrides. More... | |
virtual double | dxfAngle (QgsSymbolRenderContext &context) const |
get angle More... | |
virtual QColor | dxfBrushColor (QgsSymbolRenderContext &context) const |
get brush/fill color More... | |
virtual Qt::BrushStyle | dxfBrushStyle () const |
get brush/fill style More... | |
virtual QColor | dxfColor (QgsSymbolRenderContext &context) const |
get color More... | |
virtual QVector< qreal > | dxfCustomDashPattern (QgsUnitTypes::RenderUnit &unit) const |
get dash pattern More... | |
virtual double | dxfOffset (const QgsDxfExport &e, QgsSymbolRenderContext &context) const |
get offset More... | |
virtual Qt::PenStyle | dxfPenStyle () const |
get pen style More... | |
virtual double | dxfWidth (const QgsDxfExport &e, QgsSymbolRenderContext &context) const |
get line width More... | |
bool | enabled () const |
Returns true if symbol layer is enabled and will be drawn. More... | |
virtual double | estimateMaxBleed (const QgsRenderContext &context) const |
Returns the estimated maximum distance which the layer style will bleed outside the drawn shape when drawn in the specified /a context. More... | |
virtual QColor | fillColor () const |
Get fill color. More... | |
virtual bool | isCompatibleWithSymbol (QgsSymbol *symbol) const |
Returns if the layer can be used below the specified symbol. More... | |
bool | isLocked () const |
virtual QString | layerType () const =0 |
Returns a string that represents this layer type. More... | |
virtual QString | ogrFeatureStyle (double mmScaleFactor, double mapUnitScaleFactor) const |
QgsPaintEffect * | paintEffect () const |
Returns the current paint effect for the layer. More... | |
virtual void | prepareExpressions (const QgsSymbolRenderContext &context) |
Prepares all data defined property expressions for evaluation. More... | |
virtual QgsStringMap | properties () const =0 |
Should be reimplemented by subclasses to return a string map that contains the configuration information for the symbol layer. More... | |
int | renderingPass () const |
virtual void | setColor (const QColor &color) |
The fill color. More... | |
void | setDataDefinedProperties (const QgsPropertyCollection &collection) |
Sets the symbol layer's property collection, used for data defined overrides. More... | |
virtual void | setDataDefinedProperty (Property key, const QgsProperty &property) |
Sets a data defined property for the layer. More... | |
void | setEnabled (bool enabled) |
Sets whether symbol layer is enabled and should be drawn. More... | |
virtual void | setFillColor (const QColor &color) |
Set fill color. More... | |
void | setLocked (bool locked) |
void | setPaintEffect (QgsPaintEffect *effect) |
Sets the current paint effect for the layer. More... | |
void | setRenderingPass (int renderingPass) |
virtual void | setStrokeColor (const QColor &color) |
Set stroke color. More... | |
virtual bool | setSubSymbol (QgsSymbol *symbol) |
set layer's subsymbol. takes ownership of the passed symbol More... | |
virtual void | stopRender (QgsSymbolRenderContext &context)=0 |
virtual QColor | strokeColor () const |
Get stroke color. More... | |
virtual QgsSymbol * | subSymbol () |
Returns the symbol's sub symbol, if present. More... | |
QgsSymbol::SymbolType | type () const |
virtual QSet< QString > | usedAttributes (const QgsRenderContext &context) const |
Returns the set of attributes referenced by the layer. More... | |
virtual bool | writeDxf (QgsDxfExport &e, double mmMapUnitScaleFactor, const QString &layerName, QgsSymbolRenderContext &context, QPointF shift=QPointF(0.0, 0.0)) const |
write as DXF More... | |
Protected Member Functions | |
QgsMarkerSymbolLayer (bool locked=false) | |
Constructor for QgsMarkerSymbolLayer. More... | |
void | markerOffset (QgsSymbolRenderContext &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 (QgsSymbolRenderContext &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 (QgsSymbolRenderContext &context, double width, double height, QgsUnitTypes::RenderUnit widthUnit, QgsUnitTypes::RenderUnit heightUnit, double &offsetX, double &offsetY, const QgsMapUnitScale &widthMapUnitScale, const QgsMapUnitScale &heightMapUnitScale) const |
Protected Member Functions inherited from QgsSymbolLayer | |
QgsSymbolLayer (QgsSymbol::SymbolType type, bool locked=false) | |
void | copyDataDefinedProperties (QgsSymbolLayer *destLayer) const |
Copies all data defined properties of this layer to another symbol layer. More... | |
void | copyPaintEffect (QgsSymbolLayer *destLayer) const |
Copies paint effect of this layer to another symbol layer. More... | |
void | restoreOldDataDefinedProperties (const QgsStringMap &stringMap) |
Restores older data defined properties from string map. More... | |
Static Protected Member Functions | |
static QPointF | _rotatedOffset (QPointF offset, double angle) |
Adjusts a marker offset to account for rotation. More... | |
Additional Inherited Members | |
Static Public Member Functions inherited from QgsSymbolLayer | |
static const QgsPropertiesDefinition & | propertyDefinitions () |
Returns the symbol layer property definitions. More... | |
Static Protected Attributes inherited from QgsSymbolLayer | |
static const bool | SELECT_FILL_BORDER = false |
Whether fill styles for selected features also highlight symbol stroke. More... | |
static const bool | SELECT_FILL_STYLE = false |
Whether fill styles for selected features uses symbol layer style. More... | |
static const bool | SELECTION_IS_OPAQUE = true |
Whether styles for selected features ignore symbol alpha. More... | |
Abstract base class for marker symbol layers.
Definition at line 455 of file qgssymbollayer.h.
Symbol horizontal anchor points.
Enumerator | |
---|---|
Left | Align to left side of symbol. |
HCenter | Align to horizontal center of symbol. |
Right | Align to right side of symbol. |
Definition at line 460 of file qgssymbollayer.h.
Symbol vertical anchor points.
Enumerator | |
---|---|
Top | Align to top of symbol. |
VCenter | Align to vertical center of symbol. |
Bottom | Align to bottom of symbol. |
Definition at line 468 of file qgssymbollayer.h.
|
protected |
Constructor for QgsMarkerSymbolLayer.
locked | set to true to lock symbol color |
Definition at line 382 of file qgssymbollayer.cpp.
|
staticprotected |
Adjusts a marker offset to account for rotation.
offset | offset prior to rotation |
angle | rotation angle in degrees clockwise from north |
Definition at line 498 of file qgssymbollayer.cpp.
|
inline |
Returns the rotation angle for the marker, in degrees clockwise from north.
Definition at line 499 of file qgssymbollayer.h.
|
pure virtual |
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.
Implemented in QgsFontMarkerSymbolLayer, QgsSvgMarkerSymbolLayer, QgsSimpleMarkerSymbolLayer, QgsEllipseSymbolLayer, QgsSimpleMarkerSymbolLayerBase, and QgsVectorFieldSymbolLayer.
|
overridevirtual |
Implements QgsSymbolLayer.
Reimplemented in QgsVectorFieldSymbolLayer.
Definition at line 403 of file qgssymbollayer.cpp.
|
inline |
Returns the horizontal anchor point for positioning the symbol.
The symbol will be drawn so that the horizontal anchor point is aligned with the marker's desired location.
Definition at line 644 of file qgssymbollayer.h.
|
overridevirtual |
Reimplemented from QgsSymbolLayer.
Reimplemented in QgsVectorFieldSymbolLayer.
Definition at line 558 of file qgssymbollayer.cpp.
|
protected |
Calculates the required marker offset, including both the symbol offset and any displacement required to align with the marker's anchor point.
context | symbol render context |
offsetX | will be set to required horizontal offset (in painter units) |
offsetY | will be set to required vertical offset (in painter units) |
Definition at line 419 of file qgssymbollayer.cpp.
|
protected |
Calculates the required marker offset, including both the symbol offset and any displacement required to align with the marker's anchor point.
context | symbol render context |
width | marker width |
height | marker height |
offsetX | will be set to required horizontal offset (in painter units) |
offsetY | will be set to required vertical offset (in painter units) |
Definition at line 424 of file qgssymbollayer.cpp.
|
protected |
Definition at line 429 of file qgssymbollayer.cpp.
|
inline |
Returns the marker's offset, which is the horizontal and vertical displacement which the rendered marker will have from the original feature's geometry.
Units are specified by offsetUnit().
Definition at line 593 of file qgssymbollayer.h.
|
inline |
Returns the map unit scale for the symbol's offset.
Definition at line 627 of file qgssymbollayer.h.
|
inline |
Returns the units for the symbol's offset.
Definition at line 610 of file qgssymbollayer.h.
|
overridevirtual |
Returns the units to use for sizes and widths within the symbol layer.
Individual symbol layer subclasses will interpret this in different ways, e.g., a marker symbol layer may use it to specify the units for the marker size, while a line symbol layer may use it to specify the units for the line width.
Reimplemented from QgsSymbolLayer.
Reimplemented in QgsVectorFieldSymbolLayer.
Definition at line 543 of file qgssymbollayer.cpp.
|
pure virtual |
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 |
Implemented in QgsFontMarkerSymbolLayer, QgsSvgMarkerSymbolLayer, QgsSimpleMarkerSymbolLayer, QgsSimpleMarkerSymbolLayerBase, QgsVectorFieldSymbolLayer, and QgsEllipseSymbolLayer.
|
inline |
Returns the method to use for scaling the marker's size.
Definition at line 574 of file qgssymbollayer.h.
|
inline |
Sets the rotation angle for the marker.
angle | angle in degrees clockwise from north. |
Definition at line 493 of file qgssymbollayer.h.
|
inline |
Sets the horizontal anchor point for positioning the symbol.
h | anchor point. Symbol will be drawn so that the horizontal anchor point is aligned with the marker's desired location. |
Definition at line 636 of file qgssymbollayer.h.
|
inline |
Sets the line angle modification for the symbol's angle.
This angle is added to the marker's rotation and data defined rotation before rendering the symbol, and is usually used for orienting symbols to match a line's angle.
lineAngle | Angle in degrees clockwise from north, valid values are between 0 and 360 |
Definition at line 510 of file qgssymbollayer.h.
|
overridevirtual |
Reimplemented from QgsSymbolLayer.
Reimplemented in QgsVectorFieldSymbolLayer.
Definition at line 552 of file qgssymbollayer.cpp.
|
inline |
Sets the marker's offset, which is the horizontal and vertical displacement which the rendered marker should have from the original feature's geometry.
offset | marker offset. Units are specified by offsetUnit() |
Definition at line 584 of file qgssymbollayer.h.
|
inline |
Sets the map unit scale for the symbol's offset.
scale | offset map unit scale |
Definition at line 619 of file qgssymbollayer.h.
|
inline |
Sets the units for the symbol's offset.
unit | offset units |
Definition at line 602 of file qgssymbollayer.h.
|
overridevirtual |
Sets the units to use for sizes and widths within the symbol layer.
Individual symbol layer subclasses will interpret this in different ways, e.g., a marker symbol layer may use it to specify the units for the marker size, while a line symbol layer may use it to specify the units for the line width.
unit | output units |
Reimplemented from QgsSymbolLayer.
Reimplemented in QgsVectorFieldSymbolLayer.
Definition at line 537 of file qgssymbollayer.cpp.
|
inline |
Sets the method to use for scaling the marker's size.
scaleMethod | scale method |
Definition at line 568 of file qgssymbollayer.h.
|
inline |
Sets the symbol size.
size | symbol size. Units are specified by sizeUnit(). |
Definition at line 519 of file qgssymbollayer.h.
|
inline |
Sets the map unit scale for the symbol's size.
scale | size map unit scale |
Definition at line 553 of file qgssymbollayer.h.
|
inline |
Sets the units for the symbol's size.
unit | size units |
Definition at line 536 of file qgssymbollayer.h.
|
inline |
Sets the vertical anchor point for positioning the symbol.
v | anchor point. Symbol will be drawn so that the vertical anchor point is aligned with the marker's desired location. |
Definition at line 653 of file qgssymbollayer.h.
|
inline |
Returns the symbol size.
Units are specified by sizeUnit().
Definition at line 527 of file qgssymbollayer.h.
|
inline |
Returns the map unit scale for the symbol's size.
Definition at line 561 of file qgssymbollayer.h.
|
inline |
Returns the units for the symbol's size.
Definition at line 544 of file qgssymbollayer.h.
|
overridevirtual |
Implements QgsSymbolLayer.
Reimplemented in QgsVectorFieldSymbolLayer.
Definition at line 398 of file qgssymbollayer.cpp.
|
overridevirtual |
Reimplemented from QgsSymbolLayer.
Reimplemented in QgsVectorFieldSymbolLayer.
Definition at line 689 of file qgssymbollayer.cpp.
|
inline |
Returns the vertical anchor point for positioning the symbol.
The symbol will be drawn so that the vertical anchor point is aligned with the marker's desired location.
Definition at line 661 of file qgssymbollayer.h.
|
inlinevirtual |
Writes the symbol layer definition as a SLD XML element.
doc | XML document |
element | parent XML element |
props | symbol layer definition (see properties()) |
Reimplemented in QgsFontMarkerSymbolLayer, QgsSvgMarkerSymbolLayer, QgsSimpleMarkerSymbolLayer, and QgsEllipseSymbolLayer.
Definition at line 671 of file qgssymbollayer.h.
|
protected |
Marker rotation angle, in degrees clockwise from north.
Definition at line 731 of file qgssymbollayer.h.
|
protected |
Horizontal anchor point.
Definition at line 749 of file qgssymbollayer.h.
|
protected |
Line rotation angle (see setLineAngle() for details)
Definition at line 733 of file qgssymbollayer.h.
|
protected |
Marker offset.
Definition at line 741 of file qgssymbollayer.h.
|
protected |
Offset map unit scale.
Definition at line 745 of file qgssymbollayer.h.
|
protected |
Offset units.
Definition at line 743 of file qgssymbollayer.h.
|
protected |
Marker size scaling method.
Definition at line 747 of file qgssymbollayer.h.
|
protected |
Marker size.
Definition at line 735 of file qgssymbollayer.h.
|
protected |
Marker size map unit scale.
Definition at line 739 of file qgssymbollayer.h.
|
protected |
Marker size unit.
Definition at line 737 of file qgssymbollayer.h.
|
protected |
Vertical anchor point.
Definition at line 751 of file qgssymbollayer.h.