A symbol layer class for displaying displacement arrows based on point layer attributes. More...

#include <qgsvectorfieldsymbollayer.h>

Inheritance diagram for QgsVectorFieldSymbolLayer:

Public Types
enum	AngleOrientation { ClockwiseFromNorth = 0, CounterclockwiseFromEast }

enum	AngleUnits { Degrees = 0, Radians }

enum	VectorFieldType { Cartesian = 0, Polar, Height }

Public Types inherited from QgsMarkerSymbolLayerV2
enum	HorizontalAnchorPoint { Left, HCenter, Right }

enum	VerticalAnchorPoint { Top, VCenter, Bottom }

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...

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

double	scale () const

void	setAngleOrientation (AngleOrientation orientation)

void	setAngleUnits (AngleUnits units)

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

QSet< QString >	usedAttributes () const override
	Returns the set of attributes referenced by the layer. More...

VectorFieldType	vectorFieldType () const

QString	xAttribute () const

QString	yAttribute () const

Public Member Functions inherited from QgsMarkerSymbolLayerV2
double	angle () const

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

QPointF	offset () const

const QgsMapUnitScale &	offsetMapUnitScale () const

QgsSymbolV2::OutputUnit	offsetUnit () const

QgsSymbolV2::ScaleMethod	scaleMethod () const

void	setAngle (double angle)

void	setHorizontalAnchorPoint (HorizontalAnchorPoint h)

void	setLineAngle (double lineAngle)
	Sets the line angle modification for the symbol's angle. More...

void	setOffset (QPointF offset)

void	setOffsetMapUnitScale (const QgsMapUnitScale &scale)

void	setOffsetUnit (QgsSymbolV2::OutputUnit unit)

void	setScaleMethod (QgsSymbolV2::ScaleMethod scaleMethod)

void	setSize (double size)

void	setSizeMapUnitScale (const QgsMapUnitScale &scale)

void	setSizeUnit (QgsSymbolV2::OutputUnit unit)

void	setVerticalAnchorPoint (VerticalAnchorPoint v)

double	size () const

const QgsMapUnitScale &	sizeMapUnitScale () const

QgsSymbolV2::OutputUnit	sizeUnit () const

VerticalAnchorPoint	verticalAnchorPoint () const

virtual void	writeSldMarker (QDomDocument &doc, QDomElement &element, const QgsStringMap &props) const

Public Member Functions inherited from QgsSymbolLayerV2
virtual	~QgsSymbolLayerV2 ()

virtual QColor	color () const
	The fill color. More...

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 QColor	dxfBrushColor (QgsSymbolV2RenderContext &context) const

virtual Qt::BrushStyle	dxfBrushStyle () const

virtual QColor	dxfColor (QgsSymbolV2RenderContext &context) const

virtual QVector< qreal >	dxfCustomDashPattern (QgsSymbolV2::OutputUnit &unit) const

virtual double	dxfOffset (const QgsDxfExport &e, QgsSymbolV2RenderContext &context) const

virtual Qt::PenStyle	dxfPenStyle () const

virtual double	dxfWidth (const QgsDxfExport &e, QgsSymbolV2RenderContext &context) const

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 void	setColor (const QColor &color)
	The fill color. More...

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, const QgsFeature f, QPointF shift=QPointF(0.0, 0.0)) const

Static Public Member Functions
static QgsSymbolLayerV2 *	create (const QgsStringMap &properties=QgsStringMap())

static QgsSymbolLayerV2 *	createFromSld (QDomElement &element)

Additional Inherited Members
Protected Member Functions inherited from QgsMarkerSymbolLayerV2
	QgsMarkerSymbolLayerV2 (bool locked=false)

void	markerOffset (QgsSymbolV2RenderContext &context, double &offsetX, double &offsetY) const

void	markerOffset (QgsSymbolV2RenderContext &context, double width, double height, double &offsetX, double &offsetY) const

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

Protected Member Functions inherited from QgsSymbolLayerV2
	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 Protected Member Functions inherited from QgsMarkerSymbolLayerV2
static QPointF	_rotatedOffset (QPointF offset, double angle)

Protected Attributes inherited from QgsMarkerSymbolLayerV2
double	mAngle

HorizontalAnchorPoint	mHorizontalAnchorPoint

double	mLineAngle

QPointF	mOffset

QgsMapUnitScale	mOffsetMapUnitScale

QgsSymbolV2::OutputUnit	mOffsetUnit

QgsSymbolV2::ScaleMethod	mScaleMethod

