A class for line symbol layers with customized geometric effects. More...
| Header: | #include <SolidStrokeSymbolLayer.h> |
| Since: | Esri::ArcGISRuntime 100.5 |
| Inherits: | Esri::ArcGISRuntime::StrokeSymbolLayer |
This class was introduced in Esri::ArcGISRuntime 100.5.
Public Functions
| SolidStrokeSymbolLayer(double width, const QColor &color, const QList<Esri::ArcGISRuntime::GeometricEffect *> &geometricEffects, Esri::ArcGISRuntime::StrokeSymbolLayerLineStyle3D lineStyle3D, QObject *parent = nullptr) | |
| SolidStrokeSymbolLayer(double width, const QColor &color, const QList<Esri::ArcGISRuntime::GeometricEffect *> &geometricEffects, QObject *parent = nullptr) | |
| SolidStrokeSymbolLayer(double width, const QColor &color, QObject *parent = nullptr) | |
| SolidStrokeSymbolLayer(QObject *parent = nullptr) | |
| virtual | ~SolidStrokeSymbolLayer() override |
| QColor | color() const |
| Esri::ArcGISRuntime::GeometricEffectListModel * | geometricEffects() const |
| void | setColor(const QColor &color) |
Detailed Description
Currently it only supports dash effects. This class is commonly used to represent line symbols to describe the appearance of the line, or in polygon symbols as an outline.
A SolidStrokeSymbolLayer represents a polyline geometry symbolized with a solid color.
This symbol layer, in a MultilayerPolylineSymbol alone, colors the geometry of the line with the specified solid color. The class also allows setting a collection of geometric effects, which modify the stroke in various ways (see documentation for geometric effects).
The SolidStrokeSymbolLayer provides a similar user experience to the SimpleLineSymbol, but, since it is a symbol layer, can be used in a MultilayerSymbol. The simple line styles of the SimpleLineSymbol are represented here by the DashGeometricEffect, but all dash patterns are custom. A solid stroke symbol layer in a multilayer polygon symbol will act as the outline of the fill.
Note: The units used for width is DIPs, except when LineStyle3D is StrokeSymbolLayerLineStyle3D::Tube which uses meters.
Member Function Documentation
SolidStrokeSymbolLayer::SolidStrokeSymbolLayer (double width, const QColor &color, const QList<Esri::ArcGISRuntime::GeometricEffect *> &geometricEffects , Esri::ArcGISRuntime::StrokeSymbolLayerLineStyle3D lineStyle3D , QObject *parent = nullptr)
Constructor that takes width, color, geometricEffects, lineStyle3D, and an optional parent.
Note: the list of geometric effects will automatically be added to the geometricEffects.
SolidStrokeSymbolLayer::SolidStrokeSymbolLayer (double width, const QColor &color, const QList<Esri::ArcGISRuntime::GeometricEffect *> &geometricEffects , QObject *parent = nullptr)
Constructor that takes width, color, geometricEffects, and an optional parent.
Properties default to the following values: strip 3D line style.
Note: the list of geometric effects will automatically be added to the geometricEffects.
SolidStrokeSymbolLayer::SolidStrokeSymbolLayer (double width, const QColor &color, QObject *parent = nullptr)
Constructor that takes width, color, and an optional parent.
Properties default to the following values: strip 3D line style.
SolidStrokeSymbolLayer::SolidStrokeSymbolLayer (QObject *parent = nullptr)
Default constructor that takes an optional parent.
Properties default to the following values: width of 4.0 points (5.333 DIPS), color is black, and strip 3D line style.
[override virtual] SolidStrokeSymbolLayer::~SolidStrokeSymbolLayer ()
Destructor.
QColor SolidStrokeSymbolLayer::color() const
Returns the color of the solid stroke symbol layer.
The default color is opaque black, RGBA(0, 0, 0, 255). The stroke will render with the specified color. When getting the color from a symbol, the consensus value (for all layers) is reported. If there is no consensus (one or more layers have different colors), a null value is reported for the color. Likewise, setting a value for color on a symbol will apply that color to all layers the symbol contains.
See also setColor() and SymbolLayer::isColorLocked.
Esri::ArcGISRuntime::GeometricEffectListModel *SolidStrokeSymbolLayer::geometricEffects () const
Returns the geometric effects as a modifiable list model.
void SolidStrokeSymbolLayer::setColor (const QColor &color)
Sets the color of the solid stroke symbol layer to color.
Setting a value for color on a symbol will apply that color to all layers the symbol contains. If you don't want changes to the symbol color to propagate to some of the symbol layers it contains, you can lock the color for those layers. If a symbol layer is color-locked, changes to the parent symbol will not affect the symbol layer. This also means that the layer will not be considered when determining a consensus color for the symbol as a whole.
Note: this property can only be modified if the symbol layer is not color locked.
See also color() and SymbolLayer::isColorLocked.