QgsVectorFieldSymbolLayer Class Reference

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

#include <qgsvectorfieldsymbollayer.h>

Inheritance diagram for QgsVectorFieldSymbolLayer:

Collaboration diagram for QgsVectorFieldSymbolLayer:

List of all members.

Public Types
enum	VectorFieldType { Cartesian = 0, Polar, Height }
enum	AngleOrientation { ClockwiseFromNorth = 0, CounterclockwiseFromEast }
enum	AngleUnits { Degrees = 0, Radians }
Public Member Functions
	QgsVectorFieldSymbolLayer ()
	~QgsVectorFieldSymbolLayer ()
QString	layerType () const
bool	setSubSymbol (QgsSymbolV2 *symbol)
QgsSymbolV2 *	subSymbol ()
void	renderPoint (const QPointF &point, QgsSymbolV2RenderContext &context)
void	startRender (QgsSymbolV2RenderContext &context)
void	stopRender (QgsSymbolV2RenderContext &context)
QgsSymbolLayerV2 *	clone () const
QgsStringMap	properties () const
void	toSld (QDomDocument &doc, QDomElement &element, QgsStringMap props) const
void	drawPreviewIcon (QgsSymbolV2RenderContext &context, QSize size)
QSet< QString >	usedAttributes () const
void	setXAttribute (const QString &attribute)
QString	xAttribute () const
void	setYAttribute (const QString &attribute)
QString	yAttribute () const
void	setScale (double s)
double	scale () const
void	setVectorFieldType (VectorFieldType type)
VectorFieldType	vectorFieldType () const
void	setAngleOrientation (AngleOrientation orientation)
AngleOrientation	angleOrientation () const
void	setAngleUnits (AngleUnits units)
AngleUnits	angleUnits () const
Static Public Member Functions
static QgsSymbolLayerV2 *	create (const QgsStringMap &properties=QgsStringMap())
static QgsSymbolLayerV2 *	createFromSld (QDomElement &element)
Private Member Functions
void	convertPolarToCartesian (double length, double angle, double &x, double &y) const
Private Attributes
QString	mXAttribute
QString	mYAttribute
double	mScale
VectorFieldType	mVectorFieldType
AngleOrientation	mAngleOrientation
AngleUnits	mAngleUnits
QgsLineSymbolV2 *	mLineSymbol
int	mXIndex
int	mYIndex

---

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 21 of file qgsvectorfieldsymbollayer.cpp.

References setSubSymbol().

Referenced by create().

QgsVectorFieldSymbolLayer::~QgsVectorFieldSymbolLayer

(

)

Definition at line 27 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.

QgsSymbolLayerV2 * QgsVectorFieldSymbolLayer::clone

(

)

const [virtual]

Implements QgsSymbolLayerV2.

Definition at line 158 of file qgsvectorfieldsymbollayer.cpp.

References QgsLineSymbolV2::clone(), create(), mLineSymbol, properties(), and QgsSymbolLayerV2::setSubSymbol().

void QgsVectorFieldSymbolLayer::convertPolarToCartesian	(	double	length,
		double	angle,
		double &	x,
		double &	y
	)		const [private]

Definition at line 214 of file qgsvectorfieldsymbollayer.cpp.

References QgsMarkerSymbolLayerV2::angle(), CounterclockwiseFromEast, Degrees, M_PI, mAngleOrientation, and mAngleUnits.

Referenced by renderPoint().

QgsSymbolLayerV2 * QgsVectorFieldSymbolLayer::create

(

const QgsStringMap &

properties = QgsStringMap()

)

[static]

Definition at line 31 of file qgsvectorfieldsymbollayer.cpp.

References QgsVectorFieldSymbolLayer(), setAngleOrientation(), setAngleUnits(), setScale(), setVectorFieldType(), setXAttribute(), and setYAttribute().

Referenced by clone(), and QgsSymbolLayerV2Registry::QgsSymbolLayerV2Registry().

QgsSymbolLayerV2 * QgsVectorFieldSymbolLayer::createFromSld

(

QDomElement &

element

)

[static]

Definition at line 186 of file qgsvectorfieldsymbollayer.cpp.

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

Reimplemented from QgsMarkerSymbolLayerV2.

Definition at line 192 of file qgsvectorfieldsymbollayer.cpp.

References QgsSymbolV2::drawPreviewIcon(), mLineSymbol, QgsRenderContext::painter(), QgsSymbolV2RenderContext::renderContext(), and QgsMarkerSymbolLayerV2::size().

QString QgsVectorFieldSymbolLayer::layerType

(

)

const [inline, virtual]

Implements QgsSymbolLayerV2.

Definition at line 52 of file qgsvectorfieldsymbollayer.h.

QgsStringMap QgsVectorFieldSymbolLayer::properties

(

)

const [virtual]

Implements QgsSymbolLayerV2.

Definition at line 168 of file qgsvectorfieldsymbollayer.cpp.

References mAngleOrientation, mAngleUnits, mScale, mVectorFieldType, mXAttribute, and mYAttribute.

Referenced by clone().

void QgsVectorFieldSymbolLayer::renderPoint	(	const QPointF &	point,
		QgsSymbolV2RenderContext &	context
	)		[virtual]

Implements QgsMarkerSymbolLayerV2.

Definition at line 71 of file qgsvectorfieldsymbollayer.cpp.

References QgsFeature::attributeMap(), Cartesian, convertPolarToCartesian(), QgsSymbolV2RenderContext::feature(), Height, mLineSymbol, mScale, mVectorFieldType, mXIndex, mYIndex, QgsSymbolV2RenderContext::outputLineWidth(), Polar, QgsSymbolV2RenderContext::renderContext(), and QgsLineSymbolV2::renderPolyline().

double QgsVectorFieldSymbolLayer::scale

(

void

)

const [inline]

Definition at line 76 of file qgsvectorfieldsymbollayer.h.

void QgsVectorFieldSymbolLayer::setAngleOrientation

(

AngleOrientation

orientation

)

[inline]

Definition at line 79 of file qgsvectorfieldsymbollayer.h.

Referenced by create().

void QgsVectorFieldSymbolLayer::setAngleUnits

(

AngleUnits

units

)

[inline]

Definition at line 81 of file qgsvectorfieldsymbollayer.h.

Referenced by create().

void QgsVectorFieldSymbolLayer::setScale

(

double

s

)

[inline]

Definition at line 75 of file qgsvectorfieldsymbollayer.h.

Referenced by create().

bool QgsVectorFieldSymbolLayer::setSubSymbol

(

QgsSymbolV2 *

symbol

)

[virtual]

Reimplemented from QgsSymbolLayerV2.

Definition at line 61 of file qgsvectorfieldsymbollayer.cpp.

References QgsSymbolV2::Line, mLineSymbol, and QgsSymbolV2::type().

Referenced by QgsVectorFieldSymbolLayer().

void QgsVectorFieldSymbolLayer::setVectorFieldType

(

VectorFieldType

type

)

[inline]

Definition at line 77 of file qgsvectorfieldsymbollayer.h.

References QgsSymbolLayerV2::type().

Referenced by create().

void QgsVectorFieldSymbolLayer::setXAttribute

(

const QString &

attribute

)

[inline]

Definition at line 71 of file qgsvectorfieldsymbollayer.h.

Referenced by create().

void QgsVectorFieldSymbolLayer::setYAttribute

(

const QString &

attribute

)

[inline]

Definition at line 73 of file qgsvectorfieldsymbollayer.h.

Referenced by create().

void QgsVectorFieldSymbolLayer::startRender

(

QgsSymbolV2RenderContext &

context

)

[virtual]

Implements QgsSymbolLayerV2.

Definition at line 130 of file qgsvectorfieldsymbollayer.cpp.

References QgsVectorLayer::fieldNameIndex(), QgsSymbolV2RenderContext::layer(), mLineSymbol, mXAttribute, mXIndex, mYAttribute, mYIndex, QgsSymbolV2RenderContext::renderContext(), and QgsSymbolV2::startRender().

void QgsVectorFieldSymbolLayer::stopRender

(

QgsSymbolV2RenderContext &

context

)

[virtual]

Implements QgsSymbolLayerV2.

Definition at line 150 of file qgsvectorfieldsymbollayer.cpp.

References mLineSymbol, QgsSymbolV2RenderContext::renderContext(), and QgsSymbolV2::stopRender().

QgsSymbolV2* QgsVectorFieldSymbolLayer::subSymbol

(

)

[inline, virtual]

Reimplemented from QgsSymbolLayerV2.

Definition at line 55 of file qgsvectorfieldsymbollayer.h.

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

Reimplemented from QgsMarkerSymbolLayerV2.

Definition at line 180 of file qgsvectorfieldsymbollayer.cpp.

References mLineSymbol, and QgsSymbolV2::toSld().

QSet< QString > QgsVectorFieldSymbolLayer::usedAttributes

(

)

const [virtual]

Reimplemented from QgsSymbolLayerV2.

Definition at line 200 of file qgsvectorfieldsymbollayer.cpp.

References mXAttribute, and mYAttribute.

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.

---

Member Data Documentation

AngleOrientation QgsVectorFieldSymbolLayer::mAngleOrientation [private]

Definition at line 89 of file qgsvectorfieldsymbollayer.h.

Referenced by convertPolarToCartesian(), and properties().

AngleUnits QgsVectorFieldSymbolLayer::mAngleUnits [private]

Definition at line 90 of file qgsvectorfieldsymbollayer.h.

Referenced by convertPolarToCartesian(), and properties().

QgsLineSymbolV2* QgsVectorFieldSymbolLayer::mLineSymbol [private]

Definition at line 92 of file qgsvectorfieldsymbollayer.h.

Referenced by clone(), drawPreviewIcon(), renderPoint(), setSubSymbol(), startRender(), stopRender(), and toSld().

double QgsVectorFieldSymbolLayer::mScale [private]

Definition at line 87 of file qgsvectorfieldsymbollayer.h.

Referenced by properties(), and renderPoint().

VectorFieldType QgsVectorFieldSymbolLayer::mVectorFieldType [private]

Definition at line 88 of file qgsvectorfieldsymbollayer.h.

Referenced by properties(), and renderPoint().

QString QgsVectorFieldSymbolLayer::mXAttribute [private]

Definition at line 85 of file qgsvectorfieldsymbollayer.h.

Referenced by properties(), startRender(), and usedAttributes().

int QgsVectorFieldSymbolLayer::mXIndex [private]

Definition at line 95 of file qgsvectorfieldsymbollayer.h.

Referenced by renderPoint(), and startRender().

QString QgsVectorFieldSymbolLayer::mYAttribute [private]

Definition at line 86 of file qgsvectorfieldsymbollayer.h.

Referenced by properties(), startRender(), and usedAttributes().

int QgsVectorFieldSymbolLayer::mYIndex [private]

Definition at line 96 of file qgsvectorfieldsymbollayer.h.

Referenced by renderPoint(), and startRender().

---

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

• src/core/symbology-ng/qgsvectorfieldsymbollayer.h
• src/core/symbology-ng/qgsvectorfieldsymbollayer.cpp