double	mSize

QgsMapUnitScale	mSizeMapUnitScale

QgsSymbolV2::OutputUnit	mSizeUnit

VerticalAnchorPoint	mVerticalAnchorPoint

Protected Attributes inherited from QgsSymbolLayerV2
QColor	mColor

QMap< QString, QgsDataDefined * >	mDataDefinedProperties

QgsFields	mFields

bool	mLocked

QgsPaintEffect *	mPaintEffect

int	mRenderingPass

QgsSymbolV2::SymbolType	mType

Static Protected Attributes inherited from QgsSymbolLayerV2
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

Detailed Description

A symbol layer class for displaying displacement arrows based on point layer attributes.

Definition at line 24 of file qgsvectorfieldsymbollayer.h.

Member Enumeration Documentation

enum QgsVectorFieldSymbolLayer::AngleOrientation

Enumerator
ClockwiseFromNorth
CounterclockwiseFromEast

Definition at line 34 of file qgsvectorfieldsymbollayer.h.

enum QgsVectorFieldSymbolLayer::AngleUnits

Enumerator
Degrees
Radians

Definition at line 40 of file qgsvectorfieldsymbollayer.h.

enum QgsVectorFieldSymbolLayer::VectorFieldType

Enumerator
Cartesian
Polar
Height

Definition at line 27 of file qgsvectorfieldsymbollayer.h.

Constructor & Destructor Documentation

QgsVectorFieldSymbolLayer::QgsVectorFieldSymbolLayer ( )

Definition at line 22 of file qgsvectorfieldsymbollayer.cpp.

QgsVectorFieldSymbolLayer::~QgsVectorFieldSymbolLayer ( )

Definition at line 37 of file qgsvectorfieldsymbollayer.cpp.

Member Function Documentation

AngleOrientation QgsVectorFieldSymbolLayer::angleOrientation ( ) const

inline

Definition at line 80 of file qgsvectorfieldsymbollayer.h.

AngleUnits QgsVectorFieldSymbolLayer::angleUnits ( ) const

inline

Definition at line 82 of file qgsvectorfieldsymbollayer.h.

QgsVectorFieldSymbolLayer * QgsVectorFieldSymbolLayer::clone ( ) const

overridevirtual

Shall be reimplemented by subclasses to create a deep copy of the instance.

Implements QgsSymbolLayerV2.

Definition at line 234 of file qgsvectorfieldsymbollayer.cpp.

QgsSymbolLayerV2 * QgsVectorFieldSymbolLayer::create ( const QgsStringMap & properties = QgsStringMap() )

static

Definition at line 72 of file qgsvectorfieldsymbollayer.cpp.

QgsSymbolLayerV2 * QgsVectorFieldSymbolLayer::createFromSld ( QDomElement & element )

static

Definition at line 270 of file qgsvectorfieldsymbollayer.cpp.

const QgsMapUnitScale& QgsVectorFieldSymbolLayer::distanceMapUnitScale ( ) const

inline

Definition at line 94 of file qgsvectorfieldsymbollayer.h.

QgsSymbolV2::OutputUnit QgsVectorFieldSymbolLayer::distanceUnit ( ) const

inline

Definition at line 91 of file qgsvectorfieldsymbollayer.h.

void QgsVectorFieldSymbolLayer::drawPreviewIcon	(	QgsSymbolV2RenderContext &	context,
		QSize	size
	)

overridevirtual

Reimplemented from QgsMarkerSymbolLayerV2.

Definition at line 276 of file qgsvectorfieldsymbollayer.cpp.

QString QgsVectorFieldSymbolLayer::layerType ( ) const

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 52 of file qgsvectorfieldsymbollayer.h.

QgsMapUnitScale QgsVectorFieldSymbolLayer::mapUnitScale ( ) const

overridevirtual

Reimplemented from QgsMarkerSymbolLayerV2.

Definition at line 63 of file qgsvectorfieldsymbollayer.cpp.

QgsSymbolV2::OutputUnit QgsVectorFieldSymbolLayer::outputUnit ( ) const

overridevirtual

Reimplemented from QgsMarkerSymbolLayerV2.

Definition at line 48 of file qgsvectorfieldsymbollayer.cpp.

QgsStringMap QgsVectorFieldSymbolLayer::properties ( ) const

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.

void QgsVectorFieldSymbolLayer::renderPoint	(	QPointF	point,
		QgsSymbolV2RenderContext &	context
	)

overridevirtual

Implements QgsMarkerSymbolLayerV2.

Definition at line 145 of file qgsvectorfieldsymbollayer.cpp.

double QgsVectorFieldSymbolLayer::scale ( ) const

inline

Definition at line 76 of file qgsvectorfieldsymbollayer.h.

void QgsVectorFieldSymbolLayer::setAngleOrientation ( AngleOrientation orientation )

inline

Definition at line 79 of file qgsvectorfieldsymbollayer.h.

void QgsVectorFieldSymbolLayer::setAngleUnits ( AngleUnits units )

inline

Definition at line 81 of file qgsvectorfieldsymbollayer.h.

void QgsVectorFieldSymbolLayer::setDistanceMapUnitScale ( const QgsMapUnitScale & scale )

inline

Definition at line 93 of file qgsvectorfieldsymbollayer.h.

void QgsVectorFieldSymbolLayer::setDistanceUnit ( QgsSymbolV2::OutputUnit unit )

inline

Definition at line 90 of file qgsvectorfieldsymbollayer.h.

void QgsVectorFieldSymbolLayer::setMapUnitScale ( const QgsMapUnitScale & scale )

overridevirtual

Reimplemented from QgsMarkerSymbolLayerV2.

Definition at line 57 of file qgsvectorfieldsymbollayer.cpp.

void QgsVectorFieldSymbolLayer::setOutputUnit ( QgsSymbolV2::OutputUnit unit )

overridevirtual

Reimplemented from QgsMarkerSymbolLayerV2.

Definition at line 42 of file qgsvectorfieldsymbollayer.cpp.

void QgsVectorFieldSymbolLayer::setScale ( double s )

inline

Definition at line 75 of file qgsvectorfieldsymbollayer.h.

bool QgsVectorFieldSymbolLayer::setSubSymbol ( QgsSymbolV2 * symbol )

overridevirtual

set layer's subsymbol. takes ownership of the passed symbol

Reimplemented from QgsSymbolLayerV2.

Definition at line 134 of file qgsvectorfieldsymbollayer.cpp.

void QgsVectorFieldSymbolLayer::setVectorFieldType ( VectorFieldType type )

inline

Definition at line 77 of file qgsvectorfieldsymbollayer.h.

void QgsVectorFieldSymbolLayer::setXAttribute ( const QString & attribute )

inline

Definition at line 71 of file qgsvectorfieldsymbollayer.h.

void QgsVectorFieldSymbolLayer::setYAttribute ( const QString & attribute )

inline

Definition at line 73 of file qgsvectorfieldsymbollayer.h.

void QgsVectorFieldSymbolLayer::startRender ( QgsSymbolV2RenderContext & context )

overridevirtual

Reimplemented from QgsMarkerSymbolLayerV2.

Definition at line 206 of file qgsvectorfieldsymbollayer.cpp.

void QgsVectorFieldSymbolLayer::stopRender ( QgsSymbolV2RenderContext & context )

overridevirtual

Implements QgsSymbolLayerV2.

Definition at line 226 of file qgsvectorfieldsymbollayer.cpp.

QgsSymbolV2* QgsVectorFieldSymbolLayer::subSymbol ( )

inlineoverridevirtual

Reimplemented from QgsSymbolLayerV2.

Definition at line 55 of file qgsvectorfieldsymbollayer.h.

void QgsVectorFieldSymbolLayer::toSld	(	QDomDocument &	doc,
		QDomElement &	element,
		const QgsStringMap &	props
	)		const

overridevirtual

Reimplemented from QgsMarkerSymbolLayerV2.

Definition at line 264 of file qgsvectorfieldsymbollayer.cpp.

QSet< QString > QgsVectorFieldSymbolLayer::usedAttributes ( ) const

overridevirtual

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.

VectorFieldType QgsVectorFieldSymbolLayer::vectorFieldType ( ) const

inline

Definition at line 78 of file qgsvectorfieldsymbollayer.h.

QString QgsVectorFieldSymbolLayer::xAttribute ( ) const

inline

Definition at line 72 of file qgsvectorfieldsymbollayer.h.

QString QgsVectorFieldSymbolLayer::yAttribute ( ) const

inline

Definition at line 74 of file qgsvectorfieldsymbollayer.h.

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

/tmp/buildd/qgis-2.14.0+99unstable/src/core/symbology-ng/qgsvectorfieldsymbollayer.h
/tmp/buildd/qgis-2.14.0+99unstable/src/core/symbology-ng/qgsvectorfieldsymbollayer.cpp

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation