QGIS API Documentation  2.15.0-Master (af20121)
Public Member Functions | Static Public Member Functions | List of all members
QgsLineSymbolV2 Class Reference

#include <qgssymbolv2.h>

Inheritance diagram for QgsLineSymbolV2:
Inheritance graph
[legend]

Public Member Functions

 QgsLineSymbolV2 (const QgsSymbolLayerV2List &layers=QgsSymbolLayerV2List())
 
virtual QgsLineSymbolV2clone () const override
 
QgsDataDefined dataDefinedWidth () const
 Returns data defined size for whole symbol (including all symbol layers). More...
 
void renderPolyline (const QPolygonF &points, const QgsFeature *f, QgsRenderContext &context, int layer=-1, bool selected=false)
 
void setDataDefinedWidth (const QgsDataDefined &dd)
 Set data defined width for whole symbol (including all symbol layers). More...
 
void setWidth (double width)
 
double width () const
 
- Public Member Functions inherited from QgsSymbolV2
virtual ~QgsSymbolV2 ()
 
qreal alpha () const
 Get alpha transparency 1 for opaque, 0 for invisible. More...
 
bool appendSymbolLayer (QgsSymbolLayerV2 *layer)
 Append symbol layer at the end of the list Ownership will be transferred. More...
 
QImage asImage (QSize size, QgsRenderContext *customContext=nullptr)
 Generate symbol as image. More...
 
QImage bigSymbolPreviewImage (QgsExpressionContext *expressionContext=nullptr)
 Returns a large (roughly 100x100 pixel) preview image for the symbol. More...
 
bool changeSymbolLayer (int index, QgsSymbolLayerV2 *layer)
 delete layer at specified index and set a new one More...
 
bool clipFeaturesToExtent () const
 Returns whether features drawn by the symbol will be clipped to the render context's extent. More...
 
QColor color () const
 
bool deleteSymbolLayer (int index)
 delete symbol layer at specified index More...
 
void drawPreviewIcon (QPainter *painter, QSize size, QgsRenderContext *customContext=nullptr)
 Draw icon of the symbol that occupyies area given by size using the painter. More...
 
QString dump () const
 
void exportImage (const QString &path, const QString &format, QSize size)
 export symbol as image format. PNG and SVG supported More...
 
bool hasDataDefinedProperties () const
 Returns whether the symbol utilises any data defined properties. More...
 
bool insertSymbolLayer (int index, QgsSymbolLayerV2 *layer)
 Insert symbol layer to specified index Ownership will be transferred. More...
 
const QgsVectorLayerlayer () const
 
QgsMapUnitScale mapUnitScale () const
 
QgsSymbolV2::OutputUnit outputUnit () const
 
void renderFeature (const QgsFeature &feature, QgsRenderContext &context, int layer=-1, bool selected=false, bool drawVertexMarker=false, int currentVertexMarkerType=0, int currentVertexMarkerSize=0)
 Render a feature. More...
 
int renderHints () const
 
void setAlpha (qreal alpha)
 Set alpha transparency 1 for opaque, 0 for invisible. More...
 
void setClipFeaturesToExtent (bool clipFeaturesToExtent)
 Sets whether features drawn by the symbol should be clipped to the render context's extent. More...
 
void setColor (const QColor &color)
 
void setLayer (const QgsVectorLayer *layer)
 
void setMapUnitScale (const QgsMapUnitScale &scale)
 
void setOutputUnit (QgsSymbolV2::OutputUnit u)
 
void setRenderHints (int hints)
 
void startRender (QgsRenderContext &context, const QgsFields *fields=nullptr)
 
void stopRender (QgsRenderContext &context)
 
QgsSymbolLayerV2symbolLayer (int layer)
 Returns a specific symbol layers contained in the symbol. More...
 
int symbolLayerCount ()
 Returns total number of symbol layers contained in the symbol. More...
 
QgsSymbolLayerV2List symbolLayers ()
 Returns list of symbol layers contained in the symbol. More...
 
QgsSymbolV2RenderContextsymbolRenderContext ()
 Returns the symbol render context. More...
 
QgsSymbolLayerV2takeSymbolLayer (int index)
 Remove symbol layer from the list and return pointer to it. More...
 
void toSld (QDomDocument &doc, QDomElement &element, QgsStringMap props) const
 
SymbolType type () const
 
QSet< QStringusedAttributes () const
 Return a list of attributes required to render this feature. More...
 

Static Public Member Functions

static QgsLineSymbolV2createSimple (const QgsStringMap &properties)
 Create a line symbol with one symbol layer: SimpleLine with specified properties. More...
 
- Static Public Member Functions inherited from QgsSymbolV2
static QgsSymbolV2defaultSymbol (QGis::GeometryType geomType)
 return new default symbol for specified geometry type More...
 

Additional Inherited Members

- Public Types inherited from QgsSymbolV2
enum  OutputUnit {
  MM = 0, MapUnit, Mixed, Pixel,
  Percentage
}
 The unit of the output. More...
 
typedef QList< OutputUnitOutputUnitList
 
enum  RenderHint { DataDefinedSizeScale = 1, DataDefinedRotation = 2 }
 
enum  ScaleMethod { ScaleArea, ScaleDiameter }
 Scale method. More...
 
enum  SymbolType { Marker, Line, Fill, Hybrid }
 Type of the symbol. More...
 
- Protected Member Functions inherited from QgsSymbolV2
 QgsSymbolV2 (SymbolType type, const QgsSymbolLayerV2List &layers)
 
QgsSymbolLayerV2List cloneLayers () const
 Retrieve a cloned list of all layers that make up this symbol. More...
 
Q_DECL_DEPRECATED bool isSymbolLayerCompatible (SymbolType layerType)
 check whether a symbol layer type can be used within the symbol (marker-marker, line-line, fill-fill/line) More...
 
void renderUsingLayer (QgsSymbolLayerV2 *layer, QgsSymbolV2RenderContext &context)
 Renders a context using a particular symbol layer without passing in a geometry. More...
 
void renderVertexMarker (QPointF pt, QgsRenderContext &context, int currentVertexMarkerType, int currentVertexMarkerSize)
 Render editing vertex marker at specified point. More...
 
- Static Protected Member Functions inherited from QgsSymbolV2
static QgsConstWkbPtr _getLineString (QPolygonF &pts, QgsRenderContext &context, QgsConstWkbPtr wkb, bool clipToExtent=true)
 Creates a line string in screen coordinates from a wkb string in map coordinates. More...
 
static void _getPoint (QPointF &pt, QgsRenderContext &context, const QgsPointV2 *point)
 Creates a point in screen coordinates from a QgsPointV2 in map coordinates. More...
 
static QgsConstWkbPtr _getPoint (QPointF &pt, QgsRenderContext &context, QgsConstWkbPtr wkb)
 Creates a point in screen coordinates from a wkb string in map coordinates. More...
 
static QgsConstWkbPtr _getPolygon (QPolygonF &pts, QList< QPolygonF > &holes, QgsRenderContext &context, QgsConstWkbPtr wkb, bool clipToExtent=true)
 Creates a polygon in screen coordinates from a wkb string in map coordinates. More...
 
- Protected Attributes inherited from QgsSymbolV2
qreal mAlpha
 Symbol opacity (in the range 0 - 1) More...
 
bool mClipFeaturesToExtent
 
const QgsVectorLayermLayer
 
QgsSymbolLayerV2List mLayers
 
int mRenderHints
 
SymbolType mType
 

Detailed Description

Definition at line 593 of file qgssymbolv2.h.

Constructor & Destructor Documentation

QgsLineSymbolV2::QgsLineSymbolV2 ( const QgsSymbolLayerV2List layers = QgsSymbolLayerV2List())

Definition at line 1473 of file qgssymbolv2.cpp.

Member Function Documentation

QgsLineSymbolV2 * QgsLineSymbolV2::clone ( ) const
overridevirtual

Implements QgsSymbolV2.

Definition at line 1675 of file qgssymbolv2.cpp.

QgsLineSymbolV2 * QgsLineSymbolV2::createSimple ( const QgsStringMap properties)
static

Create a line symbol with one symbol layer: SimpleLine with specified properties.

This is a convenience method for easier creation of line symbols.

Definition at line 1029 of file qgssymbolv2.cpp.

QgsDataDefined QgsLineSymbolV2::dataDefinedWidth ( ) const

Returns data defined size for whole symbol (including all symbol layers).

Returns
data defined size, or empty data defined if size is not set at the line level
Note
added in QGIS 2.9
See also
setDataDefinedWidth

Definition at line 1560 of file qgssymbolv2.cpp.

void QgsLineSymbolV2::renderPolyline ( const QPolygonF points,
const QgsFeature f,
QgsRenderContext context,
int  layer = -1,
bool  selected = false 
)

Definition at line 1613 of file qgssymbolv2.cpp.

void QgsLineSymbolV2::setDataDefinedWidth ( const QgsDataDefined dd)

Set data defined width for whole symbol (including all symbol layers).

Parameters
dddata defined width
Note
added in QGIS 2.9
See also
dataDefinedWidth

Definition at line 1525 of file qgssymbolv2.cpp.

void QgsLineSymbolV2::setWidth ( double  width)

Definition at line 1480 of file qgssymbolv2.cpp.

double QgsLineSymbolV2::width ( ) const

Definition at line 1506 of file qgssymbolv2.cpp.


The documentation for this class was generated from the following files: